org.netbeans.nbbuild.MakeJnlp2.java Source code

Java tutorial

Introduction

Here is the source code for org.netbeans.nbbuild.MakeJnlp2.java

Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 */

package org.netbeans.nbbuild;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringWriter;
import java.io.Writer;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.Manifest;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.zip.ZipEntry;

import javax.xml.parsers.ParserConfigurationException;

import org.apache.commons.codec.digest.DigestUtils;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Copy;
import org.apache.tools.ant.taskdefs.Property;
import org.apache.tools.ant.taskdefs.SignJar;
import org.apache.tools.ant.taskdefs.SignJar.JarConfigResolved;
import org.apache.tools.ant.taskdefs.SignJar.JarsConfig;
import org.apache.tools.ant.taskdefs.Taskdef;
import org.apache.tools.ant.taskdefs.Zip;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.ResourceCollection;
import org.apache.tools.ant.types.ZipFileSet;
import org.apache.tools.ant.types.resources.FileResource;
import org.xml.sax.SAXException;

import com.google.common.base.Optional;
import com.google.common.io.Files;

/** Generates JNLP files for signed versions of the module JAR files.
 *
 * @author Jaroslav Tulach, Jesse Glick
 */
public class MakeJnlp2 extends Task {
    /** the files to work on */
    private ResourceCollection files;

    private String alias;

    private String storePass;

    private String keystore;

    private String storeType;

    // +p
    private boolean signingForce = true;

    // +p
    private String signingTsaCert;

    // +p
    private String signingTsaUrl;

    // +p
    private String signingMaxMemory = "96m";

    // +p
    private int signingRetryCount = 1;

    // +p
    private int nbThreads = 1;

    // +p
    private List<Property> extraManifestAttributes;

    // +p
    private boolean unsignFirst;

    // +p
    private List<JarsConfig> jarsConfigs;

    // +p
    private File basedir;

    // +p
    private boolean pack200 = false;

    // +p
    private Integer pack200Effort;

    // +p
    private boolean optimize = false;

    public boolean isOptimize() {
        return optimize;
    }

    public void setOptimize(boolean optimize) {
        this.optimize = optimize;
    }

    public FileSet createModules() throws BuildException {
        FileSet fs = new FileSet();
        fs.setProject(getProject());
        addConfigured(fs);
        return fs;
    }

    public void addConfigured(ResourceCollection rc) throws BuildException {
        if (files != null)
            throw new BuildException("modules can be specified just once");
        files = rc;
    }

    private SignJar createSignTask() {
        Taskdef taskdef = (Taskdef) getProject().createTask("taskdef");
        taskdef.setClassname(SignJar.class.getName());
        taskdef.setName("signjar");
        taskdef.execute();

        final SignJar signTask = (SignJar) getProject().createTask("signjar");

        signTask.setAlias(alias);
        signTask.setStorepass(storePass);
        signTask.setKeystore(keystore);
        signTask.setStoretype(storeType);
        signTask.setForce(signingForce);
        signTask.setTsacert(signingTsaCert);
        signTask.setTsaurl(signingTsaUrl);
        signTask.setMaxmemory(signingMaxMemory);
        signTask.setRetryCount(signingRetryCount);
        signTask.setUnsignFirst(unsignFirst);
        signTask.setExtraManifestAttributes(extraManifestAttributes);
        signTask.setJarsConfigs(jarsConfigs);
        signTask.setBasedir(getBasedir());
        signTask.setPack200(pack200);
        signTask.setPack200Effort(pack200Effort);

        return signTask;
    }

    private File targetFile;

    public void setDir(File t) {
        targetFile = t;
    }

    public void setAlias(String a) {
        this.alias = a;
    }

    public void setStorePass(String p) {
        this.storePass = p;
    }

    public void setKeystore(String k) {
        this.keystore = k;
    }

    public void setStoreType(String t) {
        this.storeType = t;
    }

    private String codebase = "$$codebase";

    public void setCodebase(String s) {
        this.codebase = s;
    }

    private boolean verify;

    public void setVerify(boolean v) {
        this.verify = v;
    }

    public void setSigningForce(boolean signingForce) {
        this.signingForce = signingForce;
    }

    public void setSigningTsaCert(String signingTsaCert) {
        this.signingTsaCert = signingTsaCert;
    }

    public void setSigningTsaUrl(String signingTsaUrl) {
        this.signingTsaUrl = signingTsaUrl;
    }

    public void setSigningMaxMemory(String signingMaxMemory) {
        this.signingMaxMemory = signingMaxMemory;
    }

    public void setSigningRetryCount(int signingRetryCount) {
        this.signingRetryCount = signingRetryCount;
    }

    public void setNbThreads(int nbThreads) {
        this.nbThreads = nbThreads;
    }

    public boolean isUnsignFirst() {
        return unsignFirst;
    }

    public void setUnsignFirst(boolean unsignFirst) {
        this.unsignFirst = unsignFirst;
    }

    public List<Property> getExtraManifestAttributes() {
        return extraManifestAttributes;
    }

    public void setExtraManifestAttributes(List<Property> extraManifestAttributes) {
        this.extraManifestAttributes = extraManifestAttributes;
    }

    public List<JarsConfig> getJarsConfigs() {
        return jarsConfigs;
    }

    public void setJarsConfigs(List<JarsConfig> jarsConfigs) {
        this.jarsConfigs = jarsConfigs;
    }

    public boolean isPack200() {
        return pack200;
    }

    public void setPack200(boolean pack200) {
        this.pack200 = pack200;
    }

    public Integer getPack200Effort() {
        return pack200Effort;
    }

    public void setPack200Effort(Integer pack200Effort) {
        this.pack200Effort = pack200Effort;
    }

    private String verifyExcludes;

    /** Comma separated list of allowed excluded names of files during verify
     * phase.
     */
    public void setVerifyExcludes(String s) {
        this.verifyExcludes = s;
    }

    public File getBasedir() {
        return basedir;
    }

    public void setBasedir(File basedir) {
        this.basedir = basedir;
    }

    private String permissions = "<all-permissions/>";

    /**
     * XML fragment pasted into the security part of the .jnlp file.
     * Should default to "&lt;all-permissions/&gt;"
     */
    public void setPermissions(String s) {
        permissions = s;
    }

    private FileSet indirectJars;

    /**
     * Other JARs which should be copied into the destination directory and referred to as resources,
     * even though they are not listed as Class-Path extensions of the module and would not normally
     * be in its effective classpath. The basedir of the fileset should be a cluster root; for each
     * such JAR, a file META-INF/clusterpath/$relpath will be inserted in the JAR, where $relpath is the
     * relative path within the cluster. This permits the JAR to be located at runtime in a flat classpath,
     * using ClassLoader.getResource.
     */
    public void addIndirectJars(FileSet fs) {
        indirectJars = fs;
    }

    private FileSet indirectFiles;

    /**
     * Other non-JAR files which should be made available to InstalledFileLocator.
     * The basedir of the fileset should be a cluster root; each
     * such file will be packed into a ZIP entry META-INF/files/$relpath
     * where the JAR will be available at runtime in a flat classpath,
     * using ClassLoader.getResource.
     */
    public void addIndirectFiles(FileSet fs) {
        indirectFiles = fs;
    }

    private boolean signJars = true;

    /**
     * Whether the final jars should be signed or not. Defaults to true
     * (if not supplied).
     */
    public void setSignJars(boolean s) {
        this.signJars = s;
    }

    private boolean processJarVersions = false;

    /**
     * Whether to add versions and sizes of jars into jnlp files. Defaults to false
     * (if not supplied).
     * @param b
     */
    public void setProcessJarVersions(boolean b) {
        this.processJarVersions = b;
    }

    private Map<String, String> jarVersions;

    /**
     * Explicit definition of jar file versions (for jars without versions specified
     * in manifest file)
     * @param jarVersions
     */
    public void setJarVersions(Map<String, String> jarVersions) {
        this.jarVersions = jarVersions;
    }

    private Set<String> nativeLibraries;

    public void setNativeLibraries(Set<String> libs) {
        this.nativeLibraries = libs;
    }

    private Set<File> jarDirectories;

    private String includelocales;

    public void setIncludelocales(String includelocales) {
        this.includelocales = includelocales;
    }

    // +p -> return locales (wow)
    private Set<String> executedLocales;

    public Set<String> getExecutedLocales() {
        return executedLocales;
    }

    /**
     * Signs or copies the given files according to the signJars variable value.
     */
    private JarConfigResolved signOrCopy(File from, File to) {
        final JarConfigResolved[] jarConfigResolved = new JarConfigResolved[1];

        if (!from.exists() && from.getParentFile().getName().equals("locale")) {
            // skip missing locale files, probably the best fix for #103301
            log("Localization file " + from + " is referenced, but cannot be found. Skipping.", Project.MSG_WARN);
            return jarConfigResolved[0];
        }

        if (signJars) {

            if (to != null) {
                // #125970: might be .../modules/locale/something_ja.jar
                to.getParentFile().mkdirs();
            }

            SignJar signJar = createSignTask();

            signJar.setSigningListener(new SignJar.SigningListener() {
                @Override
                public void beforeSigning(JarConfigResolved jarConfig) {
                    jarConfigResolved[0] = jarConfig;
                }
            });

            signJar.setJar(from);
            signJar.setSignedjar(to);

            signJar.execute();

        } else if (to != null) {
            Copy copy = (Copy) getProject().createTask("copy");
            copy.setFile(from);
            copy.setTofile(to);
            copy.execute();
        }

        if (processJarVersions) {
            if (jarDirectories == null) {
                jarDirectories = new HashSet<File>();
            }

            jarDirectories.add(new File(to.getParent()));
        }

        return jarConfigResolved[0];
    }

    @Override
    public void execute() throws BuildException {
        if (targetFile == null)
            throw new BuildException("Output dir must be provided");
        if (files == null)
            throw new BuildException("modules must be provided");
        try {
            generateFiles();
            if (processJarVersions && jarDirectories != null && jarDirectories.size() > 0) {
                generateVersionXMLFiles();
            }
        } catch (IOException ex) {
            throw new BuildException(ex);
        }
    }

    //
    final Map<String, File> fileDigestMap = new HashMap<String, File>();
    //

    private void generateFiles() throws IOException, BuildException {

        final Set<String> declaredLocales = new HashSet<String>();

        final boolean useAllLocales;

        if ("*".equals(includelocales)) {
            useAllLocales = true;
        } else if ("".equals(includelocales)) {
            useAllLocales = false;
        } else {
            useAllLocales = false;
            StringTokenizer tokenizer = new StringTokenizer(includelocales, ",");
            while (tokenizer.hasMoreElements()) {
                declaredLocales.add(tokenizer.nextToken());
            }
        }

        final Set<String> indirectFilePaths = new HashSet<String>();
        for (FileSet fs : new FileSet[] { indirectJars, indirectFiles }) {
            if (fs != null) {
                DirectoryScanner scan = fs.getDirectoryScanner(getProject());
                for (String f : scan.getIncludedFiles()) {
                    indirectFilePaths.add(f.replace(File.pathSeparatorChar, '/'));
                }
            }
        }

        final ExecutorService executorService = Executors.newFixedThreadPool(nbThreads);

        final List<BuildException> exceptions = new ArrayList<BuildException>();

        for (final Iterator fileIt = files.iterator(); fileIt.hasNext();) {
            if (!exceptions.isEmpty()) {
                break;
            }

            final FileResource fr = (FileResource) fileIt.next();
            final File jar = fr.getFile();

            if (!jar.canRead()) {
                throw new BuildException("Cannot read file: " + jar);
            }

            //
            if (optimize && checkDuplicate(jar).isPresent()) {
                continue;
            }
            //

            executorService.execute(new Runnable() {
                @Override
                public void run() {
                    JarFile theJar = null;
                    try {
                        theJar = new JarFile(jar);

                        String codenamebase = JarWithModuleAttributes
                                .extractCodeName(theJar.getManifest().getMainAttributes());
                        if (codenamebase == null) {
                            throw new BuildException("Not a NetBeans Module: " + jar);
                        }
                        {
                            int slash = codenamebase.indexOf('/');
                            if (slash >= 0) {
                                codenamebase = codenamebase.substring(0, slash);
                            }
                        }
                        String dashcnb = codenamebase.replace('.', '-');

                        String title;
                        String oneline;
                        String shrt;
                        String osDep = null;

                        {
                            String bundle = theJar.getManifest().getMainAttributes()
                                    .getValue("OpenIDE-Module-Localizing-Bundle");
                            Properties prop = new Properties();
                            if (bundle != null) {
                                ZipEntry en = theJar.getEntry(bundle);
                                if (en == null) {
                                    throw new BuildException("Cannot find entry: " + bundle + " in file: " + jar);
                                }
                                InputStream is = theJar.getInputStream(en);
                                prop.load(is);
                                is.close();
                            }
                            title = prop.getProperty("OpenIDE-Module-Name", codenamebase);
                            oneline = prop.getProperty("OpenIDE-Module-Short-Description", title);
                            shrt = prop.getProperty("OpenIDE-Module-Long-Description", oneline);
                        }

                        {
                            String osMan = theJar.getManifest().getMainAttributes()
                                    .getValue("OpenIDE-Module-Requires");
                            if (osMan != null) {
                                if (osMan.indexOf("org.openide.modules.os.MacOSX") >= 0) { // NOI18N
                                    osDep = "Mac OS X"; // NOI18N
                                } else if (osMan.indexOf("org.openide.modules.os.Linux") >= 0) { // NOI18N
                                    osDep = "Linux"; // NOI18N
                                } else if (osMan.indexOf("org.openide.modules.os.Solaris") >= 0) { // NOI18N
                                    osDep = "Solaris"; // NOI18N
                                } else if (osMan.indexOf("org.openide.modules.os.Windows") >= 0) { // NOI18N
                                    osDep = "Windows"; // NOI18N
                                }
                            }
                        }

                        Map<String, List<File>> localizedFiles = verifyExtensions(jar, theJar.getManifest(),
                                dashcnb, codenamebase, verify, indirectFilePaths);

                        executedLocales = localizedFiles.keySet();

                        new File(targetFile, dashcnb).mkdir();

                        File signed = new File(new File(targetFile, dashcnb), jar.getName());

                        // +p
                        final JarConfigResolved jarConfig = signOrCopy(jar, signed);

                        File jnlp = new File(targetFile, dashcnb + ".jnlp");
                        StringWriter writeJNLP = new StringWriter();
                        writeJNLP.write("<?xml version='1.0' encoding='UTF-8'?>\n");
                        writeJNLP.write(
                                "<!DOCTYPE jnlp PUBLIC \"-//Sun Microsystems, Inc//DTD JNLP Descriptor 6.0//EN\" \"http://java.sun.com/dtd/JNLP-6.0.dtd\">\n");
                        writeJNLP.write("<jnlp spec='1.0+' codebase='" + codebase + "'>\n");
                        writeJNLP.write("  <information>\n");
                        writeJNLP.write("   <title>" + XMLUtil.toElementContent(title) + "</title>\n");
                        writeJNLP.write("   <vendor>NetBeans</vendor>\n");
                        writeJNLP.write("   <description kind='one-line'>" + XMLUtil.toElementContent(oneline)
                                + "</description>\n");
                        writeJNLP.write("   <description kind='short'>" + XMLUtil.toElementContent(shrt)
                                + "</description>\n");
                        writeJNLP.write("  </information>\n");

                        String realPermissions = permissions;
                        if ((jarConfig != null) && (jarConfig.getExtraManifestAttributes() != null)) {
                            String jarPermissions = jarConfig.getExtraManifestAttributes().getValue("Permissions");

                            if (jarPermissions != null) {
                                if ("all-permissions".equals(jarPermissions)) {
                                    realPermissions = "<security><all-permissions/></security>\n";
                                } else {
                                    realPermissions = "";
                                }
                            }
                        }

                        writeJNLP.write(realPermissions);

                        if (osDep == null) {
                            writeJNLP.write("  <resources>\n");
                        } else {
                            writeJNLP.write("  <resources os='" + osDep + "'>\n");
                        }
                        writeJNLP.write("<property name=\"jnlp.packEnabled\" value=\"" + String.valueOf(pack200)
                                + "\"/>\n");
                        writeJNLP.write(constructJarHref(jar, dashcnb));

                        processExtensions(jar, theJar.getManifest(), writeJNLP, dashcnb, codebase, realPermissions);
                        processIndirectJars(writeJNLP, dashcnb);
                        processIndirectFiles(writeJNLP, dashcnb);

                        writeJNLP.write("  </resources>\n");

                        if (useAllLocales || !declaredLocales.isEmpty()) {

                            // write down locales
                            for (Map.Entry<String, List<File>> e : localizedFiles.entrySet()) {
                                final String locale = e.getKey();

                                if (!declaredLocales.isEmpty() && !declaredLocales.contains(locale)) {
                                    continue;
                                }

                                final List<File> allFiles = e.getValue();

                                writeJNLP.write("  <resources locale='" + locale + "'>\n");

                                for (File n : allFiles) {
                                    log("generating locale " + locale + " for " + n, Project.MSG_VERBOSE);
                                    String name = n.getName();
                                    String clusterRootPrefix = jar.getParent() + File.separatorChar;
                                    String absname = n.getAbsolutePath();
                                    if (absname.startsWith(clusterRootPrefix)) {
                                        name = absname.substring(clusterRootPrefix.length())
                                                .replace(File.separatorChar, '-');
                                    }
                                    File t = new File(new File(targetFile, dashcnb), name);
                                    signOrCopy(n, t);
                                    writeJNLP.write(constructJarHref(n, dashcnb, name));
                                }

                                writeJNLP.write("  </resources>\n");

                            }
                        }

                        writeJNLP.write("  <component-desc/>\n");
                        writeJNLP.write("</jnlp>\n");
                        writeJNLP.close();

                        // +p
                        Files.write(writeJNLP.toString(), jnlp, Charset.forName("UTF-8"));
                    } catch (Exception e) {
                        exceptions.add(new BuildException(e));
                    } finally {
                        if (theJar != null) {
                            try {
                                theJar.close();
                            } catch (IOException e) {
                            }
                        }
                    }
                }
            });
        }

        executorService.shutdown();

        try {
            executorService.awaitTermination(Long.MAX_VALUE, TimeUnit.NANOSECONDS);
        } catch (Exception e) {
            throw new BuildException(e);
        }

        if (!exceptions.isEmpty()) {
            throw exceptions.get(0);
        }
    }

    private Map<String, List<File>> verifyExtensions(File f, Manifest mf, String dashcnb, String codebasename,
            boolean verify, Set<String> indirectFilePaths) throws IOException, BuildException {
        Map<String, List<File>> localizedFiles = new HashMap<String, List<File>>();

        File clusterRoot = f.getParentFile();
        String moduleDirPrefix = "";
        File updateTracking;
        log("Verifying extensions for: " + codebasename + ", cluster root: " + clusterRoot + ", verify: " + verify,
                Project.MSG_DEBUG);
        for (;;) {
            updateTracking = new File(clusterRoot, "update_tracking");
            if (updateTracking.isDirectory()) {
                break;
            }
            moduleDirPrefix = clusterRoot.getName() + "/" + moduleDirPrefix;
            clusterRoot = clusterRoot.getParentFile();
            if (clusterRoot == null || !clusterRoot.exists()) {
                if (!verify) {
                    return localizedFiles;
                }

                throw new BuildException("Cannot find update_tracking directory for module " + f);
            }
        }

        File ut = new File(updateTracking, dashcnb + ".xml");
        if (!ut.exists()) {
            throw new BuildException("The file " + ut + " for module " + codebasename + " cannot be found");
        }

        Map<String, String> fileToOwningModule = new HashMap<String, String>();
        try {
            ModuleSelector.readUpdateTracking(getProject(), ut.toString(), fileToOwningModule);
        } catch (IOException ex) {
            throw new BuildException(ex);
        } catch (ParserConfigurationException ex) {
            throw new BuildException(ex);
        } catch (SAXException ex) {
            throw new BuildException(ex);
        }

        log("project files: " + fileToOwningModule, Project.MSG_DEBUG);
        String name = relative(f, clusterRoot);
        log("  removing: " + name, Project.MSG_DEBUG);
        removeWithLocales(fileToOwningModule, name, clusterRoot, localizedFiles);
        name = "config/Modules/" + dashcnb + ".xml";
        log("  removing: " + name, Project.MSG_DEBUG);
        removeWithLocales(fileToOwningModule, name, clusterRoot, localizedFiles);
        name = "config/ModuleAutoDeps/" + dashcnb + ".xml";
        log("  removing: " + name, Project.MSG_DEBUG);
        removeWithLocales(fileToOwningModule, name, clusterRoot, localizedFiles);
        name = "update_tracking/" + dashcnb + ".xml";
        log("  removing: " + name, Project.MSG_DEBUG);
        removeWithLocales(fileToOwningModule, name, clusterRoot, localizedFiles);

        String path = mf.getMainAttributes().getValue("Class-Path");
        if (path != null) {
            StringTokenizer tok = new StringTokenizer(path, ", ");
            while (tok.hasMoreElements()) {
                String s = tok.nextToken();
                File e = new File(f.getParentFile(), s);
                String r = relative(e, clusterRoot);
                removeWithLocales(fileToOwningModule, r, clusterRoot, localizedFiles);
            }
        }

        fileToOwningModule.remove("ant/nblib/" + dashcnb + ".jar");

        fileToOwningModule.remove("VERSION.txt"); // cluster release information

        fileToOwningModule.keySet().removeAll(indirectFilePaths);

        if (verifyExcludes != null) {
            StringTokenizer tok = new StringTokenizer(verifyExcludes, ", ");
            while (tok.hasMoreElements()) {
                removeWithLocales(fileToOwningModule, tok.nextToken(), clusterRoot, localizedFiles);
            }
        }

        if (verify) {
            if (!fileToOwningModule.isEmpty()) {
                throw new BuildException("Cannot build JNLP for module " + f + " as these files are in "
                        + "module's NBM, but are not referenced from any path (see harness/README for properties you can define to fix):\n"
                        + fileToOwningModule.keySet());
            }
        }

        return localizedFiles;
    }

    private static void removeWithLocales(Map<String, String> removeFrom, String removeWhat, File clusterRoot,
            Map<String, List<File>> recordLocales) {
        if (removeFrom.remove(removeWhat) != null && removeWhat.endsWith(".jar")) {
            int basedir = removeWhat.lastIndexOf('/');
            String base = basedir == -1 ? "" : removeWhat.substring(0, basedir);
            String name = removeWhat.substring(basedir + 1, removeWhat.length() - 4);
            Pattern p = Pattern.compile(base + "/locale/" + name + "(|_[a-zA-Z0-9_]+)\\.jar");

            Iterator it = removeFrom.keySet().iterator();
            while (it.hasNext()) {
                String s = (String) it.next();
                Matcher m = p.matcher(s);
                if (m.matches()) {
                    String locale = m.group(1).substring(1);

                    List<File> l = recordLocales.get(locale);
                    if (l == null) {
                        l = new ArrayList<File>();
                        recordLocales.put(locale, l);
                    }
                    l.add(new File(clusterRoot, s.replace('/', File.separatorChar)));
                    it.remove();
                }
            }
        }
    }

    private void processExtensions(File f, Manifest mf, Writer fileWriter, String dashcnb, String codebase,
            String permissions) throws IOException, BuildException {

        File nblibJar = new File(new File(new File(f.getParentFile().getParentFile(), "ant"), "nblib"),
                dashcnb + ".jar");
        if (nblibJar.isFile()) {
            File ext = new File(new File(targetFile, dashcnb), "ant-nblib-" + nblibJar.getName());
            fileWriter.write(constructJarHref(ext, dashcnb));
            signOrCopy(nblibJar, ext);
        }

        String path = mf.getMainAttributes().getValue("Class-Path");
        if (path == null) {
            return;
        }

        StringTokenizer tok = new StringTokenizer(path, ", ");
        while (tok.hasMoreElements()) {
            String s = tok.nextToken();

            if (s.contains("${java.home}")) {
                continue;
            }

            File e = new File(f.getParentFile(), s);
            if (!e.canRead()) {
                throw new BuildException("Cannot read extension " + e + " referenced from " + f);
            }

            //
            if (optimize && checkDuplicate(e).isPresent()) {
                continue;
            }
            //

            String n = e.getName();
            if (n.endsWith(".jar")) {
                n = n.substring(0, n.length() - 4);
            }
            File ext = new File(new File(targetFile, dashcnb), s.replace("../", "").replace('/', '-'));

            if (isSigned(e) != null) {
                signOrCopy(e, ext);
                //                Copy copy = (Copy)getProject().createTask("copy");
                //                copy.setFile(e);
                //                copy.setTofile(ext);
                //                copy.execute();

                String extJnlpName = dashcnb + '-' + ext.getName().replaceFirst("\\.jar$", "") + ".jnlp";
                File jnlp = new File(targetFile, extJnlpName);

                FileWriter writeJNLP = new FileWriter(jnlp);
                writeJNLP.write("<?xml version='1.0' encoding='UTF-8'?>\n");
                writeJNLP.write(
                        "<!DOCTYPE jnlp PUBLIC \"-//Sun Microsystems, Inc//DTD JNLP Descriptor 6.0//EN\" \"http://java.sun.com/dtd/JNLP-6.0.dtd\">\n");
                writeJNLP.write("<jnlp spec='1.0+' codebase='" + codebase + "'>\n");
                writeJNLP.write("  <information>\n");
                writeJNLP.write("    <title>" + n + "</title>\n");
                writeJNLP.write("    <vendor>NetBeans</vendor>\n");
                writeJNLP.write("  </information>\n");
                writeJNLP.write(permissions + "\n");
                writeJNLP.write("  <resources>\n");
                writeJNLP
                        .write("<property name=\"jnlp.packEnabled\" value=\"" + String.valueOf(pack200) + "\"/>\n");
                writeJNLP.write(constructJarHref(ext, dashcnb));
                writeJNLP.write("  </resources>\n");
                writeJNLP.write("  <component-desc/>\n");
                writeJNLP.write("</jnlp>\n");
                writeJNLP.close();

                fileWriter.write("    <extension name='" + e.getName().replaceFirst("\\.jar$", "") + "' href='"
                        + extJnlpName + "'/>\n");
            } else {
                signOrCopy(e, ext);

                fileWriter.write(constructJarHref(ext, dashcnb));
            }
        }
    }

    private void processIndirectJars(Writer fileWriter, String dashcnb) throws IOException, BuildException {
        if (indirectJars == null) {
            return;
        }
        DirectoryScanner scan = indirectJars.getDirectoryScanner(getProject());
        for (String f : scan.getIncludedFiles()) {
            File jar = new File(scan.getBasedir(), f);

            if (optimize && checkDuplicate(jar).isPresent()) {
                continue;
            }

            String rel = f.replace(File.separatorChar, '/');
            String sig;
            try {
                sig = isSigned(jar);
            } catch (IOException x) {
                throw new BuildException("Cannot check signature on " + jar, x, getLocation());
            }
            // javaws will reject .zip files even with signatures.
            String rel2 = rel.endsWith(".jar") ? rel : rel.replaceFirst("(\\.zip)?$", ".jar");
            File ext = new File(new File(targetFile, dashcnb),
                    rel2.replace('/', '-').replaceFirst("^modules-", ""));
            Zip jartask = (Zip) getProject().createTask("jar");
            jartask.setDestFile(ext);
            ZipFileSet zfs = new ZipFileSet();
            zfs.setSrc(jar);
            if (sig != null) {
                // Need to cancel original signature since we are adding one entry to the JAR.
                zfs.setExcludes("META-INF/" + sig + ".*");
            }
            jartask.addZipfileset(zfs);
            zfs = new ZipFileSet();
            File blank = File.createTempFile("empty", "");
            blank.deleteOnExit();
            zfs.setFile(blank);
            zfs.setFullpath("META-INF/clusterpath/" + rel);
            jartask.addZipfileset(zfs);
            jartask.execute();
            blank.delete();

            fileWriter.write(constructJarHref(ext, dashcnb));
            signOrCopy(ext, null);
        }
    }

    private void processIndirectFiles(Writer fileWriter, String dashcnb) throws IOException, BuildException {
        if (indirectFiles == null) {
            return;
        }
        DirectoryScanner scan = indirectFiles.getDirectoryScanner(getProject());
        Map<String, File> entries = new LinkedHashMap<String, File>();
        for (String f : scan.getIncludedFiles()) {
            entries.put(f.replace(File.separatorChar, '/'), new File(scan.getBasedir(), f));
        }
        if (entries.isEmpty()) {
            return;
        }
        File ext = new File(new File(targetFile, dashcnb), "extra-files.jar");
        Zip jartask = (Zip) getProject().createTask("jar");
        jartask.setDestFile(ext);
        for (Map.Entry<String, File> entry : entries.entrySet()) {
            ZipFileSet zfs = new ZipFileSet();
            zfs.setFile(entry.getValue());
            zfs.setFullpath("META-INF/files/" + entry.getKey());
            jartask.addZipfileset(zfs);
        }
        jartask.execute();
        fileWriter.write(constructJarHref(ext, dashcnb));
        signOrCopy(ext, null);
    }

    private String relative(File file, File root) {
        String sfile = file.toString().replace(File.separatorChar, '/');
        String sroot = (root.toString() + File.separator).replace(File.separatorChar, '/');
        if (sfile.startsWith(sroot)) {
            try {
                String result = new URI(null, sfile.substring(sroot.length()), null).normalize().getPath();
                return result;
            } catch (URISyntaxException x) {
                throw new BuildException(x, getLocation()); // or just ignore?
            }
        }
        return sfile;
    }

    /** return alias if signed, or null if not */
    private static String isSigned(File f) throws IOException {
        JarFile jar = new JarFile(f);
        try {
            Enumeration<JarEntry> en = jar.entries();
            while (en.hasMoreElements()) {
                Matcher m = SF.matcher(en.nextElement().getName());
                if (m.matches()) {
                    return m.group(1);
                }
            }
            return null;
        } finally {
            jar.close();
        }
    }

    private static final Pattern SF = Pattern.compile("META-INF/(.+)\\.SF");

    /**
     * returns version of jar file depending on manifest.mf or explicitly specified
     * @param jar
     * @return
     * @throws IOException
     */
    private String getJarVersion(JarFile jar) throws IOException {
        String version = jar.getManifest().getMainAttributes().getValue("OpenIDE-Module-Specification-Version");
        if (version == null) {
            version = jar.getManifest().getMainAttributes().getValue("Specification-Version");
        }
        if (version == null && jarVersions != null) {
            version = jarVersions.get(jar.getName());
        }
        return version;
    }

    /**
     * Constructs jar or nativelib tag for jars
     * @param f
     * @param dashcnb
     * @return
     * @throws IOException
     */
    private String constructJarHref(File f, String dashcnb) throws IOException {
        return constructJarHref(f, dashcnb, f.getName());
    }

    /**
     * Constructs jar or nativelib tag for jars using custom name
     * @param f
     * @param dashcnb
     * @return
     * @throws IOException
     */
    private String constructJarHref(File f, String dashcnb, String name) throws IOException {
        String tag = "jar";
        if (nativeLibraries != null && nativeLibraries.contains(name)) {
            tag = "nativelib";
        }
        if (processJarVersions) {
            if (!f.exists()) {
                throw new BuildException(
                        "JAR file " + f + " does not exist, cannot extract required versioning info.");
            }
            JarFile extJar = new JarFile(f);
            String version = getJarVersion(extJar);
            if (version != null) {
                return "    <" + tag + " href='" + dashcnb + '/' + name + "' version='" + version + "' size='"
                        + f.length() + "'/>\n";
            }
        }
        return "    <" + tag + " href='" + dashcnb + '/' + name + "'/>\n";
    }

    private void generateVersionXMLFiles() throws IOException {
        FileSet fs = new FileSet();
        fs.setIncludes("**/*.jar");
        for (File directory : jarDirectories) {
            fs.setDir(directory);
            DirectoryScanner scan = fs.getDirectoryScanner(getProject());
            StringWriter writeVersionXML = new StringWriter();
            writeVersionXML.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
            writeVersionXML.append("<jnlp-versions>\n");
            for (String jarName : scan.getIncludedFiles()) {
                File jar = new File(scan.getBasedir(), jarName);
                JarFile jarFile = new JarFile(jar);
                String version = getJarVersion(jarFile);
                if (version != null) {
                    writeVersionXML.append("    <resource>\n        <pattern>\n            <name>");
                    writeVersionXML.append(jar.getName());
                    writeVersionXML.append("</name>\n            <version-id>");
                    writeVersionXML.append(version);
                    writeVersionXML.append("</version-id>\n        </pattern>\n        <file>");
                    writeVersionXML.append(jar.getName());
                    writeVersionXML.append("</file>\n    </resource>\n");
                } else {
                    writeVersionXML.append("    <!-- No version found for ");
                    writeVersionXML.append(jar.getName());
                    writeVersionXML.append(" -->\n");
                }
            }
            writeVersionXML.append("</jnlp-versions>\n");
            writeVersionXML.close();

            File versionXML = new File(directory, "version.xml");
            FileWriter w = new FileWriter(versionXML);
            w.write(writeVersionXML.toString());
            w.close();
        }
    }

    private Optional<File> checkDuplicate(File f) throws IOException {
        final String digest = new String(DigestUtils.getSha1Digest().digest(Files.toByteArray(f)));

        final File jarFile = fileDigestMap.get(digest);

        if (jarFile == null) {
            fileDigestMap.put(digest, f);

            return Optional.absent();
        }

        return Optional.of(jarFile);
    }
}