Merge pull request #4 from iTrace-Dev/develop

Create first release of iTrace-JetBrains

Author: Joshua2000B

.idea/vcs.xml

@@ -1,2 +1,37 @@
 # iTrace-JetBrains
-iTrace support of the JetBrains family of IDEs
+iTrace-JetBrains is a plugin for the [JetBrains](https://www.jetbrains.com/) family of IDEs. The plugin will establish a connection to the [iTrace Core](https://github.com/iTrace-Dev/iTrace-Core) desktop application. Once connected to the Core, the plugin will accept eye-tracking information from the Core and translate it to editor-specific data and output said data to an XML file.
+
+# Installation
+1. Download the latest version of the plugin. The file is named `iTrace-JetBrains-X.X.X.zip`.
+2. Open the desired JetBrains editor. iTrace-JetBrains was tested on IntelliJ IDEA, PyCharm, WebStorm, and RustRover - however, it should work on any of the various JetBrains IDEs.
+3. Open the Settings menu and navigate to "Plugins".
+4. Click on the gear icon next to "Installed". Then, select "Install Plugin from Disk...".
+5. Navigate to and select the .zip file you downloaded earlier.
+6. Accept any prompts you are given, and click "Apply" in the Settings menu.
+
+# Usage
+To use iTrace-JetBrains, make sure you have iTrace-Core installed.
+1. Open the project/files you wish to view.
+2. Run iTrace-Core and set up the parameters of your tracking session.
+3. Go to the "Tools" tab in your JetBrains editor.
+4. Select "Connect to iTrace-Core". If the connection is successful, a notification at the bottom of the screen should alert you.
+5. iTrace-JetBrains is now connected, you can control the tracking session using iTrace-Core.
+6. Once a tracking session is started, iTrace-JetBrains will begin writing to a file in the location specified in iTrace-Core. When the tracking session is finished, two files will be present - one from iTrace-JetBrains and the other from iTrace-Core. iTrace-JetBrains will recongize which JetBrains IDE you are using and automatically name the file appropriately.
+
+# How to Install From Source
+If you want to install or run the plugin from source, follow these steps:
+1. Download or clone the source code.
+2. Open IntelliJ IDEA.
+3. Select "Open" and select the folder containing iTrace-JetBrains
+You should now have the project open in IntelliJ. You have two options for building the plugin.
+## Running the Pluign
+If you want to run and debug the plugin, go to the top and select the "Current File" dropdown. Select "Run Plugin" and then click the green play button. This will launch a new instance of IntelliJ with the plugin running, and you can debug it.
+## Building the Plugin for Distribution
+To build the plugin for distribution and installation, follow these steps:
+1. Open the project in IntelliJ.
+2. Select View->Tool Windows->Terminal.
+3. Run `.\gradlew buildPlugin` in the opened terminal.
+4. After running, the built plugin will be in the `build\distributions`.
+
+# Further Steps
+After gathering your data, you can use our other tools [iTrace-Toolkit](https://github.com/iTrace-Dev/iTrace-Toolkit) and [iTrace-Visualize](https://github.com/iTrace-Dev/iTrace-Visualize) to analyze and process the tracking sessions.

LICENSE.md

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "org.itrace"
-version = "1.0-SNAPSHOT"
+version = "0.2.0"
 
 repositories {
     mavenCentral()

README.md

@@ -3,9 +3,15 @@
 import java.awt.*;
 import java.io.*;
 import java.net.Socket;
+import java.util.Locale;
 import java.util.concurrent.atomic.AtomicReference;
 
+import com.intellij.notification.NotificationType;
+import com.intellij.notification.Notification;
+import com.intellij.notification.Notifications;
+import com.intellij.openapi.application.ApplicationInfo;
 import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.editor.Document;
 import com.intellij.openapi.editor.LogicalPosition;
 import com.intellij.openapi.fileEditor.FileEditorManager;
 import com.intellij.openapi.progress.ProgressIndicator;
@@ -15,6 +21,8 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+
+
 public class ConnectionSingleton {
     private static ConnectionSingleton instance;
     private Socket socket;
@@ -29,7 +37,9 @@ public static ConnectionSingleton getInstance() {
         return instance;
     }
 
-    private ConnectionSingleton() {
+    private ConnectionSingleton() { }
+
+    public void ProcessCoreData(@Nullable Project project, @NotNull ProgressIndicator indicator) {
         try {
             socket = new Socket(hostName,port);
             in = new BufferedReader(new InputStreamReader(socket.getInputStream()));
@@ -38,9 +48,7 @@ private ConnectionSingleton() {
             System.err.println("Connection Error - iTrace-Core might not be running");
             throw new RuntimeException(e);
         }
-    }
 
-    public void ProcessCoreData(@Nullable Project project, @NotNull ProgressIndicator indicator) {
         while(socket != null && !socket.isClosed()) {
             String data = null;
             try {
@@ -53,13 +61,15 @@ public void ProcessCoreData(@Nullable Project project, @NotNull ProgressIndicato
 
             if(tokens[0].equals("session_start")) {
                 indicator.setText("Session starting");
+                String ide = ApplicationInfo.getInstance().getFullApplicationName().split(" ")[0];
                 try {
-                    xmlFile = new BufferedWriter(new FileWriter(tokens[3]+String.format("\\itrace_jetbrains-%s.xml",System.currentTimeMillis()), true));
+                    xmlFile = new BufferedWriter(new FileWriter(tokens[3]+String.format("\\itrace_%s-%d.xml",ide.toLowerCase(),System.currentTimeMillis()), true));
                     xmlFile.write("<?xml version=\"1.0\"?>\n");
                     xmlFile.write("<itrace_plugin session_id=\"" + tokens[1] + "\">\n");
-                    xmlFile.write(String.format("    <environment screen_width=\"%d\" screen_height=\"%d\" plugin_type=\"JETBRAINS\"/>\n",
+                    xmlFile.write(String.format("    <environment screen_width=\"%d\" screen_height=\"%d\" plugin_type=\"%s\"/>\n",
                             Toolkit.getDefaultToolkit().getScreenSize().width,
-                            Toolkit.getDefaultToolkit().getScreenSize().height));
+                            Toolkit.getDefaultToolkit().getScreenSize().height,
+                            ide.toUpperCase()));
                     xmlFile.write("    <gazes>\n");
                 }
                 catch (IOException e) {
@@ -78,33 +88,59 @@ else if(tokens[0].equals("session_end")) {
                     throw new RuntimeException(e);
                 }
                 indicator.setText("Session ended.");
+                System.out.println("Session ended");
             }
 
             else if(tokens[0].equals("gaze")) {
                 try {
                     int x = Integer.parseInt(tokens[2]);
                     int y = Integer.parseInt(tokens[3]);
                     Editor editor = FileEditorManager.getInstance(project).getSelectedTextEditor();
+                    if(editor == null) {
+                        continue;
+                    }
                     int line_height = -1;//editor.getComponent().getFontMetrics(editor.getColorsScheme().getFontPreferences().getFontType()).getHeight();
                     float font_size = editor.getColorsScheme().getEditorFontSize2D();
                     String filename = FileEditorManager.getInstance(project).getSelectedFiles()[0].getPath();
                     int editor_x = editor.getContentComponent().getLocationOnScreen().x;
                     int editor_y = editor.getContentComponent().getLocationOnScreen().y;
-                    Point gaze_point = new Point(x-editor_x,y-editor_y);
-                    //LogicalPosition logicalPosition = editor.xyToLogicalPosition(gaze_point);
 
-                    AtomicReference<LogicalPosition> logicalPositionRef = new AtomicReference<>();
+                    int line;
+                    int column;
+
+                    if(x - editor_x < 0 || y - editor_y < 0) {
+                        line = -1;
+                        column = -1;
+                    }
+                    else {
+
+                        Point gaze_point = new Point(x - editor_x, y - editor_y);
 
-                    ApplicationManager.getApplication().invokeAndWait(() -> {
-                        // Safely access xyToLogicalPosition on the EDT
-                        logicalPositionRef.set(editor.xyToLogicalPosition(gaze_point));
-                    });
+                        AtomicReference<LogicalPosition> logicalPositionRef = new AtomicReference<>();
 
-                    LogicalPosition logicalPosition = logicalPositionRef.get();
+                        ApplicationManager.getApplication().invokeAndWait(() -> {
+                            // Safely access xyToLogicalPosition on the EDT
+                            logicalPositionRef.set(editor.xyToLogicalPosition(gaze_point));
+                        });
 
-                    indicator.setText(tokens[2]+","+tokens[3]+" -> " + String.valueOf(logicalPosition.line+1) +","+String.valueOf(logicalPosition.column+1));
+                        LogicalPosition logicalPosition = logicalPositionRef.get();
 
+                        line = logicalPosition.line + 1;
+                        column = logicalPosition.column + 1;
 
+                        Document doc = editor.getDocument();
+                        String[] text_lines = doc.getText().split("\n");
+                        if (logicalPosition.line >= text_lines.length) {
+                            line = -1;
+                            column = -1;
+                        } else if (logicalPosition.column >= text_lines[logicalPosition.line].length()) {
+                            line = -1;
+                            column = -1;
+                        }
+                    }
+
+                    indicator.setText(tokens[2]+","+tokens[3]+" -> " + String.valueOf(line) +","+String.valueOf(column));
+//                    indicator.setText(String.valueOf(editor_x)+","+String.valueOf(editor_y)+" -> " + String.valueOf(line) +","+String.valueOf(column));
                     xmlFile.write(String.format("        <response event_id=\"%s\" plugin_time=\"%d\" x=\"%d\" y=\"%d\" gaze_target=\"%s\" gaze_target_type=\"%s\" source_file_path=\"%s\" source_file_line=\"%d\" source_file_col=\"%d\" editor_line_height=\"%s\" editor_font_height=\"%f\" editor_line_base_x=\"\" editor_line_base_y=\"\"/>\n",
                                   tokens[1], // event ID
                                   System.currentTimeMillis(), //Plugin Time
@@ -113,8 +149,8 @@ else if(tokens[0].equals("gaze")) {
                                   filename.split("/")[filename.split("/").length-1], // Gaze Target
                                   filename.split("\\.")[filename.split("\\.").length-1], // Gaze Target Type
                                   filename, // Source File Path
-                                  logicalPosition.line+1, // Source File Line
-                                  logicalPosition.column+1, // Source File Column
+                                  line, // Source File Line
+                                  column, // Source File Column
                                   line_height, // Line Height
                                   font_size // Editor Font Height
                             ));
@@ -133,6 +169,7 @@ private void CloseConnection() {
         }
         catch (IOException e) {
             System.err.println("Error closing connection: " + e.getMessage());
+            throw new RuntimeException(e);
         }
         finally {
             socket = null;

build.gradle.kts

@@ -9,7 +9,7 @@ public class ConnectionTask extends Task.Backgroundable {
     private Project project;
 
     public ConnectionTask(@NotNull Project project) {
-        super(project, "Connecting to iTrace Core", true); // "true" means the task can be canceled
+        super(project, "Connecting to iTrace Core", false); // "true" means the task can be canceled
         this.project = project;
     }