[T3CMS] Index ajax routes correctly

Author: cedricziel

typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/RouteIndex.java

@@ -20,6 +20,9 @@
 public class RouteIndex extends FileBasedIndexExtension<String, RouteStub> {
 
     public static final ID<String, RouteStub> KEY = ID.create("com.cedricziel.idea.typo3.index.route");
+    public static final String AJAX_ROUTES_PHP = "AjaxRoutes.php";
+    public static final String ROUTES_PHP = "Routes.php";
+    public static final String EXT_TABLES_PHP = "ext_tables.php";
 
     @NotNull
     public static boolean hasRoute(@NotNull Project project, @NotNull String routeName) {
@@ -75,13 +78,13 @@ public DataExternalizer<RouteStub> getValueExternalizer() {
 
     @Override
     public int getVersion() {
-        return 0;
+        return 1;
     }
 
     @NotNull
     @Override
     public FileBasedIndex.InputFilter getInputFilter() {
-        return file -> file.getName().equals("Routes.php") || file.getName().equals("AjaxRoutes.php") || file.getName().equals("ext_tables.php");
+        return file -> file.getName().equals(ROUTES_PHP) || file.getName().equals(AJAX_ROUTES_PHP) || file.getName().equals(EXT_TABLES_PHP);
     }
 
     @Override
@@ -107,12 +110,15 @@ public void visitElement(PsiElement element) {
             PhpExpression classRefExpr = methodReference.getClassReference();
             if (!(classRefExpr instanceof ClassReference)) {
                 super.visitElement(element);
+
                 return;
             }
 
             ClassReference classReference = (ClassReference) classRefExpr;
 
-            if (classReference.getFQN().equals("\\TYPO3\\CMS\\Core\\Utility\\ExtensionManagementUtility") && methodReference.getName().equals("addModule")) {
+            String fqn = classReference.getFQN();
+            String methodName = methodReference.getName();
+            if (fqn != null && fqn.equals("\\TYPO3\\CMS\\Core\\Utility\\ExtensionManagementUtility") && methodName != null && methodName.equals("addModule")) {
                 RouteStub e = extractRouteStubFromMethodCall(methodReference);
                 if (e != null) {
                     routeStubs.add(e);
@@ -135,7 +141,7 @@ private RouteStub extractRouteStubFromMethodCall(MethodReference methodReference
             ArrayCreationExpression routeArray = (ArrayCreationExpression) psiElement;
             for (ArrayHashElement arrayHashElement : routeArray.getHashElements()) {
                 PhpPsiElement key = arrayHashElement.getKey();
-                if (key == null || !(key instanceof StringLiteralExpression)) {
+                if (!(key instanceof StringLiteralExpression)) {
                     continue;
                 }
 

typo3-cms/src/main/java/com/cedricziel/idea/typo3/routing/RouteHelper.java

@@ -18,8 +18,13 @@
 public class RouteHelper {
     @NotNull
     public static Collection<RouteStub> routesFromRoutesPhp(@NotNull PsiFile psiFile) {
+        RouteParserVisitor visitor;
+        if (psiFile.getName().equals(RouteIndex.AJAX_ROUTES_PHP)) {
+            visitor = new RouteParserVisitor("ajax_");
+        } else {
+            visitor = new RouteParserVisitor();
+        }
 
-        RouteParserVisitor visitor = new RouteParserVisitor();
         visitor.visitElement(psiFile);
 
         return visitor.getRouteStubs();
@@ -56,7 +61,7 @@ public static PsiElement[] getRouteDefinitionElements(@NotNull Project project,
             return true;
         }, GlobalSearchScope.allScope(project));
 
-        return results.toArray(new PsiElement[results.size()]);
+        return results.toArray(new PsiElement[0]);
     }
 
     @NotNull
@@ -76,7 +81,7 @@ private static PsiElement[] getTargetMethods(@NotNull Project project, @NotNull
             });
         }
 
-        return result.toArray(new PsiElement[result.size()]);
+        return result.toArray(new PsiElement[0]);
     }
 
     @NotNull

typo3-cms/src/main/java/com/cedricziel/idea/typo3/routing/RouteParserVisitor.java

@@ -14,10 +14,17 @@
  */
 public class RouteParserVisitor extends PsiRecursiveElementVisitor {
 
+    private final String prefix;
     private Collection<RouteStub> routeStubs;
 
     public RouteParserVisitor() {
-        routeStubs = new ArrayList<>();
+        this.prefix = "";
+        this.routeStubs = new ArrayList<>();
+    }
+
+    public RouteParserVisitor(String prefix) {
+        this.prefix = prefix;
+        this.routeStubs = new ArrayList<>();
     }
 
     @NotNull
@@ -60,7 +67,7 @@ private void visitRouteCreation(ArrayHashElement element) {
             if (valueMap instanceof ArrayCreationExpression) {
                 ArrayCreationExpression propertyArray = (ArrayCreationExpression) valueMap;
 
-                routeDefinition.setName(key);
+                routeDefinition.setName(prefix + key);
 
                 for (ArrayHashElement routePropertyHashElement : propertyArray.getHashElements()) {
                     visitProperty(routeDefinition, routePropertyHashElement);

typo3-cms/src/test/java/com/cedricziel/idea/typo3/routing/RouteHelperTest.java

@@ -0,0 +1,30 @@
+package com.cedricziel.idea.typo3.routing;
+
+import com.cedricziel.idea.typo3.AbstractTestCase;
+import com.jetbrains.php.lang.PhpFileType;
+
+import java.util.List;
+
+public class RouteHelperTest extends AbstractTestCase {
+    @Override
+    protected String getTestDataPath() {
+        return "testData/com/cedricziel/idea/typo3/routing";
+    }
+
+    public void testCanCorrectlyIdentifyRoutesFromRoutesPhp() {
+        myFixture.copyFileToProject("AjaxRoutes.php");
+        myFixture.copyFileToProject("Routes.php");
+
+        myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+            "/** @var $uriBuilder \\TYPO3\\CMS\\Backend\\Routing\\UriBuilder */\n" +
+            "$uriBuilder->buildUriFromRoute('<caret>');"
+        );
+
+        myFixture.completeBasic();
+
+        List<String> lookupElementStrings = myFixture.getLookupElementStrings();
+        assertTrue(lookupElementStrings.contains("ajax_solr_updateConnections"));
+        assertTrue(lookupElementStrings.contains("ajax_solr_updateConnection"));
+        assertTrue(lookupElementStrings.contains("xMOD_tximpexp"));
+    }
+}

typo3-cms/testData/com/cedricziel/idea/typo3/routing/AjaxRoutes.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Definitions for routes provided by EXT:solr
+ */
+return [
+    'solr_updateConnections' => [
+        'path' => '/solr/updateConnections',
+        'target' => \ApacheSolrForTypo3\Solr\Controller\Backend\AjaxController::class . '::updateConnections',
+    ],
+    'solr_updateConnection' => [
+        'path' => '/solr/updateConnection',
+        'target' => \ApacheSolrForTypo3\Solr\Controller\Backend\AjaxController::class . '::updateConnection',
+    ],
+];

typo3-cms/testData/com/cedricziel/idea/typo3/routing/Routes.php

@@ -0,0 +1,12 @@
+<?php
+
+/**
+ * Definitions for routes provided by EXT:impexp
+ */
+return [
+    // Register click menu entry point
+    'xMOD_tximpexp' => [
+        'path' => '/record/importexport/',
+        'target' => \TYPO3\CMS\Impexp\Controller\ImportExportController::class . '::mainAction',
+    ],
+];