[T3CMS] allowed TCA field can contain CSV string of tables (#351)

cedricziel · web-flow · commit c2b9eca93ee3 · 2021-03-27T13:24:39.000+01:00
diff --git a/lang-fluid/src/main/java/com/cedricziel/idea/fluid/tagMode/UnboundNamespaceSuppressor.java b/lang-fluid/src/main/java/com/cedricziel/idea/fluid/tagMode/UnboundNamespaceSuppressor.java
@@ -44,6 +44,6 @@ public boolean isSuppressedFor(@NotNull PsiElement element, @NotNull String tool
     @NotNull
     @Override
     public SuppressQuickFix @NotNull [] getSuppressActions(@Nullable PsiElement element, @NotNull String toolId) {
-        return new SuppressQuickFix[0];
+        return SuppressQuickFix.EMPTY_ARRAY;
     }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInsight/navigation/PathResourceGotoDeclarationHandler.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInsight/navigation/PathResourceGotoDeclarationHandler.java
@@ -34,7 +34,7 @@ public PsiElement[] getGotoDeclarationTargets(@Nullable PsiElement sourceElement
 
     @NotNull
     private PsiElement[] emptyPsiElementArray() {
-        return new PsiElement[0];
+        return PsiElement.EMPTY_ARRAY;
     }
 
     @Nullable
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInspection/MissingTableInspection.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInspection/MissingTableInspection.java
@@ -4,13 +4,18 @@
 import com.cedricziel.idea.typo3.util.TableUtil;
 import com.intellij.codeInsight.daemon.GroupNames;
 import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.util.TextRange;
 import com.intellij.psi.PsiElementVisitor;
 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.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+
 import static com.cedricziel.idea.typo3.psi.PhpElementsUtil.extractArrayIndexFromValue;
 import static com.cedricziel.idea.typo3.util.TCAUtil.arrayIndexIsTCATableNameField;
 import static com.cedricziel.idea.typo3.util.TCAUtil.insideTCAColumnDefinition;
@@ -51,13 +56,26 @@ public void visitPhpElement(PhpPsiElement element) {
                 }
 
                 boolean valueIsTableNameFieldValue = arrayIndexIsTCATableNameField(element);
-                if (valueIsTableNameFieldValue) {
-                    if (element instanceof StringLiteralExpression) {
-                        String tableName = ((StringLiteralExpression) element).getContents();
-                        boolean isValidTableName = TableUtil.getAvailableTableNames(element.getProject()).contains(tableName);
+                if (!valueIsTableNameFieldValue) {
+                    return;
+                }
+
+                if (element instanceof StringLiteralExpression) {
+                    List<String> tableNames = new ArrayList<>();
 
+                    String content = ((StringLiteralExpression) element).getContents();
+
+                    if (arrayKey != null && arrayKey.equals("allowed")) {
+                        tableNames = Arrays.asList(content.trim().split("\\s*,\\s*"));
+                    } else {
+                        tableNames.add(content);
+                    }
+
+                    for (String tableName : tableNames) {
+                        boolean isValidTableName = TableUtil.getAvailableTableNames(element.getProject()).contains(tableName);
                         if (!isValidTableName) {
-                            problemsHolder.registerProblem(element, "Missing table definition");
+                            int i = content.indexOf(tableName);
+                            problemsHolder.registerProblem(element, new TextRange(i + 1, i + 1 + tableName.length()), String.format("Table '%s' is not defined", tableName));
                         }
                     }
                 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/dispatcher/SignalSlotMethodReference.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/dispatcher/SignalSlotMethodReference.java
@@ -80,7 +80,7 @@ public SignalSlotMethodReference(@NotNull StringLiteralExpression className, @No
             results.add(new PsiElementResolveResult(psiElement));
         }
 
-        return results.toArray(new ResolveResult[0]);
+        return results.toArray(ResolveResult.EMPTY_ARRAY);
     }
 
     @NotNull
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/extbase/controller/ControllerActionReferenceContributor.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/extbase/controller/ControllerActionReferenceContributor.java
@@ -18,7 +18,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
                     @Override
                     public PsiReference @NotNull [] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
                         if (!(element instanceof StringLiteralExpression)) {
-                            return new PsiReference[0];
+                            return PsiReference.EMPTY_ARRAY;
                         }
 
                         StringLiteralExpression stringLiteralExpression = (StringLiteralExpression) element;
@@ -29,7 +29,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
                             return new PsiReference[]{new ControllerActionReference(stringLiteralExpression)};
                         }
 
-                        return new PsiReference[0];
+                        return PsiReference.EMPTY_ARRAY;
                     }
                 }
         );
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/IconIndex.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/IconIndex.java
@@ -74,7 +74,7 @@ public static PsiElement[] getIconDefinitionElements(@NotNull Project project, @
                     .toArray(PsiElement[]::new);
         }
 
-        return new PsiElement[0];
+        return PsiElement.EMPTY_ARRAY;
     }
 
     @NotNull
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/routing/RouteFoldingBuilder.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/routing/RouteFoldingBuilder.java
@@ -42,7 +42,7 @@ public class RouteFoldingBuilder extends FoldingBuilderEx {
 
         }
 
-        return descriptors.toArray(new FoldingDescriptor[0]);
+        return descriptors.toArray(FoldingDescriptor.EMPTY);
     }
 
     @Nullable
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/routing/RouteHelper.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/routing/RouteHelper.java
@@ -61,7 +61,7 @@ public static PsiElement[] getRouteDefinitionElements(@NotNull Project project,
             return true;
         }, GlobalSearchScope.allScope(project));
 
-        return results.toArray(new PsiElement[0]);
+        return results.toArray(PsiElement.EMPTY_ARRAY);
     }
 
     @NotNull
@@ -81,7 +81,7 @@ private static PsiElement[] getTargetMethods(@NotNull Project project, @NotNull
             });
         }
 
-        return result.toArray(new PsiElement[0]);
+        return result.toArray(PsiElement.EMPTY_ARRAY);
     }
 
     @NotNull
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/translation/TranslationFoldingBuilder.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/translation/TranslationFoldingBuilder.java
@@ -49,7 +49,7 @@ public String getPlaceholderText() {
             }
         }
 
-        return descriptors.toArray(new FoldingDescriptor[0]);
+        return descriptors.toArray(FoldingDescriptor.EMPTY);
     }
 
     @Nullable
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/ControllerActionUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/ControllerActionUtil.java
@@ -43,6 +43,6 @@ public static PsiElement[] getDefinitionElements(@NotNull Project project, @NotN
             return true;
         }, GlobalSearchScope.allScope(project));
 
-        return elements.toArray(new PsiElement[0]);
+        return elements.toArray(PsiElement.EMPTY_ARRAY);
     }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/SignalSlotDispatcherUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/SignalSlotDispatcherUtil.java
@@ -23,7 +23,7 @@ public static PsiElement[] getSignalPsiElements(final Project project, String fq
             }
         });
 
-        return foundElements.toArray(new PsiElement[0]);
+        return foundElements.toArray(PsiElement.EMPTY_ARRAY);
     }
 
     public static LookupElement[] getPossibleSlotMethodLookupElements(@NotNull Project project, @NotNull String fqn) {
@@ -36,6 +36,6 @@ public static LookupElement[] getPossibleSlotMethodLookupElements(@NotNull Proje
             }
         });
 
-        return lookupElements.toArray(new LookupElement[0]);
+        return lookupElements.toArray(LookupElement.EMPTY_ARRAY);
     }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/TableUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/TableUtil.java
@@ -48,7 +48,7 @@ public static PsiElement[] getTableDefinitionElements(@NotNull String tableName,
             }, GlobalSearchScope.allScope(project));
         }
 
-        return elements.toArray(new PsiElement[0]);
+        return elements.toArray(PsiElement.EMPTY_ARRAY);
     }
 
     private static PsiFile[] getExtTablesSqlFilesInProjectContainingTable(@NotNull String tableName, @NotNull Project project) {
@@ -65,7 +65,7 @@ private static PsiFile[] getExtTablesSqlFilesInProjectContainingTable(@NotNull S
             return true;
         }, GlobalSearchScope.allScope(project));
 
-        return files.toArray(new PsiFile[0]);
+        return files.toArray(PsiFile.EMPTY_ARRAY);
     }
 
     @NotNull
@@ -93,6 +93,6 @@ public static LookupElement[] createAvailableTableNamesLookupElements(@NotNull P
             elements.add(new TableLookupElement(name));
         }
 
-        return elements.toArray(new LookupElement[0]);
+        return elements.toArray(LookupElement.EMPTY_ARRAY);
     }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/TranslationUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/TranslationUtil.java
@@ -142,7 +142,7 @@ public static PsiElement[] findDefinitionElements(@NotNull Project project, @Not
             }
         });
 
-        return elements.toArray(new PsiElement[0]);
+        return elements.toArray(PsiElement.EMPTY_ARRAY);
     }
 
     public static boolean hasTranslationReference(@NotNull PsiElement element) {
diff --git a/typo3-cms/src/test/java/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionTest.java b/typo3-cms/src/test/java/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionTest.java
@@ -28,4 +28,24 @@ public void testMissingRenderTypeIsNotMarkedWhenPluginDisabled() {
 
         myFixture.checkHighlighting();
     }
+
+    public void testAllowedKeyCanContainCSVOfTables() {
+        myFixture.enableInspections(new MissingTableInspection());
+
+        myFixture.addFileToProject("ext_tables.sql", "CREATE TABLE tt_content; CREATE TABLE pages;");
+
+        VirtualFile virtualFile = myFixture.copyFileToProject("MissingTableInspectionIsNotMarkedForAllowed.php", "MyClass.php");
+        myFixture.configureFromExistingVirtualFile(virtualFile);
+
+        myFixture.checkHighlighting();
+    }
+
+    public void testAllowedKeyCanContainCSVOfTablesNotExistent() {
+        myFixture.enableInspections(new MissingTableInspection());
+
+        VirtualFile virtualFile = myFixture.copyFileToProject("MissingTableInspectionIsMarkedForAllowed.php", "MyClass.php");
+        myFixture.configureFromExistingVirtualFile(virtualFile);
+
+        myFixture.checkHighlighting();
+    }
 }
diff --git a/typo3-cms/testData/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionIsMarked.php b/typo3-cms/testData/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionIsMarked.php
@@ -6,7 +6,7 @@
             'label' => 'title',
             'config' => [
                 'type' => 'input',
-                'foreign_table' => <warning descr="Missing table definition">'footable'</warning>,
+                'foreign_table' => '<warning descr="Table 'footable' is not defined">footable</warning>',
                 'size' => 25,
                 'max' => 255,
                 'eval' => 'required'
diff --git a/typo3-cms/testData/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionIsMarkedForAllowed.php b/typo3-cms/testData/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionIsMarkedForAllowed.php
@@ -0,0 +1,16 @@
+<?php
+
+return [
+    'columns' => [
+        'title' => [
+            'label' => 'title',
+            'config' => [
+                'type' => 'input',
+                'size' => 25,
+                'max' => 255,
+                'eval' => 'required',
+                'allowed' => '<warning descr="Table 'foo' is not defined">foo</warning>,<warning descr="Table 'bar' is not defined">bar</warning>',
+            ]
+        ],
+    ],
+];
diff --git a/typo3-cms/testData/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionIsNotMarkedForAllowed.php b/typo3-cms/testData/com/cedricziel/idea/typo3/codeInspection/MissingTableInspectionIsNotMarkedForAllowed.php
@@ -0,0 +1,16 @@
+<?php
+
+return [
+    'columns' => [
+        'title' => [
+            'label' => 'title',
+            'config' => [
+                'type' => 'input',
+                'size' => 25,
+                'max' => 255,
+                'eval' => 'required',
+                'allowed' => 'tt_content,pages',
+            ]
+        ],
+    ],
+];

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,6 @@ public boolean isSuppressedFor(@NotNull PsiElement element, @NotNull String tool`
`44`	`44`	`@NotNull`
`45`	`45`	`@Override`
`46`	`46`	`public SuppressQuickFix @NotNull [] getSuppressActions(@Nullable PsiElement element, @NotNull String toolId) {`
`47`		`- return new SuppressQuickFix[0];`
	`47`	`+ return SuppressQuickFix.EMPTY_ARRAY;`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public PsiElement[] getGotoDeclarationTargets(@Nullable PsiElement sourceElement`
`34`	`34`
`35`	`35`	`@NotNull`
`36`	`36`	`private PsiElement[] emptyPsiElementArray() {`
`37`		`- return new PsiElement[0];`
	`37`	`+ return PsiElement.EMPTY_ARRAY;`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@Nullable`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public SignalSlotMethodReference(@NotNull StringLiteralExpression className, @No`
`80`	`80`	`results.add(new PsiElementResolveResult(psiElement));`
`81`	`81`	`}`
`82`	`82`
`83`		`- return results.toArray(new ResolveResult[0]);`
	`83`	`+ return results.toArray(ResolveResult.EMPTY_ARRAY);`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`@NotNull`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)`
`18`	`18`	`@Override`
`19`	`19`	`public PsiReference @NotNull [] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {`
`20`	`20`	`if (!(element instanceof StringLiteralExpression)) {`
`21`		`- return new PsiReference[0];`
	`21`	`+ return PsiReference.EMPTY_ARRAY;`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`StringLiteralExpression stringLiteralExpression = (StringLiteralExpression) element;`
`@@ -29,7 +29,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)`
`29`	`29`	`return new PsiReference[]{new ControllerActionReference(stringLiteralExpression)};`
`30`	`30`	`}`
`31`	`31`
`32`		`- return new PsiReference[0];`
	`32`	`+ return PsiReference.EMPTY_ARRAY;`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`	`);`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public static PsiElement[] getIconDefinitionElements(@NotNull Project project, @`
`74`	`74`	`.toArray(PsiElement[]::new);`
`75`	`75`	`}`
`76`	`76`
`77`		`- return new PsiElement[0];`
	`77`	`+ return PsiElement.EMPTY_ARRAY;`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`@NotNull`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public class RouteFoldingBuilder extends FoldingBuilderEx {`
`42`	`42`
`43`	`43`	`}`
`44`	`44`
`45`		`- return descriptors.toArray(new FoldingDescriptor[0]);`
	`45`	`+ return descriptors.toArray(FoldingDescriptor.EMPTY);`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`@Nullable`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public static PsiElement[] getRouteDefinitionElements(@NotNull Project project,`
`61`	`61`	`return true;`
`62`	`62`	`}, GlobalSearchScope.allScope(project));`
`63`	`63`
`64`		`- return results.toArray(new PsiElement[0]);`
	`64`	`+ return results.toArray(PsiElement.EMPTY_ARRAY);`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`@NotNull`
`@@ -81,7 +81,7 @@ private static PsiElement[] getTargetMethods(@NotNull Project project, @NotNull`
`81`	`81`	`});`
`82`	`82`	`}`
`83`	`83`
`84`		`- return result.toArray(new PsiElement[0]);`
	`84`	`+ return result.toArray(PsiElement.EMPTY_ARRAY);`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`@NotNull`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public String getPlaceholderText() {`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`
`52`		`- return descriptors.toArray(new FoldingDescriptor[0]);`
	`52`	`+ return descriptors.toArray(FoldingDescriptor.EMPTY);`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`@Nullable`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,6 @@ public static PsiElement[] getDefinitionElements(@NotNull Project project, @NotN`
`43`	`43`	`return true;`
`44`	`44`	`}, GlobalSearchScope.allScope(project));`
`45`	`45`
`46`		`- return elements.toArray(new PsiElement[0]);`
	`46`	`+ return elements.toArray(PsiElement.EMPTY_ARRAY);`
`47`	`47`	`}`
`48`	`48`	`}`