web_plsql 0.5.1 → 0.8.0

package/CHANGELOG.md

@@ -1,133 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## [?.?.?] - ????-??-??
-
-### Added
-### Changed
-### Fixed
-
-
-## [0.5.1] - 2022-09-11
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.5.0] - 2022-05-09
-
-### Changed
-- Replaced mocha with jest.
-- Added support for node 18.
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.4.2] - 2022-01-17
-
-### Changed
-- node.js support starting with v16.
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.4.1] - 2021-08-30
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.4.0] - 2021-04-09
-
-### Added
-- Added a simple oracledb example "examples/oracledb_example.js".
-
-### Changed
-- The credentials for the "examples/sample.js" are stored in "examples/credentials.js" and can also be set using the environment.
-
-### Fixed
-- Updated to oracledb 5 and full binary support for node 14 and later.
-- Updated all minor dependencies.
-
-
-## [0.3.2] - 2020-03-29
-
-### Fixed
-- Updated all minor dependencies.
-
-
-## [0.3.1] - 2020-02-19
-
-### Fixed
-- Updated all minor dependencies.
-
-
-## [0.2.0] - 2019-06-02
-
-## [0.2.0] - 2019-06-02
-
-### Fixed
-- Fixed a problem with the dependencies when installing the npm package.
-- Fixed link to the official oracledb installation documentation.
-- Updated all dependencies.
-
-
-## [0.1.2] - 2019-03-02
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.1.1] - 2019-02-05
-
-### Changed
-- Migrated from Babel to TypeScript
-
-### Fixed
-- Updated all dependencies.
-
-
-## [0.1.0] - 2018-09-03
-
-### Added
-- Added the configuration open "errorStyle" that can be set to "basic" or "debug".
-- The current web_plsql version is now a string property "version" in the middleware object.
-- Added the express status monitor to the sample. (http://localhost:8000/status)
-
-### Fixed
-- When downloading a file, first send any eventual "other headers" like "Content-Disposition".
-- Changed x-db-xontent-length to x-db-content-length.
-- Updated all dependencies.
-
-
-## [0.0.3] - 2018-03-20
-
-### Added
-- Added support for the PlsqlPathAlias and PlsqlPathAliasProcedure DAD settings.
-- Partial support of APEX application.
-- Added example configuration for APEX application.
-- Added unit tests with a code coverage of over 90%.
-
-### Fixed
-- Fixed some edge cases when processing the http headers.
-
-
-## [0.0.2] - 2018-03-19
-
-### Added
-- Allow to add or override CGI environment variables using the "cgi" property in the configuration object.
-- Added unit tests with a code coverage of over 80%.
-
-### Fixed
-- Fixed wrong field name when uploading files using a form.
-
-
-## [0.0.1] - 2018-03-17
-
-- Initial release

package/examples/apex.js

@@ -1,70 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const express = require('express');
-const bodyParser = require('body-parser');
-const multipart = require('connect-multiparty');
-const cookieParser = require('cookie-parser');
-const compression = require('compression');
-const morgan = require('morgan');
-
-const oracledb = require('oracledb');
-const webplsql = require('../lib');
-
-/*
-*	Allocate the Oracle database pool
-*/
-
-const connectionPool = oracledb.createPool({
-	user: 'APEX_PUBLIC_USER',
-	password: 'manager',
-	connectString: 'localhost:1521/TEST',
-	poolMin: 10,
-	poolMax: 1000,
-	poolIncrement: 10,
-	queueRequests: false,
-	queueTimeout: 1000
-});
-
-connectionPool.catch(e => {
-	console.error(`Unable to create database pool.\n${e.message}`);
-	process.exit(1);
-});
-
-/*
-*	Start the server
-*/
-
-const PORT = 8000;
-const PATH = '/apex';
-const OPTIONS = {
-	trace: 'on',
-	defaultPage: 'apex',
-	doctable: 'wwv_flow_file_objects$',
-	pathAlias: {
-		alias: 'r',
-		procedure: 'wwv_flow.resolve_friendly_url'
-	},
-	errorStyle: 'debug'
-};
-
-// create express app
-const app = express();
-
-// add middleware
-app.use(multipart());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: true}));
-app.use(cookieParser());
-app.use(compression());
-app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
-
-// add the oracle pl/sql express middleware
-app.use(PATH + '/:name?', webplsql(connectionPool, OPTIONS));
-
-// serving static files
-const staticFilesPath = path.resolve('/Middleware/apex/images/');
-app.use('/i/', express.static(staticFilesPath));
-
-// listen on port
-console.log(`Listening on http://localhost:${PORT}${PATH}`);
-app.listen(PORT);

package/examples/credentials.js

@@ -1,22 +0,0 @@
-/*
- *   Holds the credentials used to connect to the database.
- */
-
-module.exports = {
-  user          : process.env.NODE_ORACLEDB_USER || 'sample',
-
-  // Get the password from the environment variable
-  // NODE_ORACLEDB_PASSWORD.  The password could also be a hard coded
-  // string (not recommended), or it could be prompted for.
-  // Alternatively use External Authentication so that no password is
-  // needed.
-  password      : process.env.NODE_ORACLEDB_PASSWORD || 'sample',
-
-  // For information on connection strings see:
-  // https://oracle.github.io/node-oracledb/doc/api.html#connectionstrings
-  connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING || 'localhost:1521/test',
-
-  // Setting externalAuth is optional.  It defaults to false.  See:
-  // https://oracle.github.io/node-oracledb/doc/api.html#extauth
-  externalAuth  : process.env.NODE_ORACLEDB_EXTERNALAUTH ? true : false
-};

package/examples/oracledb_example.js

@@ -1,30 +0,0 @@
-const oracledb = require('oracledb');
-const dbConfig = require('./credentials.js');
-
-async function run() {
-	let connection;
-
-	try {
-		// Connect to database
-		connection = await oracledb.getConnection(dbConfig);
-
-		// Select some data
-		binds = {};
-		result = await connection.execute('SELECT sysdate FROM dual', binds, {});
-		console.log('metadata: ', result.metaData);
-		console.log('results: ');
-		console.log(result.rows);
-	} catch (err) {
-		console.error(err);
-	} finally {
-		if (connection) {
-			try {
-				await connection.close();
-			} catch (err) {
-				console.error(err);
-			}
-		}
-	}
-}
-
-run();

package/examples/sample.js

@@ -1,101 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const express = require('express');
-const bodyParser = require('body-parser');
-const multipart = require('connect-multiparty');
-const cookieParser = require('cookie-parser');
-const compression = require('compression');
-const morgan = require('morgan');
-
-const oracledb = require('oracledb');
-const webplsql = require('../lib');
-
-
-/*
-*	Holds the credentials used by node-oracledb examples to connect
-*	to the database.  Production applications should consider using
-*	External Authentication to avoid hard coded credentials.
-*/
-const dbConfig = require('./credentials.js');
-
-/*
-*	Allocate the Oracle database pool
-*/
-
-const connectionPool = oracledb.createPool({
-	user: dbConfig.user,					// The database user name.
-	password: dbConfig.password,			// The password of the database user.
-	connectString: dbConfig.connectString,	// The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance.
-	poolMin: 10,							// The minimum number of connections a connection pool maintains, even when there is no activity to the target database.
-	poolMax: 1000,							// The maximum number of connections to which a connection pool can grow.
-	poolIncrement: 10,						// The number of connections that are opened whenever a connection request exceeds the number of currently open connections.
-	queueRequests: false,					// If this property is false and a request for a connection is made from a pool where the number of “checked out” connections has reached poolMax, then an ORA-24418 error indicating that further sessions cannot be opened will be returned.
-	queueTimeout: 1000						// The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated.
-});
-
-connectionPool.catch(e => {
-	console.error(`Unable to create database pool.\n${e.message}`);
-	process.exit(1);
-});
-
-/*
-*	Start the server
-*/
-
-const PORT = 8000;
-const PATH = '/base';
-const OPTIONS = {
-	trace: 'on',
-	defaultPage: 'sample.pageIndex',
-	doctable: 'docTable',
-	pathAlias: {
-		alias: 'myalias',
-		procedure: 'sample.pagePathAlias'
-	},
-	errorStyle: 'debug'
-};
-
-// Welcome message
-console.log(`Welcome to web_plsql version ${webplsql.version}!`);
-
-// create express app
-const app = express();
-
-// add middleware
-app.use(multipart());
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: true}));
-app.use(cookieParser());
-app.use(compression());
-app.use(morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), 'access.log'), {flags: 'a'})}));
-
-// add express status monitor
-app.use(require('express-status-monitor')());
-console.log(`Express status monitor is listening on http://localhost:${PORT}/status`);
-
-// add the oracle pl/sql express middleware
-app.use(PATH + '/:name?', webplsql(connectionPool, OPTIONS));
-
-// serving static files
-app.use('/static', express.static(path.join(process.cwd(), 'examples/static')));
-
-// shutdown
-process.on('SIGTERM', shutDown);
-process.on('SIGINT', shutDown);
-
-// listen on port
-console.log(`Sample app is listening on http://localhost:${PORT}${PATH}`);
-const server = app.listen(PORT);
-
-function shutDown() {
-	console.log('Received kill signal, shutting down gracefully');
-	server.close(() => {
-		console.log('Closed out remaining connections');
-		process.exit(0);
-	});
-
-	setTimeout(() => {
-		console.error('Could not close connections in time, forcefully shutting down');
-		process.exit(1);
-	}, 10000);
-}

package/examples/sql/sample.pkb

@@ -1,223 +0,0 @@
-CREATE OR REPLACE
-PACKAGE BODY sample IS
-
-PROCEDURE openPage(title IN VARCHAR2);
-PROCEDURE closePage;
-
-FUNCTION emptyArray RETURN vc_arr
-IS
-	arr vc_arr;
-BEGIN
-	RETURN arr;
-END emptyArray;
-
-PROCEDURE pageIndex(p IN VARCHAR2 DEFAULT NULL)
-IS
-BEGIN
-	openPage('web_plsql - Index Page');
-	htp.p('<ul>');
-	htp.p('<li><a href="sample.pageSimple?text=some-text">Simple page</a></li>');
-	htp.p('<li><a href="sample.pageArray?text=some-text'||CHR(38)||'text=more-text'||CHR(38)||'text=last-text">Array passing</a></li>');
-	htp.p('<li><a href="!sample.pageFlexible?p1=v1'||CHR(38)||'p2=v2'||CHR(38)||'p3=v3.1'||CHR(38)||'p3=v3.2"">Flexible parameter passing</a></li>');
-	htp.p('<li><a href="sample.pageCGI">CGI</a></li>');
-	htp.p('<li><a href="sample.pageCookie">Cookies</a></li>');
-	htp.p('<li><a href="sample.pageForm">Form</a></li>');
-	htp.p('<li><a href="sample.pageFileUpload">File upload</a></li>');
-	htp.p('<li><a href="sample.pageRedirect">Redirect</a></li>');
-	htp.p('<li><a href="sample.pageLocation">Change location</a></li>');
-	htp.p('<li><a href="myalias">pathAlias configuration setting</a></li>');
-	htp.p('</ul>');
-	closePage();
-END pageIndex;
-
-PROCEDURE pageSimple(text IN VARCHAR2 DEFAULT NULL)
-IS
-BEGIN
-	openPage('web_plsql - Simple page');
-	htp.p('<p>'||text||'</p>');
-	closePage();
-END pageSimple;
-
-PROCEDURE pageArray(text IN vc_arr)
-IS
-BEGIN
-	openPage('web_plsql - Array parameter passing');
-	htp.p('<table>');
-	htp.p('<tr><th>value</th></tr>');
-	FOR i IN 1 .. text.COUNT LOOP
-		htp.p('<tr><td>'||text(i)||'</td></tr>');
-	END LOOP;
-	htp.p('</table>');
-	closePage();
-END pageArray;
-
-PROCEDURE pageFlexible(name_array IN owa.vc_arr, value_array IN owa.vc_arr)
-IS
-BEGIN
-	openPage('web_plsql - Flexible parameter passing');
-	htp.p('<table>');
-	htp.p('<tr><th>name</th><th>value</th></tr>');
-	FOR i IN 1 .. name_array.COUNT LOOP
-		htp.p('<tr><td>'||name_array(i)||'</td><td>'||value_array(i)||'</td></tr>');
-	END LOOP;
-	htp.p('</table>');
-	closePage();
-END pageFlexible;
-
-PROCEDURE pageCGI
-IS
-BEGIN
-	openPage('web_plsql - CGI');
-	htp.p('<table>');
-	htp.p('<tr><th>name</th><th>value</th></tr>');
-	FOR i IN 1 .. owa.num_cgi_vars LOOP
-		htp.p('<tr><td>'||owa.cgi_var_name(i)||'</td><td>'||owa.cgi_var_val(i)||'</td></tr>');
-	END LOOP;
-	htp.p('</table>');
-	closePage();
-END pageCGI;
-
-PROCEDURE pageCookie
-IS
-	names		owa_cookie.vc_arr;
-	vals		owa_cookie.vc_arr;
-	num_vals	INTEGER;
-BEGIN
-	owa_cookie.get_all(names=>names, vals=>vals, num_vals=>num_vals);
-
-	owa_util.mime_header('text/html', FALSE);
-	owa_cookie.send('demoCookie', TO_CHAR(SYSDATE, 'YYYY.MM.DD HH24:MI:SS'));
-	owa_util.http_header_close;
-
-	openPage('web_plsql - Cookies');
-	htp.p('<table>');
-	htp.p('<tr><th>name</th><th>value</th></tr>');
-	FOR i IN 1 .. num_vals LOOP
-		htp.p('<tr><td>'||names(i)||'</td><td>'||vals(i)||'</td></tr>');
-	END LOOP;
-	htp.p('</table>');
-	closePage();
-END pageCookie;
-
-PROCEDURE pageForm
-IS
-BEGIN
-	openPage('web_plsql - Form');
-	htp.p('<form method="POST" action="sample.pageFormProcess">');
-	htp.p('<table>');
-	htp.p('<tr><td>First name:</td><td><input type="text" name="firstname"></td></tr>');
-	htp.p('<tr><td>Last name:</td><td><input type="text" name="lastname"></td></tr>');
-	htp.p('<tr><td>Age:</td><td><input type="text" name="age"></td></tr>');
-	htp.p('<tr><td colspan="2"><input type="radio" name="sex" value="male">Male</td></tr>');
-	htp.p('<tr><td colspan="2"><input type="radio" name="sex" value="female">Female</td></tr>');
-	htp.p('<tr><td colspan="2"><input type="checkbox" name="vehicle" value="Bike">I have a bike</td></tr>');
-	htp.p('<tr><td colspan="2"><input type="checkbox" name="vehicle" value="Car">I have a car </td></tr>');
-	htp.p('<tr><td colspan="2"><input type="submit" value="Submit"></td></tr>');
-	htp.p('</table>');
-	htp.p('</form>');
-	closePage();
-END pageForm;
-
-PROCEDURE pageFormProcess(firstname IN VARCHAR2 DEFAULT NULL, lastname IN VARCHAR2 DEFAULT NULL, age IN VARCHAR2 DEFAULT NULL, sex IN VARCHAR2 DEFAULT NULL, vehicle IN vc_arr  DEFAULT emptyArray)
-IS
-	PROCEDURE line(name IN VARCHAR2, value IN VARCHAR2)
-	IS
-	BEGIN
-		htp.p('<tr><th>'||name||'</th><td>'||value||'</td></tr>');
-	END line;
-BEGIN
-	openPage('web_plsql - Form processed');
-	htp.p('<table>');
-	line('firstname', firstname);
-	line('lastname', lastname);
-	line('age', age);
-	line('sex', sex);
-	FOR i IN 1 .. vehicle.COUNT LOOP
-		line('vehicle '||i, vehicle(i));
-	END LOOP;
-	htp.p('</table>');
-	closePage();
-END pageFormProcess;
-
-PROCEDURE pageFileUpload
-IS
-BEGIN
-	openPage('web_plsql - File upload');
-	htp.p('<form enctype="multipart/form-data" method="POST" action="!sample.pageFileUploaded">');
-	htp.p('<p>File 1: <input type="file" name="file1" /></p>');
-	htp.p('<p>File 2: <input type="file" name="file2" /></p>');
-	htp.p('<p>File 3: <input type="file" name="file3" /></p>');
-	htp.p('<p><input type="submit" name="submit" value"Upload" /></p>');
-	htp.p('</form>');
-	closePage();
-END pageFileUpload;
-
-PROCEDURE pageFileUploaded(name_array IN owa.vc_arr, value_array IN owa.vc_arr)
-IS
-BEGIN
-	openPage('web_plsql - File uploaded');
-	htp.p('<table>');
-	htp.p('<tr><th>name</th><th>value</th></tr>');
-	FOR i IN 1 .. name_array.COUNT LOOP
-		htp.p('<tr><td>'||name_array(i)||'</td><td>'||value_array(i)||'</td></tr>');
-	END LOOP;
-	htp.p('</table>');
-	closePage();
-END pageFileUploaded;
-
-PROCEDURE pageRedirect
-IS
-BEGIN
-	owa_util.mime_header('text/html', FALSE);
-	owa_cookie.send('fromPage', 'sample.pageRedirect');
-	owa_util.redirect_url(curl=>'sample.pageOther', bclose_header=>FALSE);
-	owa_util.http_header_close;
-END pageRedirect;
-
-PROCEDURE pageLocation
-IS
-BEGIN
-	openPage('web_plsql - pageLocation');
-	htp.p('<script>self.top.location.replace("sample.pageOther");</script>');
-	closePage();
-END pageLocation;
-
-PROCEDURE pageOther
-IS
-BEGIN
-	openPage('web_plsql - Other page');
-	closePage();
-END pageOther;
-
-PROCEDURE pagePathAlias(p_path IN VARCHAR2)
-IS
-BEGIN
-	openPage('web_plsql - pathAlias page');
-	htp.p('<p>p_path: "'||p_path||'"</p>');
-	closePage();
-END pagePathAlias;
-
-PROCEDURE openPage(title IN VARCHAR2)
-IS
-BEGIN
-	htp.p('<!DOCTYPE html>');
-	htp.p('<html>');
-	htp.p('<head>');
-	htp.p('<title>'||title||'</title>');
-	htp.p('<meta charset="utf-8">');
-	htp.p('<link rel="stylesheet" type="text/css" href="/static/sample.css" />');
-	htp.p('</head>');
-	htp.p('<body>');
-	htp.p('<h1>'||title||'</h1>');
-	htp.p('<p><a href="sample.pageIndex">Menu</a></p>');
-END openPage;
-
-PROCEDURE closePage
-IS
-BEGIN
-	htp.p('</body>');
-	htp.p('</html>');
-END closePage;
-
-END sample;
-/

package/examples/sql/sample.pks

@@ -1,24 +0,0 @@
-CREATE OR REPLACE
-PACKAGE sample IS
-
-TYPE vc_arr IS TABLE OF VARCHAR2(2000) INDEX BY BINARY_INTEGER;
-
-FUNCTION emptyArray RETURN vc_arr;
-
-PROCEDURE pageIndex(p IN VARCHAR2 DEFAULT NULL);
-PROCEDURE pageSimple(text IN VARCHAR2 DEFAULT NULL);
-PROCEDURE pageFlexible(name_array IN owa.vc_arr, value_array IN owa.vc_arr);
-PROCEDURE pageArray(text IN vc_arr);
-PROCEDURE pageCGI;
-PROCEDURE pageCookie;
-PROCEDURE pageForm;
-PROCEDURE pageFormProcess(firstname IN VARCHAR2 DEFAULT NULL, lastname IN VARCHAR2 DEFAULT NULL, age IN VARCHAR2 DEFAULT NULL, sex IN VARCHAR2 DEFAULT NULL, vehicle IN vc_arr  DEFAULT emptyArray);
-PROCEDURE pageFileUpload;
-PROCEDURE pageFileUploaded(name_array IN owa.vc_arr, value_array IN owa.vc_arr);
-PROCEDURE pageRedirect;
-PROCEDURE pageLocation;
-PROCEDURE pageOther;
-PROCEDURE pagePathAlias(p_path IN VARCHAR2);
-
-END sample;
-/