<?xml version="1.0" encoding="UTF-8"?>

<!-- 

============================================================================ 

Name        : publish.ant.xml 

Part of     : Helium 

Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

All rights reserved.

This component and the accompanying materials are made available

under the terms of the License "Eclipse Public License v1.0"

which accompanies this distribution, and is available

at the URL "http://www.eclipse.org/legal/epl-v10.html".

Initial Contributors:

Nokia Corporation - initial contribution.

Contributors:

Description:

============================================================================

-->

<project name="publish" xmlns:hlm="http://www.nokia.com/helium">

    <description>

    Zipping, delta zipping and copying targets

    </description>

    <import file="subcon.ant.xml" />

    <import file="internal-api/internal-api.ant.xml" />

    <import file="nwiki.ant.xml" />

    <import file="synergy.ant.xml" />

    <import file="test/test2_publishing_to_diamonds.ant.xml" />

    <property name="archive.max.number.of.threads" value="8" />

    <fileset id="publish.files" dir="${build.output.dir}">

        <include name="logs/**/*" />

        <exclude name="logs/**/*_ant_build.log" />

        <include name="development_flash_images/**/*" />

        <include name="release_flash_images/**/*" />

        <include name="sisfiles/**/*" />

        <include name="build_area/**/*" />

        <include name="relnotes/**/*" />

        <include name="test_results/**/*" />

        <include name="utilities/**/*" />

        <include name="images/**/*" />

        <include name="variant_images/**/*" />

        <include name="BaseForNightlyBuild.txt" />

    </fileset>

    <!-- above fileset divided into following 4 filesets-->

    <fileset id="publish.files1" dir="${build.output.dir}">

        <include name="logs/**/*" />

        <exclude name="logs/**/*_ant_build.log" />

    </fileset>

    <fileset id="publish.files2" dir="${build.output.dir}">

        <include name="development_flash_images/**/*" />

    </fileset>

    <fileset id="publish.files3" dir="${build.output.dir}">

        <include name="sisfiles/**/*" />

        <include name="build_area/**/*" />

        <include name="relnotes/**/*" />

        <include name="test_results/**/*" />

        <include name="utilities/**/*" />

        <include name="variant_images/**/*" />

        <include name="images/**/*" />

        <include name="BaseForNightlyBuild.txt" />

    </fileset>

    <fileset id="publish.files4" dir="${build.output.dir}">

        <include name="release_flash_images/**/*" />

    </fileset>

    <!-- list of filesets -->

    <property name="publish.fileset.ids" value="publish.files1,publish.files2,publish.files3,publish.files4" />

    <fileset id="helium.files" dir="${helium.dir}">

        <include name="*.bat" />

        <include name="**/*.ant.xml" />

        <include name="tools/common/**/*" />

        <include name="tools/release/**/*" />

    </fileset>

    <!-- 

        If publish property is set, copy the publish.files fileset to the publish.dir directory using 

        number.of.threads parallel threads

    -->

    <macrodef name="publishMacro" uri="http://www.nokia.com/helium">

        <sequential>

            <if>

                <isset property="publish" />

                <then>

                    <for list="${publish.fileset.ids}" param="fileset.id" parallel="true" threadCount='${number.of.threads}'>

                        <sequential>

                            <copy todir="${publish.dir}" preservelastmodified="true" failonerror="false">

                                <fileset refid="@{fileset.id}" />

                            </copy>

                        </sequential>

                    </for>

                </then>

            </if>

        </sequential>

    </macrodef>

    <!-- Creates the publish directory. Directory location is defined by property: ${publish.dir} -->

    <target name="prep-publish" if="publish">

        <mkdir dir="${publish.dir}" />

    </target>

    <!-- Parses the zip configuration file. Expands all the ant properties. -->

    <target name="preprocess-zip-config">

        <property name="zip.config.file.parsed" location="${temp.build.dir}/zip.cfg.xml.parsed" />

        <copy file="${zip.config.file}" tofile="${zip.config.file.parsed}" overwrite="true">

            <filterchain>

                <expandproperties />

            </filterchain>

        </copy>

    </target>

    <!-- This macro merges all the generated metadata files together.

    It uses the archiving configuration to find the output archive directory.

    The it merges all the <config.name>.metadata.xml files together.

    e.g:

    <pre>

    <hlm:mergeMetadataMacro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}"/>

    </pre>

    -->

    <scriptdef name="mergeMetadataMacro" language="jython" uri="http://www.nokia.com/helium">

        <attribute name="file" />

        <attribute name="config" />

        <![CDATA[

import configuration

import symrec

import os

import traceback

# Nicer name

self.setTaskName("merge-metadata")

def merge_filelist(merger, filelist):

    for filename in filelist:

        try:

            self.log(str("Merging %s" % filename))

            merger.merge(filename)

            os.unlink(filename)

        except Exception, exc:

            self.log("Warning: %s" % exc)

try:

    builder = configuration.NestedConfigurationBuilder(open(str(attributes.get('file')), 'r'))

    configSet = builder.getConfiguration()

    configs = configSet.getConfigurations(str(attributes.get('config')))

    if len(configs) > 0:

        filelist = []

        for config in configs:

            if config.get_boolean("grace.metadata", False):

                metadata = os.path.join(config['archives.dir'], config['name']+ ".metadata.xml")

                if os.path.exists(metadata):

                    self.log(str("Found %s" % metadata))

                    filelist.append(metadata)

        merger = None

        metadata_main = os.path.join(configs[0]['archives.dir'], "release_metadata.xml")

        if os.path.exists(metadata_main):

            merger = symrec.MetadataMerger(metadata_main)

            merge_filelist(merger, filelist)

            self.log(str("Writing %s" % metadata_main))

            merger.save()

        elif len(filelist) > 0:

            input = filelist.pop(0)

            merger = symrec.MetadataMerger(input)

            merge_filelist(merger, filelist)

            self.log(str("Writing %s" % metadata_main))

            merger.save(metadata_main)

            os.unlink(input)

except Exception, e:

    self.log('ERROR: %s' % e)

    traceback.print_exc()

    # Let's propagate at the moment

    raise e

]]> 

    </scriptdef>

    <!-- This macro allows you to add or update one archive definition inside the release metadata files.

    e.g.:

    <pre>

        <hlm:updateMetadataMacro file="<path>/release_metadata.xml" archive="<path>/archive.zip" />

    </pre>

     -->

    <scriptdef name="updateMetadataMacro" language="jython" uri="http://www.nokia.com/helium">

        <attribute name="file" />

        <attribute name="archive" />

        <attribute name="filters" />

        <![CDATA[

import symrec

import os

import traceback

import fileutils

self.setTaskName("updateMetadataMacro")

if attributes.get('file') is None:

    raise Exception('file attribute is not defined.')

if attributes.get('archive') is None:

    raise Exception('archive attribute is not defined.')

filters = None

if attributes.get('filters') is not None:

    filters = str(attributes.get('filters')).split(r',')

try:

    filename = str(attributes.get('file'))

    archive = str(attributes.get('archive'))

    if not os.path.exists(filename):

        raise Exception("Could not find file: %s" % filename)

    if not os.path.exists(archive):

        raise Exception("Could not find file: %s" % archive)

    self.log(str("Opening %s" % filename))

    md = symrec.ReleaseMetadata(filename)

    if os.path.basename(archive) not in md.keys():

        self.log(str("Adding %s to metadata" % os.path.basename(archive)))

        md.add_package(os.path.basename(archive), md5checksum=fileutils.getmd5(archive), size=os.path.getsize(archive), filters=filters)

    else:

        self.log(str("Updating %s to metadata" % os.path.basename(archive)))

        result = md[os.path.basename(archive)]

        result['md5checksum'] = unicode(fileutils.getmd5(archive))

        result['size'] = unicode(os.path.getsize(archive))

        if filters is not None:

            result['filters'] = filters

        md[os.path.basename(archive)] = result

    md.save()

except Exception, e:

    self.log('ERROR: %s' % e)

    traceback.print_exc()

    # Let's propagate at the moment

    raise e

]]> 

    </scriptdef>

    <!-- This macro update the metadata file generated by the config provided by file.

    e.g:

    <pre>

    <hlm:updateMD5Macro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}"/>

    </pre>

    -->

    <scriptdef name="updateMD5Macro" language="jython" uri="http://www.nokia.com/helium">

        <attribute name="file" />

        <attribute name="config" />

        <![CDATA[

import configuration

import archive

import os

import symrec

import traceback       

self.setTaskName("update-md5")

# Reading the config from Ant

try:

    config_filename = str(attributes.get('file'))

    spec_name = str(attributes.get('config'))

    # Loading the config file.                        

    builder = configuration.NestedConfigurationBuilder(open(config_filename, 'r'))

    configSet = builder.getConfiguration()

    configs = configSet.getConfigurations(spec_name)

    if len(configs) > 0:

        if os.path.exists(os.path.join(configs[0]['archives.dir'], "release_metadata.xml")):

            md5update = symrec.MD5Updater(os.path.join(configs[0]['archives.dir'], "release_metadata.xml"))

            md5update.update()

            md5update.save()

        else:

            self.log(str('WARNING: Could not find %s.' % os.path.join(configs[0]['archives.dir'], "release_metadata.xml")))

    else:

        self.log('WARNING: No config.')

except Exception, e:

    self.log('ERROR: %s' % e)

    traceback.print_exc()

    # Let's propagate at the moment

    raise e

]]> 

    </scriptdef>

    <condition property="archive.using.ec">

        <or>

            <equals arg1="${build.system}" arg2="ec-helium" />

            <equals arg1="${build.system}" arg2="sbs-ec" />

        </or>

    </condition>

    <!-- Zips files using a type and zip config file as args -->

    <macrodef name="zipContentMacro" uri="http://www.nokia.com/helium">

        <attribute name="type" />

        <attribute name="file" />

        <attribute name="ec" default="${archive.using.ec}"/>

        <sequential>

            <if>

                <not>

                    <isset property="zip.@{type}.log.file" />

                </not>

                <then>

                    <property name="zip.@{type}.log.file" location="${build.log.dir}/${build.id}_@{type}_zip.log" />

                </then>

            </if>

            <trycatch property="exception" reference="exception">

                <try>

                    <!-- Don't print 'compressing' on console -->

                    <hlm:logtoconsole action="stop" />

                    <!-- Stops writing on ...ant_build.log file-->

                    <hlm:startSpecificLogMacro name="${zip.@{type}.log.file}" />

                    <property name="zip.config.file.parsed" location="${temp.build.dir}/zip.cfg.xml.parsed" />

                    <copy file="@{file}" tofile="${zip.config.file.parsed}" overwrite="true">

                        <filterchain>

                            <expandproperties />

                        </filterchain>

                    </copy>

                    <hlm:updateArchiveConfig configtype="${zips.@{type}.spec.name}" configfileparsed="${zip.config.file.parsed}" usingec="@{ec}" />

                    <if>

                        <istrue value="@{ec}" />

                        <then>

                            <echo>emake.root.to.append=${emake.root.to.append}</echo>

                            <hlm:emakeMacro name="archive-full-@{type}" makefile="${build.drive}/ZIP_${zips.@{type}.spec.name}.make" target="all" dir="${build.drive}" annodetail="basic,history,file,waiting" root="${emake.root.to.append}" failonerror="false" />

                        </then>

                        <else>

                            <if>

                                <isgreaterthan arg1="${number.of.threads}" arg2="${archive.max.number.of.threads}"/>

                                <then>

                                    <ant antfile="${build.drive}/ZIP_${zips.@{type}.spec.name}.xml">

                                        <property name="number.of.threads" value="${archive.max.number.of.threads}"/>

                                    </ant>

                                </then>

                                <else>

                                    <ant antfile="${build.drive}/ZIP_${zips.@{type}.spec.name}.xml" />

                                </else>

                            </if>

                        </else>

                    </if>

                    <hlm:python>

import archive

import configuration

builder = configuration.NestedConfigurationBuilder(open(r'${zip.config.file.parsed}', 'r'))

configSet = builder.getConfiguration()

configs = configSet.getConfigurations(r'${zips.@{type}.spec.name}')

prebuilder = archive.ArchivePreBuilder(configuration.ConfigurationSet(configs), r'${zips.@{type}.spec.name}')

prebuilder.cleanupSubstDrives()

                    </hlm:python>

                    <hlm:mergeMetadataMacro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}" />

                    <hlm:updateMD5Macro file="${zip.config.file.parsed}" config="${zips.@{type}.spec.name}" />

                </try>

                <catch>

                    <!-- Printing and propagating the error -->

                    <echo>ERROR: ${exception}</echo>

                    <throw refid="exception"/>

                </catch>

                <finally>

                    <!-- Todo: metadata: Convert to metadata structure -->

                    <!-- Stops log back to main log. -->

                    <hlm:stopSpecificLogMacro name="${zip.@{type}.log.file}" />

                    <hlm:logtoconsole action="resume" />

                </finally>

            </trycatch>

            <hlm:assertFileExists file="${zip.@{type}.log.file}" />

            <copy file="${zip.@{type}.log.file}" tofile="${build.log.dir}/${build.id}_@{type}_archive.nopolicy.log" verbose="true">

                <filterchain>

                    <linecontainsregexp negate="true">

                        <regexp pattern="POLICY_(ERROR|WARNING|INFO)" />

                    </linecontainsregexp>

                </filterchain>

            </copy>

            <hlm:metadatarecord database="${metadata.dbfile}">

                <hlm:textmetadatainput>

                    <fileset casesensitive="false" file="${build.log.dir}/${build.id}_@{type}_archive.nopolicy.log" />

                    <metadatafilterset refid="filterset.archive.nopolicy" />

                </hlm:textmetadatainput>

            </hlm:metadatarecord>

            <hlm:signalMacro logfile="${build.log.dir}/${build.id}_@{type}_archive.nopolicy.log" 

                signal.input="archiveErrorSignalInput" />

            <!-- Extracting policy errors from archiving. -->

            <copy file="${zip.@{type}.log.file}" tofile="${build.log.dir}/${build.id}_@{type}_archive.policy.log" verbose="true">

                <filterchain>

                    <linecontainsregexp>

                        <regexp pattern="POLICY_(ERROR|WARNING|INFO)" />

                    </linecontainsregexp>

                    <tokenfilter>

                        <replaceregex pattern=".*(POLICY_(?:ERROR|WARNING|INFO))" replace="\1" flags="gi" />

                    </tokenfilter>

                </filterchain>

            </copy>

            <hlm:assertFileExists file="${build.log.dir}/${build.id}_@{type}_archive.policy.log" />

            <hlm:metadatarecord database="${metadata.dbfile}">

                <hlm:textmetadatainput>

                    <fileset casesensitive="false" file="${build.log.dir}/${build.id}_@{type}_archive.policy.log" />

                    <metadatafilterset refid="filterset.archive.policy" />

                </hlm:textmetadatainput>

            </hlm:metadatarecord>

            <hlm:signalMacro logfile="${build.log.dir}/${build.id}_@{type}_archive.policy.log" 

                signal.input="archivePolicyErrorSignalInput" />

        </sequential>

    </macrodef>

    <!--

    1. To update the archive configuration file with substituted drives information for UNC paths (if any).

    2. To create the .make file to zip the sources using EC.    

    -->

    <scriptdef name="updateArchiveConfig" language="jython" uri="http://www.nokia.com/helium">

        <attribute name="configtype" />

        <attribute name="configfileparsed" />

        <attribute name="usingec" />

        <![CDATA[

import archive

import configuration

import logging

import os

config_parsed_filename = str(attributes.get('configfileparsed'))

config_type = str(attributes.get('configtype'))

is_it_ec = str(attributes.get('usingec'))

builder = configuration.NestedConfigurationBuilder(open(config_parsed_filename, 'r'))

configSet = builder.getConfiguration()

configs = configSet.getConfigurations(config_type)

outputtype = 'ant'

outputext = '.xml'

if is_it_ec == "true":

    outputtype = 'make'

    outputext = '.make'

if len(configs) > 0:

    prebuilder = archive.ArchivePreBuilder(configuration.ConfigurationSet(configs), config_type, outputtype)

    if os.sep == '\\':

        toAppendEmakeRoot = prebuilder.checkRootDirValue(builder, config_parsed_filename, project.getProperty('build.drive'), config_type)

        if toAppendEmakeRoot is not None:

            project.setProperty("emake.root.to.append", str(toAppendEmakeRoot))

    prebuilder.writeTopLevel(os.path.join(project.getProperty('build.drive') + os.sep, 'ZIP_' + config_type + outputext), project.getProperty('temp.build.dir'), config_parsed_filename)       

else:

    raise Exception('There are no archive configs to build. Looked for %s' % config_type)

]]>

    </scriptdef>

    <!-- Zips the Engineering English content. -->

    <target name="zip-ee" unless="skip-zips">

        <hlm:zipContentMacro type="ee" file="${zip.config.file}" />

    </target>

    <!-- Zips the subcon content. -->

    <target name="zip-subcon" unless="skip-zips">

        <hlm:zipContentMacro type="subcon" file="${zip.config.file}" />

    </target>

    <!-- Zips the subcon rom content. -->

    <target name="zip-subcon-roms" unless="skip-zips">

        <hlm:zipContentMacro type="subcon_roms" file="${zip.config.file}" />

    </target>

    <!-- Zips the localised content. -->

    <target name="zip-localised" unless="skip-zips">

        <hlm:zipContentMacro type="localised" file="${zip.config.file}" />

    </target>

    <!-- Zips the trace rom content -->

    <target name="zip-trace-roms" unless="skip-zips">

        <hlm:zipContentMacro type="trace_roms" file="${zip.config.file}" />

    </target>

    <!-- Zips the trace rom content -->

    <target name="zip-uda-roms" unless="skip-zips">

        <hlm:zipContentMacro type="uda_roms" file="${zip.config.file}" />

    </target>

    <!-- Zips .loc files into individual packages. -->

    <target name="zip-loc-files">

        <mkdir dir="${temp.loc.dir}" />

        <exec executable="perl" dir="${build.drive}/" failonerror="${failonerror}">

            <arg file="${helium.dir}/tools/publish/get_loc_files.pl" />

            <arg value="${build.drive}" />

        </exec>

        <zip destfile="${loc.output.dir}/${loc.output.filename}" basedir="${temp.loc.dir}" />

    </target>

    <!-- Publishes the content defined by the filesets at the top of this project.

    The files are split into 4 filesets to parallelize the publish operation:

    * publish.files1

    * publish.files2

    * publish.files3

    * publish.files4

    All content is copied to the location defined by publish.dir. Also verify the source and target content after publish.

    -->

    <target name="publish" depends="prep-publish" if="publish">

        <hlm:publishMacro />

        <resourcecount property="total.changes.in.fileset">

            <fileset id="publish.files.location" dir="${build.output.dir}">

                <exclude name="logs/**/*_ant_build.log" />

                <exclude name="*" />

                <exclude name="build/**/*" />

                <exclude name="ec/**/*" />

                <exclude name="temp_build_files/**/*" />

                <exclude name="uda/**/*" />

                <different targetdir="${publish.dir}" ignoreFileTimes="true" ignoreContents="yes" />

            </fileset>

        </resourcecount>

        <if>

            <not>

                <equals arg1="${total.changes.in.fileset}" arg2="0" />

            </not>

            <then>

                <echo message="ERROR: There are ${total.changes.in.fileset} changes in the publish directory. Uploading the changes again..." />

                <hlm:publishMacro />

            </then>

        </if>

    </target>