Changeset 7231

Timestamp:

Nov 16, 2016, 12:57:05 PM (5 years ago)

Author:

Nicklas Nordborg

Message:

References #2042: Add support for ignoring an extension or other file in the extensions directory

Ignored files are now saved in the Settings so that they are remembered after a server restart.

The ExtensionsManager can now be used for listing the ignored files.

Location:

trunk/src/core/net/sf/basedb/util/extensions/manager

Files:

• ExtensionsManager.java (modified) (10 diffs)
• Settings.java (modified) (3 diffs)

trunk/src/core/net/sf/basedb/util/extensions/manager/ExtensionsManager.java

@@ -35 +35 @@
 import java.util.Set;
 import java.util.TreeMap;
+import java.util.TreeSet;
 
 import net.sf.basedb.core.ItemAlreadyExistsException;
@@ -76 +77 @@
   private int numUnmodified;
   private int numDeleted;
+  private int numIgnored;
   
   /**
@@ -88 +90 @@
     this.registry = registry;
     this.settings = new Settings(this, settingsFile);
-    this.ignore = new HashSet<File>();
+    this.ignore = new TreeSet<File>(settings.getIgnoredFiles());
     this.directories = new HashSet<File>();
     this.xtFiles = new TreeMap<URI, ExtensionsFile>(new JarFirstURIComparator());
@@ -141 +143 @@
   {
     if (file == null) return;
-    ignore.add(file);
+    if (ignore.add(file))
+    {
+      settings.setIgnoredFile(file, true);
+      removeFile(file);
+    }
   }
   
@@ -152 +158 @@
   {
     if (file == null) return;
-    ignore.remove(file);
-  }
-
+    if (ignore.remove(file))
+    {
+      settings.setIgnoredFile(file, false);
+    }
+  }
+
+  /**
+    Get all ignored files. 
+    
+    @param onlyInManagedDirectory TRUE to only look for files that
+      are located in a managed directory
+    @since 3.10
+  */
+  public List<File> getIgnoredFiles(boolean onlyInManagedDirectory)
+  {
+    // Create a copy, or the iterator will fail if new
+    // files are added by another thread
+    List<File> copy = new ArrayList<File>(ignore.size());
+    if (onlyInManagedDirectory)
+    {
+      for (File f : ignore)
+      {
+        if (directories.contains(f.getParentFile())) copy.add(f);
+      }
+    }
+    else
+    {
+      copy.addAll(ignore);
+    }
+    return copy;
+  }
+  
   /**
     Add a directory to this manager. The directory will be monitored
@@ -190 +225 @@
     ExtensionsFile xtFile = new ExtensionsFile(this, file);
     addExtensionsFile(xtFile);
+    ignore.remove(file);
     return xtFile;
   }
@@ -260 +296 @@
     numDeleted = 0;
     numUnmodified = 0;
+    numIgnored = 0;
     
     // 1. Check and count all known files
@@ -337 +374 @@
   
   /**
+    Get the number of ignored files that was found in the last
+    call to {@link #scanForChanges()}.
+    @since 3.10
+  */
+  public int getNumIgnored()
+  {
+    return numIgnored;
+  }
+  
+  /**
     Scan the given directory and add files that are new.
     @param dir The directory to scan
@@ -363 +410 @@
         {
           log.debug("File '" + file + "' is ignored.");
+          numIgnored++;
           continue; // with the next file
         }
@@ -417 +465 @@
         {
           log.debug("File '" + file + "' is ignored.");
+          numIgnored++;
           continue; // with the next file
         }

trunk/src/core/net/sf/basedb/util/extensions/manager/Settings.java

@@ -74 +74 @@
   private Preset settings;
   private Preset installedFiles;
+  private Preset ignoredFiles;
   private Preset disabledExtensions;
   private Preset disabledExtensionPoints;
@@ -104 +105 @@
     this.settings = presets.getDefault();
     this.installedFiles = presets.getPreset("installed-files");
+    this.ignoredFiles = presets.getPreset("ignored-files");
     this.disabledExtensionPoints = presets.getPreset("disabled-extension-points");
     this.disabledExtensions = presets.getPreset("disabled-extensions");
@@ -245 +247 @@
   
   /**
+    Check if the given file is marked as ignored.
+    @since 3.10
+  */
+  public boolean isIgnoredFile(File file)
+  {
+    return Values.getBoolean(ignoredFiles.getSetting(file.getAbsolutePath()));
+  }
+  
+  /**
+    Mark the given file as ignored/not ignored by the extension system.
+    @since 3.10
+  */
+  public void setIgnoredFile(File file, boolean ignore)
+  {
+    if (file == null) return;
+    hasChanged = true;
+    ignoredFiles.setSetting(file.getAbsolutePath(), ignore ? "1" :  null);
+  }
+  
+  /**
+    Get a list with all files that are ignored.
+    @since 3.10
+  */
+  public List<File> getIgnoredFiles()
+  {
+    List<String> paths = ignoredFiles.getKeys();
+    List<File> files = new ArrayList<File>(paths.size());
+    for (String path : paths)
+    {
+      files.add(new File(path));
+    }
+    return files;
+  }
+  
+  /**
     Save the settings to disk. If the settings has not been
     changed the file is not written.