Update files that use symbolic links (#1840)

Author: ahus1

CHANGELOG.adoc

@@ -12,6 +12,7 @@ This document provides a high-level view of the changes introduced by release.
 - Prevent "Read access not allowed" when using LLMs (#1822)
 - Prevent "InvalidVirtualFileAccessException" when iterating the file tree (#1825)
 - Build correct URL for content security policy in IntelliJ 2025.2 EAP (#1837)
+- Update files that use symbolic links (#1840)
 
 === 0.44.5
 

src/main/java/org/asciidoc/intellij/psi/search/AsciiDocLinkIndex.java

@@ -0,0 +1,34 @@
+package org.asciidoc.intellij.psi.search;
+
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.util.containers.CollectionFactory;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.intellij.util.indexing.ID;
+import org.asciidoc.intellij.psi.AsciiDocSearchScope;
+import org.jetbrains.annotations.NonNls;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.Set;
+
+/**
+ * Index that specifically contains only file system links
+ * This should avoid a situation where IntelliJ sometime has outdated information about files that leads to PSI problems.
+ *
+ * @author Alexander Schwartz ([email protected])
+ */
+public class AsciiDocLinkIndex {
+  @NonNls
+  public static final ID<String, Void> NAME = ID.create("AsciiDocLinkIndex");
+
+  public static Collection<VirtualFile> getLinkSources(@NotNull Project project, String target) {
+    Set<VirtualFile> files = CollectionFactory.createSmallMemoryFootprintSet();
+    FileBasedIndex.getInstance().processValues(NAME, target, null, (file, value) -> {
+      files.add(file);
+      return true;
+    }, new AsciiDocSearchScope(project), null);
+    return files;
+  }
+
+}

src/main/java/org/asciidoc/intellij/psi/search/AsciiDocLinkIndexImpl.java

@@ -0,0 +1,87 @@
+package org.asciidoc.intellij.psi.search;
+
+import com.intellij.openapi.fileTypes.FileType;
+import com.intellij.util.indexing.DataIndexer;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.intellij.util.indexing.FileContent;
+import com.intellij.util.indexing.ID;
+import com.intellij.util.indexing.ScalarIndexExtension;
+import com.intellij.util.io.EnumeratorStringDescriptor;
+import com.intellij.util.io.KeyDescriptor;
+import org.asciidoc.intellij.file.AsciiDocFileType;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Objects;
+
+/**
+ * Index implementation to contain all Antora playbooks.
+ *
+ * @author Alexander Schwartz ([email protected])
+ */
+public class AsciiDocLinkIndexImpl extends ScalarIndexExtension<String> {
+
+  @NotNull
+  @Override
+  public ID<String, Void> getName() {
+    return AsciiDocLinkIndex.NAME;
+  }
+
+  /**
+   * Map all entries to a single key, so we can later retrieve them with a single lookup.
+   */
+  @NotNull
+  @Override
+  public DataIndexer<String, Void, FileContent> getIndexer() {
+    return inputData -> {
+      String canonicalPath = inputData.getFile().getCanonicalPath();
+      return Collections.singletonMap(canonicalPath, null);
+    };
+  }
+
+  @NotNull
+  @Override
+  public KeyDescriptor<String> getKeyDescriptor() {
+    return EnumeratorStringDescriptor.INSTANCE;
+  }
+
+  /**
+   * Files to be indexed need to end with ".yml", and need to contain both "antora" and "playbook".
+   */
+  @NotNull
+  @Override
+  public FileBasedIndex.InputFilter getInputFilter() {
+    return vf -> {
+      if (!vf.getFileType().equals(AsciiDocFileType.INSTANCE)) {
+        return false;
+      }
+      return !Objects.equals(vf.getPath(), vf.getCanonicalPath());
+    };
+  }
+
+  @Override
+  public @NotNull Collection<FileType> getFileTypesWithSizeLimitNotApplicable() {
+    return super.getFileTypesWithSizeLimitNotApplicable();
+  }
+
+  @Override
+  public boolean dependsOnFileContent() {
+    return false;
+  }
+
+  @Override
+  public boolean indexDirectories() {
+    return false;
+  }
+
+  @Override
+  public int getVersion() {
+    return 1;
+  }
+
+  @Override
+  public boolean traceKeyHashToVirtualFileMapping() {
+    return true;
+  }
+}

src/main/java/org/asciidoc/intellij/psi/search/AsciiDocLinkProjectOpen.java

@@ -0,0 +1,64 @@
+package org.asciidoc.intellij.psi.search;
+
+import com.intellij.openapi.Disposable;
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.project.DumbAware;
+import com.intellij.openapi.project.DumbService;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.startup.StartupActivity;
+import com.intellij.openapi.vfs.LocalFileSystem;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.openapi.vfs.VirtualFileManager;
+import com.intellij.openapi.vfs.newvfs.BulkFileListener;
+import com.intellij.openapi.vfs.newvfs.events.VFileEvent;
+import com.intellij.util.messages.MessageBusConnection;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Shows update notification.
+ */
+public class AsciiDocLinkProjectOpen implements StartupActivity, DumbAware, Disposable {
+
+  private MessageBusConnection connection;
+
+  @Override
+  public void runActivity(@NotNull Project project) {
+    connection = project.getMessageBus().connect(this);
+    connection.subscribe(VirtualFileManager.VFS_CHANGES, new BulkFileListener() {
+      @Override
+      public void after(@NotNull List<? extends VFileEvent> events) {
+        // any modification of a file within the project refreshes the preview
+        Set<VirtualFile> linkSources = new HashSet<>();
+        for (VFileEvent event : events) {
+          if (event.getFile() != null) {
+            if (!project.isDisposed()) {
+              VirtualFile file = event.getFile();
+              if (!file.isValid()) {
+                continue;
+              }
+              if (!DumbService.isDumb(project)) {
+                linkSources.addAll(AsciiDocLinkIndex.getLinkSources(project, file.getCanonicalPath()));
+              }
+            }
+          }
+        }
+        if (!linkSources.isEmpty()) {
+          ApplicationManager.getApplication().invokeLater(() -> {
+            ApplicationManager.getApplication().runWriteAction(() -> {
+              LocalFileSystem.getInstance().refreshFiles(linkSources);
+            });
+          });
+        }
+      }
+    });
+  }
+
+  @Override
+  public void dispose() {
+    connection.disconnect();
+  }
+}

src/main/resources/META-INF/plugin.xml

@@ -433,5 +433,7 @@
     <errorHandler implementation="org.asciidoc.intellij.errorHandler.AsciiDocErrorHandler"/>
     <registryKey defaultValue="true" description="Whether the AsciiDoc view should be displayed in the off-screen mode." key="ide.browser.jcef.asciidocView.osr.enabled" />
     <fileBasedIndex implementation="org.asciidoc.intellij.psi.search.AsciiDocAntoraPlaybookIndexImpl"/>
+    <fileBasedIndex implementation="org.asciidoc.intellij.psi.search.AsciiDocLinkIndexImpl"/>
+    <postStartupActivity implementation="org.asciidoc.intellij.psi.search.AsciiDocLinkProjectOpen"/>
   </extensions>
 </idea-plugin>