Skip to content

support file and directory resolving for resources #1939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2022
Merged

support file and directory resolving for resources #1939

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
195 changes: 172 additions & 23 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/util/resource/FileResourceUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,34 @@
import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.NotNullLazyValue;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.vfs.VfsUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.PsiManager;
import com.intellij.psi.search.GlobalSearchScope;
import com.intellij.psi.util.CachedValueProvider;
import com.intellij.psi.util.CachedValuesManager;
import com.intellij.util.PlatformIcons;
import com.intellij.util.indexing.FileBasedIndex;
import com.jetbrains.php.PhpIcons;
import fr.adrienbrault.idea.symfony2plugin.stubs.cache.FileIndexCaches;
import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.FileResourcesIndex;
import fr.adrienbrault.idea.symfony2plugin.util.FileResourceVisitorUtil;
import fr.adrienbrault.idea.symfony2plugin.util.PhpIndexUtil;
import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
import fr.adrienbrault.idea.symfony2plugin.util.SymfonyBundleUtil;
import fr.adrienbrault.idea.symfony2plugin.util.*;
import fr.adrienbrault.idea.symfony2plugin.util.dict.SymfonyBundle;
import org.apache.commons.lang.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.File;
import java.io.IOException;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.*;
import java.util.function.Supplier;
import java.util.stream.Collectors;

/**
* @author Daniel Espendiller <daniel@espendiller.net>
Expand All @@ -49,14 +55,84 @@ public static Collection<VirtualFile> getFileResourceRefers(@NotNull Project pro
* Search for files refers to given file
*/
@NotNull
public static Collection<VirtualFile> getFileResourceRefers(@NotNull Project project, @NotNull String bundleLocateName) {
private static Collection<VirtualFile> getFileResourceRefers(@NotNull Project project, @NotNull String bundleLocateName) {
return FileBasedIndex.getInstance().getContainingFiles(
FileResourcesIndex.KEY,
bundleLocateName,
GlobalSearchScope.allScope(project)
);
}

/**
* Search for files refers to given file
*/
public static boolean hasFileResources(@NotNull Project project, @NotNull PsiFile psiFile) {
return CachedValuesManager.getCachedValue(
psiFile,
() -> {
VirtualFile virtualFile = psiFile.getVirtualFile();
if (virtualFile == null) {
return CachedValueProvider.Result.create(Boolean.FALSE, FileIndexCaches.getModificationTrackerForIndexId(project, FileResourcesIndex.KEY));
}

Set<String> collect = FileBasedIndex.getInstance().getAllKeys(FileResourcesIndex.KEY, project)
.stream()
.filter(s -> !s.startsWith("@"))
.collect(Collectors.toSet());

for (String s : collect) {
for (VirtualFile containingFile : FileBasedIndex.getInstance().getContainingFiles(FileResourcesIndex.KEY, s, GlobalSearchScope.allScope(project))) {
VirtualFile directory = containingFile.getParent();
if (directory == null) {
continue;
}

VirtualFile relativeFile = VfsUtil.findRelativeFile(directory, s.replace("\\", "/").split("/"));
if (relativeFile != null) {
String relativePath = VfsUtil.getRelativePath(virtualFile, relativeFile);
if (relativePath != null) {
return CachedValueProvider.Result.create(Boolean.TRUE, FileIndexCaches.getModificationTrackerForIndexId(project, FileResourcesIndex.KEY));
}
}
}
}

return CachedValueProvider.Result.create(Boolean.FALSE, FileIndexCaches.getModificationTrackerForIndexId(project, FileResourcesIndex.KEY));
}
);
}

/**
* Search for files refers to given file
*/
@NotNull
public static Collection<Pair<VirtualFile, String>> getFileResources(@NotNull Project project, @NotNull VirtualFile virtualFile) {
Set<String> collect = FileBasedIndex.getInstance().getAllKeys(FileResourcesIndex.KEY, project)
.stream()
.filter(s -> !s.startsWith("@"))
.collect(Collectors.toSet());

Collection<Pair<VirtualFile, String>> files = new ArrayList<>();
for (String s : collect) {
for (VirtualFile containingFile : FileBasedIndex.getInstance().getContainingFiles(FileResourcesIndex.KEY, s, GlobalSearchScope.allScope(project))) {
VirtualFile directory = containingFile.getParent();
if (directory == null) {
continue;
}

VirtualFile relativeFile = VfsUtil.findRelativeFile(directory, s.replace("\\", "/").split("/"));
if (relativeFile != null) {
String relativePath = VfsUtil.getRelativePath(virtualFile, relativeFile);
if (relativePath != null) {
files.add(Pair.create(containingFile, s));
}
}
}
}

return files;
}

@Nullable
public static String getBundleLocateName(@NotNull Project project, @NotNull VirtualFile virtualFile) {
SymfonyBundle containingBundle = new SymfonyBundleUtil(project).getContainingBundle(virtualFile);
Expand Down Expand Up @@ -104,19 +180,28 @@ public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarker(
}

String bundleLocateName = FileResourceUtil.getBundleLocateName(project, virtualFile);
if(bundleLocateName == null) {
return null;
}
if(bundleLocateName != null) {
if(FileResourceUtil.getFileResourceRefers(project, bundleLocateName).size() == 0) {
return null;
}

if(FileResourceUtil.getFileResourceRefers(project, bundleLocateName).size() == 0) {
return null;
}
NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS)
.setTargets(NotNullLazyValue.lazy(new FileResourceBundleNotNullLazyValue(project, bundleLocateName)))
.setTooltipText("Navigate to resource");

NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS)
.setTargets(NotNullLazyValue.lazy(new FileResourceUtil.FileResourceNotNullLazyValue(project, bundleLocateName)))
.setTooltipText("Navigate to resource");
return builder.createLineMarkerInfo(psiFile);
} else {
if (hasFileResources(project, psiFile)) {
NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS);
builder.setTargets(NotNullLazyValue.lazy(new FileResourceNotNullLazyValue(project, virtualFile)));

return builder.createLineMarkerInfo(psiFile);
builder.setTooltipText("Navigate to resource");

return builder.createLineMarkerInfo(psiFile);
}
}

return null;
}

/**
Expand Down Expand Up @@ -154,23 +239,23 @@ public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarkerI
}

NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PlatformIcons.ANNOTATION_TYPE_ICON)
.setTargets(NotNullLazyValue.lazy(new FileResourceUtil.FileResourceNotNullLazyValue(project, names)))
.setTargets(NotNullLazyValue.lazy(new FileResourceBundleNotNullLazyValue(project, names)))
.setTooltipText("Symfony: <a href=\"https://symfony.com/doc/current/routing.html#creating-routes-as-annotations\">Annotation Routing</a>");

return builder.createLineMarkerInfo(psiFile);
}

private static class FileResourceNotNullLazyValue implements Supplier<Collection<? extends PsiElement>> {
private static class FileResourceBundleNotNullLazyValue implements Supplier<Collection<? extends PsiElement>> {

private final Collection<String> resources;
private final Project project;

public FileResourceNotNullLazyValue(@NotNull Project project, @NotNull Collection<String> resource) {
public FileResourceBundleNotNullLazyValue(@NotNull Project project, @NotNull Collection<String> resource) {
this.resources = resource;
this.project = project;
}

public FileResourceNotNullLazyValue(@NotNull Project project, @NotNull String resource) {
public FileResourceBundleNotNullLazyValue(@NotNull Project project, @NotNull String resource) {
this.resources = Collections.singleton(resource);
this.project = project;
}
Expand Down Expand Up @@ -264,11 +349,75 @@ public static Collection<PsiFile> getFileResourceTargetsInDirectoryScope(@NotNul
return Collections.emptyList();
}

PsiFile targetFile = PsiElementUtils.virtualFileToPsiFile(psiFile.getProject(), relativeFile);
if(targetFile == null) {
return Collections.emptyList();
Set<PsiFile> psiFiles = new HashSet<>();
if (relativeFile.isDirectory()) {
String path = relativeFile.getPath();
final PathMatcher pathMatcher = FileSystems.getDefault().getPathMatcher("glob:/**/*.php");

Set<String> files = new HashSet<>();
try {
Files.walkFileTree(Paths.get(path), new SimpleFileVisitor<>() {
@Override
public FileVisitResult visitFile(Path path, BasicFileAttributes attrs) {
if (pathMatcher.matches(path)) {
files.add(path.toString());
}
return files.size() < 200 ? FileVisitResult.CONTINUE : FileVisitResult.TERMINATE;
}

@Override
public FileVisitResult visitFileFailed(Path file, IOException exc) {
return FileVisitResult.CONTINUE;
}
});
} catch (IOException ignored) {
}

Set<PsiFile> collect = files.stream()
.map(s -> VfsUtil.findFileByIoFile(new File(s), false))
.filter(Objects::nonNull)
.map(virtualFile -> PsiElementUtils.virtualFileToPsiFile(psiFile.getProject(), virtualFile))
.filter(Objects::nonNull)
.collect(Collectors.toSet());

psiFiles.addAll(collect);
} else {
PsiFile targetFile = PsiElementUtils.virtualFileToPsiFile(psiFile.getProject(), relativeFile);
if(targetFile != null) {
psiFiles.add(targetFile);
}
}

return psiFiles;
}

private static class FileResourceNotNullLazyValue implements Supplier<Collection<? extends PsiElement>> {
private final Project project;
private final VirtualFile virtualFile;

public FileResourceNotNullLazyValue(Project project, VirtualFile virtualFile) {
this.project = project;
this.virtualFile = virtualFile;
}

return Collections.singletonList(targetFile);
@Override
public Collection<? extends PsiElement> get() {
Collection<PsiElement> psiElements = new HashSet<>();

for (Pair<VirtualFile, String> pair : getFileResources(project, virtualFile)) {
PsiFile psiFile1 = PsiElementUtils.virtualFileToPsiFile(project, pair.getFirst());
if (psiFile1 == null) {
continue;
}

FileResourceVisitorUtil.visitFile(psiFile1, fileResourceConsumer -> {
if (fileResourceConsumer.getResource().equalsIgnoreCase(pair.getSecond())) {
psiElements.add(fileResourceConsumer.getPsiElement());
}
});
}

return psiElements;
}
}
}