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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
|
/**
* @file AssistantManager.ts
* @description This file defines the AssistantManager class, responsible for managing various
* API routes related to the Assistant functionality. It provides features such as file handling,
* web scraping, and integration with third-party APIs like OpenAI and Google Custom Search.
* It also handles job tracking and progress reporting for tasks like document creation and web scraping.
* Utility functions for path manipulation and file operations are included, along with
* a mechanism for handling retry logic during API calls.
*/
import { Readability } from '@mozilla/readability';
import axios from 'axios';
import { spawn } from 'child_process';
import * as fs from 'fs';
import { writeFile } from 'fs';
import { google } from 'googleapis';
import { JSDOM } from 'jsdom';
import OpenAI from 'openai';
import * as path from 'path';
import * as puppeteer from 'puppeteer';
import { promisify } from 'util';
import * as uuid from 'uuid';
import { AI_Document } from '../../client/views/nodes/chatbot/types/types';
import { DashUploadUtils } from '../DashUploadUtils';
import { Method } from '../RouteManager';
import { filesDirectory, publicDirectory } from '../SocketData';
import ApiManager, { Registration } from './ApiManager';
import { env } from 'process';
// Enumeration of directories where different file types are stored
export enum Directory {
parsed_files = 'parsed_files',
images = 'images',
videos = 'videos',
pdfs = 'pdfs',
text = 'text',
pdf_thumbnails = 'pdf_thumbnails',
audio = 'audio',
csv = 'csv',
chunk_images = 'chunk_images',
scrape_images = 'scrape_images',
}
// In-memory job tracking
const jobResults: { [key: string]: unknown } = {};
const jobProgress: { [key: string]: unknown } = {};
/**
* Constructs a normalized path to a file in the server's file system.
* @param directory The directory where the file is stored.
* @param filename The name of the file.
* @returns The full normalized path to the file.
*/
export function serverPathToFile(directory: Directory, filename: string) {
return path.normalize(`${filesDirectory}/${directory}/${filename}`);
}
/**
* Constructs a normalized path to a directory in the server's file system.
* @param directory The directory to access.
* @returns The full normalized path to the directory.
*/
export function pathToDirectory(directory: Directory) {
return path.normalize(`${filesDirectory}/${directory}`);
}
/**
* Constructs the client-accessible URL for a file.
* @param directory The directory where the file is stored.
* @param filename The name of the file.
* @returns The URL path to the file.
*/
export function clientPathToFile(directory: Directory, filename: string) {
return `/files/${directory}/${filename}`;
}
// Promisified versions of filesystem functions
const writeFileAsync = promisify(writeFile);
const readFileAsync = promisify(fs.readFile);
/**
* Class responsible for handling various API routes related to the Assistant functionality.
* This class extends `ApiManager` and handles registration of routes and secure request handlers.
*/
export default class AssistantManager extends ApiManager {
/**
* Registers all API routes and initializes necessary services like OpenAI and Google Custom Search.
* @param register The registration method to register routes and handlers.
*/
protected initialize(register: Registration): void {
// Initialize Google Custom Search API
const customsearch = google.customsearch('v1');
const openai = new OpenAI({ apiKey: env.OPENAI_API_KEY });
// Register Wikipedia summary API route
register({
method: Method.POST,
subscription: '/getWikipediaSummary',
secureHandler: async ({ req, res }) => {
const { title } = req.body;
try {
// Fetch summary from Wikipedia using axios
const response = await axios.get('https://en.wikipedia.org/w/api.php', {
params: {
action: 'query',
list: 'search',
srsearch: title,
format: 'json',
},
});
const summary = response.data.query.search[0]?.snippet || 'No article found with that title.';
res.send({ text: summary });
} catch (error) {
console.error('Error retrieving Wikipedia summary:', error);
res.status(500).send({
error: 'Error retrieving article summary from Wikipedia.',
});
}
},
});
// Register an API route to retrieve web search results using Google Custom Search
// This route filters results by checking their x-frame-options headers for security purposes
register({
method: Method.POST,
subscription: '/getWebSearchResults',
secureHandler: async ({ req, res }) => {
const { query, max_results } = req.body;
const MIN_VALID_RESULTS_RATIO = 0.75; // 3/4 threshold
let startIndex = 1; // Start at the first result initially
const fetchSearchResults = async (start: number) => {
return customsearch.cse.list({
q: query,
cx: process.env._CLIENT_GOOGLE_SEARCH_ENGINE_ID,
key: process.env._CLIENT_GOOGLE_API_KEY,
safe: 'active',
num: max_results,
start, // This controls which result index the search starts from
});
};
const filterResultsByXFrameOptions = async (
results: {
url: string | null | undefined;
snippet: string | null | undefined;
}[]
) => {
const filteredResults = await Promise.all(
results
.filter(result => result.url)
.map(async result => {
try {
const urlResponse = await axios.head(result.url!, { timeout: 5000 });
const xFrameOptions = urlResponse.headers['x-frame-options'];
if (xFrameOptions && xFrameOptions.toUpperCase() === 'SAMEORIGIN') {
return result;
}
} catch (error) {
console.error(`Error checking x-frame-options for URL: ${result.url}`, error);
}
return null; // Exclude the result if it doesn't match
})
);
return filteredResults.filter(result => result !== null); // Remove null results
};
try {
// Fetch initial search results
let response = await fetchSearchResults(startIndex);
const initialResults =
response.data.items?.map(item => ({
url: item.link,
snippet: item.snippet,
})) || [];
// Filter the initial results
let validResults = await filterResultsByXFrameOptions(initialResults);
// If valid results are less than 3/4 of max_results, fetch more results
while (validResults.length < max_results * MIN_VALID_RESULTS_RATIO) {
// Increment the start index by the max_results to fetch the next set of results
startIndex += max_results;
response = await fetchSearchResults(startIndex);
const additionalResults =
response.data.items?.map(item => ({
url: item.link,
snippet: item.snippet,
})) || [];
const additionalValidResults = await filterResultsByXFrameOptions(additionalResults);
validResults = [...validResults, ...additionalValidResults]; // Combine valid results
// Break if no more results are available
if (additionalValidResults.length === 0 || response.data.items?.length === 0) {
break;
}
}
// Return the filtered valid results
res.send({ results: validResults.slice(0, max_results) }); // Limit the results to max_results
} catch (error) {
console.error('Error performing web search:', error);
res.status(500).send({
error: 'Failed to perform web search',
});
}
},
});
/**
* Converts a video file to audio format using ffmpeg.
* @param videoPath The path to the input video file.
* @param outputAudioPath The path to the output audio file.
* @returns A promise that resolves when the conversion is complete.
*/
function convertVideoToAudio(videoPath: string, outputAudioPath: string): Promise<void> {
return new Promise((resolve, reject) => {
const ffmpegProcess = spawn('ffmpeg', [
'-i',
videoPath, // Input file
'-vn', // No video
'-acodec',
'pcm_s16le', // Audio codec
'-ac',
'1', // Number of audio channels
'-ar',
'16000', // Audio sampling frequency
'-f',
'wav', // Output format
outputAudioPath, // Output file
]);
ffmpegProcess.on('error', error => {
console.error('Error running ffmpeg:', error);
reject(error);
});
ffmpegProcess.on('close', code => {
if (code === 0) {
console.log('Audio extraction complete:', outputAudioPath);
resolve();
} else {
reject(new Error(`ffmpeg exited with code ${code}`));
}
});
});
}
// Register an API route to process a media file (audio or video)
// Extracts audio from video files, transcribes the audio using OpenAI Whisper, and provides a summary
register({
method: Method.POST,
subscription: '/processMediaFile',
secureHandler: async ({ req, res }) => {
const { fileName } = req.body;
// Ensure the filename is provided
if (!fileName) {
res.status(400).send({ error: 'Filename is required' });
return;
}
try {
// Determine the file type and location
const isAudio = fileName.toLowerCase().endsWith('.mp3');
const directory = isAudio ? Directory.audio : Directory.videos;
const filePath = serverPathToFile(directory, fileName);
// Check if the file exists
if (!fs.existsSync(filePath)) {
res.status(404).send({ error: 'File not found' });
return;
}
console.log(`Processing ${isAudio ? 'audio' : 'video'} file: ${fileName}`);
// Step 1: Extract audio if it's a video
let audioPath = filePath;
if (!isAudio) {
const audioFileName = `${path.basename(fileName, path.extname(fileName))}.wav`;
audioPath = path.join(pathToDirectory(Directory.audio), audioFileName);
console.log('Extracting audio from video...');
await convertVideoToAudio(filePath, audioPath);
}
// Step 2: Transcribe audio using OpenAI Whisper
console.log('Transcribing audio...');
const transcription = await openai.audio.transcriptions.create({
file: fs.createReadStream(audioPath),
model: 'whisper-1',
response_format: 'verbose_json',
timestamp_granularities: ['segment'],
});
console.log('Audio transcription complete.');
// Step 3: Extract concise JSON
console.log('Extracting concise JSON...');
const originalSegments = transcription.segments?.map((segment, index) => ({
index: index.toString(),
text: segment.text,
start: segment.start,
end: segment.end,
}));
interface ConciseSegment {
text: string;
indexes: string[];
start: number | null;
end: number | null;
}
const combinedSegments = [];
let currentGroup: ConciseSegment = { text: '', indexes: [], start: null, end: null };
let currentDuration = 0;
originalSegments?.forEach(segment => {
const segmentDuration = segment.end - segment.start;
if (currentDuration + segmentDuration <= 4000) {
// Add segment to the current group
currentGroup.text += (currentGroup.text ? ' ' : '') + segment.text;
currentGroup.indexes.push(segment.index);
if (currentGroup.start === null) {
currentGroup.start = segment.start;
}
currentGroup.end = segment.end;
currentDuration += segmentDuration;
} else {
// Push the current group and start a new one
combinedSegments.push({ ...currentGroup });
currentGroup = {
text: segment.text,
indexes: [segment.index],
start: segment.start,
end: segment.end,
};
currentDuration = segmentDuration;
}
});
// Push the final group if it has content
if (currentGroup.text) {
combinedSegments.push({ ...currentGroup });
}
const lastSegment = combinedSegments[combinedSegments.length - 1];
// Check if the last segment is too short and combine it with the second last
if (combinedSegments.length > 1 && lastSegment.end && lastSegment.start) {
const secondLastSegment = combinedSegments[combinedSegments.length - 2];
const lastDuration = lastSegment.end - lastSegment.start;
if (lastDuration < 30) {
// Combine the last segment with the second last
secondLastSegment.text += (secondLastSegment.text ? ' ' : '') + lastSegment.text;
secondLastSegment.indexes = secondLastSegment.indexes.concat(lastSegment.indexes);
secondLastSegment.end = lastSegment.end;
// Remove the last segment from the array
combinedSegments.pop();
}
}
console.log('Segments combined successfully.');
console.log('Generating summary using GPT-4...');
const combinedText = combinedSegments.map(segment => segment.text).join(' ');
let summary = '';
try {
const completion = await openai.chat.completions.create({
messages: [{ role: 'system', content: `Summarize the following text in a concise paragraph:\n\n${combinedText}` }],
model: 'gpt-4o',
});
console.log('Summary generation complete.');
summary = completion.choices[0].message.content ?? 'Summary could not be generated.';
} catch (summaryError) {
console.error('Error generating summary:', summaryError);
summary = 'Summary could not be generated.';
}
// Step 5: Return the JSON result
res.send({ full: originalSegments, condensed: combinedSegments, summary });
} catch (error) {
console.error('Error processing media file:', error);
res.status(500).send({ error: 'Failed to process media file' });
}
},
});
// Axios instance with custom headers for scraping
const axiosInstance = axios.create({
headers: {
'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36',
},
});
/**
* Utility function to introduce delay (used for retries).
* @param ms Delay in milliseconds.
*/
const delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
/**
* Function to fetch a URL with retry logic, handling rate limits.
* Retries a request if it fails due to rate limits (HTTP status 429).
* @param url The URL to fetch.
* @param retries The number of retry attempts.
* @param backoff Initial backoff time in milliseconds.
*/
const fetchWithRetry = async (url: string, retries = 3, backoff = 300): Promise<unknown> => {
try {
const response = await axiosInstance.get(url);
return response.data;
} catch (error) {
if (retries > 0 && (error as { response: { status: number } }).response?.status === 429) { // bcz: don't know the error type
console.log(`Rate limited. Retrying in ${backoff}ms...`);
await delay(backoff);
return fetchWithRetry(url, retries - 1, backoff * 2);
} // prettier-ignore
throw error;
}
};
// Register an API route to generate an image using OpenAI's DALL-E model
// Uploads the generated image to the server and provides a URL for access
register({
method: Method.POST,
subscription: '/generateImage',
secureHandler: async ({ req, res }) => {
const { image_prompt } = req.body;
if (!image_prompt) {
res.status(400).send({ error: 'No prompt provided' });
return;
}
try {
const image = await openai.images.generate({ model: 'dall-e-3', prompt: image_prompt, response_format: 'url' });
console.log(image);
const result = await DashUploadUtils.UploadImage(image.data[0].url!);
const url = image.data[0].url;
res.send({ result, url });
} catch (error) {
console.error('Error fetching the URL:', error);
res.status(500).send({
error: 'Failed to fetch the URL',
});
}
},
});
// Register an API route to fetch data from a URL using a proxy with retry logic
// Useful for bypassing rate limits or scraping inaccessible data
register({
method: Method.POST,
subscription: '/proxyFetch',
secureHandler: async ({ req, res }) => {
const { url } = req.body;
if (!url) {
res.status(400).send({ error: 'No URL provided' });
return;
}
try {
const data = await fetchWithRetry(url);
res.send({ data });
} catch (error) {
console.error('Error fetching the URL:', error);
res.status(500).send({
error: 'Failed to fetch the URL',
});
}
},
});
// Register an API route to scrape website content using Puppeteer and JSDOM
// Extracts and returns readable content from a given URL
register({
method: Method.POST,
subscription: '/scrapeWebsite',
secureHandler: async ({ req, res }) => {
const { url } = req.body;
let browser = null;
try {
// Set a longer timeout for slow-loading pages
const navigationTimeout = 60000; // 60 seconds
// Launch Puppeteer browser to navigate to the webpage
browser = await puppeteer.launch({
args: ['--no-sandbox', '--disable-setuid-sandbox', '--disable-dev-shm-usage'],
});
const page = await browser.newPage();
await page.setUserAgent('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36');
// Set timeout for navigation
page.setDefaultNavigationTimeout(navigationTimeout);
// Navigate with timeout and wait for content to load
await page.goto(url, {
waitUntil: 'networkidle2',
timeout: navigationTimeout,
});
// Wait a bit longer to ensure dynamic content loads
await new Promise(resolve => setTimeout(resolve, 2000));
// Extract HTML content
const htmlContent = await page.content();
await browser.close();
browser = null;
// Use a try-catch block specifically for JSDOM parsing
try {
// Parse HTML content using JSDOM
const dom = new JSDOM(htmlContent, { url });
// Extract readable content using Mozilla's Readability API
const reader = new Readability(dom.window.document);
const article = reader.parse();
if (article) {
const plainText = article.textContent;
res.send({ website_plain_text: plainText });
} else {
// If Readability fails, fallback to extracting main content
const mainContent = await extractMainContent(htmlContent);
res.send({ website_plain_text: mainContent });
}
} catch (parsingError) {
console.error('Error parsing website content:', parsingError);
// Fallback to a simplified extraction method
const mainContent = await extractMainContent(htmlContent);
res.send({ website_plain_text: mainContent });
}
} catch (error) {
console.error('Error scraping website:', error);
// Clean up browser if still open
if (browser) {
await browser.close().catch(e => console.error('Error closing browser:', e));
}
res.status(500).send({
error: 'Failed to scrape website: ' + ((error as Error).message || 'Unknown error'),
});
}
},
});
// Register an API route to create a document and start a background job for processing
// Uses Python scripts to process files and generate document chunks for further use
register({
method: Method.POST,
subscription: '/createDocument',
secureHandler: async ({ req, res }) => {
const { file_path } = req.body;
const public_path = path.join(publicDirectory, file_path); // Resolve the file path in the public directory
const file_name = path.basename(file_path); // Extract the file name from the path
try {
// Read the file data and encode it as base64
const file_data: string = fs.readFileSync(public_path, { encoding: 'base64' });
// Generate a unique job ID for tracking
const jobId = uuid.v4();
// Spawn the Python process and track its progress/output
// eslint-disable-next-line no-use-before-define
spawnPythonProcess(jobId, public_path);
// Send the job ID back to the client for tracking
res.send({ jobId });
} catch (error) {
console.error('Error initiating document creation:', error);
res.status(500).send({
error: 'Failed to initiate document creation',
});
}
},
});
// Register an API route to check the progress of a document creation job
// Returns the current step and progress percentage
register({
method: Method.GET,
subscription: '/getProgress/:jobId',
secureHandler: async ({ req, res }) => {
const { jobId } = req.params; // Get the job ID from the URL parameters
// Check if the job progress is available
if (jobProgress[jobId]) {
res.json(jobProgress[jobId]);
} else {
res.json({
step: 'Processing Document...',
progress: '0',
});
}
},
});
// Register an API route to retrieve the final result of a document creation job
// Returns the processed data or an error status if the job is incomplete
register({
method: Method.GET,
subscription: '/getResult/:jobId',
secureHandler: async ({ req, res }) => {
const { jobId } = req.params;
if (jobResults[jobId]) {
const result = jobResults[jobId] as AI_Document & { status: string };
if (result.chunks && Array.isArray(result.chunks)) {
result.status = 'completed';
} else {
result.status = 'pending';
}
res.json(result);
} else {
res.status(202).send({ status: 'pending' });
}
},
});
// Register an API route to format chunks of text or images for structured display
// Converts raw chunk data into a structured format for frontend consumption
register({
method: Method.POST,
subscription: '/formatChunks',
secureHandler: async ({ req, res }) => {
const { relevantChunks } = req.body; // Get the relevant chunks from the request body
// Initialize an array to hold the formatted content
const content: { type: string; text?: string; image_url?: { url: string } }[] = [{ type: 'text', text: '<chunks>' }];
await Promise.all(
relevantChunks.map((chunk: { id: string; metadata: { type: string; text: TimeRanges; file_path: string } }) => {
// Format each chunk by adding its metadata and content
content.push({
type: 'text',
text: `<chunk chunk_id=${chunk.id} chunk_type="${chunk.metadata.type}">`,
});
// If the chunk is an image or table, read the corresponding file and encode it as base64
if (chunk.metadata.type === 'image' || chunk.metadata.type === 'table') {
try {
const filePath = path.join(pathToDirectory(Directory.chunk_images), chunk.metadata.file_path); // Get the file path
console.log(filePath);
readFileAsync(filePath).then(imageBuffer => {
const base64Image = imageBuffer.toString('base64'); // Convert the image to base64
// Add the base64-encoded image to the content array
if (base64Image) {
content.push({
type: 'image_url',
image_url: {
url: `data:image/jpeg;base64,${base64Image}`,
},
});
} else {
console.log(`Failed to encode image for chunk ${chunk.id}`);
}
});
} catch (error) {
console.error(`Error reading image file for chunk ${chunk.id}:`, error);
}
}
// Add the chunk's text content to the formatted content
content.push({ type: 'text', text: `${chunk.metadata.text}\n</chunk>\n` });
})
);
content.push({ type: 'text', text: '</chunks>' });
// Send the formatted content back to the client
res.send({ formattedChunks: content });
},
});
// Register an API route to create and save a CSV file on the server
// Writes the CSV content to a unique file and provides a URL for download
register({
method: Method.POST,
subscription: '/createCSV',
secureHandler: async ({ req, res }) => {
const { filename, data } = req.body;
// Validate that both the filename and data are provided
if (!filename || !data) {
res.status(400).send({ error: 'Filename and data fields are required.' });
return;
}
try {
// Generate a UUID for the file to ensure unique naming
const uuidv4 = uuid.v4();
const fullFilename = `${uuidv4}-${filename}`; // Prefix the file name with the UUID
// Get the full server path where the file will be saved
const serverFilePath = serverPathToFile(Directory.csv, fullFilename);
// Write the CSV data (which is a raw string) to the file
await writeFileAsync(serverFilePath, data, 'utf8');
// Construct the client-accessible URL for the file
const fileUrl = clientPathToFile(Directory.csv, fullFilename);
// Send the file URL and UUID back to the client
res.send({ fileUrl, id: uuidv4 });
} catch (error) {
console.error('Error creating CSV file:', error);
res.status(500).send({
error: 'Failed to create CSV file.',
});
}
},
});
// Register an API route to capture a screenshot of a webpage using Puppeteer
// and return the image URL for display in the WebBox component
register({
method: Method.POST,
subscription: '/captureWebScreenshot',
secureHandler: async ({ req, res }) => {
const { url, width, height, fullPage } = req.body;
if (!url) {
res.status(400).send({ error: 'URL is required' });
return;
}
let browser = null;
try {
// Increase timeout for websites that load slowly
const navigationTimeout = 60000; // 60 seconds
// Launch a headless browser with additional options to improve stability
browser = await puppeteer.launch({
headless: true, // Use headless mode
args: [
'--no-sandbox',
'--disable-setuid-sandbox',
'--disable-dev-shm-usage',
'--disable-accelerated-2d-canvas',
'--disable-gpu',
'--window-size=1200,800',
'--disable-web-security', // Helps with cross-origin issues
'--disable-features=IsolateOrigins,site-per-process', // Helps with frames
],
timeout: navigationTimeout,
});
const page = await browser.newPage();
// Set a larger viewport to capture more content
await page.setViewport({
width: Number(width) || 1200,
height: Number(height) || 800,
deviceScaleFactor: 1,
});
// Enable request interception to speed up page loading
await page.setRequestInterception(true);
page.on('request', request => {
// Skip unnecessary resources to speed up loading
const resourceType = request.resourceType();
if (resourceType === 'font' || resourceType === 'media' || resourceType === 'websocket' || request.url().includes('analytics') || request.url().includes('tracker')) {
request.abort();
} else {
request.continue();
}
});
// Set navigation and timeout options
console.log(`Navigating to URL: ${url}`);
// Navigate to the URL and wait for the page to load
await page.goto(url, {
waitUntil: ['networkidle2'],
timeout: navigationTimeout,
});
// Wait for a short delay after navigation to allow content to render
await new Promise(resolve => setTimeout(resolve, 2000));
// Take a screenshot
console.log('Taking screenshot...');
const screenshotPath = `./src/server/public/files/images/webpage_${Date.now()}.png`;
const screenshotOptions = {
path: screenshotPath,
fullPage: fullPage === true,
omitBackground: false,
type: 'png' as 'png',
clip:
fullPage !== true
? {
x: 0,
y: 0,
width: Number(width) || 1200,
height: Number(height) || 800,
}
: undefined,
};
await page.screenshot(screenshotOptions);
// Get the full height of the page
const fullHeight = await page.evaluate(() => {
return Math.max(document.body.scrollHeight, document.documentElement.scrollHeight, document.body.offsetHeight, document.documentElement.offsetHeight, document.body.clientHeight, document.documentElement.clientHeight);
});
console.log(`Screenshot captured successfully with height: ${fullHeight}px`);
// Return the URL to the screenshot
const screenshotUrl = `/files/images/webpage_${Date.now()}.png`;
res.json({
screenshotUrl,
fullHeight,
});
} catch (error: any) {
console.error('Error capturing screenshot:', error);
res.status(500).send({
error: `Failed to capture screenshot: ${error.message}`,
details: error.stack,
});
} finally {
// Ensure browser is closed to free resources
if (browser) {
try {
await browser.close();
console.log('Browser closed successfully');
} catch (error) {
console.error('Error closing browser:', error);
}
}
}
},
});
}
}
/**
* Spawns a Python process to handle file processing tasks.
* @param jobId The job ID for tracking progress.
* @param file_name The name of the file to process.
* @param file_path The filepath of the file to process.
*/
function spawnPythonProcess(jobId: string, file_path: string) {
const venvPath = path.join(__dirname, '../chunker/venv');
const requirementsPath = path.join(__dirname, '../chunker/requirements.txt');
const pythonScriptPath = path.join(__dirname, '../chunker/pdf_chunker.py');
const outputDirectory = pathToDirectory(Directory.chunk_images);
function runPythonScript() {
const pythonPath = process.platform === 'win32' ? path.join(venvPath, 'Scripts', 'python') : path.join(venvPath, 'bin', 'python3');
const pythonProcess = spawn(pythonPath, [pythonScriptPath, jobId, file_path, outputDirectory]);
let pythonOutput = '';
let stderrOutput = '';
pythonProcess.stdout.on('data', data => {
pythonOutput += data.toString();
});
pythonProcess.stderr.on('data', data => {
stderrOutput += data.toString();
const lines = stderrOutput.split('\n');
stderrOutput = lines.pop() || ''; // Save the last partial line back to stderrOutput
lines.forEach(line => {
if (line.trim()) {
if (line.startsWith('PROGRESS:')) {
const jsonString = line.substring('PROGRESS:'.length);
try {
const parsedOutput = JSON.parse(jsonString);
if (parsedOutput.job_id && parsedOutput.progress !== undefined) {
jobProgress[parsedOutput.job_id] = {
step: parsedOutput.step,
progress: parsedOutput.progress,
};
} else if (parsedOutput.progress !== undefined) {
jobProgress[jobId] = {
step: parsedOutput.step,
progress: parsedOutput.progress,
};
}
} catch (err) {
console.error('Error parsing progress JSON:', jsonString, err);
}
} else {
// Log other stderr output
console.error('Python stderr:', line);
}
}
});
});
pythonProcess.on('close', code => {
if (code === 0) {
try {
const finalResult = JSON.parse(pythonOutput);
jobResults[jobId] = finalResult;
jobProgress[jobId] = { step: 'Complete', progress: 100 };
} catch (err) {
console.error('Error parsing final JSON result:', err);
jobResults[jobId] = { error: 'Failed to parse final result' };
}
} else {
console.error(`Python process exited with code ${code}`);
// Check if there was an error message in stderr
if (stderrOutput) {
// Try to parse the last line as JSON
const lines = stderrOutput.trim().split('\n');
const lastLine = lines[lines.length - 1];
try {
const errorOutput = JSON.parse(lastLine);
jobResults[jobId] = errorOutput;
} catch {
jobResults[jobId] = { error: 'Python process failed' };
}
} else {
jobResults[jobId] = { error: 'Python process failed' };
}
}
});
}
// Check if venv exists
if (!fs.existsSync(venvPath)) {
console.log('Virtual environment not found. Creating and setting up...');
// Create venv
const createVenvProcess = spawn('python', ['-m', 'venv', venvPath]);
createVenvProcess.on('close', code => {
if (code !== 0) {
console.error(`Failed to create virtual environment. Exit code: ${code}`);
return;
}
console.log('Virtual environment created. Installing requirements...');
// Determine the pip path based on the OS
const pipPath = process.platform === 'win32' ? path.join(venvPath, 'Scripts', 'pip.exe') : path.join(venvPath, 'bin', 'pip3'); // Try 'pip3' for Unix-like systems
if (!fs.existsSync(pipPath)) {
console.error(`pip executable not found at ${pipPath}`);
return;
}
// Install requirements
const installRequirementsProcess = spawn(pipPath, ['install', '-r', requirementsPath]);
installRequirementsProcess.stdout.on('data', data => {
console.log(`pip stdout: ${data}`);
});
installRequirementsProcess.stderr.on('data', data => {
console.error(`pip stderr: ${data}`);
});
installRequirementsProcess.on('error', error => {
console.error(`Error starting pip process: ${error}`);
});
installRequirementsProcess.on('close', closecode => {
if (closecode !== 0) {
console.error(`Failed to install requirements. Exit code: ${closecode}`);
return;
}
console.log('Requirements installed. Running Python script...');
runPythonScript();
});
});
} else {
console.log('Virtual environment found. Running Python script...');
runPythonScript();
}
}
/**
* Extracts main content from HTML by removing scripts, styles, and non-content elements
* Used as a fallback when Readability fails
* @param html The HTML content to process
* @returns Extracted main text content
*/
async function extractMainContent(html: string): Promise<string> {
try {
// Create a simple DOM to extract content
const dom = new JSDOM(html, { runScripts: 'outside-only' });
const document = dom.window.document;
// Remove scripts, styles, and other non-content elements
const elementsToRemove = ['script', 'style', 'iframe', 'noscript', 'svg', 'header', 'footer', 'nav', 'aside', 'ads', 'banner', 'form', 'button', 'input'];
elementsToRemove.forEach(tag => {
const elements = document.querySelectorAll(tag);
elements.forEach(el => el.remove());
});
// Try to find the main content container using common selectors
const mainSelectors = ['main', 'article', '#content', '.content', '#main', '.main', '.post-content', '.article-content', '.entry-content'];
let mainContent = '';
// Try each selector to find main content
for (const selector of mainSelectors) {
const element = document.querySelector(selector);
if (element && element.textContent && element.textContent.trim().length > 100) {
mainContent = element.textContent;
break;
}
}
// If no main content found with selectors, use body content
if (!mainContent || mainContent.length < 200) {
mainContent = document.body.textContent || '';
}
// Clean up the text
return mainContent.replace(/\s+/g, ' ').replace(/\n+/g, '\n').trim();
} catch (error) {
console.error('Error extracting main content:', error);
return 'Failed to extract content from the webpage.';
}
}
|