Skip to content

refactor glob / resource handling, allowing it to use in a more central way #1950

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
Jun 2, 2022
Merged

refactor glob / resource handling, allowing it to use in a more central way #1950

Show file tree
Hide file tree
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
110 changes: 95 additions & 15 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 @@ -34,13 +34,19 @@
import java.nio.file.attribute.BasicFileAttributes;
import java.util.*;
import java.util.function.Supplier;
import java.util.regex.PatternSyntaxException;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
* @author Daniel Espendiller <daniel@espendiller.net>
*/
public class FileResourceUtil {
/**
* chars that trigger a glob resolving on symfony
* extracted from: \Symfony\Component\Config\Loader\FileLoader::import
*/
private static final String[] GLOB_DETECTION_CHARS = {"*", "?", "{", "["};

/**
* Search for files refers to given file
Expand Down Expand Up @@ -79,19 +85,56 @@ public static boolean hasFileResources(@NotNull Project project, @NotNull PsiFil
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());
Set<String> resources = new HashSet<>(FileBasedIndex.getInstance().getAllKeys(FileResourcesIndex.KEY, project));

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

VirtualFile relativeFile = VfsUtil.findRelativeFile(directory, s.replace("\\", "/").split("/"));
String resourceResolved = resource;

if (resource.startsWith("@")) {
String replace = resource.replace("\\", "/");
int i = replace.indexOf("/");
if (i > 2) {
String substring = resource.substring(1, i);
Collection<SymfonyBundle> bundle = new SymfonyBundleUtil(project).getBundle(substring);

for (SymfonyBundle symfonyBundle : bundle) {
PsiDirectory directory1 = symfonyBundle.getDirectory();
if (directory1 == null) {
continue;
}

String substring1 = resource.substring(i);
String path = directory1.getVirtualFile().getPath();
resourceResolved = path + substring1;

break;
}
}
}

if (Arrays.stream(GLOB_DETECTION_CHARS).anyMatch(resource::contains)) {
String path = directory.getPath();

// nested types not support by java glob implementation so just catch the exception: "../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php,Service/{IspConfiguration,DataCollection}}"
try {
String s1 = Paths.get(path + File.separatorChar + StringUtils.stripStart(resourceResolved, "\\/")).normalize().toString();
String syntaxAndPattern = "glob:" + s1;
if (FileSystems.getDefault().getPathMatcher(syntaxAndPattern).matches(Paths.get(virtualFile.getPath()))) {
return CachedValueProvider.Result.create(Boolean.TRUE, FileIndexCaches.getModificationTrackerForIndexId(project, FileResourcesIndex.KEY));
}
} catch (PatternSyntaxException | InvalidPathException ignored) {
}

continue;
}

VirtualFile relativeFile = VfsUtil.findRelativeFile(directory, resourceResolved.replace("\\", "/").split("/"));
if (relativeFile != null) {
String relativePath = VfsUtil.getRelativePath(virtualFile, relativeFile);
if (relativePath != null) {
Expand All @@ -111,24 +154,61 @@ public static boolean hasFileResources(@NotNull Project project, @NotNull PsiFil
*/
@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());
Set<String> resources = new HashSet<>(FileBasedIndex.getInstance().getAllKeys(FileResourcesIndex.KEY, project));

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

VirtualFile relativeFile = VfsUtil.findRelativeFile(directory, s.replace("\\", "/").split("/"));
String resourceResolved = resource;

if (resource.startsWith("@")) {
String replace = resource.replace("\\", "/");
int i = replace.indexOf("/");
if (i > 2) {
String substring = resource.substring(1, i);
Collection<SymfonyBundle> bundle = new SymfonyBundleUtil(project).getBundle(substring);

for (SymfonyBundle symfonyBundle : bundle) {
PsiDirectory directory1 = symfonyBundle.getDirectory();
if (directory1 == null) {
continue;
}

String substring1 = resource.substring(i);
String path = directory1.getVirtualFile().getPath();
resourceResolved = path + substring1;

break;
}
}
}

if (Arrays.stream(GLOB_DETECTION_CHARS).anyMatch(resource::contains)) {
String path = directory.getPath();

// nested types not support by java glob implementation so just catch the exception: "../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php,Service/{IspConfiguration,DataCollection}}"
try {
String s1 = Paths.get(path + File.separatorChar + StringUtils.stripStart(resourceResolved, "\\/")).normalize().toString();
String syntaxAndPattern = "glob:" + s1;
if (FileSystems.getDefault().getPathMatcher(syntaxAndPattern).matches(Paths.get(virtualFile.getPath()))) {
files.add(Pair.create(containingFile, resource));
}
} catch (PatternSyntaxException | InvalidPathException ignored) {
}

continue;
}

VirtualFile relativeFile = VfsUtil.findRelativeFile(directory, resourceResolved.replace("\\", "/").split("/"));
if (relativeFile != null) {
String relativePath = VfsUtil.getRelativePath(virtualFile, relativeFile);
if (relativePath != null) {
files.add(Pair.create(containingFile, s));
files.add(Pair.create(containingFile, resource));
}
}
}
Expand Down
40 changes: 40 additions & 0 deletions ...st/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/FileResourceUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiFile;
import com.intellij.psi.PsiManager;
import com.intellij.util.containers.ContainerUtil;
import com.jetbrains.php.lang.psi.elements.PhpClass;
import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
Expand Down Expand Up @@ -76,12 +77,51 @@ public void testFileResources() {
assertTrue(fileResources.stream().anyMatch(pair -> pair.getFirst().getPath().equals(services.getPath())));
}

public void testFileResourcesForBundle() {
myFixture.copyFileToProject("classes.php");
myFixture.configureByText("target.xml", "" +
"<routes>\n" +
" <import resource=\"@FooBundle/*Controller.php\" />\n" +
"</routes>"
);

VirtualFile virtualFile = myFixture.copyFileToProject("dummy.php", "src/TestController.php");

assertTrue(FileResourceUtil.hasFileResources(getProject(), PsiManager.getInstance(getProject()).findFile(virtualFile)));

Collection<Pair<VirtualFile, String>> fileResources = FileResourceUtil.getFileResources(getProject(), virtualFile);
assertTrue(fileResources.stream().anyMatch(pair -> pair.getSecond().equals("@FooBundle/*Controller.php")));
}

public void testFileResourcesForBundleNoMatch() {
myFixture.copyFileToProject("classes.php");

PsiFile psiFile = myFixture.configureByText("target.xml", "" +
"<routes>\n" +
" <import resource=\"@FooBundle/*Foobar.php\" />\n" +
"</routes>"
);

VirtualFile virtualFile = myFixture.copyFileToProject("dummy.php", "src/TestController.php");

assertFalse(FileResourceUtil.hasFileResources(getProject(), PsiElementUtils.virtualFileToPsiFile(getProject(), virtualFile)));

Collection<Pair<VirtualFile, String>> fileResources = FileResourceUtil.getFileResources(getProject(), virtualFile);
assertFalse(fileResources.stream().anyMatch(pair -> pair.getFirst().getPath().equals(psiFile.getVirtualFile().getPath())));
}

public void testGetFileImplementsLineMarker() {
myFixture.copyFileToProject("services.xml", "config/services.xml");
VirtualFile virtualFile = myFixture.copyFileToProject("classes.php", "src/Test.php");
assertNotNull(FileResourceUtil.getFileImplementsLineMarker(PsiElementUtils.virtualFileToPsiFile(getProject(), virtualFile)));
}

public void testGetFileImplementsLineMarkerForGlob() {
myFixture.copyFileToProject("services.xml", "config/services.xml");
VirtualFile virtualFile = myFixture.copyFileToProject("classes.php", "src/TestController.php");
assertNotNull(FileResourceUtil.getFileImplementsLineMarker(PsiElementUtils.virtualFileToPsiFile(getProject(), virtualFile)));
}

public void testGetFileImplementsLineMarkerForBundle() {
createBundleScopeProject();

Expand Down
1 change: 1 addition & 0 deletions src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/fixtures/dummy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?php