web_plsql 0.5.0 → 0.6.0

package/src/fileUpload.ts

@@ -1,126 +0,0 @@
-/*
-*	Process file uploads
-*/
-
-import path from 'path';
-import fs from 'fs';
-import express from 'express';
-import oracledb from 'oracledb';
-
-export type fileUploadType = {
-	fieldValue: string;
-	filename: string;
-	physicalFilename: string;
-	encoding: string;
-	mimetype: string;
-	size: number;
-};
-export type filesUploadType = Array<fileUploadType>;
-
-let sequencialID = 0;
-
-/**
-* Get the files
-*
-* @param {express.Request} req - The req object represents the HTTP request.
-* @returns {Promise<filesUploadType>} - Promise that resolves with an array of files to be uploaded.
-*/
-export function getFiles(req: express.Request): filesUploadType {
-	interface TCustomRequest extends express.Request {
-		files: Array<any>;
-	}
-	const customRequest = req as TCustomRequest;
-	const files: filesUploadType = [];
-
-	// are there any files
-	/* istanbul ignore next */
-	if (typeof customRequest.files !== 'object') {
-		return files;
-	}
-
-	// process the files
-	for (const key in customRequest.files) {
-		const file = customRequest.files[key];
-
-		/* istanbul ignore else */
-		if (typeof file.originalFilename === 'string' && file.originalFilename.length > 0) {
-			// get a temporary filename
-			const filename = getRandomizedFilename(file.originalFilename);
-
-			// Add the field
-			file.filename = filename;
-
-			// Add the file to upload
-			files.push({
-				fieldValue: file.fieldName,
-				filename: file.originalFilename,
-				physicalFilename: path.normalize(path.resolve(file.path)),
-				encoding: '',
-				mimetype: file.type,
-				size: file.size
-			});
-		}
-	}
-
-	return files;
-}
-
-/**
-* Upload the given array of files and return a promise that resolves when all uploads have been finished.
-*
-* @param {Array<string>} files - array of file path's.
-* @param {string} docTableName - name of the oracle table holding the uploaded files.
-* @param {oracledb.Connection} databaseConnection - Database connection.
-* @returns {Promise<void>} - Promise that resolves when the request has been fullfilled.
-*/
-export async function uploadFiles(files: filesUploadType, docTableName: string, databaseConnection: oracledb.Connection): Promise<void> {
-	await Promise.all(files.map(file => uploadFile(file, docTableName, databaseConnection)));
-}
-
-/*
-*	Upload the given file and return a promise.
-*/
-export function uploadFile(file: fileUploadType, docTableName: string, databaseConnection: oracledb.Connection): Promise<void> {
-	return new Promise((resolve, reject) => {
-		/* istanbul ignore next */
-		if (typeof docTableName !== 'string' || docTableName.length === 0) {
-			reject(new Error('The option "docTableName" has not been defined or the name is empty'));
-		}
-
-		let blobContent;
-		try {
-			blobContent = fs.readFileSync(file.physicalFilename);
-		} catch (err) {
-			/* istanbul ignore next */
-			reject(new Error(`Unable to read file "${file.physicalFilename}"\n${err instanceof Error ? err.toString() : ''}`));
-			/* istanbul ignore next */
-			return;
-		}
-
-		const sql = `INSERT INTO ${docTableName} (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.fieldValue,
-			mime_type: file.mimetype,
-			doc_size: file.size,
-			blob_content: {
-				val: blobContent,
-				type: oracledb.BUFFER
-			}
-		};
-
-		databaseConnection.execute(sql, bind, {autoCommit: true})
-			.then(() => {
-				resolve();
-			}).catch(/* istanbul ignore next */(e: any) => {
-				reject(new Error(`Unable to insert file "${file.physicalFilename}"\n` + e.toString()));
-			});
-	});
-}
-
-/*
-*	get a randomized filename
-*/
-function getRandomizedFilename(filename: string): string {
-	++sequencialID;
-	return 'F' + (Date.now() + sequencialID).toString() + '/' + path.basename(filename);
-}

package/src/index.ts

@@ -1,65 +0,0 @@
-/*
-*	Express middleware for Oracle PL/SQL
-*/
-
-import url from 'url';
-import express from 'express';
-import oracledb from 'oracledb';
-import {processRequest} from './request';
-import {validate, oracleExpressMiddleware$options} from './config';
-import {RequestError} from './requestError';
-import {errorPage} from './errorPage';
-import {Trace} from './trace';
-const version = require('../package.json').version; // eslint-disable-line @typescript-eslint/no-var-requires
-
-/**
-* Express middleware.
-*
-* @param {Promise<oracledb.Pool>} databasePoolPromise - The promise that will be fullfilled when the database pool has been allocated.
-* @param {Object} options - The configuration options.
-* @returns {Function} - The request handler.
-*/
-const webplsql = function (databasePoolPromise: Promise<oracledb.Pool>, options: oracleExpressMiddleware$options) {
-	// validate the configuration options
-	const validOptions = validate(options);
-
-	// instantiate trace object
-	const trace = new Trace(validOptions.trace);
-
-	return function handler(req: express.Request, res: express.Response/*, next: () => void*/) {
-		requestHandler(req, res, databasePoolPromise, validOptions, trace);
-	};
-};
-
-webplsql.version = version;
-exports = module.exports = webplsql;
-
-/*
-* express.Request handler
-*/
-function requestHandler(req: express.Request, res: express.Response, databasePoolPromise: Promise<oracledb.Pool>, options: oracleExpressMiddleware$options, trace: Trace) {
-	try {
-		trace.start(req);
-
-		// should we switch to the default page if there is one defined
-		if (typeof req.params.name !== 'string' || req.params.name.length === 0) {
-			if (typeof options.defaultPage === 'string' && options.defaultPage.length > 0) {
-				const newUrl = url.resolve(req.originalUrl + '/' + options.defaultPage, '');
-				trace.write(`Redirect to the url "${newUrl}"`);
-				res.redirect(newUrl);
-			} else {
-				/* istanbul ignore next */
-				errorPage(req, res, options, trace, new RequestError('No procedure name given and no default page has been specified'));
-			}
-		} else {
-			processRequest(req, res, options, databasePoolPromise, trace)
-				.catch(e => {
-					/* istanbul ignore next */
-					errorPage(req, res, options, trace, e);
-				});
-		}
-	} catch (err) {
-		/* istanbul ignore next */
-		errorPage(req, res, options, trace, err);
-	}
-}

package/src/page.ts

@@ -1,275 +0,0 @@
-/*
-*	Page the raw page content and return the content to the client
-*/
-
-import {Trace} from './trace';
-import express from 'express';
-
-type cookieType = {
-	name: string;
-	value: string;
-	path?: string;
-	domain?: string;
-	secure?: string;
-	expires?: Date;
-	httpOnly?: boolean;
-};
-
-type pageType = {
-	body: string;
-	head: {
-		cookies: Array<cookieType>;
-		contentType?: string;
-		contentLength?: number;
-		statusCode?: number;
-		statusDescription?: string;
-		redirectLocation?: string;
-		otherHeaders: Record<string, unknown>;
-		server?: string;
-	};
-	file: {
-		fileType: any;
-		fileSize: any;
-		fileBlob: any;
-	};
-};
-
-/**
-*	Parse the header and split it up into the individual components
-*
-* @param {string} text - The text returned from the PL/SQL procedure.
-* @returns {Object} - The parsed page.
-*/
-export function parse(text: string): pageType {
-	const page: pageType = {
-		body: '',
-		head: {
-			cookies: [],
-			otherHeaders: {}
-		},
-		file: {
-			fileType: null,
-			fileSize: null,
-			fileBlob: null
-		}
-	};
-
-	//
-	//	1)	Split up the text in header and body
-	//
-
-	// Find the end of the header identified by \n\n
-	let head = '';
-	const headerEndPosition = text.indexOf('\n\n');
-	if (headerEndPosition === -1) {
-		head = text;
-	} else {
-		head = text.substring(0, headerEndPosition + 2);
-		page.body = text.substring(headerEndPosition + 2);
-	}
-
-	//
-	//	2)	parse the headers
-	//
-
-	head.split('\n').forEach(line => {
-		const header = getHeader(line);
-
-		if (header) {
-			switch (header.name.toLowerCase()) {
-				case 'set-cookie':
-					{
-						const cookie = parseCookie(header.value);
-						/* istanbul ignore else */
-						if (cookie !== null) {
-							page.head.cookies.push(cookie);
-						}
-					}
-					break;
-
-				case 'content-type':
-					page.head.contentType = header.value;
-					break;
-
-				case 'x-db-content-length':
-					{
-						const contentLength = parseInt(header.value, 10);
-						/* istanbul ignore else */
-						if (!Number.isNaN(contentLength)) {
-							page.head.contentLength = contentLength;
-						}
-					}
-					break;
-
-				case 'status':
-					{
-						const statusCode = parseInt(header.value, 10);
-						/* istanbul ignore else */
-						if (!Number.isNaN(statusCode)) {
-							page.head.statusCode = statusCode;
-							const index = header.value.indexOf(' ');
-							/* istanbul ignore else */
-							if (index !== -1) {
-								page.head.statusDescription = header.value.substr(index + 1);
-							}
-						}
-					}
-					break;
-
-				case 'location':
-					page.head.redirectLocation = header.value;
-					break;
-
-				case 'x-oracle-ignore':
-					break;
-
-				default:
-					page.head.otherHeaders[header.name] = header.value;
-					break;
-			}
-		}
-	});
-
-	return page;
-}
-
-/*
-*	get a header line
-*/
-function getHeader(line: string): {name: string; value: string} | null {
-	const index = line.indexOf(':');
-
-	if (index !== -1) {
-		return {
-			name: line.substr(0, index).trim(),
-			value: line.substr(index + 1).trim()
-		};
-	}
-
-	return null;
-}
-
-/*
-*	Send "default" response to the browser
-*/
-export function send(req: express.Request, res: express.Response, page: {body: string; head: any; file: any}, trace: Trace): void {
-	trace.write('send: ENTER');
-
-	// Send the "cookies"
-	page.head.cookies.forEach((cookie: Record<string, unknown>) => {
-		const name = cookie.name as string;
-		const value = cookie.value as string;
-
-		delete cookie.name;
-		delete cookie.value;
-
-		res.cookie(name, value, cookie);
-		trace.append(`send: res.cookie("${name}", "${value}")\n`);
-	});
-
-	// If there is a "redirectLocation" header, we immediately redirect and return
-	if (typeof page.head.redirectLocation === 'string' && page.head.redirectLocation.length > 0) {
-		res.redirect(302, page.head.redirectLocation);
-		trace.append(`send: res.redirect(302, "${page.head.redirectLocation}")\n`);
-		return;
-	}
-
-	// Send all the "otherHeaders"
-	for (const key in page.head.otherHeaders) {
-		res.set(key, page.head.otherHeaders[key]);
-		trace.append(`send: res.set("${key}", "${page.head.otherHeaders[key]}")\n`);
-	}
-
-	// If this is a file download, we eventually set the "Content-Type" and the file content and then return.
-	if (page.file.fileType === 'B' || page.file.fileType === 'F') {
-		if (typeof page.head.contentType === 'string' && page.head.contentType.length > 0) {
-			res.writeHead(200, {'Content-Type': page.head.contentType});
-			trace.append(`sendFile: res.writeHead("Content-Type", "${page.head.contentType}")\n`);
-		}
-		res.end(page.file.fileBlob, 'binary');
-		trace.append('send: res.end()\n');
-		return;
-	}
-
-	// Is the a "contentType" header
-	if (typeof page.head.contentType === 'string' && page.head.contentType.length > 0) {
-		res.set('Content-Type', page.head.contentType);
-		trace.append(`send: res.set("Content-Type", "${page.head.contentType}")\n`);
-	}
-
-	// If we have a "Status" header, we send the header and then return.
-	if (typeof page.head.statusCode === 'number') {
-		res.status(page.head.statusCode).send(page.head.statusDescription);
-		return;
-	}
-
-	// Send the body
-	res.send(page.body);
-	trace.append(`send: res.send\n${'-'.repeat(30)}${page.body}\n${'-'.repeat(30)}\n`);
-
-	trace.write('send: EXIT');
-}
-
-/*
-*	Parses a cookie string
-*/
-function parseCookie(text: string): cookieType | null {
-	// validate
-	/* istanbul ignore next */
-	if (typeof text !== 'string' || text.trim().length === 0) {
-		return null;
-	}
-
-	// split the cookie into it's parts
-	let cookieElements = text.split(';');
-
-	// trim cookie elements
-	cookieElements = cookieElements.map(element => element.trim());
-
-	// get name and value
-	const index = cookieElements[0].indexOf('=');
-	/* istanbul ignore next */
-	if (index <= 0) {
-		// if the index is -1, there is no equal sign and if it's 0 the name is empty
-		return null;
-	}
-	const cookie: any = {};
-	cookie.name = cookieElements[0].substring(0, index).trim();
-	cookie.value = cookieElements[0].substring(index + 1).trim();
-
-	// remove the fisrt element
-	cookieElements.shift();
-
-	// get the other options
-	cookieElements.forEach(element => {
-		if (element.indexOf('path=') === 0) {
-			cookie.path = element.substring(5);
-		} else if (element.toLowerCase().indexOf('domain=') === 0) {
-			cookie.domain = element.substring(7);
-		} else if (element.toLowerCase().indexOf('secure=') === 0) {
-			/* istanbul ignore next */
-			cookie.secure = element.substring(7);
-		} else if (element.toLowerCase().indexOf('expires=') === 0) {
-			const date = tryDecodeDate(element.substring(8));
-			if (date) {
-				cookie.expires = date;
-			}
-		} else if (element.toLowerCase().indexOf('httponly') === 0) {
-			cookie.httpOnly = true;
-		}
-	});
-
-	return cookie;
-}
-
-/*
-*	Decode a date
-*/
-function tryDecodeDate(value: string): Date | null {
-	try {
-		return new Date(value);
-	} catch (err) {
-		/* istanbul ignore next */
-		return null;
-	}
-}