nbm.executable.files=launchers/app.sh

nbm.executable.files [since 6.8] - space separated patterns of files relative to 

cluster directory for which executable permissions should be set on Unix system 

when building the module and on NBM installation/update in runtime.

genexecutables=org.netbeans.nbbuild.MakeExecutableFilesList

import java.lang.reflect.Method;

    public static final String EXECUTABLE_FILES_ENTRY = "Info/executable.list";

                    List <String> executableFiles = readExecutableFilesList(jarFile);

                    List <File> filesToChmod = new ArrayList <File> ();

                                if(executableFiles.contains(pathTo)) {

                                    filesToChmod.add(destFile);

                                }

                    chmod(filesToChmod);

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2008 Sun Microsystems, Inc. All rights reserved.

 *

 * 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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-2008 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.modules.autoupdate.services;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.lang.reflect.Method;

import java.util.HashMap;

import java.util.Map;

import org.netbeans.api.autoupdate.UpdateUnit;

import org.netbeans.spi.autoupdate.UpdateItem;

import org.netbeans.spi.autoupdate.UpdateProvider;

/**

 *

 * @author Dmitry Lipin

 */

public class ExecutablePermissionsTest extends NbmAdvancedTestCase {

    private UpdateProvider p = null;

    private String testModuleVersion = "1.0";

    private String testModuleName = "org.yourorghere.executable.permissions";

    public ExecutablePermissionsTest(String name) {

        super(name);

    }

    @Override

    protected void setUp() throws IOException, Exception {

        super.setUp();

    }

    @Override

    public boolean canRun() {

        return super.canRun() && !System.getProperty("os.name").startsWith("Windows");

    }

    private String generateExecutablePermissionsModuleElement() {

        String res = "\n<module codenamebase=\"" + testModuleName + "\" " +

                "homepage=\"http://www.netbeans.org/\" distribution=\"nbresloc:/org/netbeans/api/autoupdate/data/org-yourorghere-executable-permissions.nbm\" " +

                "license=\"standard-nbm-license.txt\" downloadsize=\"5122\" " +

                "needsrestart=\"false\" moduleauthor=\"\" " +

                "eager=\"false\" " +

                "releasedate=\"2006/02/23\">\n";

        res += "<manifest OpenIDE-Module=\"" + testModuleName + "\" " +

                "OpenIDE-Module-Name=\"" + testModuleName + "\" " +

                "AutoUpdate-Show-In-Client=\"true\" " +

                "OpenIDE-Module-Specification-Version=\"" + testModuleVersion + "\"/>\n";

        res += "</module>";

        return res;

    }

    public void testExecutablePermissionsModule() throws IOException {

        String os = !org.openide.util.Utilities.isUnix() ? "Windows" : "Unix";

        String catalog = generateCatalog(generateExecutablePermissionsModuleElement());

        p = createUpdateProvider(catalog);

        p.refresh(true);

        Map<String, UpdateUnit> unitImpls = new HashMap<String, UpdateUnit>();

        Map<String, UpdateItem> updates = p.getUpdateItems();

        assertNotNull("Some modules are installed.", updates);

        assertFalse("Some modules are installed.", updates.isEmpty());

        assertTrue(testModuleName + " found in parsed items.", updates.keySet().contains(testModuleName + "_" + testModuleVersion));

        Map<String, UpdateUnit> newImpls = UpdateUnitFactory.getDefault().appendUpdateItems(unitImpls, p);

        assertNotNull("Some units found.", newImpls);

        assertFalse("Some units found.", newImpls.isEmpty());

        UpdateUnit u1 = newImpls.get(testModuleName);

        installUpdateUnit(u1);

        File f = new File(userDir, "bin/start.sh");

        assertTrue("File " + f + " should exist after module installation", f.exists());

        if (System.getProperty("java.version").startsWith("1.5")) {

            File ls = new File("/bin/ls");

            if (!ls.isFile()) {

                ls = new File("/usr/bin/ls");

            }

            if (ls.isFile()) {

                String output = readCommandOutput(ls.getAbsolutePath(), "-la", f.getAbsolutePath()).trim();

                int index = output.indexOf(" ");

                assertFalse("Can`t read permissions from output:\n" + output, index == -1);

                String permissions = output.substring(0, index);

                assertTrue("File " + f + " does not have executable permissions after installation, actual perms : " + permissions,

                        permissions.matches(".*x.*x.*x.*"));

            }

        } else {

            Method canExecuteMethod = null;

            try {

                canExecuteMethod = File.class.getMethod("canExecute", new Class[]{});

            } catch (Exception e) {

                assertTrue("java.io.File.canExecute method is not accessible", false);

            }

            boolean canExecute = false;

            try {

                canExecute = (Boolean) canExecuteMethod.invoke(f);

            } catch (Exception e) {

                assertTrue("File " + f + " is not executable after module installation", canExecute);

                e.printStackTrace();

            }

        }

    }

    private String readCommandOutput(String... command) {

        ProcessBuilder builder = new ProcessBuilder(command);

        boolean doRun = true;

        StringBuilder sb = new StringBuilder();

        byte[] bytes = new byte[8192];

        int c = 0;

        try {

            Process process = builder.start();

            while (doRun) {

                try {

                    Thread.sleep(20);

                } catch (InterruptedException e) {

                }

                try {

                    process.exitValue();

                    doRun = false;

                } catch (IllegalThreadStateException e) {

                    ; // do nothing - the process is still running

                }

                InputStream is = process.getInputStream();

                while ((c = is.read(bytes)) != -1) {

                    sb.append(new String(bytes, 0, c));

                }

            }

            return sb.toString();

        } catch (IOException e) {

            e.printStackTrace();

            return new String();

        }

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.

 *

 * 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.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun 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]"

 *

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

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.nbbuild;

import java.io.File;

import java.util.ArrayList;

import java.util.List;

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.types.FileSet;

/**

 * Create the list of files which require executable permissions to be set.

 * @author Dmitry Lipin

 */

public class MakeExecutableFilesList extends Task {

    File targetDir = null;

    ModuleFileSet mfs = null;

    String executableIncludes = null;

    //String propertyName = null;

    String refid;

    private static final String ALL_FILES_PATTERN = "**";

    //String sep = null;

    public MakeExecutableFilesList() {

    }

    @Override

    public void execute() throws BuildException {

        if (targetDir == null) {

            throw new BuildException("You have to specify target directoty");

        }

        //if (propertyName == null) {

        //    throw new BuildException("You have to specify property name for storing executable files list");

        //}

        if (refid == null) {

           throw new BuildException("You have to specify reference id for storing executable files list");

        }

        DirectoryScanner moduleFilesDs = mfs.getDirectoryScanner(this.getProject());

        moduleFilesDs.scan();

        FileSet efs = new FileSet();

        efs.setDir(targetDir);

        efs.setProject(getProject());

        if(executableIncludes==null || executableIncludes.length() == 0) {

            efs.setExcludes(ALL_FILES_PATTERN);

        } else {

            efs.setIncludes(executableIncludes);

        }

        DirectoryScanner executableDs = efs.getDirectoryScanner(this.getProject());

        executableDs.scan();

        String[] moduleIncludes = moduleFilesDs.getIncludedFiles();

        List<String> moduleExecutables = new ArrayList<String>();

        for (String executable : executableDs.getIncludedFiles()) {

            for (String include : moduleIncludes) {

                if (executable.equals(include)) {

                    moduleExecutables.add(executable);

                    break;

                }

            }

        }

        if (!moduleExecutables.isEmpty()) {

            log("Executable files in module: " + moduleExecutables, Project.MSG_VERBOSE);

        } else {

            log("No executable files in module: " + moduleExecutables, Project.MSG_VERBOSE);

        }

        FileSet fs = new FileSet();

        fs.setDir(targetDir);

        fs.setProject(getProject());

        StringBuilder sb = new StringBuilder("");

        for (int i = 0; i < moduleExecutables.size(); i++) {

            if (i != 0) {

                sb.append(" ");

            }

            sb.append(moduleExecutables.get(i).replace("\\", "/"));

        }

        if(sb.length()>0) {

            fs.setIncludes(sb.toString());

        } else {

            fs.setExcludes(ALL_FILES_PATTERN);

        }

        DirectoryScanner ds = fs.getDirectoryScanner();

        ds.scan();

        log("Executable files length: " + ds.getIncludedFilesCount());

        getProject().addReference(refid, fs);

    }

    public void setRefid(String refid) {

        this.refid = refid;

    }

    public void setTargetDir(File s) {

        this.targetDir = s;

    }

    public void setIncludes(String executableIncludes) {

        this.executableIncludes = executableIncludes;

    }

    public ModuleFileSet createModuleFileSet() {

        return (mfs = new ModuleFileSet());

    }

    public static class ModuleFileSet extends FileSet {

    }

}

import org.apache.tools.ant.DirectoryScanner;

import org.apache.tools.ant.types.FileSet;

    /** List of executable files in NBM concatinated by ${line.separator}. */

    public FileSet createExecutables() {

        return (executablesSet = new FileSet());

    }

        DirectoryScanner ds = executablesSet.getDirectoryScanner();

        ds.scan();

        String  [] executables = ds.getIncludedFiles();

        if(executables!=null && executables.length > 0) {

            ZipFileSet executablesList = new ZipFileSet();

            File executablesFile;

            StringBuilder sb = new StringBuilder("");

                String ls = System.getProperty("line.separator");

                for(int i=0;i < executables.length;i++) {

                    if(i!=0) {

                        sb.append(ls);

                    }

                    sb.append(executables[i].replace("\\","/"));

                }

            try {

                executablesFile = File.createTempFile("executables",".list");

                OutputStream infoStream = new FileOutputStream (executablesFile);

                try {

                    infoStream.write(sb.toString().getBytes());

                } finally {

                    infoStream.close ();

                }

            } catch (IOException e) {

                throw new BuildException("exception when creating Info/executables.list", e, getLocation());

            }

            executablesFile.deleteOnExit();

            executablesList.setFile(executablesFile);

            executablesList.setFullpath("Info/executables.list");

            jar.addZipfileset(executablesList);

        }

    <taskdef name="genexecutables"

         classname="org.netbeans.nbbuild.MakeExecutableFilesList"

         classpath="${nb_all}/nbbuild/nbantext.jar"/>

        <antcall target="chmod-executables"/>

    </target>

    <target name="chmod-executables" depends="-init-executables">

        <chmod perm="a+x" dir="${cluster}">

            <fileset refid="module.executable.files"/>

        </chmod>

            <executables refid="module.executable.files"/>