<?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:

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

-->

<!--* @package publishing -->

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

    <description>

    Zipping, delta zipping and copying targets

    </description>

    <!--* @property zip.config.file

    The ZIP configuration XML file.

    @type string

    @editable required

    @scope public

    -->

    <!--* @property zips.ee.spec.name

    The name of the configuration section for EE zipping.

    @type string

    @editable optional

    @scope public

    -->

    <!--* @property zips.localised.spec.name

    The name of the configuration section for localisation zipping.

    @type string

    @editable optional

    @scope public

    -->

    <!--* @property zips.localised.spec.name

    The name of the configuration section for subcon zipping.

    @type string

    @editable optional

    @scope public

    -->

    <!--* @property delta.zip.file.size

    Define the file size of the zipped up released file, this is then used by delta zipping code to determine if a delta zip is required or a full zip should be created. The delta zip will only be published if it is less than 1/2 the size of this property

    @type string

    @editable required

    @scope public

    -->

    <!--* @property file-comparison.left_side

    The fileset id used on the left side of comparison.

    @type string

    @editable required

    @scope public

    -->

    <!--* @property file-comparison.right_side

    The fileset id used on the right side of comparison.

    @type string

    @editable required

    @scope public

    -->

    <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" />

    <!-- Set the maximum number of threads running for archiving (for a parallel job).

    @type integer

    -->

    <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 -->

    <!-- The fileset id which will be upload

    @type string

    -->

    <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">

        <!-- Path to the parsed file of zip specification file

        @type string

        @scope private

        -->

        <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>

    -->

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

        <attribute name="file" />

        <attribute name="config" />

        <sequential>

            <hlm:python>

                <![CDATA[

import configuration

import symrec

import os

import sys

import logging

import ant

LOGGER = logging.getLogger("metadatamerger")

LOGGER.setLevel(level=logging.INFO)

logging.basicConfig(level=logging.INFO)

def merge_filelist(merger, filelist):

    for filename in filelist:

        try:

            LOGGER.info("Merging %s" % filename)

            merger.merge(filename)

            os.unlink(filename)

        except Exception, exc:

            LOGGER.warning("Warning: %s" % exc)

try:

    builder = configuration.NestedConfigurationBuilder(open(ant.get_property(r'@{file}')), 'r')

    configSet = builder.getConfiguration()

    configs = configSet.getConfigurations(ant.get_property(r'@{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):

                    LOGGER.info("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)

            LOGGER.info(str("Writing %s" % metadata_main))

            merger.save()

        elif len(filelist) > 0:

            input = filelist.pop(0)

            merger = symrec.MetadataMerger(input)

            merge_filelist(merger, filelist)

            LOGGER.info(str("Writing %s" % metadata_main))

            merger.save(metadata_main)

            os.unlink(input)

except Exception, e:

    LOGGER.error('ERROR: %s' % e)

    sys.exit(-1)

]]> 

            </hlm:python>

        </sequential>

    </macrodef>

    <!-- 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>

     -->

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

        <attribute name="file" />

        <attribute name="archive" />

        <attribute name="filters" default=""/>

        <sequential>

            <hlm:python>

        <![CDATA[

import symrec

import os

import traceback

import fileutils

import ant

import sys

import logging

LOGGER = logging.getLogger("metadataupdater")

LOGGER.setLevel(level=logging.INFO)

logging.basicConfig(level=logging.INFO)

if ant.get_property(r'@{file}') is None:

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

if ant.get_property(r'@{archive}') is None:

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

filters = None

if ant.get_property(r'@{filters}') is not None:

    filters = ant.get_property(r'@{filters}').split(r',')

try:

    filename = ant.get_property(r'@{file}')

    archive = ant.get_property(r'@{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)

    LOGGER.info(str("Opening %s" % filename))

    md = symrec.ReleaseMetadata(filename)

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

        LOGGER.info(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:

        LOGGER.info(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:

    LOGGER.error('ERROR: %s' % e)

    sys.exit(-1)

]]> 

            </hlm:python>

        </sequential>

    </macrodef>

    <!-- 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>

    -->

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

        <attribute name="file" />

        <attribute name="config" />

        <sequential>

            <hlm:python>

        <![CDATA[

import configuration

import archive

import os

import symrec

import ant

import logging

import sys

LOGGER = logging.getLogger("metadataMD5updater")

LOGGER.setLevel(level=logging.INFO)

logging.basicConfig(level=logging.INFO)

# Reading the config from Ant

try:

    config_filename = ant.get_property(r'@{file}')

    spec_name = ant.get_property(r'@{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:

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

    else:

        LOGGER.warning('WARNING: No config.')

except Exception, e:

    LOGGER.error('ERROR: %s' % e)

    sys.exit(-1)

]]> 

        </hlm:python>

        </sequential>

    </macrodef>

    <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}"/>

        <attribute name="failonemptyconfig" default="true"/>

        <attribute name="phase" default="archive"/>

        <sequential>

            <if>

                <not>

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

                </not>

                <then>

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

                </then>

            </if>

            <mkdir dir="${@{phase}.log.dir}"/>

            <mkdir dir="${post.log.dir}"/>

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

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

            <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}" phase="@{phase}"/>

                    <!-- Path to the parsed file of zip specification file

                    @type string

                    @scope private

                    -->

                    <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}" failonemptyconfig="@{failonemptyconfig}"/>

                    <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" phase="archive"/>

                        </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">

                                        <!-- how many parallel threads can run

                                        @type string

                                        -->

                                        <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}" phase="@{phase}"/>

                    <hlm:logtoconsole action="resume" />

                </finally>

            </trycatch>

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

            <copy file="${zip.@{type}.log.file}" tofile="${zip.@{type}.nopolicy.log.file}" 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="${zip.@{type}.nopolicy.log.file}" />

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

                </hlm:textmetadatainput>

            </hlm:metadatarecord>

            <hlm:signalMacro logfile="${zip.@{type}.nopolicy.log.file}" 

                signal.input="archiveErrorSignalInput" />

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

            <copy file="${zip.@{type}.log.file}" tofile="${zip.@{type}.policy.log.file}" 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="${zip.@{type}.policy.log.file}" />

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

                <hlm:textmetadatainput>

                    <fileset casesensitive="false" file="${zip.@{type}.policy.log.file}" />

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

                </hlm:textmetadatainput>

            </hlm:metadatarecord>

            <hlm:signalMacro logfile="${zip.@{type}.policy.log.file}" 

                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" />

        <attribute name="failonemptyconfig" />

        <![CDATA[

import archive