botserver/packages/basic.gblib/services/SystemKeywords.ts

2625 lines
79 KiB
TypeScript

/*****************************************************************************\
| ( )_ _ |
| _ _ _ __ _ _ __ ___ ___ _ _ | ,_)(_) ___ ___ _ |
| ( '_`\ ( '__)/'_` ) /'_ `\/' _ ` _ `\ /'_` )| | | |/',__)/' v `\ /'_`\ |
| | (_) )| | ( (_| |( (_) || ( ) ( ) |( (_| || |_ | |\__, \| (˅) |( (_) ) |
| | ,__/'(_) `\__,_)`\__ |(_) (_) (_)`\__,_)`\__)(_)(____/(_) (_)`\___/' |
| | | ( )_) | |
| (_) \___/' |
| |
| General Bots Copyright (c) Pragmatismo.io. 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. |
| |
| "General Bots" is a registered trademark of Pragmatismo.io. |
| 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. |
| |
\*****************************************************************************/
'use strict';
import { GBLog, GBMinInstance } from 'botlib';
import { GBConfigService } from '../../core.gbapp/services/GBConfigService.js';
import { CollectionUtil } from 'pragmatismo-io-framework';
import { GBAdminService } from '../../admin.gbapp/services/GBAdminService.js';
import { GBDeployer } from '../../core.gbapp/services/GBDeployer.js';
import { DialogKeywords } from './DialogKeywords.js';
import { GBServer } from '../../../src/app.js';
import { GBVMService } from './GBVMService.js';
import Fs from 'fs';
import { GBSSR } from '../../core.gbapp/services/GBSSR.js';
import urlJoin from 'url-join';
import Excel from 'exceljs';
import { TwitterApi } from 'twitter-api-v2';
import Path from 'path';
import ComputerVisionClient from '@azure/cognitiveservices-computervision';
import ApiKeyCredentials from '@azure/ms-rest-js';
import alasql from 'alasql';
import PizZip from 'pizzip';
import Docxtemplater from 'docxtemplater';
import pptxTemplaterModule from 'pptxtemplater';
import _ from 'lodash';
import { pdfToPng, PngPageOutput } from 'pdf-to-png-converter';
import sharp from 'sharp';
import ImageModule from 'open-docxtemplater-image-module';
import DynamicsWebApi from 'dynamics-web-api';
import * as MSAL from '@azure/msal-node';
import { GBConversationalService } from '../../core.gbapp/services/GBConversationalService.js';
import { WebAutomationServices } from './WebAutomationServices.js';
import { KeywordsExpressions } from './KeywordsExpressions.js';
import { ChatServices } from '../../gpt.gblib/services/ChatServices.js';
import mime from 'mime-types';
import exts from '../../../extensions.json' assert { type: 'json' };
import { SecService } from '../../security.gbapp/services/SecService.js';
import { GBLogEx } from '../../core.gbapp/services/GBLogEx.js';
import retry from 'async-retry';
import {
BlobServiceClient,
BlockBlobClient,
StorageSharedKeyCredential
} from '@azure/storage-blob';
import { md5 } from 'js-md5';
/**
* @fileoverview General Bots server core.
*/
/**
* BASIC system class for extra manipulation of bot behaviour.
*/
export class SystemKeywords {
public async callVM({ pid, text }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const step = null;
const deployer = null;
return await GBVMService.callVM(text, min, step, user, deployer, false);
}
public async append({ pid, args }) {
let array = [].concat(...args);
return array.filter(function (item, pos) {
return item;
});
}
/**
*
* @example SEE CAPTION OF url AS variable
*
*/
public async seeCaption({ pid, url }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const computerVisionClient = new ComputerVisionClient.ComputerVisionClient(
new ApiKeyCredentials.ApiKeyCredentials({ inHeader: { 'Ocp-Apim-Subscription-Key': process.env.VISION_KEY } }),
process.env.VISION_ENDPOINT
);
let caption = (await computerVisionClient.describeImage(url)).captions[0];
const contentLocale = min.core.getParam(
min.instance,
'Default Content Language',
GBConfigService.get('DEFAULT_CONTENT_LANGUAGE')
);
GBLog.info(`GBVision (caption): '${caption.text}' (Confidence: ${caption.confidence.toFixed(2)})`);
return await min.conversationalService.translate(min, caption.text, contentLocale);
}
/**
*
* @example SEE TEXT OF url AS variable
*
*/
public async seeText({ pid, url }) {
const computerVisionClient = new ComputerVisionClient.ComputerVisionClient(
new ApiKeyCredentials.ApiKeyCredentials({ inHeader: { 'Ocp-Apim-Subscription-Key': process.env.VISION_KEY } }),
process.env.VISION_ENDPOINT
);
const result = await computerVisionClient.recognizePrintedText(true, url);
const text = result.regions[0].lines[0].words[0].text;
let final = '';
for (let i = 0; i < result.regions.length; i++) {
const region = result.regions[i];
for (let j = 0; j < region.lines.length; j++) {
const line = region.lines[j];
for (let k = 0; k < line.words.length; k++) {
final += `${line.words[k].text} `;
}
}
}
GBLog.info(`GBVision (text): '${final}'`);
return final;
}
public async sortBy({ pid, array, memberName }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
memberName = memberName.trim();
const contentLocale = min.core.getParam(
min.instance,
'Default Content Language',
GBConfigService.get('DEFAULT_CONTENT_LANGUAGE')
);
// Detects data type from the first element of array.
let dt = array[0] ? array[0][memberName] : null;
let date = SystemKeywords.getDateFromLocaleString(pid, dt, contentLocale);
if (date) {
return array
? array.sort((a, b) => {
const c = new Date(a[memberName]);
const d = new Date(b[memberName]);
return c.getTime() - d.getTime();
})
: null;
} else {
return array
? array.sort((a, b) => {
if (a[memberName] < b[memberName]) {
return -1;
}
if (a[memberName] > b[memberName]) {
return 1;
}
return 0;
})
: array;
}
}
public static JSONAsGBTable(data, headers) {
try {
let output = [];
let isObject = false;
if (data[0].gbarray) {
return data;
} // Already GB Table.
if (Array.isArray(data)) {
isObject = Object.keys(data[1]) !== null;
} else {
isObject = true;
}
if (isObject || JSON.parse(data) !== null) {
// Copies data from JSON format into simple array.
if (!Array.isArray(data)) {
// If data is a single object, wrap it in an array
data = [data];
}
// Ensure that keys is an array of strings representing the object keys
const keys = Object.keys(data[0]);
if (headers) {
output[0] = [];
// Copies headers as the first element.
for (let i = 0; i < keys.length; i++) {
output[0][i] = keys[i];
}
} else {
output.push({ gbarray: '0' });
}
for (let i = 0; i < data.length; i++) {
output[i + 1] = [];
for (let j = 0; j < keys.length; j++) {
output[i + 1][j] = data[i][keys[j]];
}
}
return output;
}
} catch (error) {
GBLog.error(error);
return data;
}
}
/**
*
* @param data
* @param renderImage
* @returns
*
* @see http://tabulator.info/examples/5.2
*/
private async renderTable(pid, data, renderPDF, renderImage) {
if (data.length && !data[1]) {
return null;
}
data = SystemKeywords.JSONAsGBTable(data, true);
// Detects if it is a collection with repeated
// headers.
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const gbaiName = DialogKeywords.getGBAIPath(min.botId);
const browser = await GBSSR.createBrowser(null);
const page = await browser.newPage();
await page.minimize();
// Includes the associated CSS related to current theme.
const theme: string = await DialogKeywords.getOption({ pid, name: 'theme', root: true });
switch (theme) {
case 'white':
await page.addStyleTag({ path: 'node_modules/tabulator-tables/dist/css/tabulator_simple.min.css' });
break;
case 'dark':
await page.addStyleTag({ path: 'node_modules/tabulator-tables/dist/css/tabulator_midnight.min.css' });
break;
case 'blue':
await page.addStyleTag({ path: 'node_modules/tabulator-tables/dist/css/tabulator_modern.min.css' });
break;
default:
break;
}
await page.addScriptTag({ path: 'node_modules/tabulator-tables/dist/js/tabulator.min.js' });
// Removes internal hidden element used to hold one-based index arrays.
data.shift();
// Guess fields from data variable into Tabulator fields collection.
let fields = [];
let keys = Object.keys(data[0]);
for (let i = 0; i < keys.length; i++) {
fields.push({ field: keys[i], title: keys[i] });
}
// Adds DIV for Tabulator.
await page.evaluate(() => {
const el = document.createElement('div');
el.setAttribute('id', 'table');
document.body.appendChild(el);
});
const code = `
var table = new Tabulator("#table", {
height:"auto",
layout:"fitDataStretch",
data: ${JSON.stringify(data)},
columns: ${JSON.stringify(fields)}
});
`;
await page.evaluate(code);
await page.waitForSelector('#table');
// Handles image generation.
let url;
let localName;
if (renderImage) {
localName = Path.join('work', gbaiName, 'cache', `img${GBAdminService.getRndReadableIdentifier()}.png`);
await page.screenshot({ path: localName, fullPage: true });
url = urlJoin(GBServer.globals.publicAddress, min.botId, 'cache', Path.basename(localName));
GBLog.info(`BASIC: Table image generated at ${url} .`);
}
// Handles PDF generation.
if (renderPDF) {
localName = Path.join('work', gbaiName, 'cache', `img${GBAdminService.getRndReadableIdentifier()}.pdf`);
url = urlJoin(GBServer.globals.publicAddress, min.botId, 'cache', Path.basename(localName));
let pdf = await page.pdf({ format: 'A4' });
GBLog.info(`BASIC: Table PDF generated at ${url} .`);
}
await browser.close();
return { url, localName };
}
public async closeHandles({ pid }) {
delete this.cachedMerge[pid];
}
public async asPDF({ pid, data }) {
let file = await this.renderTable(pid, data, true, false);
return file;
}
public async asImage({ pid, data }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
// Checks if it is a GBFILE.
if (data.data) {
const gbfile = data.data;
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
const gbaiName = DialogKeywords.getGBAIPath(min.botId);
const tmpDocx = urlJoin(gbaiName, `${botId}.gbdrive`, `tmp${GBAdminService.getRndReadableIdentifier()}.docx`);
// Performs the conversion operation.
await client.api(`${baseUrl}/drive/root:/${tmpDocx}:/content`).put(data.data);
const res = await client.api(`${baseUrl}/drive/root:/${tmpDocx}:/content?format=pdf`).get();
await client.api(`${baseUrl}/drive/root:/${tmpDocx}:/content`).delete();
const streamToBuffer = stream => {
const chunks = [];
return new Promise((resolve, reject) => {
stream.on('data', chunk => chunks.push(chunk));
stream.on('error', reject);
stream.on('end', () => resolve(Buffer.concat(chunks)));
});
};
gbfile.data = await streamToBuffer(res);
// Converts the PDF to PNG.
const pngPages: PngPageOutput[] = await pdfToPng(gbfile.data, {
disableFontFace: false,
useSystemFonts: false,
viewportScale: 2.0,
pagesToProcess: [1],
strictPagesToProcess: false,
verbosityLevel: 0
});
// Prepare an image on cache and return the GBFILE information.
const localName = Path.join('work', gbaiName, 'cache', `img${GBAdminService.getRndReadableIdentifier()}.png`);
if (pngPages.length > 0) {
const buffer = pngPages[0].content;
const url = urlJoin(GBServer.globals.publicAddress, min.botId, 'cache', Path.basename(localName));
Fs.writeFileSync(localName, buffer, { encoding: null });
return { localName: localName, url: url, data: buffer };
}
} else {
let file = await this.renderTable(pid, data, false, true);
return file;
}
}
public async executeSQL({ pid, data, sql, tableName }) {
if (!data || !data[0]) {
return data;
}
let objectMode = false;
if (data[0].gbarray) {
objectMode = true;
}
let first;
if (objectMode) {
first = data.shift();
}
data = alasql(sql, [data]);
if (objectMode) {
data.unshift(first);
}
return data;
}
/**
* Retrives the content of a given URL.
*/
public async getFileContents({ pid, url, headers }) {
const options = {
method: 'GET',
encoding: 'binary',
headers: headers
};
return await fetch(url, options);
}
/**
* Retrives a random id with a length of five, every time it is called.
*/
public getRandomId() {
const idGeneration = '1v'; // TODO: this.dk['idGeneration'];
if (idGeneration && idGeneration.trim().toLowerCase() === 'number') {
return GBAdminService.getNumberIdentifier();
} else {
return GBAdminService.getRndReadableIdentifier().substr(5);
}
}
/**
* Retrives stock inforation for a given symbol.
*/
public async getStock({ pid, symbol }) {
const url = `http://live-nse.herokuapp.com/?symbol=${symbol}`;
let data = await fetch(url);
return data;
}
/**
* Holds script execution for the number of seconds specified.
*
* @example WAIT 5 ' This will wait five seconds.
*
*/
public async wait({ pid, seconds }) {
// tslint:disable-next-line no-string-based-set-timeout
GBLog.info(`BASIC: WAIT for ${seconds} second(s).`);
const timeout = async (ms: number) => new Promise(resolve => setTimeout(resolve, ms));
await timeout(seconds * 1000);
}
/**
* Sends a text message to the mobile number specified.
*
* @example TALK TO "+199988887777", "Message text here"
*
*/
public async talkTo({ pid, mobile, message }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: Talking '${message}' to a specific user (${mobile}) (TALK TO). `);
await min.conversationalService.sendMarkdownToMobile(min, null, mobile, message);
}
/**
* Get a user object from a alias.
*
* @example user = USER "someone"
*
*/
public async getUser({ pid, username }) {
const { min } = await DialogKeywords.getProcessInfo(pid);
let sec = new SecService();
const user = await sec.getUserFromUsername(min.instance.instanceId, username);
return { displayName: user.displayName, mobile: user.userSystemId, email: user.email };
}
/**
* Sends a SMS message to the mobile number specified.
*
* @example SEND SMS TO "+199988887777", "Message text here"
*
*/
public async sendSmsTo({ pid, mobile, message }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: SEND SMS TO '${mobile}', message '${message}'.`);
await min.conversationalService.sendSms(min, mobile, message);
}
/**
* 1. Defines a cell value in the tabular file.
* 2. Defines an element text on HTML page.
*
* @example SET "file.xlsx", "A2", 4500
*
* @example SET page, "elementHTMLSelector", "text"
*
*/
public async set({ pid, handle, file, address, value, name = null }): Promise<any> {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
// Handles calls for HTML stuff
if (handle && WebAutomationServices.isSelector(file)) {
GBLog.info(`BASIC: Web automation SET ${file}' to '${address}' . `);
await new WebAutomationServices().setElementText({ pid, handle, selector: file, text: address });
return;
}
// TODO: Add a semaphore between FILTER and SET.
// Processes FILTER option to ensure parallel SET calls.
const filter = await DialogKeywords.getOption({ pid, name: 'filter' });
if (filter) {
const row = this.find({ pid, handle: null, args: [filter] });
address += row['line'];
}
// Handles calls for BASIC persistence on sheet files.
GBLog.info(`BASIC: Defining '${address}' in '${file}' to '${value}' (SET). `);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
const path = DialogKeywords.getGBAIPath(botId, 'gbdata');
let document = await this.internalGetDocument(client, baseUrl, path, file);
let sheets = await client.api(`${baseUrl}/drive/items/${document.id}/workbook/worksheets`).get();
let body = { values: [[]] };
// Processes FILTER option to ensure parallel SET calls.
let titleAddress;
if (filter) {
// Transforms address number (col index) to letter based.
// Eg.: REM This is A column and index automatically specified by filter.
// SET file.xlsx, 1, 4000
if (KeywordsExpressions.isNumber(address)) {
address = `${this.numberToLetters(address)}`;
titleAddress = `${address}1:${address}1`;
}
// Processes SET FILTER directive to calculate address.
body.values[0][0] = 'id';
const addressId = 'A1:A1';
await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='${addressId}')`
)
.patch(body);
const row = await this.find({ pid, handle: null, args: [file, filter] });
if (row) {
address += row['line']; // Eg.: "A" + 1 = "A1".
}
}
address = address.indexOf(':') !== -1 ? address : address + ':' + address;
if (titleAddress) {
body.values[0][0] = name.trim().replace(/[^a-zA-Z]/gi, '');
await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='${titleAddress}')`
)
.patch(body);
}
body.values[0][0] = value;
await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='${address}')`
)
.patch(body);
}
/**
* Retrives a document from the drive, given a path and filename.
*/
public async internalGetDocument(client: any, baseUrl: any, path: string, file: string) {
let res = await client.api(`${baseUrl}/drive/root:/${path}:/children`).get();
let documents = res.value.filter(m => {
return m.name.toLowerCase() === file.toLowerCase();
});
if (!documents || documents.length === 0) {
throw new Error(
`File '${file}' specified on GBasic command not found. Check the .gbdata or the .gbdialog associated.`,
{ cause: 404 }
);
}
return documents[0];
}
/**
* Saves the content of variable into the file in .gbdata default folder.
*
* @exaple SAVE variable as "my.txt"
*
*/
public async saveFile({ pid, file, data }): Promise<any> {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: Saving '${file}' (SAVE file).`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
const path = DialogKeywords.getGBAIPath(min.botId, `gbdrive`);
// Checks if it is a GB FILE object.
if (data.data && data.filename) {
data = data.data;
}
try {
data = GBServer.globals.files[data].data; // TODO
await client.api(`${baseUrl}/drive/root:/${path}/${file}:/content`).put(data);
} catch (error) {
if (error.code === 'itemNotFound') {
GBLog.info(`BASIC: BASIC source file not found: ${file}.`);
} else if (error.code === 'nameAlreadyExists') {
GBLog.info(`BASIC: BASIC destination file already exists: ${file}.`);
}
throw error;
}
}
/**
* Saves the content of variable into BLOB storage.
*
* @exaple UPLOAD file.
*
*/
public async uploadFile({ pid, file, data }): Promise<any> {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: Saving Blob'${file}' (SAVE file).`);
// Checks if it is a GB FILE object.
if (data.data && data.filename) {
data = data.data;
}
try {
data = GBServer.globals.files[data].data;
const accountName = min.getParam('Blob Account');
const accountKey = min.getParam('Blob Key');
const blobName = min.getParam('Blob Name');
const sharedKeyCredential = new StorageSharedKeyCredential(
accountName,
accountKey
);
const baseUrl = `https://${accountName}.blob.core.windows.net`;
const blobServiceClient = new BlobServiceClient(
`${baseUrl}`,
sharedKeyCredential
);
const container = blobServiceClient.getContainerClient(accountName);
const hash = new Uint8Array(md5.array(data));
const blockBlobClient: BlockBlobClient = container.getBlockBlobClient(blobName);
const res = await blockBlobClient.uploadFile(data.filename,
{
blobHTTPHeaders: {
blobContentMD5: hash
}
});
if (res._response.status === 200 && res.contentMD5 === hash) {
const tmpFile = '';
Fs.rmSync(tmpFile);
}
else {
GBLog.error(`BASIC: BLOB HTTP ${res.errorCode} ${res._response.status} .`);
}
} catch (error) {
if (error.code === 'itemNotFound') {
GBLog.info(`BASIC: BASIC source file not found: ${file}.`);
} else if (error.code === 'nameAlreadyExists') {
GBLog.info(`BASIC: BASIC destination file already exists: ${file}.`);
}
throw error;
}
}
/**
* Takes note inside a notes.xlsx of .gbdata.
*
* @example NOTE "text"
*
*/
public async note({ pid, text }): Promise<any> {
await this.save({ pid, file: "Notes.xlsx", args: [text] });
}
/**
* Saves variables to storage, not a worksheet.
*
*/
public async saveToStorageBatch({ pid, table, rows }): Promise<void> {
const { min } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: Saving batch to storage '${table}' (SAVE).`);
const definition = this.getTableFromName(table, min);
await retry(
async (bail) => {
await definition.bulkCreate(rows);
},
{
retries: 5,
onRetry: (err) => { GBLog.error(`Retrying SaveToStorageBatch due to: ${err.message}.`); }
}
);
}
/**
* Saves variables to storage, not a worksheet.
*
* @example SAVE "Billing", columnName1, columnName2
*
*/
public async saveToStorage({ pid, table, fieldsValues, fieldsNames }): Promise<any> {
const { min } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: Saving to storage '${table}' (SAVE).`);
const definition = this.getTableFromName(table, min);
let dst = {};
// Uppercases fields.
let i = 0;
Object.keys(fieldsValues).forEach(fieldSrc => {
const field = fieldsNames[i].charAt(0).toUpperCase() + fieldsNames[i].slice(1);
dst[field] = fieldsValues[fieldSrc];
i++;
});
let item;
await retry(
async (bail) => {
item = await definition.create(dst);
},
{
retries: 5,
onRetry: (err) => { GBLog.error(`Retrying SaveToStorage due to: ${err.message}.`); }
}
);
return item;
}
public async saveToStorageWithJSON({ pid, table, fieldsValues, fieldsNames }): Promise<any> {
GBLog.info(`BASIC: Saving to storage '${table}' (SAVE).`);
const minBoot = GBServer.globals.minBoot as any;
const definition = minBoot.core.sequelize.models[table];
let out = [];
let data = {}, data2 = {};
// Flattern JSON to a table.
data = this.flattenJSON(fieldsValues, {}, '_')
// Uppercases fields.
Object.keys(data).forEach(field => {
const field2 = field.charAt(0).toUpperCase() + field.slice(1);
data2[field2] = data[field];
});
return await definition.create(data2);
}
/**
* Saves the content of several variables to a new row in a tabular file.
*
* @example SAVE "customers.xlsx", name, email, phone, address, city, state, country
*
*/
public async save({ pid, file, args }): Promise<any> {
const { min } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: Saving '${file}' (SAVE). Args: ${args.join(',')}.`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
const path = DialogKeywords.getGBAIPath(botId, 'gbdata');
let sheets;
let document;
try {
document = await this.internalGetDocument(client, baseUrl, path, file);
sheets = await client.api(`${baseUrl}/drive/items/${document.id}/workbook/worksheets`).get();
} catch (e) {
if (e.cause === 404) {
// Creates the file.
const blank = Path.join(process.env.PWD, 'blank.xlsx');
const data = Fs.readFileSync(blank);
await client.api(`${baseUrl}/drive/root:/${path}/${file}:/content`).put(data);
// Tries to open again.
document = await this.internalGetDocument(client, baseUrl, path, file);
sheets = await client.api(`${baseUrl}/drive/items/${document.id}/workbook/worksheets`).get();
} else {
throw e;
}
}
let address;
let body = { values: [[]] };
// Processes FILTER option to ensure parallel SET calls.
const filter = await DialogKeywords.getOption({ pid, name: 'filter' });
if (filter) {
// Creates id row.
body.values[0][0] = 'id';
const addressId = 'A1:A1';
await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='${addressId}')`
)
.patch(body);
body.values[0][0] = undefined;
// FINDs the filtered row to be updated.
const row = await this.find({ pid, handle: null, args: [file, filter] });
if (row) {
address = `A${row['line']}:${this.numberToLetters(args.length)}${row['line']}`;
}
}
// Editing or saving detection.
if (!address) {
await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='A2:DX2')/insert`
)
.post({});
address = `A2:${this.numberToLetters(args.length - 1)}2`;
}
// Fills rows object to call sheet API.
for (let index = 0; index < args.length; index++) {
let value = args[index];
if (value && (await this.isValidDate({ pid, dt: value }))) {
value = `'${value}`;
}
// If filter is defined, skips id column.
body.values[0][filter ? index + 1 : index] = value;
}
await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='${address}')`
)
.patch(body);
}
/**
* Retrives the content of a cell in a tabular file.
*
* @example value = GET "file.xlsx", "A2"
*
*/
public async getHttp({ pid, file, addressOrHeaders, httpUsername, httpPs, qs, streaming }): Promise<any> {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
if (file.startsWith('http')) {
return await this.getByHttp({
pid,
url: file,
headers: addressOrHeaders,
username: httpUsername,
ps: httpPs,
qs
});
} else {
GBLog.info(`BASIC: GET '${addressOrHeaders}' in '${file}'.`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
('');
const path = DialogKeywords.getGBAIPath(botId, 'gbdata');
let document = await this.internalGetDocument(client, baseUrl, path, file);
// Creates workbook session that will be discarded.
let sheets = await client.api(`${baseUrl}/drive/items/${document.id}/workbook/worksheets`).get();
let results = await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='${addressOrHeaders}')`
)
.get();
let val = results.text[0][0];
GBLog.info(`BASIC: Getting '${file}' (GET). Value= ${val}.`);
return val;
}
}
public async isValidDate({ pid, dt }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const contentLocale = min.core.getParam(
min.instance,
'Default Content Language',
GBConfigService.get('DEFAULT_CONTENT_LANGUAGE')
);
let date = SystemKeywords.getDateFromLocaleString(pid, dt, contentLocale);
if (!date) {
return false;
}
if (!(date instanceof Date)) {
date = new Date(date);
}
return !isNaN(date.valueOf());
}
public async isValidNumber({ pid, number }) {
return KeywordsExpressions.isNumber(number);
}
public isValidHour({ pid, value }) {
return /^([01]?[0-9]|2[0-3]):[0-5][0-9]$/.test(value);
}
/**
* Finds a value or multi-value results in a tabular file.
*
* @example
*
* rows = FIND "file.xlsx", "A2=active", "A2 < 12/06/2010 15:00"
* i = 1
* do while i <= ubound(row)
* row = rows[i]
* send sms to "+" + row.mobile, "Hello " + row.name + "! "
* loop
* @see NPM package data-forge
*
*/
public async find({ pid, handle, args }): Promise<any> {
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
const file = args[0];
args.shift();
const botId = min.instance.botId;
const path = DialogKeywords.getGBAIPath(botId, 'gbdata');
// MAX LINES property.
let maxLines = 5000;
if (params && params.maxLines) {
if (params.maxLines.toString().toLowerCase() !== 'default') {
maxLines = Number.parseInt(params.maxLines).valueOf();
}
} else {
maxLines = maxLines;
}
GBLog.info(`BASIC: FIND running on ${file} (maxLines: ${maxLines}) and args: ${JSON.stringify(args)}...`);
// Choose data sources based on file type (HTML Table, data variable or sheet file)
let results;
let header, rows;
let page;
if (handle) {
page = WebAutomationServices.getPageByHandle(handle);
}
if (handle && page['$eval'] && WebAutomationServices.isSelector(file)) {
const container = page['frame'] ? page['frame'] : page;
const originalSelector = file;
// Transforms table
const resultH = await container.evaluate(originalSelector => {
const rows = document.querySelectorAll(`${originalSelector} tr`);
return Array.from(rows, row => {
const columns = row.querySelectorAll('th');
return Array.from(columns, column => column.innerText);
});
}, originalSelector);
const result = await container.evaluate(originalSelector => {
const rows = document.querySelectorAll(`${originalSelector} tr`);
return Array.from(rows, row => {
const columns = row.querySelectorAll('td');
return Array.from(columns, column => column.innerText);
});
}, originalSelector);
header = [];
for (let i = 0; i < resultH[0].length; i++) {
header[i] = resultH[0][i];
}
rows = [];
rows[0] = header;
for (let i = 1; i < result.length; i++) {
rows[i] = result[i];
}
} else if (file['cTag']) {
const gbaiName = DialogKeywords.getGBAIPath(min.botId);
const localName = Path.join('work', gbaiName, 'cache', `csv${GBAdminService.getRndReadableIdentifier()}.csv`);
const url = file['@microsoft.graph.downloadUrl'];
const response = await fetch(url);
Fs.writeFileSync(localName, Buffer.from(await response.arrayBuffer()), { encoding: null });
var workbook = new Excel.Workbook();
const worksheet = await workbook.csv.readFile(localName);
header = [];
rows = [];
for (let i = 0; i < worksheet.rowCount; i++) {
const r = worksheet.getRow(i + 1);
let outRow = [];
for (let j = 0; j < r.cellCount; j++) {
outRow.push(r.getCell(j + 1).text);
}
if (i == 0) {
header = outRow;
} else {
rows.push(outRow);
}
}
} else {
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
let document;
document = await this.internalGetDocument(client, baseUrl, path, file);
// Creates workbook session that will be discarded.
let sheets = await client.api(`${baseUrl}/drive/items/${document.id}/workbook/worksheets`).get();
results = await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='A1:CZ${maxLines}')`
)
.get();
header = results.text[0];
rows = results.text;
}
let getFilter = async text => {
let filter;
const operators = [/\<\=/, /\<\>/, /\>\=/, /\</, /\>/, /\bnot in\b/, /\bin\b/, /\=/];
let done = false;
await CollectionUtil.asyncForEach(operators, async op => {
var re = new RegExp(op, 'gi');
const parts = text.split(re);
if (parts.length === 2 && !done) {
filter = {
columnName: parts[0].trim(),
operator: op.toString().replace(/\\b/g, '').replace(/\//g, '').replace(/\\/g, '').replace(/\b/g, ''),
value: parts[1].trim()
};
// Swaps values and names in case of IN operators.
if (filter.operator === 'not in' || filter.operator === 'in') {
const columnName = filter.columnName;
filter.columnName = filter.value;
filter.value = columnName;
}
done = true;
}
});
return filter;
};
const contentLocale = min.core.getParam(
min.instance,
'Default Content Language',
GBConfigService.get('DEFAULT_CONTENT_LANGUAGE')
);
// Increments columnIndex by looping until find a column match.
const filters = [];
let predefinedFilterTypes;
if (params.filterTypes) {
predefinedFilterTypes = params.filterTypes.split(',');
}
let filterIndex = 0;
await CollectionUtil.asyncForEach(args, async arg => {
const filter = await getFilter(arg);
if (!filter) {
throw new Error(`BASIC: FIND filter has an error: ${arg} check this and publish .gbdialog again.`);
}
let columnIndex = 0;
for (; columnIndex < header.length; columnIndex++) {
if (header[columnIndex].toLowerCase() === filter.columnName.toLowerCase()) {
break;
}
}
filter.columnIndex = columnIndex;
const fixed = predefinedFilterTypes ? predefinedFilterTypes[filterIndex] : null;
if (this.isValidHour(filter.value)) {
filter.dataType = fixed ? fixed : 'hourInterval';
} else if (await this.isValidDate({ pid, dt: filter.value })) {
filter.value = SystemKeywords.getDateFromLocaleString(pid, filter.value, contentLocale);
filter.dataType = fixed ? fixed : 'date';
} else if (await this.isValidNumber({ pid, number: filter.value })) {
filter.value = Number.parseInt(filter.value);
filter.dataType = fixed ? fixed : 'number';
} else {
filter.value = filter.value;
filter.dataType = fixed ? fixed : 'string';
}
filters.push(filter);
filterIndex++;
});
// As BASIC uses arrays starting with 1 (one) as index,
// a ghost element is added at 0 (zero) position.
let table = [];
table.push({ gbarray: '0' });
let foundIndex = 1;
// Fills the row variable.
let rowCount = 0;
for (; foundIndex < rows.length; foundIndex++) {
let filterAcceptCount = 0;
await CollectionUtil.asyncForEach(filters, async filter => {
let result = rows[foundIndex][filter.columnIndex];
let wholeWord = true;
if (user && params && params.wholeWord) {
wholeWord = params.wholeWord;
}
if (!result) {
return;
}
switch (filter.dataType) {
case 'string':
const v1 = GBConversationalService.removeDiacritics(result.toLowerCase().trim());
const v2 = GBConversationalService.removeDiacritics(filter.value.toLowerCase().trim());
switch (filter.operator) {
case '=':
if (wholeWord) {
if (v1 === v2) {
filterAcceptCount++;
}
} else {
if (v1.indexOf(v2) > -1) {
filterAcceptCount++;
}
}
break;
case '<>':
if (wholeWord) {
if (v1 !== v2) {
filterAcceptCount++;
}
} else {
if (v1.indexOf(v2) === -1) {
filterAcceptCount++;
}
}
break;
case 'not in':
if (wholeWord) {
if (v1 !== v2) {
filterAcceptCount++;
}
} else {
if (v1.indexOf(v2) === -1) {
filterAcceptCount++;
}
}
break;
case 'in':
if (wholeWord) {
if (v1 === v2) {
filterAcceptCount++;
}
} else {
if (v1.indexOf(v2) > -1) {
filterAcceptCount++;
}
}
break;
}
break;
case 'number':
switch (filter.operator) {
case '=':
if (Number.parseInt(result) === filter.value) {
filterAcceptCount++;
}
break;
}
break;
case 'hourInterval':
switch (filter.operator) {
case '=':
if (v1 === v2) {
filterAcceptCount++;
}
break;
case 'in':
const e = result.split(';');
const hr = Number.parseInt(filter.value.split(':')[0]);
let lastHour = Number.parseInt(e[0]);
let found = false;
await CollectionUtil.asyncForEach(e, async hour => {
if (!found && lastHour <= hr && hr <= hour) {
filterAcceptCount++;
found = true;
}
lastHour = hour;
});
break;
}
break;
case 'date':
if (result.charAt(0) === "'") {
result = result.substr(1);
}
const resultDate = SystemKeywords.getDateFromLocaleString(pid, result, contentLocale);
if (resultDate) {
if (filter.value['dateOnly']) {
resultDate.setHours(0, 0, 0, 0);
}
switch (filter.operator) {
case '=':
if (resultDate.getTime() == filter.value.getTime()) filterAcceptCount++;
break;
case '<':
if (resultDate.getTime() < filter.value.getTime()) filterAcceptCount++;
break;
case '>':
if (resultDate.getTime() > filter.value.getTime()) filterAcceptCount++;
break;
case '<=':
if (resultDate.getTime() <= filter.value.getTime()) filterAcceptCount++;
break;
case '>=':
if (resultDate.getTime() >= filter.value.getTime()) filterAcceptCount++;
break;
}
break;
}
}
});
if (filterAcceptCount === filters.length) {
rowCount++;
let row = {};
const xlRow = rows[foundIndex];
for (let colIndex = 0; colIndex < xlRow.length; colIndex++) {
const propertyName = header[colIndex];
let value = xlRow[colIndex];
if (value && value.charAt(0) === "'") {
if (await this.isValidDate({ pid, dt: value.substr(1) })) {
value = value.substr(1);
}
}
row[propertyName] = value;
}
row['ordinal'] = rowCount;
row['line'] = foundIndex + 1;
table.push(row);
}
}
const outputArray = await DialogKeywords.getOption({ pid, name: 'output' });
if (table.length === 1) {
GBLog.info(`BASIC: FIND returned no results (zero rows).`);
return null;
} else if (table.length === 2 && !outputArray) {
GBLog.info(`BASIC: FIND returned single result: ${table[0]}.`);
return table[1];
} else {
GBLog.info(`BASIC: FIND returned multiple results (Count): ${table.length - 1}.`);
return table;
}
}
public static getDateFromLocaleString(pid, date: any, contentLocale: any) {
let ret = null;
let parts = /^([0-3]?[0-9]).([0-3]?[0-9]).((?:[0-9]{2})?[0-9]{2})\s*(10|11|12|0?[1-9]):([0-5][0-9])/gi.exec(date);
if (parts && parts[5]) {
switch (contentLocale) {
case 'pt':
ret = new Date(
Number.parseInt(parts[3]),
Number.parseInt(parts[2]) - 1,
Number.parseInt(parts[1]),
Number.parseInt(parts[4]),
Number.parseInt(parts[5]),
0,
0
);
break;
case 'en':
ret = new Date(
Number.parseInt(parts[3]),
Number.parseInt(parts[1]) - 1,
Number.parseInt(parts[2]),
Number.parseInt(parts[4]),
Number.parseInt(parts[5]),
0,
0
);
break;
}
ret['dateOnly'] = false;
}
parts = /^([0-3]?[0-9]).([0-3]?[0-9]).((?:[0-9]{2})?[0-9]{2})$/gi.exec(date);
if (parts && parts[3]) {
switch (contentLocale) {
case 'pt':
ret = new Date(
Number.parseInt(parts[3]),
Number.parseInt(parts[2]) - 1,
Number.parseInt(parts[1]),
0,
0,
0,
0
);
break;
case 'en':
ret = new Date(
Number.parseInt(parts[3]),
Number.parseInt(parts[1]) - 1,
Number.parseInt(parts[2]),
0,
0,
0,
0
);
break;
}
ret['dateOnly'] = true;
}
return ret;
}
/**
* Creates a folder in the bot instance drive.
*
* @example folder = CREATE FOLDER "notes\01"
*
*/
public async createFolder({ pid, name }) {
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
let path = DialogKeywords.getGBAIPath(min.botId, `gbdrive`);
// Extracts each part of path to call create folder to each
// one of them.
name = name.replace(/\\/gi, '/');
const parts = name.split('/');
let lastFolder = null;
// Creates each subfolder.
await CollectionUtil.asyncForEach(parts, async item => {
// Calls drive API.
const body = {
name: item,
folder: {},
'@microsoft.graph.conflictBehavior': 'fail'
};
try {
lastFolder = await client.api(`${baseUrl}/drive/root:/${path}:/children`).post(body);
} catch (error) {
if (error.code !== 'nameAlreadyExists') {
throw error;
} else {
lastFolder = await client.api(`${baseUrl}/drive/root:/${urlJoin(path, item)}`).get();
}
}
// Increments path to the next child be created.
path = urlJoin(path, item);
});
return lastFolder;
}
/**
* Shares a folder from the drive to a e-mail recipient.
*
* @example
*
* folder = CREATE FOLDER "notes\10"
* SHARE FOLDER folder, "nome@domain.com", "E-mail message"
*
*/
public async shareFolder({ pid, folder, email, message }) {
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const path = DialogKeywords.getGBAIPath(min.botId, `gbdrive`);
const root = urlJoin(path, folder);
const src = await client.api(`${baseUrl}/drive/root:/${root}`).get();
const driveId = src.parentReference.driveId;
const itemId = src.id;
const body = {
recipients: [{ email: email }],
message: message,
requireSignIn: true,
sendInvitation: true,
roles: ['write']
};
await client.api(`https://graph.microsoft.com/v1.0/drives/${driveId}/items/${itemId}/invite`).post(body);
}
public async internalCreateDocument(min, path, content) {
GBLog.info(`BASIC: CREATE DOCUMENT '${path}...'`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const gbaiName = DialogKeywords.getGBAIPath(min.botId);
const tmpDocx = urlJoin(gbaiName, path);
// Templates a blank {content} tag inside the blank.docx.
const blank = Path.join(process.env.PWD, 'blank.docx');
let buf = Fs.readFileSync(blank);
let zip = new PizZip(buf);
let doc = new Docxtemplater();
doc.setOptions({ linebreaks: true });
doc.loadZip(zip);
doc.setData({ content: content }).render();
buf = doc.getZip().generate({ type: 'nodebuffer', compression: 'DEFLATE' });
// Performs the upload.
await client.api(`${baseUrl}/drive/root:/${tmpDocx}:/content`).put(buf);
}
public async createDocument({ pid, path, content }) {
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
this.internalCreateDocument(min, path, content);
}
/**
* Copies a drive file from a place to another .
*
* @example
*
* COPY "template.xlsx", "reports\" + customerName + "\final.xlsx"
*
*/
public async copyFile({ pid, src, dest }) {
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: BEGINING COPY '${src}' to '${dest}'`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
// Normalizes all slashes.
src = src.replace(/\\/gi, '/');
dest = dest.replace(/\\/gi, '/');
// Determines full path at source and destination.
const root = DialogKeywords.getGBAIPath(botId, 'gbdrive');
const srcPath = urlJoin(root, src);
const dstPath = urlJoin(root, dest);
// Checks if the destination contains subfolders that
// need to be created.
let folder;
if (dest.indexOf('/') !== -1) {
const pathOnly = Path.dirname(dest);
folder = await this.createFolder({ pid, name: pathOnly });
} else {
folder = await client.api(`${baseUrl}/drive/root:/${root}`).get();
}
// Performs the copy operation getting a reference
// to the source and calling /copy on drive API.
try {
const srcFile = await client.api(`${baseUrl}/drive/root:/${srcPath}`).get();
const destFile = {
parentReference: { driveId: folder.parentReference.driveId, id: folder.id },
name: `${Path.basename(dest)}`
};
const file = await client.api(`${baseUrl}/drive/items/${srcFile.id}/copy`).post(destFile);
GBLog.info(`BASIC: FINISHED COPY '${src}' to '${dest}'`);
return file;
} catch (error) {
if (error.code === 'itemNotFound') {
GBLog.info(`BASIC: COPY source file not found: ${srcPath}.`);
} else if (error.code === 'nameAlreadyExists') {
GBLog.info(`BASIC: COPY destination file already exists: ${dstPath}.`);
}
throw error;
}
}
/**
* Converts a drive file from a place to another .
*
* Supported sources csv, doc, docx, odp, ods, odt, pot, potm, potx, pps,
* ppsx, ppsxm, ppt, pptm, pptx, rtf, xls, xlsx
*
* @example
*
* CONVERT "customers.xlsx" TO "reports\" + today + ".pdf"
*
*/
public async convert({ pid, src, dest }) {
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
GBLog.info(`BASIC: CONVERT '${src}' to '${dest}'`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const botId = min.instance.botId;
// Normalizes all slashes.
src = src.replace(/\\/gi, '/');
dest = dest.replace(/\\/gi, '/');
// Determines full path at source and destination.
const path = DialogKeywords.getGBAIPath(min.botId, `gbdrive`);
const root = path;
const srcPath = urlJoin(root, src);
const dstPath = urlJoin(path, dest);
// Checks if the destination contains subfolders that
// need to be created.
let folder;
if (dest.indexOf('/') !== -1) {
const pathOnly = Path.dirname(dest);
folder = await this.createFolder({ pid, name: pathOnly });
} else {
folder = await client.api(`${baseUrl}/drive/root:/${root}`).get();
}
// Performs the conversion operation getting a reference
// to the source and calling /content on drive API.
try {
const res = await client.api(`${baseUrl}/drive/root:/${srcPath}:/content?format=pdf`).get();
const streamToBuffer = stream => {
const chunks = [];
return new Promise((resolve, reject) => {
stream.on('data', chunk => chunks.push(chunk));
stream.on('error', reject);
stream.on('end', () => resolve(Buffer.concat(chunks)));
});
};
const result = await streamToBuffer(res);
await client.api(`${baseUrl}/drive/root:/${dstPath}:/content`).put(result);
} catch (error) {
if (error.code === 'itemNotFound') {
GBLog.info(`BASIC: CONVERT source file not found: ${srcPath}.`);
} else if (error.code === 'nameAlreadyExists') {
GBLog.info(`BASIC: CONVERT destination file already exists: ${dstPath}.`);
}
throw error;
}
}
/**
* Generate a secure and unique password.
*
* @example pass = PASSWORD
*
*/
public generatePassword(pid) {
return GBAdminService.getRndPassword();
}
private flattenJSON(obj, res, extraKey, hierarchy = false) {
for (let key in obj) {
if (typeof obj[key] === 'function') {
continue;
}
if (typeof obj[key] !== 'object' || obj[key] instanceof Date) {
// If not defined already add the flattened field.
const newKey = `${hierarchy ? extraKey : ''}${key}`;
if (!res[newKey]) {
res[newKey] = obj[key];
}
else {
GBLog.verbose(`Ignoring duplicated field in flatten operation to storage: ${key}.`);
}
} else {
obj[key] = this.flattenJSON(obj[key], res, `${key}${extraKey}`, true);
};
};
return res;
}
public async getCustomToken({ pid, token }): Promise<string> {
const { min } = await DialogKeywords.getProcessInfo(pid);
GBLogEx.info(min, `GET TOKEN: ${token}`);
return await (min.adminService as any)['acquireElevatedToken']
(min.instance.instanceId, false,
token,
min.core.getParam(min.instance, `${token} Client ID`, null),
min.core.getParam(min.instance, `${token} Client Secret`, null),
min.core.getParam(min.instance, `${token} Host`, null),
min.core.getParam(min.instance, `${token} Tenant`, null)
);
}
/**
* Calls any REST API by using GET HTTP method.
*
* @example user = get "http://server/users/1"
*
*/
public async getByHttp({ pid, url, headers, username, ps, qs }) {
let options = {};
const { min, user, params, proc } = await DialogKeywords.getProcessInfo(pid);
GBLogEx.info(min, `GET: ${url}`);
let pageMode = await DialogKeywords.getOption({ pid, name: 'pageMode' });
let continuationToken = await
DialogKeywords.getOption({ pid, name: `${proc.executable}-continuationToken` });
if (pageMode === "auto" && continuationToken) {
headers = headers ? headers : {};
headers['MS-ContinuationToken'] = continuationToken;
}
if (headers) {
options['headers'] = headers;
}
if (username) {
options['auth'] = {
user: username,
pass: ps
};
}
if (qs) {
options['qs'] = qs;
}
let result;
await retry(
async (bail) => {
result = await fetch(url, options);
const sleep = ms => {
return new Promise(resolve => {
setTimeout(resolve, ms);
});
};
if (result.status === 429 || result.status === 401) {
GBLog.info(`Waiting 1min. before retrynig GET: ${url}.`);
await sleep(60 * 1000);
throw new Error(`BASIC: HTTP:${result.status} retry: ${result.statusText}.`);
}
if (result.status === 2000) {
// Token expired.
await DialogKeywords.setOption({ pid, name: `${proc.executable}-continuationToken`, value: null });
bail(new Error(`Expired Token for ${url}.`));
}
if (result.status != 200) {
throw new Error(`BASIC: GET ${result.status}: ${result.statusText}.`);
}
},
{
retries: 5,
onRetry: (err) => { GBLog.error(`Retrying HTTP GET due to: ${err.message}.`); }
}
);
let res = JSON.parse(await result.text());
function process(key, value, o) {
if (value === '0000-00-00') {
o[key] = null;
}
}
function traverse(o, func) {
for (var i in o) {
func.apply(this, [i, o[i], o]);
if (o[i] !== null && typeof (o[i]) == "object") {
traverse(o[i], func);
}
}
}
traverse(res, process);
if (pageMode === "auto") {
continuationToken = res.next?.headers['MS-ContinuationToken'];
if (continuationToken) {
GBLog.info(`Updating continuationToken for ${url}.`);
await DialogKeywords.setOption({ pid, name: 'continuationToken', value: continuationToken });
}
}
else {
pageMode = "none";
}
if (res) { res['pageMode'] = pageMode; }
return res;
}
/**
* Calls any REST API by using POST HTTP method.
*
* @example
*
* user = put "http://server/path", "data"
* talk "The updated user area is" + area
*
*/
public async putByHttp({ pid, url, data, headers }) {
const options = {
json: data,
headers: headers
};
let result = await fetch(url, options);
GBLog.info(`[PUT]: ${url} (${data}): ${result}`);
return typeof result === 'object' ? result : JSON.parse(result);
}
/**
* Calls any REST API by using POST HTTP method.
*
* @example
*
* user = post "http://server/path", "data"
* talk "The updated user area is" + area
*
*/
public async postByHttp({ pid, url, data, headers }) {
const options = {
headers: headers,
method: 'POST'
};
if (typeof (data) === 'object') {
options['json'] = data;
}
else {
options['body'] = data;
}
let result = await fetch(url, options);
const text = await result.text();
GBLog.info(`BASIC: POST ${url} (${data}): ${text}`);
if (result.status != 200) {
throw new Error(`BASIC: POST ${result.status}: ${result.statusText}.`)
}
let res = JSON.parse(text);
return res;
}
public async numberOnly({ pid, text }) {
return text.replace(/\D/gi, '');
}
//Create a CREAT LEAD keyword
public async createLead({ pid, templateName, data }) {
//OAuth Token Endpoint (from your Azure App Registration)
const authorityUrl = 'https://login.microsoftonline.com/<COPY A GUID HERE>';
const msalConfig = {
auth: {
authority: authorityUrl,
clientId: process.env.DYNAMICS_CLIENTID,
clientSecret: process.env.DYNAMICS_CLIENTSECRET,
knownAuthorities: ['login.microsoftonline.com']
}
};
const cca = new MSAL.ConfidentialClientApplication(msalConfig);
const serverUrl = ` `;
//function that acquires a token and passes it to DynamicsWebApi
const acquireToken = dynamicsWebApiCallback => {
cca
.acquireTokenByClientCredential({
scopes: [`${serverUrl}/.default`]
})
.then(response => {
//call DynamicsWebApi callback only when a token has been retrieved successfully
dynamicsWebApiCallback(response.accessToken);
})
.catch(error => {
console.log(JSON.stringify(error));
});
};
//create DynamicsWebApi
const dynamicsWebApi = new DynamicsWebApi({
webApiUrl: `${serverUrl}/api/data/v9.2/`,
onTokenRefresh: acquireToken
});
//initialize a CRM entity record object
var lead = {
subject: 'Test WebAPI',
firstname: 'Test',
lastname: 'WebAPI',
jobtitle: 'Title'
};
//call dynamicsWebApi.create function
dynamicsWebApi
.create(lead, 'leads')
.then(function (id) {
//do something with id here
})
.catch(function (error) {
//catch error here
});
}
/**
*
* Fills a .docx or .pptx with template data.
*
* doc = FILL "templates/template.docx", data
*
*/
public async fill({ pid, templateName, data }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const botId = min.instance.botId;
const gbaiName = DialogKeywords.getGBAIPath(botId, 'gbdata');
let localName;
// Downloads template from .gbdrive.
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
let path = '/' + urlJoin(gbaiName, `${botId}.gbdrive`);
let template = await this.internalGetDocument(client, baseUrl, path, templateName);
let url = template['@microsoft.graph.downloadUrl'];
const res = await fetch(url);
let buf: any = Buffer.from(await res.arrayBuffer());
localName = Path.join('work', gbaiName, 'cache', `tmp${GBAdminService.getRndReadableIdentifier()}.docx`);
Fs.writeFileSync(localName, buf, { encoding: null });
// Replace image path on all elements of data.
const images = [];
let index = 0;
path = Path.join(gbaiName, 'cache', `tmp${GBAdminService.getRndReadableIdentifier()}.docx`);
url = urlJoin(GBServer.globals.publicAddress, min.botId, 'cache', Path.basename(localName));
const traverseDataToInjectImageUrl = async o => {
for (var i in o) {
let value = o[i];
if (value && value.gbarray) {
o.shift();
value = o[i];
}
for (const kind of ['png', 'jpg', 'jpeg']) {
if (value.endsWith && value.endsWith(`.${kind}`)) {
const { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
path = urlJoin(gbaiName, `${botId}.gbdrive`);
if (value.indexOf('/') !== -1) {
path = '/' + urlJoin(path, Path.dirname(value));
value = Path.basename(value);
}
const ref = await this.internalGetDocument(client, baseUrl, path, value);
let url = ref['@microsoft.graph.downloadUrl'];
const imageName = Path.join(
'work',
gbaiName,
'cache',
`tmp${GBAdminService.getRndReadableIdentifier()}-${value}.png`
);
const response = await fetch(url);
const buf = Buffer.from(await response.arrayBuffer());
Fs.writeFileSync(imageName, buf, { encoding: null });
const getNormalSize = ({ width, height, orientation }) => {
return (orientation || 0) >= 5 ? [height, width] : [width, height];
};
const size = getNormalSize(await sharp(buf).metadata());
url = urlJoin(GBServer.globals.publicAddress, min.botId, 'cache', Path.basename(imageName));
images[index++] = { url: url, size: size, buf: buf };
}
}
if (o[i] !== null && typeof o[i] == 'object') {
await traverseDataToInjectImageUrl(o[i]);
}
}
};
let indexImage = 0;
var opts = {
fileType: 'docx',
centered: false,
getImage: (tagValue, tagName) => {
return images[indexImage].buf;
},
getSize: (img, tagValue, tagName) => {
return images[indexImage++].size;
}
};
// Loads the file as binary content.
let zip = new PizZip(buf);
let doc = new Docxtemplater();
doc.setOptions({ paragraphLoop: true, linebreaks: true });
doc.loadZip(zip);
if (localName.endsWith('.pptx')) {
doc.attachModule(pptxTemplaterModule);
}
doc.attachModule(new ImageModule(opts));
await traverseDataToInjectImageUrl(data);
doc.setData(data).render();
buf = doc.getZip().generate({ type: 'nodebuffer', compression: 'DEFLATE' });
Fs.writeFileSync(localName, buf, { encoding: null });
return { localName: localName, url: url, data: buf };
}
public screenCapture(pid) {
// scrcpy Disabled
// function captureImage({ x, y, w, h }) {
// const pic = robot.screen.capture(x, y, w, h)
// const width = pic.byteWidth / pic.bytesPerPixel // pic.width is sometimes wrong!
// const height = pic.height
// const image = new Jimp(width, height)
// let red, green, blue
// pic.image.forEach((byte, i) => {
// switch (i % 4) {
// case 0: return blue = byte
// case 1: return green = byte
// case 2: return red = byte
// case 3:
// image.bitmap.data[i - 3] = red
// image.bitmap.data[i - 2] = green
// image.bitmap.data[i - 1] = blue
// image.bitmap.data[i] = 255
// }
// })
// return image
// }
// let file = 'out.png';
// captureImage({ x: 60, y: 263, w: 250, h: 83 }).write(file)
// const config = {
// lang: "eng",
// oem: 1,
// psm: 3,
// }
// tesseract.recognize(file, config).then(value => {
// console.log(value);
// });
}
private numberToLetters(num) {
let letters = '';
while (num >= 0) {
letters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'[num % 26] + letters;
num = Math.floor(num / 26) - 1;
}
return letters;
}
private getTableFromName(file, min) {
const minBoot = GBServer.globals.minBoot;
const parts = file.split('.');
const con = min[parts[0]];
if (con) {
return con.models[parts[1]];
} else {
return minBoot.core.sequelize.models[file];
}
}
private cachedMerge = {};
/**
* Merges a multi-value with a tabular file using BY field as key.
*
* @example
*
* data = FIND first.xlsx
* MERGE "second.xlsx" WITH data BY customer_id
*
*/
public async merge({ pid, file, data, key1, key2 }): Promise<any> {
GBLog.info(`BASIC: MERGE running on ${file} and key1: ${key1}, key2: ${key2}...`);
if (!this.cachedMerge[pid]) {
this.cachedMerge[pid] = { file: {} }
}
if (!data) {
GBLog.info(`BASIC: MERGE running on ${file}: NO DATA.`);
return data;
}
const { min, user, params } = await DialogKeywords.getProcessInfo(pid);
// Check if is a tree or flat object.
const hasSubObject = (t) => {
for (var key in t) {
if (!t.hasOwnProperty(key)) continue;
if (typeof t[key] === "object") return true;
}
return false;
}
// MAX LINES property.
let maxLines = 1000;
if (user && params && params.maxLines) {
if (params.maxLines.toString().toLowerCase() !== 'default') {
maxLines = Number.parseInt(params.maxLines).valueOf();
}
}
// Choose data sources based on file type (HTML Table, data variable or sheet file)
let storage = file.indexOf('.xlsx') === -1;
let results;
let header = [], rows = [];
let t;
let fieldsNames = [];
let fieldsSizes = [];
let fieldsValuesList = [];
if (storage) {
t = this.getTableFromName(file, min);
if (!t) {
throw new Error(`TABLE ${file} not found. Check TABLE keywords.`);
}
Object.keys(t.fieldRawAttributesMap).forEach(e => {
fieldsNames.push(e);
})
Object.keys(t.fieldRawAttributesMap).forEach(e => {
fieldsSizes.push(t.fieldRawAttributesMap[e].size);
})
header = Object.keys(t.fieldRawAttributesMap);
if (!this.cachedMerge[pid][file]) {
await retry(
async (bail) => {
let rows = [];
const paginate = (query, { page, pageSize }) => {
const offset = page * pageSize;
const limit = pageSize;
return {
...query,
offset,
limit,
};
};
let page = 0, pageSize = 1000;
let count = 0;
do {
rows = [
await t.findAll(
paginate(
{
where: {},
},
{ page, pageSize },
),
), ...rows];
count = rows.length;
} while (count !== 1000)
},
{
retries: 5,
onRetry: (err) => { GBLog.error(`MERGE: Retrying SELECT ALL on table: ${err.message}.`); }
}
);
}
else {
rows = this.cachedMerge[pid][file];
}
} else {
const botId = min.instance.botId;
const path = DialogKeywords.getGBAIPath(botId, 'gbdata');
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
let document;
document = await this.internalGetDocument(client, baseUrl, path, file);
// Creates workbook session that will be discarded.
let sheets = await client.api(`${baseUrl}/drive/items/${document.id}/workbook/worksheets`).get();
results = await client
.api(
`${baseUrl}/drive/items/${document.id}/workbook/worksheets('${sheets.value[0].name}')/range(address='A1:CZ${maxLines}')`
)
.get();
header = results.text[0];
rows = results.text;
}
let table = [];
let foundIndex = 0;
// Fills the row variable on the base dataset.
if (!storage || !this.cachedMerge[pid][file]) {
for (; foundIndex < rows.length; foundIndex++) {
let row = {};
const tmpRow = rows[foundIndex];
row = tmpRow.dataValues ? tmpRow.dataValues : tmpRow;
for (let colIndex = 0; colIndex < tmpRow.length; colIndex++) {
const propertyName = header[colIndex];
let value = tmpRow[colIndex];
if (value && value.charAt(0) === "'") {
if (await this.isValidDate({ pid, dt: value.substr(1) })) {
value = value.substr(1);
}
}
row[propertyName] = value;
}
row['line'] = foundIndex + 1;
table.push(row);
}
if (storage) {
this.cachedMerge[pid][file] = table;
}
}
else {
table = this.cachedMerge[pid][file];
}
let key1Index, key2Index;
if (key1) {
key1Index = _.invertBy(table, key1);
}
if (key2) {
key2Index = _.invertBy(table, key2);
}
let merges = 0,
adds = 0, skipped = 0;
// Scans all items in incoming data.
for (let i = 0; i < data.length; i++) {
// Scans all sheet lines and compare keys.
let row = data[i];
if (hasSubObject(row)) {
row = this.flattenJSON(row, {}, '_', false);
}
let found;
let key1Value;
let key1Original = key1;
if (key1Index) {
key1 = key1.charAt(0).toLowerCase() + key1.slice(1);
Object.keys(row).forEach(e => {
if (e.toLowerCase() === key1.toLowerCase()) {
key1Value = row[e];
}
});
const foundRow = key1Index[key1Value];
if (foundRow) {
found = table[foundRow[0]];
}
}
if (found) {
let merge = false;
for (let j = 0; j < header.length; j++) {
const columnName = header[j];
let columnNameFound = false;
let value;
Object.keys(row).forEach(e => {
if (columnName.toLowerCase() === e.toLowerCase()) {
value = row[e];
columnNameFound = true;
}
});
if (value === undefined) { value = null; }
let valueFound;
Object.keys(found).forEach(e => {
if (columnName.toLowerCase() === e.toLowerCase()) {
valueFound = found[e];
}
});
if (value != valueFound && columnNameFound) {
if (storage) {
let obj = {};
obj[columnName] = value;
let criteria = {};
criteria[key1Original] = key1Value;
let item;
await retry(
async (bail) => {
await t.update(obj, { where: criteria });
},
{
retries: 5,
}
);
return item;
} else {
const cell = `${this.numberToLetters(j)}${i + 1}`;
const address = `${cell}:${cell}`;
await this.set({ pid, handle: null, file, address, value });
}
merge = true;
}
}
merge ? merges++ : skipped++;
} else {
let fieldsValues = [];
for (let j = 0; j < fieldsNames.length; j++) {
let add = false;
Object.keys(row).forEach(p => {
if (fieldsNames[j].toLowerCase() === p.toLowerCase()) {
let value = row[p];
if (typeof (value) === 'string') {
value = value.substr(0, fieldsSizes[j]);
}
fieldsValues.push(value);
add = true;
}
});
if (!add) {
fieldsValues.push(null);
}
}
if (storage) {
let dst = {};
// Uppercases fields.
let i = 0;
Object.keys(fieldsValues).forEach(fieldSrc => {
const field = fieldsNames[i].charAt(0).toUpperCase() + fieldsNames[i].slice(1);
dst[field] = fieldsValues[fieldSrc];
i++;
});
fieldsValuesList.push(dst);
this.cachedMerge[pid][file].push(dst);
}
else {
await this.save({ pid, file, args: fieldsValues });
}
adds++;
}
}
// In case of storage, persist to DB in batch.
if (fieldsValuesList.length) {
await this.saveToStorageBatch({ pid, table: file, rows: fieldsValuesList });
}
GBLog.info(`BASIC: MERGE updated (merges:${merges}, additions:${adds}, skipped: ${skipped}).`);
return table;
}
public async tweet({ pid, text }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const consumer_key = min.core.getParam(min.instance, 'Twitter Consumer Key', null);
const consumer_secret = min.core.getParam(min.instance, 'Twitter Consumer Key Secret', null);
const access_token_key = min.core.getParam(min.instance, 'Twitter Access Token', null);
const access_token_secret = min.core.getParam(min.instance, 'Twitter Access Token Secret', null);
if (!consumer_key || !consumer_secret || !access_token_key || !access_token_secret) {
GBLog.info('Twitter not configured in .gbot.');
}
const client = new TwitterApi({
appKey: consumer_key,
appSecret: consumer_secret,
accessToken: access_token_key,
accessSecret: access_token_secret
});
await client.v2.tweet(text);
GBLog.info(`Twitter Automation: ${text}.`);
}
/**
* HEAR description
* text = REWRITE description
* SAVE "logs.xlsx", username, text
*/
public async rewrite({ pid, text }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const prompt = `rewrite this sentence in a better way: ${text}`;
const answer = await ChatServices.continue(min, prompt, 0);
GBLog.info(`BASIC: REWRITE ${text} TO ${answer}`);
return answer;
}
/**
*
* qrcode = PAY "10000", "Name", 100
* SEND FILE qrcode
*
*/
public async pay({ pid, orderId, customerName, ammount }) {
const { min, user } = await DialogKeywords.getProcessInfo(pid);
const gbaiName = DialogKeywords.getGBAIPath(min.botId);
const merchantId = min.core.getParam(min.instance, 'Merchant ID', null);
const merchantKey = min.core.getParam(min.instance, 'Merchant Key', null);
if (!merchantId || !merchantKey) {
throw new Error('Payment not configured in .gbot.');
}
const apiUrl = 'https://apisandbox.cieloecommerce.cielo.com.br/1/sales/';
const requestId = GBAdminService.generateUuid();
GBLog.info(`GBPay: ${requestId}, ${orderId}, ${ammount}... `);
const requestData = {
MerchantOrderId: orderId,
Customer: {
Name: customerName
},
Payment: {
Type: 'qrcode',
Amount: ammount,
Installments: 1,
Capture: false,
Modality: 'Debit'
}
};
const response = await fetch(apiUrl, {
method: 'POST',
body: JSON.stringify(requestData),
headers: {
'Content-Type': 'application/json',
MerchantId: merchantId,
MerchantKey: merchantKey,
RequestId: requestId
}
});
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const data = await response.json();
// Prepare an image on cache and return the GBFILE information.
const buf = Buffer.from(data.Payment.QrCodeBase64Image, 'base64');
const localName = Path.join('work', gbaiName, 'cache', `qr${GBAdminService.getRndReadableIdentifier()}.png`);
Fs.writeFileSync(localName, buf, { encoding: null });
const url = urlJoin(GBServer.globals.publicAddress, min.botId, 'cache', Path.basename(localName));
GBLog.info(`GBPay: ${data.MerchantOrderId} OK: ${url}.`);
return {
name: Path.basename(localName),
localName: localName,
url: url,
data: buf,
text: data.Payment.QrCodeString
};
}
/**
* HEAR logo AS FILE
* file = AUTO SAVE logo
* TALK "Your " + file.name + " file is saved."
*/
public async autoSave({ pid, handle }) {
const { min } = await DialogKeywords.getProcessInfo(pid);
this.internalAutoSave({ min, handle });
}
private async internalAutoSave({ min, handle }) {
const file = GBServer.globals.files[handle];
GBLog.info(`BASIC: Auto saving '${file.filename}' (SAVE file).`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const path = DialogKeywords.getGBAIPath(min.botId, `gbdrive`);
const fileName = file.url ? file.url : file.name;
const contentType = mime.lookup(fileName);
const ext = Path.extname(fileName).substring(1);
const kind = await this.getExtensionInfo(ext);
let d = new Date(),
month = '' + (d.getMonth() + 1),
day = '' + d.getDate(),
year = d.getFullYear();
const today = [day, month, year].join('-');
const result = await client
.api(`${baseUrl}/drive/root:/${path}/${today}/${kind.category}/${fileName}:/content`)
.put(file.data);
return { contentType, ext, kind, category: kind['category'] };
}
private async deleteFile({ min, file }) {
// const file = GBServer.globals.files[handle];
GBLog.info(`BASIC: Auto saving '${file.filename}' (SAVE file).`);
let { baseUrl, client } = await GBDeployer.internalGetDriveClient(min);
const path = DialogKeywords.getGBAIPath(min.botId, `gbdrive`);
const fileName = file.url ? file.url : file.name;
const contentType = mime.lookup(fileName);
const ext = Path.extname(fileName).substring(1);
const kind = await this.getExtensionInfo(ext);
const result = await client
.api(`${baseUrl}/drive/root:/${path}/${file}`)
.delete(file.data);
return { contentType, ext, kind, category: kind['category'] };
}
public async getExtensionInfo(ext: any): Promise<any> {
let array = exts.filter((v, i, a) => a[i]['extension'] === ext);
if (array[0]) {
return array[0];
}
return { category: 'Other', description: 'General documents' };
}
/**
* Loads all para from tabular file Config.xlsx.
*/
public async dirFolder({ pid, remotePath, baseUrl = null, array = null }) {
const { min } = await DialogKeywords.getProcessInfo(pid);
GBLogEx.info(min, `dirFolder: remotePath=${remotePath}, baseUrl=${baseUrl}`);
if (!baseUrl) {
let client;
[baseUrl, client] = await GBDeployer.internalGetDriveClient(min);
remotePath = remotePath.replace(/\\/gi, '/');
// Retrieves all files in remote folder.
let path = DialogKeywords.getGBAIPath(min.botId);
path = urlJoin(path, remotePath);
let url = `${baseUrl}/drive/root:/${path}:/children`;
const res = await client.api(url).get();
const documents = res.value;
if (documents === undefined || documents.length === 0) {
GBLogEx.info(min, `${remotePath} is an empty folder.`);
return array;
}
// Navigate files / directory to recurse.
await CollectionUtil.asyncForEach(documents, async item => {
if (item.folder) {
remotePath = urlJoin(remotePath, item.name);
array = [array, ... await this.dirFolder({ pid, remotePath, baseUrl, array })];
} else {
// TODO: https://raw.githubusercontent.com/ishanarora04/quickxorhash/master/quickxorhash.js
let obj = {};
obj['modified'] = item.lastModifiedDateTime;
obj['name'] = item.name;
obj['size'] = item.size;
obj['hash'] = item.file?.hashes?.quickXorHash;
obj['path'] = Path.join(remotePath, item.name);
array.push(obj);
return array;
}
});
}
}
}