server/Common/sources/storage-fs.js

/*
 * (c) Copyright Ascensio System SIA 2010-2024
 *
 * 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-6 Ernesta Birznieka-Upish
 * 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 { cp, rm, mkdir } = require('fs/promises');
const { stat, readFile, writeFile } = require('fs/promises');
var path = require('path');
var utils = require("./utils");
var crypto = require('crypto');
const ms = require('ms');
const config = require('config');
const commonDefines = require('./../../Common/sources/commondefines');
const constants = require('./../../Common/sources/constants');

const cfgExpSessionAbsolute = ms(config.get('services.CoAuthoring.expire.sessionabsolute'));

//Stubs are needed until integrators pass these parameters to all requests
let shardKeyCached;
let wopiSrcCached;

function getFilePath(storageCfg, strPath) {
  const storageFolderPath = storageCfg.fs.folderPath;
  return path.join(storageFolderPath, strPath);
}
function getOutputPath(strPath) {
  return strPath.replace(/\\/g, '/');
}

async function headObject(storageCfg, strPath) {
  let fsPath = getFilePath(storageCfg, strPath);
  let stats = await stat(fsPath);
  return {ContentLength: stats.size};
}

async function getObject(storageCfg, strPath) {
  let fsPath = getFilePath(storageCfg, strPath);
  return await readFile(fsPath);
}

async function createReadStream(storageCfg, strPath) {
  let fsPath = getFilePath(storageCfg, strPath);
  let stats = await stat(fsPath);
  let contentLength = stats.size;
  let readStream = await utils.promiseCreateReadStream(fsPath);
  return {
    contentLength: contentLength,
    readStream: readStream
  };
}

async function putObject(storageCfg, strPath, buffer, contentLength) {
  var fsPath = getFilePath(storageCfg, strPath);
  await mkdir(path.dirname(fsPath), {recursive: true});

  if (Buffer.isBuffer(buffer)) {
    await writeFile(fsPath, buffer);
  } else {
    let writable = await utils.promiseCreateWriteStream(fsPath);
    await utils.pipeStreams(buffer, writable, true);
  }
}

async function uploadObject(storageCfg, strPath, filePath) {
  let fsPath = getFilePath(storageCfg, strPath);
  await cp(filePath, fsPath, {force: true, recursive: true});
}

async function copyObject(storageCfgSrc, storageCfgDst, sourceKey, destinationKey) {
  let fsPathSource = getFilePath(storageCfgSrc, sourceKey);
  let fsPathDestination = getFilePath(storageCfgDst, destinationKey);
  await cp(fsPathSource, fsPathDestination, {force: true, recursive: true});
}

async function listObjects(storageCfg, strPath) {
  const storageFolderPath = storageCfg.fs.folderPath;
  let fsPath = getFilePath(storageCfg, strPath);
  let values = await utils.listObjects(fsPath);
  return values.map(function(curvalue) {
    return getOutputPath(curvalue.substring(storageFolderPath.length + 1));
  });
}

async function deleteObject(storageCfg, strPath) {
  const fsPath = getFilePath(storageCfg, strPath);
  return rm(fsPath, {force: true, recursive: true});
}

async function deletePath(storageCfg, strPath) {
  const fsPath = getFilePath(storageCfg, strPath);
  return rm(fsPath, {force: true, recursive: true, maxRetries: 3});
}

async function getSignedUrl(ctx, storageCfg, baseUrl, strPath, urlType, optFilename, opt_creationDate) {
  const storageSecretString = storageCfg.fs.secretString;
  const storageUrlExpires = storageCfg.fs.urlExpires;
  const bucketName = storageCfg.bucketName;
  const storageFolderName = storageCfg.storageFolderName;
  //replace '/' with %2f before encodeURIComponent becase nginx determine %2f as '/' and get wrong system path
  const userFriendlyName = optFilename ? encodeURIComponent(optFilename.replace(/\//g, "%2f")) : path.basename(strPath);
  var uri = '/' + bucketName + '/' + storageFolderName + '/' + strPath + '/' + userFriendlyName;
  //RFC 1123 does not allow underscores https://stackoverflow.com/questions/2180465/can-domain-name-subdomains-have-an-underscore-in-it
  var url = utils.checkBaseUrl(ctx, baseUrl, storageCfg).replace(/_/g, "%5f");
  url += uri;

  var date = Date.now();
  let creationDate = opt_creationDate || date;
  let expiredAfter = (commonDefines.c_oAscUrlTypes.Session === urlType ? (cfgExpSessionAbsolute / 1000) : storageUrlExpires) || 31536000;
  //todo creationDate can be greater because mysql CURRENT_TIMESTAMP uses local time, not UTC
  var expires = creationDate + Math.ceil(Math.abs(date - creationDate) / expiredAfter) * expiredAfter;
  expires = Math.ceil(expires / 1000);
  expires += expiredAfter;

  var md5 = crypto.createHash('md5').update(expires + decodeURIComponent(uri) + storageSecretString).digest("base64");
  md5 = md5.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");

  url += '?md5=' + encodeURIComponent(md5);
  url += '&expires=' + encodeURIComponent(expires);
  if (ctx.shardKey) {
    shardKeyCached = ctx.shardKey;
    url += `&${constants.SHARD_KEY_API_NAME}=${encodeURIComponent(ctx.shardKey)}`;
  } else if (ctx.wopiSrc) {
    wopiSrcCached = ctx.wopiSrc;
    url += `&${constants.SHARD_KEY_WOPI_NAME}=${encodeURIComponent(ctx.wopiSrc)}`;
  } else if (process.env.DEFAULT_SHARD_KEY) {
    //Set DEFAULT_SHARD_KEY from environment as shardkey in case of integrator did not pass this param
    url += `&${constants.SHARD_KEY_API_NAME}=${encodeURIComponent(process.env.DEFAULT_SHARD_KEY)}`;
  } else if (shardKeyCached) {
    //Add stubs for shardkey params until integrators pass these parameters to all requests
    url += `&${constants.SHARD_KEY_API_NAME}=${encodeURIComponent(shardKeyCached)}`;
  } else if (wopiSrcCached) {
    url += `&${constants.SHARD_KEY_WOPI_NAME}=${encodeURIComponent(wopiSrcCached)}`;
  }
  url += '&filename=' + userFriendlyName;
  return url;
}

function needServeStatic() {
  return true;
}

module.exports = {
  headObject,
  getObject,
  createReadStream,
  putObject,
  uploadObject,
  copyObject,
  listObjects,
  deleteObject,
  deletePath,
  getSignedUrl,
  needServeStatic
};