Merge pull request #252 from codefori/cleanup/filter_params

Cleanup/filter_params
codefori · Aug 2, 2024 · 66c15ff · 66c15ff
2 parents a99abb0 + 4faa35d
commit 66c15ff
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 23 deletions.
diff --git a/src/database/schemas.ts b/src/database/schemas.ts
@@ -16,22 +16,33 @@ export const AllSQLTypes: SQLType[] = ["tables", "views", "aliases", "constraint
 
 export const SQL_ESCAPE_CHAR = `\\`;
 
-function getFilterClause(againstColumn: string, filter: string|undefined, noAnd?: boolean): string {
+type BasicColumnType = string|number;
+interface PartStatementInfo {clause: string, parameters: BasicColumnType[]};
+
+function getFilterClause(againstColumn: string, filter: string, noAnd?: boolean): PartStatementInfo {
   if (!filter) {
-    return ``;
+    return {clause: ``, parameters: []};
   }
 
-  let clause = `${noAnd ? '' : 'AND '} UPPER(${againstColumn})`;
+  let clause = `${noAnd ? '' : 'AND'} UPPER(${againstColumn})`;
+  let parameters: BasicColumnType[] = [];
 
   if (filter.endsWith(`*`)) {
-    clause += ` LIKE '${filter.slice(0, -1).toUpperCase()}%'`;
+    clause += ` LIKE ? CONCAT '%'`;
+    parameters.push(filter.slice(0, -1).toUpperCase());
   } else {
-    clause += ` LIKE '%${filter.toUpperCase()}%'`;
+    clause += ` LIKE '%' CONCAT ? CONCAT '%'`;
+    parameters.push(filter.toUpperCase());
   }
 
-  clause += ` ESCAPE '${SQL_ESCAPE_CHAR}'`;
+  if (filter.indexOf('\\') >= 0) {
+    clause += ` ESCAPE '\\'`;
+  }
 
-  return clause;
+  return {
+    clause,
+    parameters
+  };
 }
 
 export default class Schemas {
@@ -40,6 +51,8 @@ export default class Schemas {
    */
   static async getObjects(schema: string, types: SQLType[], details: PageData = {}): Promise<BasicSQLObject[]> {
     const selects: string[] = [];
+    let parameters: (string|number)[] = [];
+    let filter: PartStatementInfo;
 
     // If there are multiple types, we build a union. It's important that the ordering of the columns in the selects are consistant:
     // OBJ_TYPE, NAME, TEXT, SYS_NAME, SYS_SCHEMA, SPECNAME, BASE_SCHEMA, BASE_OBJ
@@ -50,101 +63,135 @@ export default class Schemas {
           selects.push([
             `select '${type}' as OBJ_TYPE, SCHEMA_NAME as NAME, SCHEMA_TEXT as TEXT, SYSTEM_SCHEMA_NAME as SYS_NAME, '' as SYS_SCHEMA, '' as SPECNAME, '' as BASE_SCHEMA, '' as BASE_OBJ`,
             `from QSYS2.SYSSCHEMAS`,
-            details.filter ? `where UPPER(SCHEMA_NAME) = '${details.filter}' or UPPER(SYSTEM_SCHEMA_NAME) = '${details.filter}'` : ``,
+            details.filter ? `where UPPER(SCHEMA_NAME) = ? or UPPER(SYSTEM_SCHEMA_NAME) = ?` : ``,
           ].join(` `));
+
+          parameters.push(details.filter, details.filter);
           break;
 
         case `tables`:
         case `views`:
         case `aliases`:
+          filter = getFilterClause(`TABLE_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, TABLE_NAME as NAME, TABLE_TEXT as TEXT, SYSTEM_TABLE_NAME as SYS_NAME, SYSTEM_TABLE_SCHEMA as SYS_SCHEMA, '' as SPECNAME, BASE_TABLE_SCHEMA as BASE_SCHEMA, BASE_TABLE_NAME as BASE_OBJ`,
             `from QSYS2.SYSTABLES`,
-            `where TABLE_SCHEMA = '${schema}' and TABLE_TYPE in (${typeMap[type].map(item => `'${item}'`).join(`, `)}) ${getFilterClause(`TABLE_NAME`, details.filter)}`,
+            `where TABLE_SCHEMA = ? and TABLE_TYPE in (${typeMap[type].map(item => `'${item}'`).join(`, `)}) ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `constraints`:
+          filter = getFilterClause(`CONSTRAINT_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, CONSTRAINT_NAME as NAME, CONSTRAINT_TEXT as TEXT, SYSTEM_TABLE_NAME as SYS_NAME, SYSTEM_TABLE_SCHEMA as SYS_SCHEMA, '' as SPECNAME, TABLE_SCHEMA as BASE_SCHEMA, TABLE_NAME as BASE_OBJ`,
             `from QSYS2.SYSCST`,
-            `where CONSTRAINT_SCHEMA = '${schema}' ${getFilterClause(`CONSTRAINT_NAME`, details.filter)}`,
+            `where CONSTRAINT_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `functions`:
+          filter = getFilterClause(`ROUTINE_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, ROUTINE_NAME as NAME, coalesce(ROUTINE_TEXT, LONG_COMMENT) as TEXT, '' as SYS_NAME, '' as SYS_SCHEMA, SPECIFIC_NAME as SPECNAME, '' as BASE_SCHEMA, '' as BASE_OBJ`,
             `from QSYS2.SYSFUNCS`,
-            `where ROUTINE_SCHEMA = '${schema}' ${getFilterClause(`ROUTINE_NAME`, details.filter)} and FUNCTION_ORIGIN in ('E','U')`,
+            `where ROUTINE_SCHEMA = ? ${filter.clause} and FUNCTION_ORIGIN in ('E','U')`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `variables`:
+          filter = getFilterClause(`VARIABLE_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, VARIABLE_NAME as NAME, VARIABLE_TEXT as TEXT, SYSTEM_VAR_NAME as SYS_NAME, SYSTEM_VAR_SCHEMA as SYS_SCHEMA, '' as SPECNAME, '' as BASE_SCHEMA, '' as BASE_OBJ`,
             `from QSYS2.SYSVARIABLES`,
-            `where VARIABLE_SCHEMA = '${schema}' ${getFilterClause(`VARIABLE_NAME`, details.filter)}`,
+            `where VARIABLE_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `indexes`:
+          filter = getFilterClause(`INDEX_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, INDEX_NAME as NAME, INDEX_TEXT as TEXT, SYSTEM_INDEX_NAME as SYS_NAME, SYSTEM_INDEX_SCHEMA as SYS_SCHEMA, '' as SPECNAME, TABLE_SCHEMA as BASE_SCHEMA, TABLE_NAME as BASE_OBJ`,
             `from QSYS2.SYSINDEXES`,
-            `where INDEX_SCHEMA = '${schema}' ${getFilterClause(`INDEX_NAME`, details.filter)}`,
+            `where INDEX_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `procedures`:
+          filter = getFilterClause(`ROUTINE_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, ROUTINE_NAME as NAME, ROUTINE_TEXT as TEXT, '' as SYS_NAME, '' as SYS_SCHEMA, SPECIFIC_NAME as SPECNAME, '' as BASE_SCHEMA, '' as BASE_OBJ`,
             `from QSYS2.SYSPROCS`,
-            `where ROUTINE_SCHEMA = '${schema}' ${getFilterClause(`ROUTINE_NAME`, details.filter)}`,
+            `where ROUTINE_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `sequences`:
+          filter = getFilterClause(`SEQUENCE_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, SEQUENCE_NAME as NAME, SEQUENCE_TEXT as TEXT, SYSTEM_SEQ_NAME as SYS_NAME, SYSTEM_SEQ_SCHEMA as SYS_SCHEMA, '' as SPECNAME, '' as BASE_SCHEMA, '' as BASE_OBJ`,
             `from QSYS2.SYSSEQUENCES`,
-            `where SEQUENCE_SCHEMA = '${schema}' ${getFilterClause(`SEQUENCE_NAME`, details.filter)}`,
+            `where SEQUENCE_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         // case `packages`:
         //   selects.push([
         //     `select '${type}' as OBJ_TYPE, PACKAGE_NAME as NAME, PACKAGE_TEXT as TEXT, PROGRAM_SCHEMA as BASE_SCHEMA, PROGRAM_NAME as BASE_OBJ, `,
         //     `  '' as SYS_SCHEMA, '' as SYS_NAME, '' as SPECNAME`,
         //     `from QSYS2.SQLPACKAGE`,
-        //     `where PACKAGE_SCHEMA = '${schema}' ${details.filter ? `and PACKAGE_NAME like '%${details.filter}%'`: ``}`,
+        //     `where PACKAGE_SCHEMA = '${schema}' ${details.filter ? `and PACKAGE_NAME like '%${filter.clause}%'`: ``}`,
         //   ].join(` `));
         //   break;
 
         case `triggers`:
+          filter = getFilterClause(`TRIGGER_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, TRIGGER_NAME as NAME, TRIGGER_TEXT as TEXT, '' as SYS_NAME, '' as SYS_SCHEMA, '' as SPECNAME, EVENT_OBJECT_SCHEMA as BASE_SCHEMA, EVENT_OBJECT_TABLE as BASE_OBJ`,
             `from QSYS2.SYSTRIGGERS`,
-            `where TRIGGER_SCHEMA = '${schema}' ${getFilterClause(`TRIGGER_NAME`, details.filter)}`,
+            `where TRIGGER_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
 
         case `types`:
+          filter = getFilterClause(`USER_DEFINED_TYPE_NAME`, details.filter);
           selects.push([
             `select '${type}' as OBJ_TYPE, USER_DEFINED_TYPE_NAME as NAME, TYPE_TEXT as TEXT, SYSTEM_TYPE_NAME as SYS_NAME, SYSTEM_TYPE_SCHEMA as SYS_SCHEMA, '' as SPECNAME, '' as BASE_SCHEMA, '' as BASE_OBJ`,
             `from QSYS2.SYSTYPES`,
-            `where USER_DEFINED_TYPE_SCHEMA = '${schema}' ${getFilterClause(`USER_DEFINED_TYPE_NAME`, details.filter)}`,
+            `where USER_DEFINED_TYPE_SCHEMA = ? ${filter.clause}`,
           ].join(` `));
+
+          parameters.push(schema, ...filter.parameters);
           break;
       }
     }
 
     const query = `with results as (${selects.join(" UNION ALL ")}) select * from results Order by QSYS2.DELIMIT_NAME(NAME) asc`;
 
-    const objects: any[] = await JobManager.runSQL([
+    const objects: any[] = await JobManager.runSQL(
+      [
       query,
       `${details.limit ? `limit ${details.limit}` : ``} ${details.offset ? `offset ${details.offset}` : ``}`
-    ].join(` `));
+      ].join(` `),
+      {
+        parameters
+      }
+    );
 
     return objects.map(object => ({
       type: object.OBJ_TYPE,

diff --git a/src/extension.ts b/src/extension.ts
@@ -1,7 +1,7 @@
 // The module 'vscode' contains the VS Code extensibility API
 // Import the module and reference it with the alias vscode in your code below
 import vscode from "vscode"
-import schemaBrowser from "./views/schemaBrowser/schemaBrowser";
+import schemaBrowser from "./views/schemaBrowser";
 
 import * as JSONServices from "./language/json";
 import * as resultsProvider from "./views/results";

diff --git a/src/views/schemaBrowser/schemaBrowser.ts → src/views/schemaBrowser/index.ts b/src/views/schemaBrowser/schemaBrowser.ts → src/views/schemaBrowser/index.ts
@@ -360,8 +360,8 @@ export default class schemaBrowser {
           const value = await vscode.window.showInputBox({
             title: `Set filter for ${node.schema}`,
             value: this.filters[node.schema],
-            placeHolder: `COOL_IEW, COOL*, COOL\\_, etc`,
-            prompt: `Show objects that contain this value (case-insensitive). Blank to reset. When using '_', escape it with '${SQL_ESCAPE_CHAR}'. Use '*' for wildcard at end.`,
+            placeHolder: `COOL, COOL*`,
+            prompt: `Show objects that contain this value (case-insensitive). Blank to reset. Use '*' for wildcard at end.`,
           });
 
           if (value !== undefined) {