import java.util.ArrayList;

import java.util.Arrays;

import java.util.List;

import org.openide.util.Lookup;

    /** lookup result we listen on */

    private static Lookup.Result<FileSystem> result = Lookup.getDefault().lookupResult(FileSystem.class);

    /** the set of layers provided by the system */

    private static FileSystem[] layers;

        layers = (FileSystem[])arr.clone();

    private synchronized static FileSystem[] computeLayers () {

        FileSystem[] fromLookup = result.allInstances ().toArray (new FileSystem[0]);

        if (fromLookup.length > 0) {

            ArrayList<FileSystem> arr = new ArrayList<FileSystem>(layers.length + fromLookup.length);

            arr.addAll (Arrays.asList (layers));

            List<FileSystem> lkpBased = Arrays.asList(fromLookup);

            arr.addAll(lkpBased);

            return arr.toArray (new FileSystem[0]);

        }

        return layers;

    }

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (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.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

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

 */

package org.netbeans.core.startup.layers;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.Collections;

import java.util.Enumeration;

import java.util.Iterator;

import java.util.LinkedList;

import java.util.List;

import java.util.TreeSet;

import junit.framework.TestCase;

import org.netbeans.Module;

import org.netbeans.ModuleManager;

import org.netbeans.core.startup.Main;

import org.netbeans.core.startup.MainLookup;

import org.netbeans.core.startup.ModuleManagerTest;

import org.netbeans.junit.NbTestCase;

import org.openide.filesystems.FileAttributeEvent;

import org.openide.filesystems.FileChangeListener;

import org.openide.filesystems.FileEvent;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileRenameEvent;

import org.openide.filesystems.FileSystem;

import org.openide.filesystems.FileUtil;

import org.openide.filesystems.Repository;

import org.openide.modules.ModuleInfo;

import org.openide.util.Lookup;

import org.openide.util.lookup.InstanceContent;

/** Test layering of filesystems installed via lookup.

 *

 * @author Jaroslav Tulach

 */

public class SystemFileSystemTest extends NbTestCase 

implements InstanceContent.Convertor<FileSystem,FileSystem>, FileChangeListener {

    FileSystem fs;

    FileSystem fs1 = FileUtil.createMemoryFileSystem();

    FileSystem fs2 = FileUtil.createMemoryFileSystem();

    private List<FileEvent> events;

    private File jars;

    public SystemFileSystemTest(String testName) {

        super(testName);

    }

    @Override

    protected void setUp() throws Exception {

        fs = Repository.getDefault().getDefaultFileSystem();

        Lookup.getDefault().lookup(ModuleInfo.class);

        for (FileObject fo : fs.getRoot().getChildren()) {

            fo.delete();

        }

        events = new LinkedList<FileEvent>();

        fs.addFileChangeListener(this);

        jars = new File(ModuleManagerTest.class.getResource("jars").getFile());

        clearWorkDir();

    }

    @Override

    protected void tearDown() throws Exception {

        MainLookup.unregister(fs1, this);

        MainLookup.unregister(fs2, this);

    }

    public void testUserHasPreferenceOverFSs() throws Exception {

        FileObject global = FileUtil.createData(fs.getRoot(), "dir/file.txt");

        global.setAttribute("global", 3);

        write(global, "global");

        FileObject fo1 = FileUtil.createData(fs1.getRoot(), "dir/file.txt");

        fo1.setAttribute("one", 1);

        write(fo1, "fileone");

        FileObject fo2 = FileUtil.createData(fs2.getRoot(), "dir/file.txt");

        fo2.setAttribute("two", 2);

        write(fo2, "two");

        events.clear();

        MainLookup.register(fs1, this);

        MainLookup.register(fs2, this);

        Enumeration<String> en = global.getAttributes();

        TreeSet<String> t = new TreeSet<String>();

        while (en.hasMoreElements()) {

            t.add(en.nextElement());

        }

        assertEquals("three elements: " + t, 3, t.size());

        assertTrue(t.contains("two"));

        assertTrue(t.contains("one"));

        assertTrue(t.contains("global"));

        assertEquals(1, global.getAttribute("one"));

        assertEquals(2, global.getAttribute("two"));

        assertEquals(3, global.getAttribute("global"));

        assertEquals("contains global", 6, global.getSize());

        assertEquals("global", read(global));

        assertTrue("no events: " + events, events.isEmpty());

    }

    public void testUserHasPreferenceOverFSsButGeneratesAnEvent() throws Exception {

        FileObject fo1 = FileUtil.createData(fs1.getRoot(), "dir/file.txt");

        fo1.setAttribute("one", 1);

        write(fo1, "fileone");

        FileObject fo2 = FileUtil.createData(fs2.getRoot(), "dir/file.txt");

        fo2.setAttribute("two", 2);

        write(fo2, "two");

        events.clear();

        MainLookup.register(fs1, this);

        MainLookup.register(fs2, this);

        assertFalse("not empty", events.isEmpty());

        events.clear();

        FileObject global = FileUtil.createData(fs.getRoot(), "dir/file.txt");

        global.setAttribute("global", 3);

        write(global, "global");

        assertFalse("yet another set", events.isEmpty());

        Enumeration<String> en = global.getAttributes();

        TreeSet<String> t = new TreeSet<String>();

        while (en.hasMoreElements()) {

            t.add(en.nextElement());

        }

        assertEquals("three elements: " + t, 3, t.size());

        assertTrue(t.contains("two"));

        assertTrue(t.contains("one"));

        assertTrue(t.contains("global"));

        assertEquals(1, global.getAttribute("one"));

        assertEquals(2, global.getAttribute("two"));

        assertEquals(3, global.getAttribute("global"));

        assertEquals("contains global", 6, global.getSize());

        assertEquals("global", read(global));

    }

    public void testPreferenceOfLayers() throws Exception {

        ModuleManager mgr = Main.getModuleSystem ().getManager();

        mgr.mutexPrivileged().enterWriteAccess();

        try {

            Module m1 = mgr.create(new File(jars, "base-layer-mod.jar"), null, false, false, false);

            assertEquals(Collections.EMPTY_SET, m1.getProblems());

            mgr.enable(m1);

            FileObject global = fs.findResource("foo/file2.txt");

            assertNotNull("File Object installed: " + global, global);

            assertEquals("base contents", read(global));

            FileObject fo1 = FileUtil.createData(fs1.getRoot(), global.getPath());

            fo1.setAttribute("one", 1);

            write(fo1, "fileone");

            FileObject fo2 = FileUtil.createData(fs2.getRoot(), global.getPath());

            fo2.setAttribute("two", 2);

            write(fo2, "two");

            events.clear();

            MainLookup.register(fs1, this);

            MainLookup.register(fs2, this);

            Iterator<? extends FileSystem> it = Lookup.getDefault().lookupAll(FileSystem.class).iterator();

            assertTrue("At least One", it.hasNext());

            assertEquals("first is fs1", fs1, it.next());

            assertTrue("At least two ", it.hasNext());

            assertEquals("first is fs2", fs2, it.next());

            assertEquals("base contents", read(global));

            mgr.disable(m1);

            mgr.delete(m1);

            assertTrue("Still valid", global.isValid());

            assertEquals("fileone", read(global));

        } finally {

            mgr.mutexPrivileged().exitWriteAccess();

        }

    }

    private static void write(FileObject fo, String txt) throws IOException {

        OutputStream os = fo.getOutputStream();

        os.write(txt.getBytes());

        os.close();

    }

    private static String read(FileObject fo) throws IOException {

        byte[] arr = new byte[(int)fo.getSize()];

        InputStream is = fo.getInputStream();

        int len = is.read(arr);

        assertEquals("Not enough read", arr.length, len);

        return new String(arr);

    }

    public FileSystem convert(FileSystem obj) {

        return obj;

    }

    public Class<? extends FileSystem> type(FileSystem obj) {

        return obj.getClass();

    }

    public String id(FileSystem obj) {

        return obj.getDisplayName();

    }

    public String displayName(FileSystem obj) {

        return obj.getDisplayName();

    }

    public void fileFolderCreated(FileEvent fe) {

        events.add(fe);

    }

    public void fileDataCreated(FileEvent fe) {

        events.add(fe);

    }

    public void fileChanged(FileEvent fe) {

        events.add(fe);

    }

    public void fileDeleted(FileEvent fe) {

        events.add(fe);

    }

    public void fileRenamed(FileRenameEvent fe) {

        events.add(fe);

    }

    public void fileAttributeChanged(FileAttributeEvent fe) {

        events.add(fe);

    }

}

<!--

        <question id="arch-overall" when="init">

            Describe the overall architecture. 

            <hint>

            What will be API for 

            <a href="http://openide.netbeans.org/tutorial/api-design.html#design.apiandspi" shape="rect">

                clients and what support API</a>? 

            What parts will be pluggable?

            How will plug-ins be registered? Please use <code>&lt;api type="export"/&gt;</code>

            to describe your general APIs and specify their

            <a href="http://openide.netbeans.org/tutorial/api-design.html#category-private" shape="rect">

            stability categories</a>.

            If possible please provide simple diagrams.

            </hint>

        </question>

-->

 <answer id="arch-overall">

  <p>

   NetBeans internally uses the concept of a virtual filesystem. This module

   provide APIs for accessing such virtual files as well as some support classes

   to make writing of custom vitual filesystems easier.

  </p>

 </answer>

<!--

        <question id="arch-quality" when="init">

            How will the <a href="http://www.netbeans.org/community/guidelines/q-evangelism.html" shape="rect">quality</a>

            of your code be tested and 

            how are future regressions going to be prevented?

            <hint>

            What kind of testing do

            you want to use? How much functionality, in which areas,

            should be covered by the tests? How you find out that your

            project was successful?

            </hint>

        </question>

-->

 <answer id="arch-quality">

  <p>

   XXX no answer for arch-quality

  </p>

 </answer>

<!--

        <question id="arch-time" when="init">

            What are the time estimates of the work?

            <hint>

            Please express your estimates of how long the design, implementation,

            stabilization are likely to last. How many people will be needed to

            implement this and what is the expected milestone by which the work should be 

            ready?

            </hint>

        </question>

-->

 <answer id="arch-time">

  <p>

   XXX no answer for arch-time

  </p>

 </answer>

<!--

        <question id="arch-usecases" when="init">

            <hint>

                Content of this answer will be displayed as part of page at

                http://www.netbeans.org/download/dev/javadoc/usecases.html 

                You can use tags <usecase name="name> regular html description </usecase>

                and if you want to use an URL you can prefix if with @TOP@ to begin

                at the root of your javadoc

            </hint>

            Describe the main <a href="http://openide.netbeans.org/tutorial/api-design.html#usecase" shape="rect">

            use cases</a> of the new API. Who will use it under

            what circumstances? What kind of code would typically need to be written

            to use the module?

        </question>

-->

 <answer id="arch-usecases">

  <p>

   Many of the usecases are described at the

   <a href="@TOP@/org/openide/filesystems/doc-files/api.html">overall documentation</a>,

   in a way how to 

   <a href="@TOP@/org/openide/filesystems/doc-files/HOWTO-MIME.html">register a mime type</a>.

   Some of the additional usecases are covered here.

  </p>

  <usecase id="login-changes" name="How to change menus, etc. after login?">

      <p>

      Since version 7.1 there is a way to change the content of system file

      system in a dynamic way. As system file systems contains various 

      definitions (in NetBeans Platform menus, toolbars, layout of windows, etc.)

      it de-facto allows global change to these settings for example when

      user logs into some system.

      </p>

      <p>

          First thing to do is to create an implementation of filesystem.

          It can be created either from scratch, or by subclassing

          <a href="@TOP@/org/openide/filesystems/AbstractFileSystem.html">AbstractFileSystem</a>,

          or

          <a href="@TOP@/org/openide/filesystems/MultiFileSystem.html">MultiFileSystem</a>.

          In this example we will subclass the 

          <a href="@TOP@/org/openide/filesystems/MultiFileSystem.html">MultiFileSystem</a>:

      </p>

      <pre>

public class LoginFileSystem extends <a href="@TOP@/org/openide/filesystems/MultiFileSystem.html">MultiFileSystem</a> {

  public LoginFileSystem() {

    // let's create the filesystem empty, because the user

    // is not yet logged in

    super(new FileSystem[0]);

  }

  public static void assignURL(URL u) {

    LoginFileSystem lfs = <a href="@org-openide-util@/org/openide/util/Lookup.html">Lookup</a>.getDefault().lookup(LoginFileSystem.class);

    <a href="@TOP@/org/openide/filesystems/XMLFileSystem.html">XMLFileSystem</a> xmlFS = new <a href="@TOP@/org/openide/filesystems/XMLFileSystem.html">XMLFileSystem</a>(u);

    lfs.setDelegates(new FileSystem[] { xmlFS });

  }

}

      </pre>

      <p>

      It is necessary to register this instance in lookup by creating two files:

      </p>

      <ul>

          <li><code>META-INF/services/org.openide.filesystems.FileSystem</code></li>

          <li><code>META-INF/services/your.module.LoginFileSystem</code></li>

      </ul>

      <p>

          and filling these files with a single line containing the full

          name of your filesystem - e.g. <code>your.module.LoginFileSystem</code>.

          When done, the system will find out your registration of the filesystem

          on startup and will merge the content of the filesystem into the 

          default system file system. You can show a dialog letting the user

          to log in to some system anytime later, and when the user is successfully

          in, just call <code>LoginFileSystem.assignURL(url)</code> where the

          URL is an XML file in <a href="@TOP@/org/openide/filesystems/XMLFileSystem.html">the same format</a>

          as used for regular layer files inside of many NetBeans modules.

          The system will notice the change in the content and notify all the

          config file listeners accordingly.

      </p>

      <p>

          Of course, instead of 

          <a href="@TOP@/org/openide/filesystems/XMLFileSystem.html">XMLFileSystem</a>

          you can use for example

          <a href="@TOP@/org/openide/filesystems/FileUtil.html#createMemoryFileSystem()">memory file system</a>,

          or any other you write yourself.

      </p>

  </usecase>

 </answer>

<!--

        <question id="arch-where" when="impl">

            Where one can find sources for your module?

            <hint>

                Please provide link to the CVS web client at

                http://www.netbeans.org/download/source_browse.html

                or just use tag defaultanswer generate='here'

            </hint>

        </question>

-->

 <answer id="arch-where">

  <defaultanswer generate='here' />

 </answer>

<!--

        <question id="compat-deprecation" when="init">

            How the introduction of your project influences functionality

            provided by previous version of the product?

            <hint>

            If you are planning to deprecate/remove/change any existing APIs,

            list them here accompanied with the reason explaining why you

            are doing so.

            </hint>

        </question>

-->

 <answer id="compat-deprecation">

  <p>

   XXX no answer for compat-deprecation

  </p>

 </answer>

<!--

        <question id="deploy-dependencies" when="final">

            What do other modules need to do to declare a dependency on this one,

            in addition to or instead of the normal module dependency declaration

            (e.g. tokens to require)?

            <hint>

                Provide a sample of the actual lines you would add to a module manifest

                to declare a dependency, for example OpenIDE-Module-Requires: some.token.

                If other modules should not depend on this module, or should just use a

                simple regular module dependency, you can just answer "nothing". If you

                intentionally expose a semistable API to clients using implementation

                dependencies, you should mention that here (but there is no need to give

                an example of usage).

            </hint>

        </question>

-->

 <answer id="deploy-dependencies">

  <p>

   XXX no answer for deploy-dependencies

  </p>

 </answer>

<!--

        <question id="exec-ant-tasks" when="impl">

            Do you define or register any ant tasks that other can use?

            <hint>

            If you provide an ant task that users can use, you need to be very

            careful about its syntax and behaviour, as it most likely forms an

	          API for end users and as there is a lot of end users, their reaction

            when such API gets broken can be pretty strong.

            </hint>

        </question>

-->

 <answer id="exec-ant-tasks">

  <p>

   XXX no answer for exec-ant-tasks

  </p>

 </answer>

<!--

        <question id="exec-threading" when="init">

            What threading models, if any, does your module adhere to? How the

            project behaves with respect to threading?

            <hint>

                Is your API threadsafe? Can it be accessed from any threads or

                just from some dedicated ones? Any special relation to AWT and

                its Event Dispatch thread? Also

                if your module calls foreign APIs which have a specific threading model,

                indicate how you comply with the requirements for multithreaded access

                (synchronization, mutexes, etc.) applicable to those APIs.

                If your module defines any APIs, or has complex internal structures

                that might be used from multiple threads, declare how you protect

                data against concurrent access, race conditions, deadlocks, etc.,

                and whether such rules are enforced by runtime warnings, errors, assertions, etc.

                Examples: a class might be non-thread-safe (like Java Collections); might

                be fully thread-safe (internal locking); might require access through a mutex

                (and may or may not automatically acquire that mutex on behalf of a client method);

                might be able to run only in the event queue; etc.

                Also describe when any events are fired: synchronously, asynchronously, etc.

                Ideas: <a href="http://core.netbeans.org/proposals/threading/index.html#recommendations" shape="rect">Threading Recommendations</a> (in progress)

            </hint>

        </question>

-->

 <answer id="exec-threading">

  <p>

   XXX no answer for exec-threading

  </p>

 </answer>

<!--

        <question id="perf-spi" when="init">

            How the performance of the plugged in code will be enforced?

            <hint>

            If you allow foreign code to be plugged into your own module, how

            do you enforce that it will behave correctly and quickly and will not

            negatively influence the performance of your own module?

            </hint>

        </question>

-->

 <answer id="perf-spi">

  <p>

   XXX no answer for perf-spi

  </p>

 </answer>

<!--

        <question id="resources-preferences" when="final">

            Does your module uses preferences via Preferences API? Does your module use NbPreferences or

            or regular JDK Preferences ? Does it read, write or both ? 

            Does it share preferences with other modules ? If so, then why ?

            <hint>

                You may use

                    <api type="export" group="preferences"

                    name="preference node name" category="private">

                    description of individual keys, where it is used, what it

                    influences, whether the module reads/write it, etc.

                    </api>

                Due to XML ID restrictions, rather than /org/netbeans/modules/foo give the "name" as org.netbeans.modules.foo.

                Note that if you use NbPreferences this name will then be the same as the code name base of the module.

            </hint>

        </question>

-->

 <answer id="resources-preferences">

  <p>

   XXX no answer for resources-preferences

  </p>

 </answer>

<!--

        <question id="security-grant" when="final">

            Does your code grant additional rights to some other code?

            <hint>Avoid using a class loader that adds extra

            permissions to loaded code unless really necessary.

            Also note that your API implementation

            can also expose unneeded permissions to enemy code by

            calling AccessController.doPrivileged().</hint>

        </question>

-->

 <answer id="security-grant">

  <p>

   XXX no answer for security-grant

  </p>

 </answer>

<!--

        <question id="security-policy" when="final">

            Does your functionality require modifications to the standard policy file?

            <hint>Your code might pass control to third-party code not

            coming from trusted domains. This could be code downloaded over the

            network or code coming from libraries that are not bundled

            with NetBeans. Which permissions need to be granted to which domains?</hint>

        </question>

-->

 <answer id="security-policy">

  <p>

   XXX no answer for security-policy

  </p>

 </answer>

        <change id="add-content-to-sfs">

            <api name="filesystems"/>

            <summary>Allow modules to dynamically add/remove layer content</summary>

            <version major="7" minor="1"/>

            <date day="12" month="3" year="2007"/>

            <author login="jtulach"/>

            <compatibility addition="yes" binary="compatible" source="compatible" semantic="compatible" deprecation="no" deletion="no" modification="no"/>

            <description>

                <p>

                    Repository.getDefaultFileSystem's content can now be 

                    influenced by adding own 

                    <a href="@TOP@/org/openide/filesystems/FileSystem.html">FileSystem</a>s

                    into global 

                    <a href="@org-openide-util@/org/openide/util/Lookup.html">Lookup.getDefault()</a>.

                    This is supposed to work in a standalone mode as well 

                    as inside NetBeans Platform. The tutorial is available

                    in the <a href="@TOP@/architecture-summary.html#answer-arch-usecases">usecases section</a> of achitecture description.

                </p>

            </description>

            <class package="org.openide.filesystems" name="Repository"/>

            <issue number="26338"/>

        </change>

import java.util.ArrayList;

import java.util.List;

import org.openide.util.LookupEvent;

import org.openide.util.LookupListener;

    private static final class MainFS extends MultiFileSystem implements LookupListener {

        private static final Lookup.Result<FileSystem> ALL = Lookup.getDefault().lookupResult(FileSystem.class);

        private static final FileSystem MEMORY = FileUtil.createMemoryFileSystem();

        public MainFS() {

            super(computeDelegates());

            ALL.addLookupListener(this);

            resultChanged(null);

        }

        private static FileSystem[] computeDelegates() {

            List<FileSystem> arr = new ArrayList<FileSystem>();

            arr.add(MEMORY);

            arr.addAll(ALL.allInstances());

            return arr.toArray(new FileSystem[0]);

        }

        public void resultChanged(LookupEvent ev) {

            setDelegates(computeDelegates());

        }

    } // end of MainFS

/*

 * The contents of this file are subject to the terms of the Common Development

 * and Distribution License (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.html

 * or http://www.netbeans.org/cddl.txt.

 *

 * When distributing Covered Code, include this CDDL Header Notice in each file

 * and include the License file at http://www.netbeans.org/cddl.txt.

 * If applicable, add the following below the CDDL Header, with the fields

 * enclosed by brackets [] replaced by your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

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

 */

package org.openide.filesystems;

import junit.framework.TestCase;

import org.openide.util.lookup.AbstractLookup;

import org.openide.util.lookup.InstanceContent;

/**

 *

 * @author Jaroslav Tulach

 */

public class RepositoryTest extends TestCase {

    static {

        System.setProperty("org.openide.util.Lookup", MainLookup.class.getName());

    }

    public RepositoryTest(String testName) {

        super(testName);

    }

    public void testContentOfFileSystemIsInfluencedByLookup () throws Exception {

        FileSystem mem = FileUtil.createMemoryFileSystem();

        String dir = "/yarda/own/file";

        org.openide.filesystems.FileUtil.createFolder (mem.getRoot (), dir);

        assertNull ("File is not there yet", Repository.getDefault ().getDefaultFileSystem ().findResource (dir));

        MainLookup.ic.add(mem);

        try {

            assertNotNull ("The file is there now", Repository.getDefault ().getDefaultFileSystem ().findResource (dir));

        } finally {

            MainLookup.ic.remove(mem);

        }

        assertNull ("File is no longer there", Repository.getDefault ().getDefaultFileSystem ().findResource (dir));

    }

    public static final class MainLookup extends AbstractLookup {

        static final InstanceContent ic = new InstanceContent();

        public MainLookup() {

            super(ic);

        }

    }

}