Moved settings.js to ts.

src/node/hooks/express.ts

@@ -14,7 +14,7 @@ import fs from 'fs';
 const hooks = require('../../static/js/pluginfw/hooks');
 import log4js from 'log4js';
 const SessionStore = require('../db/SessionStore');
-const settings = require('../utils/Settings');
+import * as settings from '../utils/Settings';
 const stats = require('../stats')
 import util from 'util';
 const webaccess = require('./express/webaccess');
@@ -177,6 +177,7 @@ exports.restartServer = async () => {
   // starts listening to requests as reported in issue #158. Not installing the log4js connect
   // logger when the log level has a higher severity than INFO since it would not log at that level
   // anyway.
+  // @ts-ignore
   if (!(settings.loglevel === 'WARN' && settings.loglevel === 'ERROR')) {
     app.use(log4js.connectLogger(logger, {
       level: log4js.levels.DEBUG.levelStr,

src/node/hooks/express/adminplugins.ts

@@ -7,7 +7,7 @@ import {QueryType} from "../../types/QueryType";
 import {PluginType} from "../../types/Plugin";
 
 const eejs = require('../../eejs');
-const settings = require('../../utils/Settings');
+import * as settings from '../../utils/Settings';
 const installer = require('../../../static/js/pluginfw/installer');
 const pluginDefs = require('../../../static/js/pluginfw/plugin_defs');
 const plugins = require('../../../static/js/pluginfw/plugins');

src/node/hooks/express/adminsettings.ts

@@ -4,7 +4,8 @@ const eejs = require('../../eejs');
 const fsp = require('fs').promises;
 const hooks = require('../../../static/js/pluginfw/hooks');
 const plugins = require('../../../static/js/pluginfw/plugins');
-const settings = require('../../utils/Settings');
+import {reloadSettings, settingsFilename, showSettingsInAdminPage} from '../../utils/Settings';
+import * as settings from '../../utils/Settings';
 
 exports.expressCreateServer = (hookName:string, {app}:any) => {
   app.get('/admin/settings', (req:any, res:any) => {
@@ -25,12 +26,12 @@ exports.socketio = (hookName:string, {io}:any) => {
     socket.on('load', async (query:string):Promise<any> => {
       let data;
       try {
-        data = await fsp.readFile(settings.settingsFilename, 'utf8');
+        data = await fsp.readFile(settingsFilename, 'utf8');
       } catch (err) {
         return console.log(err);
       }
       // if showSettingsInAdminPage is set to false, then return NOT_ALLOWED in the result
-      if (settings.showSettingsInAdminPage === false) {
+      if (!showSettingsInAdminPage) {
         socket.emit('settings', {results: 'NOT_ALLOWED'});
       } else {
         socket.emit('settings', {results: data});
@@ -38,13 +39,13 @@ exports.socketio = (hookName:string, {io}:any) => {
     });
 
     socket.on('saveSettings', async (newSettings:string) => {
-      await fsp.writeFile(settings.settingsFilename, newSettings);
+      await fsp.writeFile(settingsFilename, newSettings);
       socket.emit('saveprogress', 'saved');
     });
 
     socket.on('restartServer', async () => {
       console.log('Admin request to restart server through a socket on /admin/settings');
-      settings.reloadSettings();
+      reloadSettings();
       await plugins.update();
       await hooks.aCallAll('loadSettings', {settings});
       await hooks.aCallAll('restartServer');

src/node/hooks/express/importexport.ts

@@ -3,7 +3,7 @@
 import {ArgsExpressType} from "../../types/ArgsExpressType";
 
 const hasPadAccess = require('../../padaccess');
-const settings = require('../../utils/Settings');
+import {exportAvailable, importExportRateLimiting} from '../../utils/Settings';
 const exportHandler = require('../../handler/ExportHandler');
 const importHandler = require('../../handler/ImportHandler');
 const padManager = require('../../db/PadManager');
@@ -14,7 +14,7 @@ const webaccess = require('./webaccess');
 
 exports.expressCreateServer = (hookName:string, args:ArgsExpressType, cb:Function) => {
   const limiter = rateLimit({
-    ...settings.importExportRateLimiting,
+    ...importExportRateLimiting,
     handler: (request:any) => {
       if (request.rateLimit.current === request.rateLimit.limit + 1) {
         // when the rate limiter triggers, write a warning in the logs
@@ -35,7 +35,7 @@ exports.expressCreateServer = (hookName:string, args:ArgsExpressType, cb:Functio
       }
 
       // if abiword is disabled, and this is a format we only support with abiword, output a message
-      if (settings.exportAvailable() === 'no' &&
+      if (exportAvailable() === 'no' &&
           ['odt', 'pdf', 'doc'].indexOf(req.params.type) !== -1) {
         console.error(`Impossible to export pad "${req.params.pad}" in ${req.params.type} format.` +
                       ' There is no converter configured');

src/node/hooks/express/openapi.ts

@@ -24,7 +24,7 @@ const cloneDeep = require('lodash.clonedeep');
 const createHTTPError = require('http-errors');
 
 const apiHandler = require('../../handler/APIHandler');
-const settings = require('../../utils/Settings');
+import {ssl} from '../../utils/Settings';
 
 const log4js = require('log4js');
 const logger = log4js.getLogger('API');
@@ -724,5 +724,5 @@ const getApiRootForVersion = (version:string, style:any = APIPathStyle.FLAT): st
 const generateServerForApiVersion = (apiRoot:string, req:any): {
   url:string
 } => ({
-  url: `${settings.ssl ? 'https' : 'http'}://${req.headers.host}${apiRoot}`,
+  url: `${ssl ? 'https' : 'http'}://${req.headers.host}${apiRoot}`,
 });

src/node/hooks/express/socketio.ts

@@ -6,7 +6,7 @@ const events = require('events');
 const express = require('../express');
 const log4js = require('log4js');
 const proxyaddr = require('proxy-addr');
-const settings = require('../../utils/Settings');
+import * as settings from '../../utils/Settings';
 import {Server} from 'socket.io'
 const socketIORouter = require('../../handler/SocketIORouter');
 const hooks = require('../../../static/js/pluginfw/hooks');
@@ -71,6 +71,7 @@ exports.expressCreateServer = (hookName:string, args:ArgsExpressType, cb:Functio
   // transports in this list at once
   // e.g. XHR is disabled in IE by default, so in IE it should use jsonp-polling
   io = new Server(args.server, {
+    // @ts-ignore
     transports: settings.socketTransportProtocols,
   }).listen(args.server, {
     /*

src/node/hooks/express/specialpages.js

@@ -6,7 +6,7 @@ const fs = require('fs');
 const fsp = fs.promises;
 const toolbar = require('../../utils/toolbar');
 const hooks = require('../../../static/js/pluginfw/hooks');
-const settings = require('../../utils/Settings');
+import * as settings from '../../utils/Settings';
 const util = require('util');
 const webaccess = require('./webaccess');
 

src/node/hooks/express/static.js

@@ -4,7 +4,7 @@ const fs = require('fs').promises;
 const minify = require('../../utils/Minify');
 const path = require('path');
 const plugins = require('../../../static/js/pluginfw/plugin_defs');
-const settings = require('../../utils/Settings');
+import * as settings from '../../utils/Settings';
 const CachingMiddleware = require('../../utils/caching_middleware');
 const Yajsml = require('etherpad-yajsml');
 

src/node/hooks/express/tests.js

@@ -4,7 +4,7 @@ const path = require('path');
 const fsp = require('fs').promises;
 const plugins = require('../../../static/js/pluginfw/plugin_defs');
 const sanitizePathname = require('../../utils/sanitizePathname');
-const settings = require('../../utils/Settings');
+import * as settings from '../../utils/Settings';
 
 // Returns all *.js files under specDir (recursively) as relative paths to specDir, using '/'
 // instead of path.sep to separate pathname components.

src/node/hooks/express/webaccess.js

@@ -3,7 +3,7 @@
 const assert = require('assert').strict;
 const log4js = require('log4js');
 const httpLogger = log4js.getLogger('http');
-const settings = require('../../utils/Settings');
+import * as settings from '../../utils/Settings';
 const hooks = require('../../../static/js/pluginfw/hooks');
 const readOnlyManager = require('../../db/ReadOnlyManager');
 

src/node/hooks/i18n.ts

@@ -9,7 +9,7 @@ const path = require('path');
 const _ = require('underscore');
 const pluginDefs = require('../../static/js/pluginfw/plugin_defs.js');
 const existsSync = require('../utils/path_exists');
-const settings = require('../utils/Settings');
+import {customLocaleStrings, maxAge, root} from '../utils/Settings';
 
 // returns all existing messages merged together and grouped by langcode
 // {es: {"foo": "string"}, en:...}
@@ -40,7 +40,7 @@ const getAllLocales = () => {
   };
 
   // add core supported languages first
-  extractLangs(path.join(settings.root, 'src/locales'));
+  extractLangs(path.join(root, 'src/locales'));
 
   // add plugins languages (if any)
   for (const {package: {path: pluginPath}} of Object.values<I18nPluginDefs>(pluginDefs.plugins)) {
@@ -71,9 +71,9 @@ const getAllLocales = () => {
   const wrongFormatErr = Error(
       'customLocaleStrings in wrong format. See documentation ' +
     'for Customization for Administrators, under Localization.');
-  if (settings.customLocaleStrings) {
-    if (typeof settings.customLocaleStrings !== 'object') throw wrongFormatErr;
-    _.each(settings.customLocaleStrings, (overrides:MapArrayType<string> , langcode:string) => {
+  if (customLocaleStrings) {
+    if (typeof customLocaleStrings !== 'object') throw wrongFormatErr;
+    _.each(customLocaleStrings, (overrides:MapArrayType<string> , langcode:string) => {
       if (typeof overrides !== 'object') throw wrongFormatErr;
       _.each(overrides, (localeString:string|object, key:string) => {
         if (typeof localeString !== 'string') throw wrongFormatErr;
@@ -133,7 +133,7 @@ exports.expressPreSession = async (hookName:string, {app}:any) => {
     // works with /locale/en and /locale/en.json requests
     const locale = req.params.locale.split('.')[0];
     if (Object.prototype.hasOwnProperty.call(exports.availableLangs, locale)) {
-      res.setHeader('Cache-Control', `public, max-age=${settings.maxAge}`);
+      res.setHeader('Cache-Control', `public, max-age=${maxAge}`);
       res.setHeader('Content-Type', 'application/json; charset=utf-8');
       res.send(`{"${locale}":${JSON.stringify(locales[locale])}}`);
     } else {
@@ -142,7 +142,7 @@ exports.expressPreSession = async (hookName:string, {app}:any) => {
   });
 
   app.get('/locales.json', (req: any, res:any) => {
-    res.setHeader('Cache-Control', `public, max-age=${settings.maxAge}`);
+    res.setHeader('Cache-Control', `public, max-age=${maxAge}`);
     res.setHeader('Content-Type', 'application/json; charset=utf-8');
     res.send(localeIndex);
   });