Add ConstantMatcherExpression

Author: cedricziel

src/main/java/com/cedricziel/idea/typo3/codeInspection/TYPO3InspectionToolProvider.java

@@ -2,6 +2,7 @@
 
 import com.cedricziel.idea.typo3.extensionScanner.codeInspection.ClassConstantMatcherInspection;
 import com.cedricziel.idea.typo3.extensionScanner.codeInspection.ClassNameMatcherInspection;
+import com.cedricziel.idea.typo3.extensionScanner.codeInspection.ConstantMatcherInspection;
 import com.cedricziel.idea.typo3.tca.codeInspection.InvalidQuantityInspection;
 import com.intellij.codeInspection.InspectionToolProvider;
 import org.jetbrains.annotations.NotNull;
@@ -19,6 +20,7 @@ public Class[] getInspectionClasses() {
                 // Extension Scanner
                 ClassConstantMatcherInspection.class,
                 ClassNameMatcherInspection.class,
+                ConstantMatcherInspection.class,
         };
     }
 }

src/main/java/com/cedricziel/idea/typo3/extensionScanner/codeInspection/ConstantMatcherInspection.java

@@ -0,0 +1,84 @@
+package com.cedricziel.idea.typo3.extensionScanner.codeInspection;
+
+import com.intellij.codeInsight.daemon.GroupNames;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.patterns.PlatformPatterns;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.search.FilenameIndex;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.psi.util.PsiTreeUtil;
+import com.jetbrains.php.lang.inspections.PhpInspection;
+import com.jetbrains.php.lang.parser.PhpElementTypes;
+import com.jetbrains.php.lang.psi.elements.ConstantReference;
+import com.jetbrains.php.lang.psi.elements.PhpPsiElement;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor;
+import org.jetbrains.annotations.Nls;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+public class ConstantMatcherInspection extends PhpInspection {
+    @Nls
+    @NotNull
+    @Override
+    public String getGroupDisplayName() {
+        return GroupNames.BUGS_GROUP_NAME;
+    }
+
+    @NotNull
+    public String getDisplayName() {
+        return "Constant removed with TYPO3 9";
+    }
+
+    @NotNull
+    @Override
+    public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder problemsHolder, boolean b) {
+        return new PhpElementVisitor() {
+            @Override
+            public void visitPhpElement(PhpPsiElement element) {
+
+                if (!PlatformPatterns.psiElement(PhpElementTypes.CLASS_REFERENCE).accepts(element)) {
+                    return;
+                }
+
+                Set<String> constants = getRemovedConstantsFQNs(element);
+                ConstantReference constantReference = (ConstantReference) element;
+                if (constants.contains(constantReference.getFQN())) {
+                    problemsHolder.registerProblem(element, "Constant removed with TYPO3 9, consider using an alternative");
+                }
+            }
+        };
+    }
+
+    private Set<String> getRemovedConstantsFQNs(PhpPsiElement element) {
+        Set<PsiElement> elements = new HashSet<>();
+        PsiFile[] constantMatcherFiles = FilenameIndex.getFilesByName(element.getProject(), "ConstantMatcher.php", GlobalSearchScope.allScope(element.getProject()));
+        for (PsiFile file : constantMatcherFiles) {
+
+            Collections.addAll(
+                    elements,
+                    PsiTreeUtil.collectElements(file, el -> PlatformPatterns
+                            .psiElement(StringLiteralExpression.class)
+                            .withParent(
+                                    PlatformPatterns.psiElement(PhpElementTypes.ARRAY_KEY)
+                                            .withAncestor(
+                                                    4,
+                                                    PlatformPatterns.psiElement(PhpElementTypes.RETURN)
+                                            )
+                            )
+                            .accepts(el)
+                    )
+            );
+        }
+
+        return elements.stream()
+                .map(stringLiteral -> "\\" + ((StringLiteralExpression)stringLiteral).getContents())
+                .collect(Collectors.toSet());
+    }
+}