From cf6f24e8da9d5cf4b5bd431ff8c8d2742ac147d6 Mon Sep 17 00:00:00 2001
From: Sergey Svistunov <zenden2k@gmail.com>
Date: Fri, 26 Mar 2021 16:36:02 +0300
Subject: [PATCH] Allow find usages of controller xml file Resolve database
 table references in joins (in object xml files) Add comments to reference
 classes in Java code

---
 resources/META-INF/plugin.xml                  |  5 +++--
 .../XmlReferenceProvider.java                  |  2 +-
 .../reference/DataViewReference.java           |  7 ++++++-
 .../reference/DatasourceMethodReference.java   |  6 ++++++
 .../reference/DbFieldReference.java            | 11 +++++++++++
 .../reference/DbSchemaReference.java           |  7 +++++++
 .../reference/DbTableReference.java            |  7 +++++++
 .../reference/InterfaceMethodReference.java    |  7 +++++++
 .../reference/InterfaceReference.java          |  8 ++++++++
 .../reference/PhpGuideReference.java           |  6 ++++++
 .../reference/PhpObjectReference.java          |  7 +++++++
 .../reference/StaticDataSourceReference.java   |  7 +++++++
 .../reference/UserRightsAliasReference.java    |  6 ++++++
 .../reference/XmlControllerReference.java      | 18 ++++++++++++++++++
 .../reference/XmlFormReference.java            |  7 +++++++
 .../reference/XmlGuideReference.java           |  7 +++++++
 .../reference/XmlObjectReference.java          |  7 +++++++
 17 files changed, 121 insertions(+), 4 deletions(-)

diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
index b3463f7..edf8300 100644
--- a/resources/META-INF/plugin.xml
+++ b/resources/META-INF/plugin.xml
@@ -1,7 +1,7 @@
 <idea-plugin>
   <id>com.zenden2k.VfFrameworkIdeaPlugin</id>
   <name>Vf Framework IDEA Integration</name>
-  <version>1.6.0</version>
+  <version>1.6.1</version>
   <vendor email="zenden2k@gmail.com" url="http://zenden2k.com">Sergey Svistunov</vendor>
 
   <description><![CDATA[
@@ -9,7 +9,8 @@
     ]]></description>
 
     <change-notes><![CDATA[
-        - Resolve references and provide autocompletion of user rights aliases
+        - Allow find usages of controller xml file <br/>
+        - Resolve database table references in joins (in object xml files)
       ]]>
     </change-notes>
 
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/XmlReferenceProvider.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/XmlReferenceProvider.java
index 085adb3..8fe0f41 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/XmlReferenceProvider.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/XmlReferenceProvider.java
@@ -178,7 +178,7 @@ else if (name.equals("interface") && parentName.equals("button")) {
                                 range.getStartOffset() + match.getStartPos() + match.getLength()), project, null));
                     }
                     return referenceList.toArray(new PsiReference[0]);
-                } else if (enableDataBaseReferences && name.equals("table") && parentName.equals("object")) {
+                } else if (enableDataBaseReferences && ( name.equals("table") && (parentName.equals("object") || parentName.equals("join")))) {
                     // Reference to database table
                     // TODO: use DbTableNameInfo class
                     String[] tokens = attrValue.split("\\s+");
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DataViewReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DataViewReference.java
index 4a4f160..ac995eb 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DataViewReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DataViewReference.java
@@ -11,7 +11,12 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-
+/*
+ * Reference to smarty file from dataview table field
+ *
+ * Example:
+ * <field name="cpm" title="test" sorting="true" view="[REFERENCE]"/>
+ */
 public class DataViewReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String viewName;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DatasourceMethodReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DatasourceMethodReference.java
index 9ca8359..5518200 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DatasourceMethodReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DatasourceMethodReference.java
@@ -12,6 +12,12 @@
 
 import java.util.Collection;
 
+/*
+    Reference to an object's method.
+
+    Example:
+    <datasource.orm name="dsIpList" method="[REFERENCE]"/>
+ */
 public class DatasourceMethodReference extends PsiReferenceBase<PsiElement> {
     protected final PsiElement element;
     protected final Project project;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbFieldReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbFieldReference.java
index 9b974b7..3cbc8e0 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbFieldReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbFieldReference.java
@@ -13,6 +13,17 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/*
+ * Reference to database table field
+ *
+ * Example:
+ *
+ * <object name="user">
+ *     <fields>
+ *         <field name="[REFERENCE]" key="true" autoincrement="true"/>
+ *     </fields>
+ * </object>
+ */
 public class DbFieldReference extends PsiReferenceBase<PsiElement> {
     protected final PsiElement element;
     protected final TextRange textRange;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbSchemaReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbSchemaReference.java
index 424dfb2..9d83a08 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbSchemaReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbSchemaReference.java
@@ -8,6 +8,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/*
+ * Reference to database schema
+ *
+ * Example:
+ *
+ * <join type="left" table="[REFERENCE].table"/>
+ */
 public class DbSchemaReference  extends PsiReferenceBase<PsiElement> {
     protected final PsiElement element;
     protected final TextRange textRange;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbTableReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbTableReference.java
index b1fff22..ceb7e16 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbTableReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/DbTableReference.java
@@ -12,6 +12,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/*
+ * Reference to database table
+ *
+ * Example:
+ *
+ * <object name="user" table="[REFERENCE]">
+ */
 public class DbTableReference extends PsiReferenceBase<PsiElement> {
     protected final PsiElement element;
     protected final TextRange textRange;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceMethodReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceMethodReference.java
index 94c0805..32ca0c5 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceMethodReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceMethodReference.java
@@ -10,6 +10,13 @@
 
 import java.util.Collection;
 
+/*
+  Reference to object's method from an interface
+
+  Example:
+
+ <interface name="group" method="[REFERENCE]"/>
+ */
 public class InterfaceMethodReference extends PsiReferenceBase<PsiElement> {
     protected final PsiElement element;
     protected final Project project;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceReference.java
index 9afb726..3eff119 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/InterfaceReference.java
@@ -13,6 +13,14 @@
 
 import java.util.ArrayList;
 
+/*
+  Reference to an interface
+
+  Example:
+  <buttons>
+    <button interface="[REFERENCE]"/>
+  </buttons>
+ */
 public class InterfaceReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String path;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpGuideReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpGuideReference.java
index 4dc3cfb..17c7455 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpGuideReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpGuideReference.java
@@ -16,7 +16,13 @@
 
 import java.util.Locale;
 
+/*
+  Reference to xml (or php) guide file
 
+  Example:
+
+    GetObject("guide")->getAssociative("[REFERENCE]");
+ */
 public class PhpGuideReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String guideName;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpObjectReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpObjectReference.java
index fe35f81..432b2ca 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpObjectReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/PhpObjectReference.java
@@ -15,6 +15,13 @@
 
 import java.util.Collection;
 
+/*
+  Reference to an xml object file
+
+  Example:
+
+    GetObject("[REFERENCE]")
+ */
 public class PhpObjectReference extends PsiReferenceBase<PsiElement>  {
     protected final Project project;
     protected final String path;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/StaticDataSourceReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/StaticDataSourceReference.java
index 821ca0b..12fd3c2 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/StaticDataSourceReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/StaticDataSourceReference.java
@@ -17,6 +17,13 @@
 import java.util.ArrayList;
 import java.util.Collection;
 
+/*
+  Reference to an object's datasource from PHP file
+
+  Example:
+
+    GetObject("user")->getStaticDatasource("[REFERENCE]")
+ */
 public class StaticDataSourceReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String path;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/UserRightsAliasReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/UserRightsAliasReference.java
index eb3be07..2f7c49d 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/UserRightsAliasReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/UserRightsAliasReference.java
@@ -17,7 +17,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/*
+    Reference to user role alias from php and xml files
 
+    Example:
+
+    $user->checkAccess('[REFERENCE],[REFERENCE],...')
+ */
 public class UserRightsAliasReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String alias;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlControllerReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlControllerReference.java
index 201e421..bce5e25 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlControllerReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlControllerReference.java
@@ -11,6 +11,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/*
+    Reference to XML controller file from page xml file
+
+    Example:
+
+    <cms.controller module="user" controller="[REFERENCE]">
+ */
 public class XmlControllerReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String moduleName;
@@ -54,6 +61,17 @@ public PsiElement resolve() {
         return null;
     }
 
+    @Override
+    public boolean isReferenceTo(@NotNull PsiElement element) {
+        PsiElement res = resolve();
+        if (res == null ) {
+            return false;
+        }
+        // We need additional check to make possible finding usages of controller's xml file
+        return this.getElement().getManager().areElementsEquivalent(res, element)
+                || this.getElement().getManager().areElementsEquivalent(res.getContainingFile(), element);
+    }
+
     @Override
     @NotNull
     public String getCanonicalText() {
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlFormReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlFormReference.java
index f1e94ce..05b81c3 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlFormReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlFormReference.java
@@ -13,6 +13,13 @@
 
 import java.util.Locale;
 
+/*
+    Reference to form
+
+    Example:
+
+    <form.link module="stream" form="[REFERENCE]" success="reload">
+ */
 public class XmlFormReference extends PsiReferenceBase<PsiElement> {
     protected final PsiElement element;
     protected final TextRange textRange;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlGuideReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlGuideReference.java
index de8c5de..a2b7fb4 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlGuideReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlGuideReference.java
@@ -13,6 +13,13 @@
 
 import java.util.Locale;
 
+/*
+    Reference to xml (or php) guide file from xml file
+
+   <field name="name" export="true" guide="[REFERENCE]" sorting="true/>
+
+   TODO: merge with PhpGuideReference
+ */
 public class XmlGuideReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String guideName;
diff --git a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlObjectReference.java b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlObjectReference.java
index 79098b9..7d73a04 100644
--- a/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlObjectReference.java
+++ b/src/main/java/com/zenden2k/VfFrameworkIdeaPlugin/reference/XmlObjectReference.java
@@ -11,6 +11,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+/*
+    Reference to an xml object
+
+    Example:
+
+    <datasource.link type="object" object="[REFERENCE]" datasource="dsExample">
+ */
 public class XmlObjectReference extends PsiReferenceBase<PsiElement> {
     protected final Project project;
     protected final String objectName;