Files
server/DocService/sources/converterservice.js
Sergey Konovalov 41399fa3d4 Feature/multi tenant (#377)
* [feature] Add tenantManager

* [fix] Fix export

* [schema] Change schema for tenants

* [de] For auth

* [config] Remove unused secret.browser param to unify with multitenancy

* [feature] Add OperationContext to store state of request

* [log] Remove docId and userId from log message

* [feature] Add OperationContext class

* [feature] For logging

* [feature] Add content to some methods

* [feature] For multitenancy

* [feature] For multitenancy

* [feature] For multitenancy

* [feature] For multitenancy

* [feature] For multitenancy

* [feature] For multitenancy

* [feature] Move all tenant logic to tenantManager

* [feature] Fix reading of tenant license

* [feature] Move tenant logic to EditorData interface

* [feature] Use context in SQL queries

* [feature] Refactoring

* [feature] Fix editorDataMemory

* [feature] Fix before merge
2022-08-02 17:34:06 +03:00

447 lines
18 KiB
JavaScript

/*
* (c) Copyright Ascensio System SIA 2010-2019
*
* This program is a free software product. You can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License (AGPL)
* version 3 as published by the Free Software Foundation. In accordance with
* Section 7(a) of the GNU AGPL its Section 15 shall be amended to the effect
* that Ascensio System SIA expressly excludes the warranty of non-infringement
* of any third-party rights.
*
* This program is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For
* details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
*
* You can contact Ascensio System SIA at 20A-12 Ernesta Birznieka-Upisha
* street, Riga, Latvia, EU, LV-1050.
*
* The interactive user interfaces in modified source and object code versions
* of the Program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU AGPL version 3.
*
* Pursuant to Section 7(b) of the License you must retain the original Product
* logo when distributing the program. Pursuant to Section 7(e) we decline to
* grant you any rights under trademark law for use of our trademarks.
*
* All the Product's GUI elements, including illustrations and icon sets, as
* well as technical writing content are licensed under the terms of the
* Creative Commons Attribution-ShareAlike 4.0 International. See the License
* terms at http://creativecommons.org/licenses/by-sa/4.0/legalcode
*
*/
'use strict';
const path = require('path');
var config = require('config');
var co = require('co');
const locale = require('windows-locale');
var taskResult = require('./taskresult');
var utils = require('./../../Common/sources/utils');
var constants = require('./../../Common/sources/constants');
var commonDefines = require('./../../Common/sources/commondefines');
var docsCoServer = require('./DocsCoServer');
var canvasService = require('./canvasservice');
var storage = require('./../../Common/sources/storage-base');
var formatChecker = require('./../../Common/sources/formatchecker');
var statsDClient = require('./../../Common/sources/statsdclient');
var storageBase = require('./../../Common/sources/storage-base');
var operationContext = require('./../../Common/sources/operationContext');
const sqlBase = require('./baseConnector');
var CONVERT_ASYNC_DELAY = 1000;
var clientStatsD = statsDClient.getClient();
function* getConvertStatus(ctx, cmd, selectRes, opt_checkPassword) {
var status = new commonDefines.ConvertStatus(constants.NO_ERROR);
if (selectRes.length > 0) {
var docId = cmd.getDocId();
var row = selectRes[0];
let password = opt_checkPassword && sqlBase.DocumentPassword.prototype.getCurPassword(ctx, row.password);
switch (row.status) {
case taskResult.FileStatus.Ok:
if (password) {
let encryptedUserPassword = cmd.getPassword();
let isCorrectPassword;
if (encryptedUserPassword) {
let decryptedPassword = yield utils.decryptPassword(password);
let userPassword = yield utils.decryptPassword(encryptedUserPassword);
isCorrectPassword = decryptedPassword === userPassword;
}
if (isCorrectPassword) {
ctx.logger.debug("getConvertStatus password match");
status.end = true;
} else {
ctx.logger.debug("getConvertStatus password mismatch");
status.err = constants.CONVERT_PASSWORD;
}
} else {
status.end = true;
}
break;
case taskResult.FileStatus.Err:
case taskResult.FileStatus.ErrToReload:
case taskResult.FileStatus.NeedPassword:
status.err = row.status_info;
if (taskResult.FileStatus.ErrToReload == row.status || taskResult.FileStatus.NeedPassword == row.status) {
yield canvasService.cleanupCache(ctx);
}
break;
case taskResult.FileStatus.NeedParams:
case taskResult.FileStatus.SaveVersion:
case taskResult.FileStatus.UpdateVersion:
status.err = constants.UNKNOWN;
break;
}
var lastOpenDate = row.last_open_date;
if (new Date().getTime() - lastOpenDate.getTime() > utils.CONVERTION_TIMEOUT) {
status.err = constants.CONVERT_TIMEOUT;
}
} else {
status.err = constants.UNKNOWN;
}
return status;
}
function* getConvertPath(ctx, docId, fileTo, formatTo) {
if (constants.AVS_OFFICESTUDIO_FILE_OTHER_OOXML === formatTo || constants.AVS_OFFICESTUDIO_FILE_OTHER_ODF === formatTo) {
let list = yield storage.listObjects(ctx, docId);
let baseName = path.basename(fileTo, path.extname(fileTo));
for (let i = 0; i < list.length; ++i) {
if (path.basename(list[i], path.extname(list[i])) === baseName) {
return list[i];
}
}
}
return docId + '/' + fileTo;
}
function* getConvertUrl(ctx, baseUrl, fileToPath, title) {
if (title) {
title = path.basename(title, path.extname(title)) + path.extname(fileToPath);
}
return yield storage.getSignedUrl(ctx, baseUrl, fileToPath, commonDefines.c_oAscUrlTypes.Temporary, title);
}
function* convertByCmd(ctx, cmd, async, opt_fileTo, opt_taskExist, opt_priority, opt_expiration, opt_queue, opt_checkPassword) {
var docId = cmd.getDocId();
var startDate = null;
if (clientStatsD) {
startDate = new Date();
}
ctx.logger.debug('Start convert request');
let bCreate = false;
if (!opt_taskExist) {
let task = new taskResult.TaskResultData();
task.tenant = ctx.tenant;
task.key = docId;
task.status = taskResult.FileStatus.WaitQueue;
task.statusInfo = constants.NO_ERROR;
let upsertRes = yield taskResult.upsert(ctx, task);
//if CLIENT_FOUND_ROWS don't specify 1 row is inserted , 2 row is updated, and 0 row is set to its current values
//http://dev.mysql.com/doc/refman/5.7/en/insert-on-duplicate.html
bCreate = upsertRes.affectedRows == 1;
}
var selectRes;
var status;
if (!bCreate) {
selectRes = yield taskResult.select(ctx, docId);
status = yield* getConvertStatus(ctx, cmd, selectRes, opt_checkPassword);
} else {
var queueData = new commonDefines.TaskQueueData();
queueData.setCtx(ctx);
queueData.setCmd(cmd);
if (opt_fileTo) {
queueData.setToFile(opt_fileTo);
}
queueData.setFromOrigin(true);
var priority = null != opt_priority ? opt_priority : constants.QUEUE_PRIORITY_LOW;
yield* docsCoServer.addTask(queueData, priority, opt_queue, opt_expiration);
status = new commonDefines.ConvertStatus(constants.NO_ERROR);
}
//wait
if (!async) {
var waitTime = 0;
while (true) {
if (status.end || constants.NO_ERROR != status.err) {
break;
}
yield utils.sleep(CONVERT_ASYNC_DELAY);
selectRes = yield taskResult.select(ctx, docId);
status = yield* getConvertStatus(ctx, cmd, selectRes, opt_checkPassword);
waitTime += CONVERT_ASYNC_DELAY;
if (waitTime > utils.CONVERTION_TIMEOUT) {
status.err = constants.CONVERT_TIMEOUT;
}
}
}
ctx.logger.debug('End convert request end %s status %s', status.end, status.err);
if (clientStatsD) {
clientStatsD.timing('coauth.convertservice', new Date() - startDate);
}
return status;
}
let convertFromChanges = co.wrap(function*(ctx, docId, baseUrl, forceSave, externalChangeInfo, opt_userdata, opt_userConnectionId,
opt_responseKey, opt_priority, opt_expiration, opt_queue, opt_redisKey) {
var cmd = new commonDefines.InputCommand();
cmd.setCommand('sfcm');
cmd.setDocId(docId);
cmd.setOutputFormat(constants.AVS_OFFICESTUDIO_FILE_OTHER_OOXML);
cmd.setEmbeddedFonts(false);
cmd.setCodepage(commonDefines.c_oAscCodePageUtf8);
cmd.setDelimiter(commonDefines.c_oAscCsvDelimiter.Comma);
cmd.setForceSave(forceSave);
cmd.setExternalChangeInfo(externalChangeInfo);
if (opt_userdata) {
cmd.setUserData(opt_userdata);
}
if (opt_userConnectionId) {
cmd.setUserConnectionId(opt_userConnectionId);
}
if (opt_responseKey) {
cmd.setResponseKey(opt_responseKey);
}
if (opt_redisKey) {
cmd.setRedisKey(opt_redisKey);
}
yield canvasService.commandSfctByCmd(ctx, cmd, opt_priority, opt_expiration, opt_queue);
var fileTo = constants.OUTPUT_NAME;
let outputExt = formatChecker.getStringFromFormat(cmd.getOutputFormat());
if (outputExt) {
fileTo += '.' + outputExt;
}
let status = yield* convertByCmd(ctx, cmd, true, fileTo, undefined, opt_priority, opt_expiration, opt_queue);
if (status.end) {
let fileToPath = yield* getConvertPath(ctx, docId, fileTo, cmd.getOutputFormat());
status.setExtName(path.extname(fileToPath));
status.setUrl(yield* getConvertUrl(ctx, baseUrl, fileToPath, cmd.getTitle()));
}
return status;
});
function parseIntParam(val){
return (typeof val === 'string') ? parseInt(val) : val;
}
function convertRequest(req, res, isJson) {
return co(function* () {
let ctx = new operationContext.Context();
try {
ctx.initFromRequest(req);
ctx.logger.info('convertRequest start');
let params;
let authRes = yield docsCoServer.getRequestParams(ctx, req);
if(authRes.code === constants.NO_ERROR){
params = authRes.params;
} else {
ctx.logger.warn('convertRequest auth failed %j', authRes);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(authRes.code), isJson);
return;
}
let outputtype = params.outputtype || '';
let docId = 'conv_' + params.key + '_' + outputtype;
ctx.setDocId(docId);
if (params.key && !constants.DOC_ID_REGEX.test(params.key)) {
ctx.logger.warn('convertRequest unexpected key = %s', params.key);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(constants.CONVERT_PARAMS), isJson);
return;
}
if (params.filetype && !constants.EXTENTION_REGEX.test(params.filetype)) {
ctx.logger.warn('convertRequest unexpected filetype = %s', params.filetype);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(constants.CONVERT_PARAMS), isJson);
return;
}
let outputFormat = formatChecker.getFormatFromString(outputtype);
if (constants.AVS_OFFICESTUDIO_FILE_UNKNOWN === outputFormat) {
ctx.logger.warn('convertRequest unexpected outputtype = %s', outputtype);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(constants.CONVERT_PARAMS), isJson);
return;
}
var cmd = new commonDefines.InputCommand();
cmd.setCommand('conv');
cmd.setUrl(params.url);
cmd.setEmbeddedFonts(false);//params.embeddedfonts'];
cmd.setFormat(params.filetype);
cmd.setDocId(docId);
cmd.setOutputFormat(outputFormat);
cmd.setCodepage(commonDefines.c_oAscEncodingsMap[params.codePage] || commonDefines.c_oAscCodePageUtf8);
cmd.setDelimiter(parseIntParam(params.delimiter) || commonDefines.c_oAscCsvDelimiter.Comma);
if(undefined != params.delimiterChar)
cmd.setDelimiterChar(params.delimiterChar);
if (params.region && locale[params.region.toLowerCase()]) {
cmd.setLCID(locale[params.region.toLowerCase()].id);
}
if (params.documentLayout) {
cmd.setJsonParams(JSON.stringify({'documentLayout': params.documentLayout}));
}
if (params.spreadsheetLayout) {
cmd.setJsonParams(JSON.stringify({'spreadsheetLayout': params.spreadsheetLayout}));
}
if (params.password) {
if (params.password.length > constants.PASSWORD_MAX_LENGTH) {
ctx.logger.warn('convertRequest password too long actual = %s; max = %s', params.password.length, constants.PASSWORD_MAX_LENGTH);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(constants.CONVERT_PARAMS), isJson);
return;
}
let encryptedPassword = yield utils.encryptPassword(params.password);
cmd.setPassword(encryptedPassword);
}
cmd.setWithAuthorization(true);
var thumbnail = params.thumbnail;
if (thumbnail) {
if (typeof thumbnail === 'string') {
thumbnail = JSON.parse(thumbnail);
}
var thumbnailData = new commonDefines.CThumbnailData(thumbnail);
//constants from CXIMAGE_FORMAT_
switch (cmd.getOutputFormat()) {
case constants.AVS_OFFICESTUDIO_FILE_IMAGE_JPG:
thumbnailData.setFormat(3);
break;
case constants.AVS_OFFICESTUDIO_FILE_IMAGE_PNG:
thumbnailData.setFormat(4);
break;
case constants.AVS_OFFICESTUDIO_FILE_IMAGE_GIF:
thumbnailData.setFormat(2);
break;
case constants.AVS_OFFICESTUDIO_FILE_IMAGE_BMP:
thumbnailData.setFormat(1);
break;
}
cmd.setThumbnail(thumbnailData);
if (false == thumbnailData.getFirst()) {
cmd.setOutputFormat(constants.AVS_OFFICESTUDIO_FILE_IMAGE);
}
}
var documentRenderer = params.documentRenderer;
if (documentRenderer) {
if (typeof documentRenderer === 'string') {
documentRenderer = JSON.parse(documentRenderer);
}
var textParamsData = new commonDefines.CTextParams();
switch (documentRenderer.textAssociation) {
case 'plainParagraph':
textParamsData.setAssociation(3);
break;
case 'plainLine':
textParamsData.setAssociation(2);
break;
case 'blockLine':
textParamsData.setAssociation(1);
break;
case 'blockChar':
default:
textParamsData.setAssociation(0);
break;
}
cmd.setTextParams(textParamsData);
}
let outputExt = formatChecker.getStringFromFormat(cmd.getOutputFormat());
if (params.title) {
cmd.setTitle(path.basename(params.title, path.extname(params.title)) + '.' + outputExt);
}
var async = (typeof params.async === 'string') ? 'true' == params.async : params.async;
if (constants.AVS_OFFICESTUDIO_FILE_UNKNOWN !== cmd.getOutputFormat()) {
let fileTo = constants.OUTPUT_NAME + '.' + outputExt;
var status = yield* convertByCmd(ctx, cmd, async, fileTo, undefined, undefined, undefined, undefined, true);
if (status.end) {
let fileToPath = yield* getConvertPath(ctx, docId, fileTo, cmd.getOutputFormat());
status.setExtName(path.extname(fileToPath));
status.setUrl(yield* getConvertUrl(ctx, utils.getBaseUrlByRequest(req), fileToPath, cmd.getTitle()));
ctx.logger.debug('convertRequest: url = %s', status.url);
}
utils.fillResponse(req, res, status, isJson);
} else {
var addresses = utils.forwarded(req);
ctx.logger.warn('Error convert unknown outputtype: query = %j from = %s', params, addresses);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(constants.UNKNOWN), isJson);
}
} catch (e) {
ctx.logger.error('convertRequest error: %s', e.stack);
utils.fillResponse(req, res, new commonDefines.ConvertStatus(constants.UNKNOWN), isJson);
} finally {
ctx.logger.info('convertRequest end');
}
});
}
function convertRequestJson(req, res) {
return convertRequest(req, res, true);
}
function convertRequestXml(req, res) {
return convertRequest(req, res, false);
}
function builderRequest(req, res) {
return co(function* () {
let ctx = new operationContext.Context();
try {
ctx.initFromRequest(req);
ctx.logger.info('builderRequest start');
let authRes;
if (!utils.isEmptyObject(req.query)) {
//todo this is a stub for compatibility. remove in future version
authRes = yield docsCoServer.getRequestParams(ctx, req, true);
} else {
authRes = yield docsCoServer.getRequestParams(ctx, req);
}
let params = authRes.params;
let docId = params.key;
ctx.setDocId(docId);
let error = authRes.code;
let urls;
let end = false;
if (error === constants.NO_ERROR &&
(params.key || params.url || (req.body && Buffer.isBuffer(req.body) && req.body.length > 0))) {
let cmd = new commonDefines.InputCommand();
cmd.setCommand('builder');
cmd.setIsBuilder(true);
cmd.setWithAuthorization(true);
cmd.setDocId(docId);
if (!docId) {
let task = yield* taskResult.addRandomKeyTask(ctx, undefined, 'bld_', 8);
docId = task.key;
cmd.setDocId(docId);
if (params.url) {
cmd.setUrl(params.url);
cmd.setFormat('docbuilder');
} else {
yield storageBase.putObject(ctx, docId + '/script.docbuilder', req.body, req.body.length);
}
let queueData = new commonDefines.TaskQueueData();
queueData.setCtx(ctx);
queueData.setCmd(cmd);
yield* docsCoServer.addTask(queueData, constants.QUEUE_PRIORITY_LOW);
}
let async = (typeof params.async === 'string') ? 'true' === params.async : params.async;
let status = yield* convertByCmd(ctx, cmd, async, utils.getBaseUrlByRequest(req), undefined, true);
end = status.end;
error = status.err;
if (end) {
urls = yield storageBase.getSignedUrls(ctx, utils.getBaseUrlByRequest(req), docId + '/output',
commonDefines.c_oAscUrlTypes.Temporary);
}
} else if (error === constants.NO_ERROR) {
error = constants.UNKNOWN;
}
ctx.logger.debug('End builderRequest request: urls = %j end = %s error = %s', urls, end, error);
utils.fillResponseBuilder(res, docId, urls, end, error);
}
catch (e) {
ctx.logger.error('Error builderRequest: %s', e.stack);
utils.fillResponseBuilder(res, undefined, undefined, undefined, constants.UNKNOWN);
} finally {
ctx.logger.info('builderRequest end');
}
});
}
exports.convertFromChanges = convertFromChanges;
exports.convertJson = convertRequestJson;
exports.convertXml = convertRequestXml;
exports.builder = builderRequest;