web_plsql 1.0.0 → 1.3.0

package/src/handler/plsql/upload.js

@@ -1,109 +0,0 @@
-/*
- *	Process file uploads
- */
-
-// eslint-disable @typescript-eslint/no-unused-vars
-
-import debugModule from 'debug';
-const debug = debugModule('webplsql:fileUpload');
-
-import {readFile, removeFile} from '../../util/file.js';
-import {errorToString} from '../../util/errorToString.js';
-import oracledb from 'oracledb';
-import z from 'zod';
-
-const z$reqFiles = z.array(
-	z.looseObject({
-		fieldname: z.string(),
-		originalname: z.string(),
-		encoding: z.string(),
-		mimetype: z.string(),
-		destination: z.string(),
-		filename: z.string(),
-		path: z.string(),
-		size: z.number(),
-	}),
-);
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('../../types.js').fileUploadType} fileUploadType
- */
-
-/**
- * Get the files
- *
- * @param {Request} req - The req object represents the HTTP request.
- * @returns {fileUploadType[]} - Promise that resolves with an array of files to be uploaded.
- */
-export const getFiles = (req) => {
-	if (!('files' in req)) {
-		debug('getFiles: no files');
-		return [];
-	}
-
-	if (typeof req.files === 'object' && req.files !== null && Object.keys(req.files).length === 0) {
-		debug('getFiles: no files');
-		return [];
-	}
-
-	const files = z$reqFiles.parse(req.files);
-
-	for (const file of files) {
-		file.filename += `/${file.originalname}`;
-	}
-
-	debug('getFiles', files);
-
-	return files;
-};
-
-/**
- * Upload the given file and return a promise.
- *
- * @param {fileUploadType} file - The file to upload.
- * @param {string} doctable - The file to upload.
- * @param {Connection} databaseConnection - The file to upload.
- * @returns {Promise<void>} - Promise that resolves when uploaded.
- */
-export const uploadFile = async (file, doctable, databaseConnection) => {
-	debug(`uploadFile`, file, doctable);
-
-	/* v8 ignore next - defensive validation */
-	if (typeof doctable !== 'string' || doctable.length === 0) {
-		throw new Error(`Unable to upload file "${file.filename}" because the option ""doctable" has not been defined`);
-	}
-
-	// read file
-	let blobContent;
-	try {
-		blobContent = await readFile(file.path);
-	} catch (err) {
-		throw new Error(`Unable to load file "${file.path}".\n${errorToString(err)}`);
-	}
-
-	// insert file in document table
-	const sql = `INSERT INTO ${doctable} (name, mime_type, doc_size, dad_charset, last_updated, content_type, blob_content) VALUES (:name, :mime_type, :doc_size, 'ascii', SYSDATE, 'BLOB', :blob_content)`;
-	const bind = {
-		name: file.filename,
-		mime_type: file.mimetype,
-		doc_size: file.size,
-		blob_content: {
-			val: blobContent,
-			type: oracledb.BUFFER,
-		},
-	};
-	try {
-		await databaseConnection.execute(sql, bind, {autoCommit: true});
-	} catch (err) {
-		throw new Error(`Unable to insert file "${file.filename}".\n${errorToString(err)}`);
-	}
-
-	// remove the file
-	try {
-		await removeFile(file.path);
-	} catch (err) {
-		throw new Error(`Unable to remove file "${file.filename}".\n${errorToString(err)}`);
-	}
-};

package/src/index.js

@@ -1,20 +0,0 @@
-// libraries
-import oracledb from 'oracledb';
-export {oracledb};
-
-// server
-export {getVersion} from './version.js';
-export {createServer, startServer, loadConfig, startServerConfig} from './server/server.js';
-export * from './util/shutdown.js';
-
-// handler
-export {handlerWebPlSql} from './handler/plsql/handlerPlSql.js';
-export {handlerLogger} from './handler/handlerLogger.js';
-export {handlerUpload} from './handler/handlerUpload.js';
-export {handlerMetrics} from './handler/handlerMetrics.js';
-
-// oracle
-export * from './util/oracle.js';
-
-// util
-export * from './util/file.js';

package/src/server/config.js

@@ -1,57 +0,0 @@
-import {getVersion} from '../version.js';
-
-/**
- * @typedef {import('../types.js').configType} configType
- */
-
-/**
- * Show configuration.
- * @param {configType} config - The config.
- * @returns {void}
- */
-export const showConfig = (config) => {
-	const LINE = '-'.repeat(80);
-
-	console.log(LINE);
-	console.log(`NODE PL/SQL SERVER version ${getVersion()}`);
-	console.log(LINE);
-
-	console.log(`Server port:            ${config.port}`);
-	console.log(`Admin route:            ${config.adminRoute ?? '/admin'}${config.adminUser ? ' (authenticated)' : ''}`);
-	console.log(`Access log:             ${config.loggerFilename.length > 0 ? config.loggerFilename : ''}`);
-	console.log(`Upload file size limit: ${typeof config.uploadFileSizeLimit === 'number' ? `${config.uploadFileSizeLimit} bytes` : 'any'}`);
-
-	if (config.routeStatic.length > 0) {
-		console.log(LINE);
-		config.routeStatic.forEach((e) => {
-			console.log(`Static route:           ${e.route}`);
-			console.log(`Directory path:         ${e.directoryPath}`);
-		});
-	}
-
-	if (config.routePlSql.length > 0) {
-		console.log(LINE);
-		config.routePlSql.forEach((e) => {
-			let transactionMode = '';
-			if (typeof e.transactionMode === 'string') {
-				transactionMode = e.transactionMode;
-			} else if (typeof e.transactionMode === 'function') {
-				transactionMode = 'custom callback';
-			}
-
-			console.log(`Route:                  http://localhost:${config.port}${e.route}`);
-			console.log(`Oracle user:            ${e.user}`);
-			console.log(`Oracle server:          ${e.connectString}`);
-			console.log(`Oracle document table:  ${e.documentTable}`);
-			console.log(`Default page:           ${e.defaultPage}`);
-			console.log(`Path alias:             ${e.pathAlias}`);
-			console.log(`Path alias procedure:   ${e.pathAliasProcedure}`);
-			console.log(`Exclution list:         ${e.exclusionList?.join(', ')}`);
-			console.log(`Validation function:    ${e.requestValidationFunction}`);
-			console.log(`After request handler:  ${transactionMode}`);
-			console.log(`Error style:            ${e.errorStyle}`);
-		});
-	}
-
-	console.log(LINE);
-};

package/src/server/connections.js

@@ -1,40 +0,0 @@
-/**
- * @typedef {import('node:net').Socket} Socket
- */
-
-/**
- * @param {string} id - id
- * @param {string} ip - address
- * @param {string} port - port
- * @param {string} read - bytes read
- * @param {string} written - bytes written
- */
-const line = (id, ip, port, read, written) => {
-	console.log(`${id.padStart(3)}  ${ip.padEnd(15)}  ${port.padStart(5)}  ${read.padStart(10)}  ${written.padStart(10)}`);
-};
-
-/**
- * Show connections.
- * @param {Set<Socket>} connections - The connections.
- * @returns {void}
- */
-export const showConnections = (connections) => {
-	if (connections.size === 0) {
-		console.log('No open connections.');
-		return;
-	}
-
-	// Print header
-	line('ID', 'IP', 'Port', 'Read', 'Written');
-
-	let i = 0;
-	for (const socket of connections) {
-		line(
-			(i++).toString(),
-			socket.remoteAddress ?? '',
-			typeof socket.remotePort === 'number' ? socket.remotePort.toFixed() : '',
-			socket.bytesRead.toFixed(),
-			socket.bytesWritten.toFixed(),
-		);
-	}
-};

package/src/server/server.js

@@ -1,289 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:server');
-import http from 'node:http';
-import https from 'node:https';
-import path from 'node:path';
-import {fileURLToPath} from 'node:url';
-import express from 'express';
-import cookieParser from 'cookie-parser';
-import compression from 'compression';
-import {z$configType} from '../types.js';
-import {installShutdown} from '../util/shutdown.js';
-import {poolCreate, poolsClose} from '../util/oracle.js';
-import {handlerUpload} from '../handler/handlerUpload.js';
-import {handlerLogger} from '../handler/handlerLogger.js';
-import {handlerWebPlSql} from '../handler/plsql/handlerPlSql.js';
-import {handlerAdmin} from '../handler/handlerAdmin.js';
-import {readFileSyncUtf8, getJsonFile} from '../util/file.js';
-import {showConfig} from './config.js';
-import {Cache} from '../util/cache.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-/**
- * @typedef {import('node:net').Socket} Socket
- * @typedef {import('express').Express} Express
- * @typedef {import('express').Request} Request
- * @typedef {import('express').Response} Response
- * @typedef {import('express').NextFunction} NextFunction
- * @typedef {import('oracledb').Pool} Pool
- * @typedef {import('../types.js').environmentType} environmentType
- * @typedef {import('../types.js').configType} configType
- * @typedef {import('../handler/plsql/procedureNamed.js').argsType} argsType
- */
-
-/**
- * @typedef {import('express').RequestHandler & {
- *   procedureNameCache: Cache<string>;
- *   argumentCache: Cache<argsType>;
- * }} ExtendedRequestHandler
- */
-
-/**
- * Global Admin Context
- */
-export const AdminContext = {
-	startTime: new Date(),
-	/** @type {configType | null} */
-	config: null,
-	/** @type {Pool[]} */
-	pools: [],
-	/** @type {Array<{poolName: string, procedureNameCache: Cache<string>, argumentCache: Cache<argsType>}>} */
-	caches: [],
-	paused: false,
-	metrics: {
-		requestCount: 0,
-		errorCount: 0,
-		totalDuration: 0,
-	},
-};
-
-/**
- * @typedef {object} webServer - Web server interface.
- * @property {configType} config - Configuration object.
- * @property {Pool[]} connectionPools - Oracle connection pools.
- * @property {Express} app - Express app.
- * @property {http.Server | https.Server} server - Native Node http(s) server instance.
- * @property {() => Promise<void>} shutdown - Shutdown function.
- */
-
-/**
- * @typedef {object} sslConfig - SSL configuration.
- * @property {string} keyFilename - key filename.
- * @property {string} certFilename - cert filename.
- */
-
-/**
- * Admin basic auth middleware
- * @param {Request} req - The request.
- * @param {Response} res - The response.
- * @param {NextFunction} next - The next function.
- */
-const adminAuth = (req, res, next) => {
-	const adminRoute = AdminContext.config?.adminRoute ?? '/admin';
-
-	// Simple pause check for all PL/SQL routes (not admin)
-	if (AdminContext.paused && !req.path.startsWith(adminRoute)) {
-		res.status(503).send('Server Paused');
-		return;
-	}
-
-	// Basic Auth for Admin Route
-	if (req.path.startsWith(adminRoute)) {
-		const user = AdminContext.config?.adminUser;
-		const pass = AdminContext.config?.adminPassword;
-
-		if (user && pass) {
-			const auth = {login: user, password: pass};
-			const b64auth = (req.headers.authorization ?? '').split(' ')[1] ?? '';
-			const [login, password] = Buffer.from(b64auth, 'base64').toString().split(':');
-
-			if (login !== auth.login || password !== auth.password) {
-				res.set('WWW-Authenticate', 'Basic realm="Admin Console"');
-				res.status(401).send('Authentication required.');
-				return;
-			}
-		}
-	}
-
-	next();
-};
-
-/**
- * Create HTTPS server.
- * @param {Express} app - express application
- * @param {sslConfig} [ssl] - ssl configuration.
- * @returns {http.Server | https.Server} - server
- */
-export const createServer = (app, ssl) => {
-	if (ssl) {
-		const key = readFileSyncUtf8(ssl.keyFilename);
-		const cert = readFileSyncUtf8(ssl.certFilename);
-
-		return https.createServer({key, cert}, app);
-	} else {
-		return http.createServer(app);
-	}
-};
-
-/**
- * Start server.
- * @param {configType} config - The config.
- * @param {sslConfig} [ssl] - ssl configuration.
- * @returns {Promise<webServer>} - Promise resolving to the web server object.
- */
-export const startServer = async (config, ssl) => {
-	debug('startServer: BEGIN', config, ssl);
-
-	const internalConfig = /** @type {configType} */ (z$configType.parse(config));
-	AdminContext.config = internalConfig;
-
-	showConfig(internalConfig);
-
-	// Create express app
-	const app = express();
-
-	// Pause & Admin Auth middleware
-	app.use(adminAuth);
-
-	// Access log
-	if (internalConfig.loggerFilename.length > 0) {
-		app.use(handlerLogger(internalConfig.loggerFilename));
-	}
-
-	// Admin console
-	const adminRoute = internalConfig.adminRoute ?? '/admin';
-	const adminDirectory = path.resolve(__dirname, '../admin');
-	app.use(adminRoute, handlerAdmin);
-	app.use(adminRoute, express.static(adminDirectory));
-
-	// Serving static files
-	for (const i of internalConfig.routeStatic) {
-		app.use(i.route, express.static(i.directoryPath));
-	}
-
-	// Default middleware
-	app.use(handlerUpload(internalConfig.uploadFileSizeLimit));
-	app.use(express.json({limit: '50mb'}));
-	app.use(express.urlencoded({limit: '50mb', extended: true}));
-	app.use(cookieParser());
-	app.use(compression());
-
-	/** @type {Pool[]} */
-	const connectionPools = [];
-	AdminContext.pools = connectionPools;
-	AdminContext.caches = [];
-
-	// Oracle pl/sql express middleware
-	for (const i of internalConfig.routePlSql) {
-		// Allocate the Oracle database pool
-		const pool = await poolCreate(i.user, i.password, i.connectString);
-		connectionPools.push(pool);
-
-		const handler = handlerWebPlSql(pool, i);
-
-		// Capture caches for admin console
-		AdminContext.caches.push({
-			poolName: i.route,
-			procedureNameCache: handler.procedureNameCache,
-			argumentCache: handler.argumentCache,
-		});
-
-		app.use([`${i.route}/:name`, i.route], (req, res, next) => {
-			AdminContext.metrics.requestCount++;
-			const start = process.hrtime();
-			res.on('finish', () => {
-				const diff = process.hrtime(start);
-				const duration = diff[0] * 1000 + diff[1] / 1_000_000;
-				AdminContext.metrics.totalDuration += duration;
-			});
-			handler(req, res, next);
-		});
-	}
-
-	// create server
-	debug('startServer: createServer');
-	const server = createServer(app, ssl);
-
-	// Track open connections
-	/** @type {Set<Socket>} */
-	const connections = new Set();
-	server.on('connection', (/** @type {Socket} */ socket) => {
-		connections.add(socket);
-		socket.on('close', () => {
-			connections.delete(socket);
-		});
-	});
-
-	const closeAllConnections = () => {
-		for (const socket of connections) {
-			socket.destroy(); // forcibly closes the connection
-			connections.delete(socket);
-		}
-	};
-
-	const shutdown = async () => {
-		debug('startServer: onShutdown');
-
-		await poolsClose(connectionPools);
-
-		server.close(() => {
-			console.log('Server has closed');
-			process.exit(0);
-		});
-
-		closeAllConnections();
-	};
-
-	// Install shutdown handler
-	installShutdown(shutdown);
-
-	// Listen
-	debug('startServer: start listener');
-	await /** @type {Promise<void>} */ (
-		new Promise((resolve, reject) => {
-			server
-				.listen(internalConfig.port)
-				.on('listening', () => {
-					debug('startServer: listener running');
-					resolve();
-				})
-				.on('error', (err) => {
-					if ('code' in err) {
-						if (err.code === 'EADDRINUSE') {
-							err.message = `Port ${internalConfig.port} is already in use`;
-						} else if (err.code === 'EACCES') {
-							err.message = `Port ${internalConfig.port} requires elevated privileges`;
-						}
-					}
-					reject(err);
-				});
-		})
-	);
-
-	debug('startServer: END');
-
-	return {
-		config: internalConfig,
-		connectionPools,
-		app,
-		server,
-		shutdown,
-	};
-};
-
-/**
- * Load configuration.
- * @param {string} [filename] - The configuration filename.
- * @returns {configType} - Promise.
- */
-export const loadConfig = (filename = 'config.json') => /** @type {configType} */ (z$configType.parse(getJsonFile(filename)));
-
-/**
- * Start server from config file.
- * @param {string} [filename] - The configuration filename.
- * @param {sslConfig} [ssl] - ssl configuration.
- * @returns {Promise<webServer>} - Promise resolving to the web server object.
- */
-export const startServerConfig = async (filename = 'config.json', ssl) => startServer(loadConfig(filename), ssl);

package/src/types.js

@@ -1,150 +0,0 @@
-import z from 'zod';
-
-/**
- * @typedef {import('oracledb').BindParameter} BindParameter
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('express').CookieOptions} CookieOptions
- * @typedef {import('express').Request} Request
- */
-
-/**
- * @typedef {'basic' | 'debug'} errorStyleType
- */
-export const z$errorStyleType = z.enum(['basic', 'debug']);
-
-/**
- * @typedef {object} configStaticType
- * @property {string} route - The Static route path.
- * @property {string} directoryPath - The Static directory.
- */
-export const z$configStaticType = z.strictObject({
-	route: z.string(),
-	directoryPath: z.string(),
-});
-
-/**
- * @typedef {(connection: Connection, procedure: string) => void | Promise<void>} transactionCallbackType
- * @typedef {'commit' | 'rollback' | transactionCallbackType | undefined | null} transactionModeType
- */
-
-/**
- * @typedef {object} configPlSqlHandlerType
- * @property {string} defaultPage - The default page.
- * @property {string} [pathAlias] - The path alias.
- * @property {string} [pathAliasProcedure] - The path alias.
- * @property {string} documentTable - The document table.
- * @property {string[]} [exclusionList] - The exclusion list.
- * @property {string} [requestValidationFunction] - The request validation function.
- * @property {Record<string, string>} [cgi] - The additional CGI.
- * @property {transactionModeType} [transactionMode] - Specifies an optional transaction mode.
- * "commit" this automatically commits any open transaction after each request. This is the defaults because this is what mod_plsql and ohs are doing.
- * "rollback" this automatically rolles back any open transaction after each request.
- * "transactionCallbackType" this allows to defined a custom handler as a JavaScript function.
- * @property {errorStyleType} errorStyle - The error style.
- */
-export const z$configPlSqlHandlerType = z.strictObject({
-	defaultPage: z.string(),
-	pathAlias: z.string().optional(),
-	pathAliasProcedure: z.string().optional(),
-	documentTable: z.string(),
-	exclusionList: z.array(z.string()).optional(),
-	requestValidationFunction: z.string().optional(),
-	transactionMode: z.unknown().optional(),
-	errorStyle: z$errorStyleType,
-});
-
-/**
- * @typedef {object} configPlSqlConfigType
- * @property {string} route - The PL/SQL route path.
- * @property {string} user - The Oracle username.
- * @property {string} password - The Oracle password.
- * @property {string} connectString - The Oracle connect string.
- */
-export const z$configPlSqlConfigType = z.strictObject({
-	route: z.string(),
-	user: z.string(),
-	password: z.string(),
-	connectString: z.string(),
-});
-
-/**
- * @typedef {configPlSqlHandlerType & configPlSqlConfigType} configPlSqlType
- */
-export const z$configPlSqlType = z.strictObject({
-	...z$configPlSqlHandlerType.shape,
-	...z$configPlSqlConfigType.shape,
-});
-
-/**
- * @typedef {object} configType
- * @property {number} port - The server port number.
- * @property {configStaticType[]} routeStatic - The static routes.
- * @property {configPlSqlType[]} routePlSql - The PL/SQL routes.
- * @property {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
- * @property {string} loggerFilename - name of the request logger filename or '' if not required.
- * @property {string} [adminRoute] - Optional route for the admin console (defaults to /admin).
- * @property {string} [adminUser] - Optional username for admin console basic auth.
- * @property {string} [adminPassword] - Optional password for admin console basic auth.
- */
-export const z$configType = z.strictObject({
-	port: z.number(),
-	routeStatic: z.array(z$configStaticType),
-	routePlSql: z.array(z$configPlSqlType),
-	uploadFileSizeLimit: z.number().optional(),
-	loggerFilename: z.string(),
-	adminRoute: z.string().optional(),
-	adminUser: z.string().optional(),
-	adminPassword: z.string().optional(),
-});
-
-/**
- * Environment variables as string key-value pairs
- * @typedef {Record<string, string>} environmentType
- */
-
-/**
- * Oracle database bind parameter configuration
- * @typedef {Record<string, BindParameter>} BindParameterConfig
- */
-
-/**
- * Arguments object with string or string array values
- * @typedef {Record<string, string | string[]>} argObjType
- */
-
-/**
- * File upload metadata
- * @typedef {object} fileUploadType
- * @property {string} fieldname - The field value.
- * @property {string} originalname - The filename.
- * @property {string} encoding - The encoding.
- * @property {string} mimetype - The mimetype.
- * @property {string} filename - The filename.
- * @property {string} path - The path.
- * @property {number} size - The size.
- */
-
-/**
- * @typedef {object} cookieType
- * @property {string} name - The name of the cookie.
- * @property {string} value - The value of the cookie.
- * @property {CookieOptions} options - The cookie options.
- */
-
-/**
- * @typedef {object} pageType - The page.
- * @property {string} body - The body of the page.
- * @property {object} head - The head of the page.
- * @property {cookieType[]} head.cookies - The cookies.
- * @property {string} [head.contentType] - The content type.
- * @property {number} [head.contentLength] - The content length.
- * @property {number} [head.statusCode] - The status code.
- * @property {string} [head.statusDescription] - The status description.
- * @property {string} [head.redirectLocation] - The redirect location.
- * @property {Record<string, string>} head.otherHeaders - The other headers.
- * @property {string} [head.server] - The server.
- * @property {object} file - The file.
- * @property {string | null} file.fileType - The file type.
- * @property {number | null} file.fileSize - The file size.
- * @property {import('node:stream').Readable | Buffer | null} file.fileBlob - The file blob.
- */