-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathextension.ts
More file actions
352 lines (307 loc) · 15.8 KB
/
extension.ts
File metadata and controls
352 lines (307 loc) · 15.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
import * as vscode from 'vscode';
import { GitHubService } from './services/githubService';
import { CodeQLService } from './services/codeqlService';
import { UiProvider } from './providers/uiProvider';
import { ResultsProvider } from './providers/resultsProvider';
import { LoggerService } from './services/loggerService';
export async function activate(context: vscode.ExtensionContext) {
const logger = LoggerService.getInstance();
logger.info('Extension', 'CodeQL Scanner extension is now active!');
// Initialize services
const githubService = new GitHubService();
const codeqlService = new CodeQLService(githubService);
// Initialize providers
const uiProvider = new UiProvider(context);
const resultsProvider = new ResultsProvider();
// Set up communication between providers
uiProvider.setResultsProvider(resultsProvider);
uiProvider.setCodeQLService(codeqlService);
// Set up real-time results callback for immediate UI updates
codeqlService.setResultsCallback((results) => {
// Update both providers immediately when new results are available
resultsProvider.setResults(results);
uiProvider.updateScanResults(results);
vscode.commands.executeCommand('setContext', 'codeql-scanner.hasResults', results.length > 0);
});
// Register webview provider for configuration
context.subscriptions.push(
vscode.window.registerWebviewViewProvider('codeql-scanner.config', uiProvider)
);
// Register tree data provider for results
context.subscriptions.push(
vscode.window.registerTreeDataProvider('codeql-scanner.results', resultsProvider)
);
// Register commands
const commands = [
vscode.commands.registerCommand('codeql-scanner.scan', async () => {
await handleCommand('scan', codeqlService, resultsProvider, uiProvider);
}),
vscode.commands.registerCommand('codeql-scanner.init', async () => {
await handleCommand('init', codeqlService, resultsProvider, uiProvider);
}),
vscode.commands.registerCommand('codeql-scanner.analysis', async () => {
await handleCommand('analysis', codeqlService, resultsProvider, uiProvider);
}),
vscode.commands.registerCommand('codeql-scanner.configure', async () => {
await openConfigurationSettings();
}),
vscode.commands.registerCommand('codeql-scanner.showLogs', () => {
const logger = LoggerService.getInstance();
logger.show();
}),
vscode.commands.registerCommand('codeql-scanner.clearLogs', () => {
const logger = LoggerService.getInstance();
logger.clearLogs();
vscode.window.showInformationMessage('CodeQL Scanner logs cleared.');
}),
vscode.commands.registerCommand('codeql-scanner.reloadSARIF', async () => {
await autoLoadExistingSARIFFiles(codeqlService, resultsProvider, uiProvider);
}),
vscode.commands.registerCommand('codeql-scanner.clearDiagnostics', () => {
resultsProvider.clearResults();
vscode.window.showInformationMessage('CodeQL diagnostics cleared.');
}),
vscode.commands.registerCommand('codeql-scanner.showCodeQLInfo', async () => {
try {
const version = await codeqlService.getVersion();
const config = vscode.workspace.getConfiguration("codeql-scanner");
const codeqlPath = config.get<string>("codeqlPath", "codeql");
vscode.window.showInformationMessage(
`CodeQL CLI Info:\nVersion: ${version}\nPath: ${codeqlPath}`,
{ modal: true }
);
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
vscode.window.showErrorMessage(`CodeQL CLI Info: ${errorMessage}`);
}
}),
vscode.commands.registerCommand('codeql-scanner.installCodeQL', async () => {
try {
await vscode.window.withProgress({
location: vscode.ProgressLocation.Notification,
title: "Installing CodeQL CLI",
cancellable: true
}, async (progress, token) => {
// Force installation
const releaseInfo = await codeqlService.getLatestCodeQLRelease();
const installedPath = await codeqlService.downloadAndInstallCodeQL(releaseInfo, progress, token);
if (installedPath) {
const config = vscode.workspace.getConfiguration("codeql-scanner");
await config.update("codeqlPath", installedPath, vscode.ConfigurationTarget.Global);
vscode.window.showInformationMessage(`CodeQL CLI installed successfully at: ${installedPath}`);
}
});
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
vscode.window.showErrorMessage(`Failed to install CodeQL CLI: ${errorMessage}`);
}
}),
vscode.commands.registerCommand('codeql-scanner.copyFlowPath', async (item) => {
if (item && item.result && item.result.flowSteps) {
const flowPath = item.result.flowSteps.map((step: any, index: number) => {
const stepType = index === 0 ? 'Source' :
index === item.result.flowSteps.length - 1 ? 'Sink' : 'Step';
return `${stepType} ${index + 1}: ${step.file}:${step.startLine}${step.message ? ` - ${step.message}` : ''}`;
}).join('\n');
await vscode.env.clipboard.writeText(flowPath);
vscode.window.showInformationMessage('Flow path copied to clipboard!');
} else {
vscode.window.showWarningMessage('No flow path available for this item.');
}
}),
vscode.commands.registerCommand('codeql-scanner.navigateFlowSteps', async (item) => {
if (item && item.result && item.result.flowSteps && item.result.flowSteps.length > 0) {
const flowSteps = item.result.flowSteps;
// Create quick pick items for each flow step
interface FlowStepQuickPickItem extends vscode.QuickPickItem {
stepData: any;
}
const quickPickItems: FlowStepQuickPickItem[] = flowSteps.map((step: any, index: number) => {
const stepType = index === 0 ? 'Source' :
index === flowSteps.length - 1 ? 'Sink' : 'Step';
const fileName = step.file.split('/').pop() || 'unknown';
return {
label: `${stepType} ${index + 1}: ${fileName}:${step.startLine}`,
description: step.message || '',
detail: step.file,
stepData: step
};
});
const selected = await vscode.window.showQuickPick(quickPickItems, {
placeHolder: 'Select a flow step to navigate to'
});
if (selected && selected.stepData) {
const step = selected.stepData;
const document = await vscode.workspace.openTextDocument(step.file);
const editor = await vscode.window.showTextDocument(document);
const range = new vscode.Range(
step.startLine - 1,
step.startColumn - 1,
step.endLine - 1,
step.endColumn - 1
);
editor.selection = new vscode.Selection(range.start, range.end);
editor.revealRange(range, vscode.TextEditorRevealType.InCenter);
}
} else {
vscode.window.showWarningMessage('No flow steps available for this item.');
}
}),
vscode.commands.registerCommand('codeql-scanner.resultSelected', async (resultData, uri, options) => {
try {
const document = await vscode.workspace.openTextDocument(uri);
const editor = await vscode.window.showTextDocument(document);
if (options && options.selection) {
editor.selection = new vscode.Selection(options.selection.start, options.selection.end);
editor.revealRange(options.selection, vscode.TextEditorRevealType.InCenter);
}
} catch (error) {
const logger = LoggerService.getInstance();
logger.error('Command', 'Failed to open file for result', error);
vscode.window.showErrorMessage(`Failed to open file: ${error instanceof Error ? error.message : String(error)}`);
}
}),
vscode.commands.registerCommand('codeql-scanner.flowStepSelected', async (flowStepData, uri, options) => {
try {
const document = await vscode.workspace.openTextDocument(uri);
const editor = await vscode.window.showTextDocument(document);
if (options && options.selection) {
editor.selection = new vscode.Selection(options.selection.start, options.selection.end);
editor.revealRange(options.selection, vscode.TextEditorRevealType.InCenter);
}
} catch (error) {
const logger = LoggerService.getInstance();
logger.error('Command', 'Failed to open file for flow step', error);
vscode.window.showErrorMessage(`Failed to open file: ${error instanceof Error ? error.message : String(error)}`);
}
})
];
context.subscriptions.push(...commands);
// Register providers for disposal
context.subscriptions.push(resultsProvider);
// Register logger disposal
context.subscriptions.push({
dispose: () => {
LoggerService.getInstance().dispose();
}
});
// Set context for when results are available
vscode.commands.executeCommand('setContext', 'codeql-scanner.hasResults', false);
// Auto-load existing SARIF files
await autoLoadExistingSARIFFiles(codeqlService, resultsProvider, uiProvider);
}
async function handleCommand(
command: 'scan' | 'init' | 'analysis',
codeqlService: CodeQLService,
resultsProvider: ResultsProvider,
uiProvider?: UiProvider
) {
const logger = LoggerService.getInstance();
try {
logger.logCommand(command, 'started');
// Check if GitHub token is configured
const config = vscode.workspace.getConfiguration('codeql-scanner');
const token = config.get<string>('github.token');
if (!token) {
logger.warn('Extension', 'GitHub token not configured');
const result = await vscode.window.showErrorMessage(
'GitHub token is required. Please configure it in settings.',
'Open Settings'
);
if (result === 'Open Settings') {
await openConfigurationSettings();
}
return;
}
// Show progress
await vscode.window.withProgress({
location: vscode.ProgressLocation.Notification,
title: `CodeQL ${command}`,
cancellable: true
}, async (progress, token) => {
progress.report({ increment: 0, message: 'Starting...' });
let results;
switch (command) {
case 'scan':
results = await codeqlService.runScan(progress, token);
if (results && results.length > 0) {
resultsProvider.setResults(results);
// Update UI provider with scan results
if (uiProvider) {
uiProvider.updateScanResults(results);
}
vscode.commands.executeCommand('setContext', 'codeql-scanner.hasResults', true);
} else {
// Clear existing results and diagnostics
resultsProvider.clearResults();
if (uiProvider) {
uiProvider.updateScanResults([]);
}
vscode.commands.executeCommand('setContext', 'codeql-scanner.hasResults', false);
}
break;
case 'init':
await codeqlService.initRepository(progress, token);
break;
case 'analysis':
await codeqlService.runAnalysis(progress, token);
break;
}
progress.report({ increment: 100, message: 'Completed!' });
});
// Refresh results view
resultsProvider.refresh();
logger.logCommand(command, 'completed');
vscode.window.showInformationMessage(`CodeQL ${command} completed successfully!`);
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
logger.logCommand(command, 'failed', error);
vscode.window.showErrorMessage(`CodeQL ${command} failed: ${errorMessage}`);
}
}
async function openConfigurationSettings() {
await vscode.commands.executeCommand('workbench.action.openSettings', 'codeql-scanner');
}
async function autoLoadExistingSARIFFiles(
codeqlService: CodeQLService,
resultsProvider: ResultsProvider,
uiProvider: UiProvider
) {
const logger = LoggerService.getInstance();
try {
logger.info('Extension', 'Checking for existing SARIF files...');
const existingResults = await codeqlService.loadExistingSARIFFiles();
if (existingResults && existingResults.length > 0) {
logger.info('Extension', `Found ${existingResults.length} existing results`);
resultsProvider.setResults(existingResults);
uiProvider.updateScanResults(existingResults);
vscode.commands.executeCommand('setContext', 'codeql-scanner.hasResults', true);
// Group results by language for better user feedback
const languageGroups = existingResults.reduce((groups, result) => {
const lang = result.language || 'unknown';
groups[lang] = (groups[lang] || 0) + 1;
return groups;
}, {} as { [key: string]: number });
const languageSummary = Object.entries(languageGroups)
.map(([lang, count]) => `${lang}: ${count}`)
.join(', ');
vscode.window.showInformationMessage(
`Loaded ${existingResults.length} existing CodeQL results (${languageSummary})`
);
} else {
logger.info('Extension', 'No existing SARIF files found');
}
} catch (error) {
logger.error('Extension', 'Failed to load existing SARIF files', error);
// Don't show error to user as this is a background operation
// But we could optionally show a debug message
const config = vscode.workspace.getConfiguration('codeql-scanner');
const showDebugMessages = config.get<boolean>('showDebugMessages', false);
if (showDebugMessages) {
vscode.window.showWarningMessage(
`Failed to auto-load existing SARIF files: ${error instanceof Error ? error.message : String(error)}`
);
}
}
}
export function deactivate() {}