botserver/src/util.ts

292 lines
11 KiB
TypeScript
Raw Normal View History

/*****************************************************************************\
| ® |
| |
| |
| |
| |
| |
2024-05-26 20:13:56 -03:00
| General Bots Copyright (c) pragmatismo.cloud. All rights reserved. |
| Licensed under the AGPL-3.0. |
| |
| According to our dual licensing model, this program can be used either |
| under the terms of the GNU Affero General Public License, version 3, |
| or under a proprietary license. |
| |
| The texts of the GNU Affero General Public License with an additional |
| permission and of our proprietary license can be found at and |
| in the LICENSE file you have received along with this program. |
| |
| This program is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY, without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| GNU Affero General Public License for more details. |
| |
2024-05-26 20:13:56 -03:00
| "General Bots" is a registered trademark of pragmatismo.cloud. |
| The licensing of the program under the AGPLv3 does not imply a |
| trademark license. Therefore any rights, title and interest in |
| our trademarks remain entirely with us. |
| |
\*****************************************************************************/
2024-01-09 17:40:48 -03:00
/**
* @fileoverview General Bots local utility.
*/
2024-01-09 17:40:48 -03:00
'use strict';
2024-05-26 20:13:56 -03:00
import * as YAML from 'yaml';
2024-08-19 16:12:23 -03:00
import SwaggerClient from 'swagger-client';
2024-09-07 18:13:36 -03:00
import fs from 'fs/promises';
2024-08-19 23:03:58 -03:00
import { GBConfigService } from '../packages/core.gbapp/services/GBConfigService.js';
2024-08-21 13:26:40 -03:00
import path from 'path';
2024-09-07 18:13:36 -03:00
import { VerbosityLevel, getDocument } from 'pdfjs-dist/legacy/build/pdf.mjs';
VerbosityLevel.ERRORS=0;
VerbosityLevel.WARNINGS=0;
VerbosityLevel.INFOS=0;
import { Page } from 'puppeteer';
import urljoin from 'url-join';
import html2md from 'html-to-md';
export class GBUtil {
2024-05-26 20:13:56 -03:00
public static repeat(chr, count) {
let str = '';
for (let x = 0; x < count; x++) {
str += chr;
}
return str;
}
2024-05-26 20:13:56 -03:00
public static padL(value, width, pad) {
if (!width || width < 1) return value;
2024-05-26 20:13:56 -03:00
if (!pad) pad = ' ';
const length = width - value.length;
if (length < 1) return value.substr(0, width);
return (GBUtil.repeat(pad, length) + value).substr(0, width);
}
2024-08-19 16:12:23 -03:00
2024-05-26 20:13:56 -03:00
public static padR(value, width, pad) {
if (!width || width < 1) return value;
2024-05-26 20:13:56 -03:00
if (!pad) pad = ' ';
const length = width - value.length;
if (length < 1) value.substr(0, width);
return (value + GBUtil.repeat(pad, length)).substr(0, width);
}
2024-08-19 16:12:23 -03:00
public static async getDirectLineClient(min) {
let config = {
2024-09-07 18:13:36 -03:00
spec: JSON.parse(await fs.readFile('directline-3.0.json', 'utf8')),
2024-08-19 16:12:23 -03:00
requestInterceptor: req => {
req.headers['Authorization'] = `Bearer ${min.instance.webchatKey}`;
}
2024-08-20 15:26:07 -03:00
};
2024-08-20 15:35:03 -03:00
if (!GBConfigService.get('STORAGE_NAME')) {
2024-08-24 00:12:50 -03:00
(config['spec'].url = `http://127.0.0.1:${GBConfigService.getServerPort()}/api/messages/${min.botId}`),
(config['spec'].servers = [
{ url: `http://127.0.0.1:${GBConfigService.getServerPort()}/api/messages/${min.botId}` }
]);
2024-08-20 16:12:30 -03:00
config['spec'].openapi = '3.0.0';
2024-08-20 15:49:28 -03:00
delete config['spec'].host;
2024-08-20 16:18:01 -03:00
delete config['spec'].swagger;
2024-08-19 16:12:23 -03:00
}
2024-08-20 15:49:28 -03:00
2024-08-20 15:32:18 -03:00
return await new SwaggerClient(config);
2024-08-19 16:12:23 -03:00
}
2024-08-20 15:26:07 -03:00
public static toYAML(data) {
2024-08-20 15:30:47 -03:00
const extractProps = obj => {
return Object.getOwnPropertyNames(obj).reduce((acc, key) => {
const value = obj[key];
acc[key] = value && typeof value === 'object' && !Array.isArray(value) ? extractProps(value) : value;
return acc;
}, {});
2024-08-20 15:26:07 -03:00
};
const extractedError = extractProps(data);
return YAML.stringify(extractedError);
2024-08-20 15:30:47 -03:00
}
public static sleep(ms) {
return new Promise(resolve => {
setTimeout(resolve, ms);
});
2024-05-26 20:13:56 -03:00
}
public static caseInsensitive(listOrRow) {
2024-05-26 20:13:56 -03:00
if (!listOrRow || typeof listOrRow !== 'object') {
2024-01-09 17:40:48 -03:00
return listOrRow;
2024-05-26 20:13:56 -03:00
}
const lowercase = oldKey => (typeof oldKey === 'string' ? oldKey.toLowerCase() : oldKey);
const createCaseInsensitiveProxy = obj => {
2024-01-09 17:40:48 -03:00
const propertiesMap = new Map(Object.keys(obj).map(propKey => [lowercase(propKey), obj[propKey]]));
const caseInsensitiveGetHandler = {
get: (target, property) => propertiesMap.get(lowercase(property))
};
return new Proxy(obj, caseInsensitiveGetHandler);
};
2024-05-26 20:13:56 -03:00
if (Array.isArray(listOrRow)) {
2024-01-09 17:40:48 -03:00
return listOrRow.map(row => createCaseInsensitiveProxy(row));
} else {
return createCaseInsensitiveProxy(listOrRow);
}
2024-05-26 20:13:56 -03:00
}
2024-08-21 13:26:40 -03:00
2024-09-07 18:13:36 -03:00
public static async exists(filePath: string): Promise<boolean> {
try {
await fs.access(filePath);
return true; // File exists
} catch (error) {
return false; // File does not exist
}
}
public static async savePage(url: string, page: Page, directoryPath: string): Promise<string | null> {
try {
// Check if the directory exists, create it if not
const directoryExists = await this.fileExists(directoryPath);
if (!directoryExists) {
await fs.mkdir(directoryPath, { recursive: true }); // Create directory if it doesn't exist
}
// Check if the URL is for a downloadable file (e.g., .pdf)
if (url.endsWith('.pdf')) {
const response = await fetch(url);
if (!response.ok) {
throw new Error('Failed to download the file');
}
const buffer = await response.arrayBuffer(); // Convert response to array buffer
const fileName = path.basename(url); // Extract file name from URL
const filePath = path.join(directoryPath, fileName); // Create file path
const data = new Uint8Array(buffer);
const text = await GBUtil.getPdfText(data);
// Write the buffer to the file asynchronously
await fs.writeFile(filePath, text);
return filePath; // Return the saved file path
} else {
// Use Puppeteer for non-downloadable pages
const parsedUrl = new URL(url);
// Get the last part of the URL path or default to 'index' if empty
const pathParts = parsedUrl.pathname.split('/').filter(Boolean); // Remove empty parts
const lastPath = pathParts.length > 0 ? pathParts[pathParts.length - 1] : 'index';
const flatLastPath = lastPath.replace(/\W+/g, '-'); // Flatten the last part of the path
const fileName = `${flatLastPath}.html`;
const filePath = path.join(directoryPath, fileName);
const htmlContent = await page.content();
// Write HTML content asynchronously
await fs.writeFile(filePath, htmlContent);
return filePath;
}
} catch (error) {
console.error('Error saving page:', error);
return null;
}
}
public static async fileExists(filePath: string): Promise<boolean> {
try {
await fs.access(filePath);
return true;
} catch (error) {
return false;
}
}
public static async copyIfNewerRecursive(src, dest) {
if (!await GBUtil.exists(src)) {
2024-08-24 00:12:50 -03:00
console.error(`Source path "${src}" does not exist.`);
return;
2024-08-21 13:26:40 -03:00
}
// Check if the source is a directory
2024-09-07 18:13:36 -03:00
if ((await fs.stat(src)).isDirectory()) {
2024-08-24 00:12:50 -03:00
// Create the destination directory if it doesn't exist
2024-09-07 18:13:36 -03:00
if (!await GBUtil.exists(dest)) {
fs.mkdir(dest, { recursive: true });
2024-08-24 00:12:50 -03:00
}
2024-08-21 13:26:40 -03:00
2024-08-24 00:12:50 -03:00
// Read all files and directories in the source directory
2024-09-07 18:13:36 -03:00
const entries =await fs.readdir(src);
2024-08-21 13:26:40 -03:00
2024-08-24 00:12:50 -03:00
for (let entry of entries) {
const srcEntry = path.join(src, entry);
const destEntry = path.join(dest, entry);
2024-08-21 13:26:40 -03:00
2024-08-24 00:12:50 -03:00
// Recursively copy each entry
this.copyIfNewerRecursive(srcEntry, destEntry);
}
2024-08-21 13:26:40 -03:00
} else {
2024-08-24 00:12:50 -03:00
// Source is a file, check if we need to copy it
2024-09-07 18:13:36 -03:00
if (await GBUtil.exists(dest)) {
const srcStat =await fs.stat(src);
const destStat =await fs.stat(dest);
2024-08-24 00:12:50 -03:00
// Copy only if the source file is newer than the destination file
if (srcStat.mtime > destStat.mtime) {
2024-09-07 18:13:36 -03:00
fs.cp(src, dest, { force: true });
2024-08-21 13:26:40 -03:00
}
2024-08-24 00:12:50 -03:00
} else {
// Destination file doesn't exist, so copy it
2024-09-07 18:13:36 -03:00
fs.cp(src, dest, { force: true });
2024-08-24 00:12:50 -03:00
}
2024-08-21 13:26:40 -03:00
}
2024-08-24 00:12:50 -03:00
}
// Check if is a tree or flat object.
2024-08-21 13:26:40 -03:00
2024-08-24 00:12:50 -03:00
public static hasSubObject(t) {
for (var key in t) {
if (!t.hasOwnProperty(key)) continue;
if (typeof t[key] === 'object') return true;
}
return false;
}
2024-09-07 18:13:36 -03:00
public static async getPdfText(data): Promise<string> {
const pdf = await getDocument({data}).promise;
let pages = [];
for (let i = 1; i <= pdf.numPages; i++) {
const page = await pdf.getPage(i);
const textContent = await page.getTextContent();
const text = textContent.items
.map(item => item['str'])
2024-09-07 18:13:36 -03:00
.join(' ')
.replace(/\s+/g, ' '); // Optionally remove extra spaces
pages.push(text);
}
2024-09-07 18:13:36 -03:00
return pages.join(' ');
}
static getGBAIPath(botId, packageType = null, packageName = null) {
let gbai = `${botId}.gbai`;
if (!packageType && !packageName) {
return GBConfigService.get('DEV_GBAI') ? GBConfigService.get('DEV_GBAI') : gbai;
}
if (GBConfigService.get('DEV_GBAI')) {
gbai = GBConfigService.get('DEV_GBAI');
botId = gbai.replace(/\.[^/.]+$/, '');
return urljoin(GBConfigService.get('DEV_GBAI'), packageName ? packageName : `${botId}.${packageType}`);
} else {
return urljoin(gbai, packageName ? packageName : `${botId}.${packageType}`);
}
}
2024-05-26 20:13:56 -03:00
}