Moved more classes to ts. (#6179)

src/node/utils/LibreOffice.ts

@@ -0,0 +1,117 @@
+'use strict';
+/**
+ * Controls the communication with LibreOffice
+ */
+
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const async = require('async');
+const fs = require('fs').promises;
+const log4js = require('log4js');
+const os = require('os');
+const path = require('path');
+const runCmd = require('./run_cmd');
+const settings = require('./Settings');
+
+const logger = log4js.getLogger('LibreOffice');
+
+const doConvertTask = async (task:{
+  type: string,
+    srcFile: string,
+  fileExtension: string,
+    destFile: string,
+}) => {
+  const tmpDir = os.tmpdir();
+  // @ts-ignore
+  const p = runCmd([
+    settings.soffice,
+    '--headless',
+    '--invisible',
+    '--nologo',
+    '--nolockcheck',
+    '--writer',
+    '--convert-to',
+    task.type,
+    task.srcFile,
+    '--outdir',
+    tmpDir,
+  ], {stdio: [
+    null,
+      // @ts-ignore
+      (line) => logger.info(`[${p.child.pid}] stdout: ${line}`),
+      // @ts-ignore
+      (line) => logger.error(`[${p.child.pid}] stderr: ${line}`),
+  ]});
+  logger.info(`[${p.child.pid}] Converting ${task.srcFile} to ${task.type} in ${tmpDir}`);
+  // Soffice/libreoffice is buggy and often hangs.
+  // To remedy this we kill the spawned process after a while.
+  // TODO: Use the timeout option once support for Node.js < v15.13.0 is dropped.
+  const hangTimeout = setTimeout(() => {
+    logger.error(`[${p.child.pid}] Conversion timed out; killing LibreOffice...`);
+    p.child.kill();
+  }, 120000);
+  try {
+    await p;
+  } catch (err:any) {
+    logger.error(`[${p.child.pid}] Conversion failed: ${err.stack || err}`);
+    throw err;
+  } finally {
+    clearTimeout(hangTimeout);
+  }
+  logger.info(`[${p.child.pid}] Conversion done.`);
+  const filename = path.basename(task.srcFile);
+  const sourceFile = `${filename.substr(0, filename.lastIndexOf('.'))}.${task.fileExtension}`;
+  const sourcePath = path.join(tmpDir, sourceFile);
+  logger.debug(`Renaming ${sourcePath} to ${task.destFile}`);
+  await fs.rename(sourcePath, task.destFile);
+};
+
+// Conversion tasks will be queued up, so we don't overload the system
+const queue = async.queue(doConvertTask, 1);
+
+/**
+ * Convert a file from one type to another
+ *
+ * @param  {String}     srcFile     The path on disk to convert
+ * @param  {String}     destFile    The path on disk where the converted file should be stored
+ * @param  {String}     type        The type to convert into
+ * @param  {Function}   callback    Standard callback function
+ */
+exports.convertFile = async (srcFile: string, destFile: string, type:string) => {
+  // Used for the moving of the file, not the conversion
+  const fileExtension = type;
+
+  if (type === 'html') {
+    // "html:XHTML Writer File:UTF8" does a better job than normal html exports
+    if (path.extname(srcFile).toLowerCase() === '.doc') {
+      type = 'html';
+    }
+    // PDF files need to be converted with LO Draw ref https://github.com/ether/etherpad-lite/issues/4151
+    if (path.extname(srcFile).toLowerCase() === '.pdf') {
+      type = 'html:XHTML Draw File';
+    }
+  }
+
+  // soffice can't convert from html to doc directly (verified with LO 5 and 6)
+  // we need to convert to odt first, then to doc
+  // to avoid `Error: no export filter for /tmp/xxxx.doc` error
+  if (type === 'doc') {
+    const intermediateFile = destFile.replace(/\.doc$/, '.odt');
+    await queue.pushAsync({srcFile, destFile: intermediateFile, type: 'odt', fileExtension: 'odt'});
+    await queue.pushAsync({srcFile: intermediateFile, destFile, type, fileExtension});
+  } else {
+    await queue.pushAsync({srcFile, destFile, type, fileExtension});
+  }
+};