cell status bar implementation

Hofstetter Benjamin (extern) · Hofstetter Benjamin (extern) · commit 0b0d87beb11c · 2023-09-22T09:15:26.000+02:00
diff --git a/src/extension/commands/export/export-to-markdown.ts b/src/extension/commands/export/export-to-markdown.ts
@@ -2,7 +2,7 @@ import { promises as fs } from "fs";
 import * as vscode from "vscode";
 import { TextEncoder } from "util";
 
-import { SparqlNotebookSerializer } from "../../file-io";
+import { SparqlNotebookSerializer } from "../../notebook/file-io";
 
 async function loadNotebook(uri: vscode.Uri) {
     const data = await fs.readFile(uri.fsPath);
diff --git a/src/extension/endpoint/endpoint.ts b/src/extension/endpoint/endpoint.ts
@@ -1,5 +1,6 @@
 
 export abstract class Endpoint {
+    public abstract url: string;
     abstract query(sparqlQuery: string, execution?: any): Promise<any>;
 }
 
diff --git a/src/extension/endpoint/file-endpoint/file-endpoint.ts b/src/extension/endpoint/file-endpoint/file-endpoint.ts
@@ -9,6 +9,7 @@ import { RdfMimeType, SparqlStore } from '../../sparql-store/sparql-store';
  * Represents an HTTP SPARQL endpoint.
  */
 export class FileEndpoint extends Endpoint {
+    private _url: string = '';
     private files: Set<Uri> = new Set<Uri>();
     private _store: SparqlStore;
     /**
@@ -22,7 +23,12 @@ export class FileEndpoint extends Endpoint {
         this._store = new SparqlStore();
     }
 
+    get url(): string {
+        return this._url;
+    }
+
     public async addFile(rdfFile: Uri) {
+        this._url = rdfFile.path;
         if (!rdfFile) {
             // show window error message
             window.showErrorMessage('No file selected');
diff --git a/src/extension/endpoint/http-endpoint/http-endpoint.ts b/src/extension/endpoint/http-endpoint/http-endpoint.ts
@@ -8,6 +8,7 @@ import { Endpoint } from '../endpoint';
  */
 export class HttpEndpoint extends Endpoint {
   private http: AxiosInstance;
+  private _url: string;
 
   /**
    * Creates a new instance of the HttpEndpoint class.
@@ -17,6 +18,7 @@ export class HttpEndpoint extends Endpoint {
    */
   constructor(endpointUrl: string, user: string, password: string) {
     super();
+    this._url = endpointUrl;
     this.http = axios.create({
       baseURL: endpointUrl,
       auth: {
@@ -26,6 +28,10 @@ export class HttpEndpoint extends Endpoint {
     });
   }
 
+  get url(): string {
+    return this._url;
+  }
+
   /**
    * Executes a SPARQL query against the endpoint.
    * @param sparqlQuery - The SPARQL query to execute.
diff --git a/src/extension/extension.ts b/src/extension/extension.ts
@@ -1,9 +1,9 @@
 import * as vscode from "vscode";
 
-import { SparqlNotebookController } from "./sparql-notebook-controller";
+import { SparqlNotebookController } from "./notebook/sparql-notebook-controller";
 import { EndpointConnections } from "./sparql-connection-menu";
 
-import { SparqlNotebookSerializer } from "./file-io";
+import { SparqlNotebookSerializer } from "./notebook/file-io";
 
 import { deleteConnection } from "./commands/sparql-connection/delete-connection";
 import { addConnection } from "./commands/sparql-connection/add-connection";
@@ -15,6 +15,7 @@ import { addQueryFromFile } from "./commands/code-cell/add-query-from-file";
 import { activateFormProvider } from "./connection-view/connection-view";
 import { createStoreFromFile } from "./commands/store-from-file/store-from-file";
 import path = require("path");
+import { SparqlNotebookCellStatusBarItemProvider } from './notebook/SparqlNotebookCellStatusBarItemProvider';
 
 export const extensionId = "sparql-notebook";
 export const storageKey = `${extensionId}-connections`;
@@ -163,8 +164,10 @@ export function activate(context: vscode.ExtensionContext) {
       }
     });
   }));
+
+  context.subscriptions.push(vscode.notebooks.registerNotebookCellStatusBarItemProvider(extensionId, new SparqlNotebookCellStatusBarItemProvider()));
+
 };
 
 // this method is called when your extension is deactivated
 export function deactivate() { }
-
diff --git a/src/extension/notebook/SparqlNotebookCellStatusBarItemProvider.ts b/src/extension/notebook/SparqlNotebookCellStatusBarItemProvider.ts
@@ -0,0 +1,27 @@
+import {
+    NotebookCellStatusBarItemProvider,
+    EventEmitter,
+    NotebookCell,
+    CancellationToken,
+    NotebookCellStatusBarItem,
+    NotebookCellStatusBarAlignment
+} from 'vscode';
+import { CellContentStatusBarItem, ConnectionSourceStatusBarItem } from './sparql-notebook-cell-status-bar-item-provider';
+import { SparqlNotebookCell } from './sparql-notebook-cell';
+
+
+export class SparqlNotebookCellStatusBarItemProvider implements NotebookCellStatusBarItemProvider {
+    private _onDidChangeCellStatusBarItems = new EventEmitter<void>();
+    readonly onDidChangeCellStatusBarItems = this._onDidChangeCellStatusBarItems.event;
+
+    provideCellStatusBarItems(cell: NotebookCell, token: CancellationToken): NotebookCellStatusBarItem[] {
+        const sparqlCell = new SparqlNotebookCell(cell);
+
+
+        const statusBarItems: NotebookCellStatusBarItem[] = [];
+
+        statusBarItems.push(new ConnectionSourceStatusBarItem(sparqlCell, NotebookCellStatusBarAlignment.Right));
+        statusBarItems.push(new CellContentStatusBarItem(sparqlCell, NotebookCellStatusBarAlignment.Right));
+        return statusBarItems;
+    }
+}
diff --git a/src/extension/notebook/file-io/index.ts b/src/extension/notebook/file-io/index.ts
diff --git a/src/extension/notebook/file-io/raw-notebook-cell.model.ts b/src/extension/notebook/file-io/raw-notebook-cell.model.ts
diff --git a/src/extension/notebook/file-io/sparql-notebook-cell.class.ts b/src/extension/notebook/file-io/sparql-notebook-cell.class.ts
diff --git a/src/extension/notebook/file-io/sparql-notebook-serializer.class.ts b/src/extension/notebook/file-io/sparql-notebook-serializer.class.ts
diff --git a/src/extension/notebook/sparql-notebook-cell-status-bar-item-provider.ts b/src/extension/notebook/sparql-notebook-cell-status-bar-item-provider.ts
@@ -0,0 +1,51 @@
+import {
+    NotebookCellStatusBarItem,
+    NotebookCellStatusBarAlignment
+} from 'vscode';
+import { SparqlNotebookCell } from './sparql-notebook-cell';
+import { notebookEndpoint } from '../endpoint/endpoint';
+
+// we have 3 possible notebook cell status bar items
+// 1. the connection source - it could be be connected to a "global" notebook connection from the cell
+// 2. then we have the text of the cell can come from a file or it's from the cell itself
+// 3. i don't remember that one
+
+// create an enum for ConnectionSource
+
+export enum ConnectionSource {
+    notebook = "Notebook",
+    file = "File",
+    cell = "Cell",
+    none = "None"
+}
+
+export class ConnectionSourceStatusBarItem extends NotebookCellStatusBarItem {
+    private readonly icon = ' $(database)';
+    private itemText = 'Notebook Connection';
+    constructor(cell: SparqlNotebookCell, alignment: NotebookCellStatusBarAlignment) {
+        super('', alignment);
+        let commentEndpoint = cell.extractDocumentEndpoint();
+        if (commentEndpoint) {
+            this.itemText = `Query Comment`;
+        }
+        this.text = `${this.icon} ${this.itemText}`;
+        this.tooltip = `Endpoint: ${commentEndpoint ?? notebookEndpoint.getEndpoint()?.url ?? "None"}`;
+    }
+}
+
+
+
+export class CellContentStatusBarItem extends NotebookCellStatusBarItem {
+    private readonly icon = ' $(code)';
+    private itemText = 'Cell';
+
+    constructor(cell: SparqlNotebookCell, alignment: NotebookCellStatusBarAlignment) {
+        super('', alignment);
+
+        if (cell.metadata.file) {
+            this.itemText = 'File';
+        }
+        this.text = `${this.icon} ${this.itemText}`;
+        this.tooltip = `Cell text source: ${cell.metadata.file ?? "Cell"}`;
+    }
+}
diff --git a/src/extension/notebook/sparql-notebook-cell.ts b/src/extension/notebook/sparql-notebook-cell.ts
@@ -0,0 +1,100 @@
+import { NotebookCell, NotebookCellExecutionSummary, NotebookCellKind, NotebookCellOutput, NotebookDocument, TextDocument, Uri, workspace } from "vscode";
+import { SPARQLQueryKind, getSPARQLQueryKind } from "../endpoint/sparql-utils";
+import { PrefixMap } from "../model/prefix-map";
+
+
+export class SparqlNotebookCell implements NotebookCell {
+    private notebookCell: NotebookCell;
+
+    constructor(notebookCell: NotebookCell) {
+        this.notebookCell = notebookCell;
+    }
+
+    /**
+     * This extracts the endpoint from the cell content. It's looking for a comment like this:
+     * `# [endpoint=http://test.lindas.admin.ch/query]`and extracts the endpoint from it.
+     * @returns the endpoint string or null
+     */
+    extractDocumentEndpoint(): string | null {
+        const sparqlQuery = this.notebookCell.document.getText();
+        const commentLines = sparqlQuery
+            .split("\n")
+            .map((l) => l.trim())
+            .filter((l) => l.startsWith("#"));
+        const endpointExp = /\[endpoint=(.*)\]/gm;
+        const endpoints: string[] = [];
+        commentLines.every((comment: string) => {
+            const match = endpointExp.exec(comment);
+            if (match) {
+                endpoints.push(match[1]);
+                return false;
+            }
+            return true;
+        });
+        return endpoints.shift() ?? null;
+    }
+
+    /**
+     * This extracts the kind of SPARQL query from the cell content.
+     * @returns the SPARQL query kind
+     * @see SPARQLQueryKind
+     */
+    queryKind(): SPARQLQueryKind {
+        return getSPARQLQueryKind(this.notebookCell.document.getText());
+    }
+
+    getPrefixMap(): PrefixMap {
+        const configuration = workspace.getConfiguration("sparqlbook");
+        const useNamespaces = configuration.get("useNamespaces");
+        if (!useNamespaces) {
+            return {};
+        }
+
+        // get namespaces from prefixes in query
+        let namespaces: PrefixMap = {};
+        let prefixRegex = /[Pp][Rr][Ee][Ff][Ii][Xx] ([^:]*):[ ]*<([^>]*)>/g;
+
+        const sparqlQuery = this.notebookCell.document.getText()
+            .split("\n")
+            .map((l) => l.trim())
+            .filter((l) => !l.startsWith("#")).join("\n");
+
+
+        // get namespaces from prefixes in query
+        let match;
+        while ((match = prefixRegex.exec(sparqlQuery)) !== null) {
+            namespaces[match[1]] = match[2];
+        }
+        return namespaces;
+    }
+
+    // NotebookCell implementation
+    get document(): TextDocument {
+        return this.notebookCell.document;
+    }
+
+    get executionSummary(): NotebookCellExecutionSummary | undefined {
+        return this.notebookCell.executionSummary;
+    }
+
+    get index(): number {
+        return this.notebookCell.index;
+    }
+
+    get kind(): NotebookCellKind {
+        return this.notebookCell.kind;
+    }
+
+    get metadata(): { readonly [key: string]: any } {
+        return this.notebookCell.metadata;
+    }
+
+    get notebook(): NotebookDocument {
+        return this.notebookCell.notebook;
+    }
+
+    get outputs(): readonly NotebookCellOutput[] {
+        return this.notebookCell.outputs;
+    }
+    // end of NotebookCell implementation
+}
diff --git a/src/extension/notebook/sparql-notebook-controller.ts b/src/extension/notebook/sparql-notebook-controller.ts
@@ -1,8 +1,8 @@
 import { NotebookCell, NotebookCellOutput, NotebookCellOutputItem, NotebookController, NotebookDocument, notebooks, window, workspace } from 'vscode';
-import { extensionId } from "./extension";
-import { Endpoint, HttpEndpoint } from "./endpoint";
-import { PrefixMap } from './model/prefix-map';
-import { notebookEndpoint } from './endpoint/endpoint';
+import { extensionId } from "../extension";
+import { Endpoint, HttpEndpoint } from "../endpoint";
+import { PrefixMap } from '../model/prefix-map';
+import { notebookEndpoint } from '../endpoint/endpoint';
 
 export class SparqlNotebookController {
   readonly controllerId = `${extensionId}-controller-id`;

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`
`2`	`2`	`export abstract class Endpoint {`
	`3`	`+ public abstract url: string;`
`3`	`4`	`abstract query(sparqlQuery: string, execution?: any): Promise<any>;`
`4`	`5`	`}`
`5`	`6`