daveappserver 0.6.26 → 0.6.27

package/appserver.js

@@ -1,4 +1,4 @@
-var myVersion = "0.6.26", myProductName = "daveAppServer";  
+var myVersion = "0.6.27", myProductName = "daveAppServer";  
 
 exports.start = startup; 
 exports.notifySocketSubscribers = notifySocketSubscribers;
@@ -66,6 +66,8 @@ var config = {
 	
 	flUseS3ForStorage: false, //2/15/23 by DW
 	
+	flUseDatabaseForConfirmations: false, //8/14/23 by DW
+	
 	isUserInDatabase: function (screenname, callback) { //2/6/23 by DW
 		callback (false);
 		},
@@ -1013,6 +1015,115 @@ function cleanFileStats (stats) { //4/19/21 by DW
 			});
 		}
 //email registration -- 12/7/22 by DW
+	function addPendingConfirmation (theConfirmation, callback) { //8/14/23 by DW
+		if (config.flUseDatabaseForConfirmations) {
+			theConfirmation.whenCreated = theConfirmation.when;
+			delete theConfirmation.when;
+			
+			var sqltext = "replace into pendingConfirmations " + davesql.encodeValues (theConfirmation);
+			davesql.runSqltext (sqltext, function (err, result) {
+				if (err) {
+					callback (err);
+					}
+				else {
+					console.log ("addPendingConfirmation: email == " + theConfirmation.email);
+					callback (undefined);
+					}
+				});
+			}
+		else {
+			stats.pendingConfirmations.push (theConfirmation);
+			statsChanged ();
+			callback (undefined); //no error
+			}
+		}
+	function findPendingConfirmation (magicString, callback) { //8/14/23 by DW
+		if (config.flUseDatabaseForConfirmations) {
+			var sqltext = "select * from pendingConfirmations where magicString=" + davesql.encode (magicString) + ";";
+			davesql.runSqltext (sqltext, function (err, result) {
+				if (err) {
+					console.log ("findPendingConfirmation: err.message == " + err.message);
+					callback (err);
+					}
+				else {
+					if (result.length == 0) {
+						const message = "Can't find the pending confirmation.";
+						callback ({message});
+						}
+					else {
+						callback (undefined, result [0]);
+						}
+					}
+				});
+			}
+		else {
+			var flFoundConfirm = false;
+			stats.pendingConfirmations.forEach (function (item) {
+				if (item.magicString == emailConfirmCode) {
+					callback (undefined, item);
+					flFoundConfirm = true;
+					}
+				});
+			if (!flFoundConfirm) {
+				const message = "Can't find the pending confirmation.";
+				callback ({message});
+				}
+			}
+		}
+	function deletePendingConfirmation (item, callback) { //8/14/23 by DW
+		if (config.flUseDatabaseForConfirmations) {
+			const sqltext = "update pendingConfirmations set flDeleted = true where magicString = " + enclode (item.magicString) + ";"
+			davesql.runSqltext (sqltext, function (err, result) {
+				if (err) {
+					if (callback !== undefined) {
+						callback (err);
+						}
+					}
+				else {
+					if (callback !== undefined) {
+						callback (undefined);
+						}
+					}
+				});
+			}
+		else {
+			item.flDeleted = true; 
+			}
+		}
+	function checkPendingConfirmations (callback) { //8/14/23 by DW
+		if (config.flUseDatabaseForConfirmations) {
+			const sqltext = "delete from pendingConfirmations where flDeleted = true or whenCreated < now() - interval 1 hour;";
+			davesql.runSqltext (sqltext, function (err, result) {
+				if (err) {
+					if (callback !== undefined) {
+						callback (err);
+						}
+					}
+				else {
+					if (callback !== undefined) {
+						callback (undefined);
+						}
+					}
+				});
+			}
+		else {
+			var flChanged = false;
+			var newArray = new Array ();
+			stats.pendingConfirmations.forEach (function (item) {
+				if ((!item.flDeleted) && (utils.secondsSince (item.when) < config.confirmationExpiresAfter)) {
+					newArray.push (item);
+					}
+				else {
+					flChanged = true;
+					}
+				});
+			if (flChanged) {
+				stats.pendingConfirmations = newArray;
+				statsChanged ();
+				}
+			}
+		}
+	
 	function sendConfirmingEmail (email, screenname, flNewUser=false, urlRedirect, callback) {
 		email = utils.stringLower (email); //3/8/23 by DW
 		function getScreenname (callback) {
@@ -1066,35 +1177,40 @@ function cleanFileStats (stats) { //4/19/21 by DW
 					urlRedirect, //3/3/23 by DW
 					when: new Date ()
 					};
-				stats.pendingConfirmations.push (obj);
-				statsChanged ();
-				console.log ("sendConfirmingEmail: obj == " + utils.jsonStringify (obj));
-				var params = {
-					title: config.confirmEmailSubject,
-					operationToConfirm: config.operationToConfirm,
-					confirmationUrl: urlWebApp + "userconfirms?emailConfirmCode=" + encodeURIComponent (magicString)
-					};
-				fs.readFile (config.fnameEmailTemplate, function (err, emailTemplate) {
+				addPendingConfirmation (obj, function (err) { //8/14/23 by DW
 					if (err) {
-						const message = "Error reading email template.";
-						console.log ("sendConfirmingEmail: err.message == " + err.message);
-						callback ({message});
+						callback (err);
 						}
 					else {
-						var mailtext = utils.multipleReplaceAll (emailTemplate.toString (), params, false, "[%", "%]");
-						mail.send (email, params.title, mailtext, config.mailSender, function (err, data) {
+						console.log ("sendConfirmingEmail: obj == " + utils.jsonStringify (obj));
+						var params = {
+							title: config.confirmEmailSubject,
+							operationToConfirm: config.operationToConfirm,
+							confirmationUrl: urlWebApp + "userconfirms?emailConfirmCode=" + encodeURIComponent (magicString)
+							};
+						fs.readFile (config.fnameEmailTemplate, function (err, emailTemplate) {
 							if (err) {
-								callback (err);
+								const message = "Error reading email template.";
+								console.log ("sendConfirmingEmail: err.message == " + err.message);
+								callback ({message});
 								}
 							else {
-								callback (undefined, {message: "Please check your email."});
+								var mailtext = utils.multipleReplaceAll (emailTemplate.toString (), params, false, "[%", "%]");
+								mail.send (email, params.title, mailtext, config.mailSender, function (err, data) {
+									if (err) {
+										callback (err);
+										}
+									else {
+										callback (undefined, {message: "Please check your email."});
+										}
+									});
+								const f = config.dataFolder + "lastmail.html";
+								utils.sureFilePath (f, function () {
+									fs.writeFile (f, mailtext, function (err) {
+										});
+									});
 								}
 							});
-						const f = config.dataFolder + "lastmail.html";
-						utils.sureFilePath (f, function () {
-							fs.writeFile (f, mailtext, function (err) {
-								});
-							});
 						}
 					});
 				}
@@ -1106,8 +1222,15 @@ function cleanFileStats (stats) { //4/19/21 by DW
 		function encode (s) {
 			return (encodeURIComponent (s));
 			}
-		stats.pendingConfirmations.forEach (function (item) {
-			if (item.magicString == emailConfirmCode) {
+		
+		findPendingConfirmation (emailConfirmCode, function (err, theConfirmation) {
+			if (err) {
+				if (urlRedirect === undefined) {
+					urlRedirect = urlWebApp;
+					}
+				callback (urlRedirect + "?failedLogin=true&message=" + encode (err.message); );
+				}
+			else {
 				if (config.addEmailToUserInDatabase !== undefined) { 
 					if (item.urlRedirect !== undefined) { //3/3/23 by DW
 						urlWebApp = item.urlRedirect;
@@ -1118,36 +1241,13 @@ function cleanFileStats (stats) { //4/19/21 by DW
 							}
 						else {
 							urlRedirect = urlWebApp + "?emailconfirmed=true&email=" + encode (item.email) + "&code=" + encode (emailSecret) + "&screenname=" + encode (item.screenname);
-							item.flDeleted = true; 
+							deletePendingConfirmation (item);
 							}
 						callback (urlRedirect);
 						});
 					}
-				flFoundConfirm = true;
 				}
 			});
-		if (!flFoundConfirm) {
-			if (urlRedirect === undefined) {
-				urlRedirect = urlWebApp + "?failedLogin=true&message=" + encode ("Can't find the pending confirmation."); 
-				}
-			callback (urlRedirect);
-			}
-		}
-	function checkPendingConfirmations () {
-		var flChanged = false;
-		var newArray = new Array ();
-		stats.pendingConfirmations.forEach (function (item) {
-			if ((!item.flDeleted) && (utils.secondsSince (item.when) < config.confirmationExpiresAfter)) {
-				newArray.push (item);
-				}
-			else {
-				flChanged = true;
-				}
-			});
-		if (flChanged) {
-			stats.pendingConfirmations = newArray;
-			statsChanged ();
-			}
 		}
 
 function startup (options, callback) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "daveappserver",
 	"description": "Factored code that was appearing in all my servers.",
-	"version": "0.6.26",
+	"version": "0.6.27",
 	"main": "appserver.js",
 	"repository": {
 		"type" : "git",

package/readme.md

@@ -1,78 +0,0 @@
-# appserver
-
-A new release of nodeStorage that removes all the historical addons, streamlines configuration, only serves from the local file system, and serves the home page of the app. It could be thought of as v2.0 of nodeStorage except it is not backward compatible. 
-
-### Overview
-
-Over the years nodeStorage got a lot of appendages and add-ons that most apps don't use. 
-
-The configuration file was confusing and not well documented.
-
-It was one of the first things I wrote for Node, and I learned a lot over time.
-
-FInally when one of my programming partners had difficulty understanding the code, I realizaed I did too, and decided to rebuild it from scratch using components I had already developed, such as davehttp, davetwitter, etc. 
-
-I have converted Little Outliner to use this backend. The app was only modified in how it's configured. Everything else remains the same. It uses the same api glue file that it used to access nodeStorage. 
-
-### Configuring
-
-Below is an example of config.json file that goes in the same directory as the appserver.js file.
-
-### Example
-
-```json
-
-### Explanation
-
-The first section provides configuration information about and to the app that's running on the server's home page.  
-
-1. productName is an id that can be used to identify the product. No specified use.
-
-2. productNameForDisplay is what the app should use in its user interface.
-
-3. urlServerHomePageSource is the address of an HTML page that is served through the home page of the server. It can contain macros that plug in values from the server. 
-
-4. prefsPath is the name of the prefs file for the app. This is the file you should read and save to, to maintain the state of the app for the user. 
-
-5. docsPath is where the documents for this app are stored in the user's storage on the server.
-
-6. urlServerForClient is the address the app uses to call back to the server. 
-
-7. urlWebsocketServerForClient is the address of the web socket that reports on changes to files stored on the server. This address can be included in the app files so that apps that read the files can subbscribe to changes. 
-
-The second section configures the HTTP server and the connection to Twitter for identity. 
-
-1. port is the port the HTTP server will run on, unless process.env.PORT is specified. It overrides the port choice in the config file.
-
-2. flWebsocketEnabled, a boolean, determines whether or not we initialize the websocket server, if it's true then websocketPort is the port it's listening on. 
-
-3. myDomain, the domain assigned to this app. It's the domain you'd use to access the home page. If that includes a port, include the port in this value.
-
-4. twitterConsumerKey and twitterConsumerSecret are the values that identify the app for Twitter, as assigned on developer.twitter.com. 
-
-### Updates
-
-#### v0.5.48 -- 3/18/22 by DW
-
-Exports three routines: fileExists, readWholeFile, writeWholeFile.
-
-#### v0.5.44 -- 3/18/22 by DW
-
-New callback, config.publishFile. If defined we call back with the file, screenname, relpath, flprivate, filetext and the url of the file if it's public.
-
-It's called when we handle a /publishfile or /writewholefile message.
-
-#### v0.5.32 -- 12/4/21 by DW
-
-Added a new callback, publicFileSaved, which is called when the user updates a public file. 
-
-Fixed a bug where a user couldn't create a new file if their public files folder was empty. 
-
-#### v0.5.32 -- 9/26/21 by DW
-
-Fixed the example app to require "../appserver.js" instead of "lib/daveappserver.js" which only exists on my development machine. 
-
-#### v0.5.31 -- 9/15/21 by DW
-
-writeWholeFile was meant to be sure the path to the file exists before writing the file. It wasn't doing it, now it does. 
-

package/readme.opml

@@ -1,67 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<opml version="2.0">
-	<head>
-		<title>readme.md</title>
-		<dateModified>Sat, 28 May 2022 18:55:48 GMT</dateModified>
-		<expansionState></expansionState>
-		<vertScrollState>1</vertScrollState>
-		<windowTop>300</windowTop>
-		<windowLeft>700</windowLeft>
-		<windowBottom>900</windowBottom>
-		<windowRight>1500</windowRight>
-		</head>
-	<body text="readme.md">
-		<outline text="# appserver">
-			<outline text="A new release of nodeStorage that removes all the historical addons, streamlines configuration, only serves from the local file system, and serves the home page of the app. It could be thought of as v2.0 of nodeStorage except it is not backward compatible. "></outline>
-			</outline>
-		<outline text="### Overview">
-			<outline text="Over the years nodeStorage got a lot of appendages and add-ons that most apps don't use. "></outline>
-			<outline text="The configuration file was confusing and not well documented."></outline>
-			<outline text="It was one of the first things I wrote for Node, and I learned a lot over time."></outline>
-			<outline text="FInally when one of my programming partners had difficulty understanding the code, I realizaed I did too, and decided to rebuild it from scratch using components I had already developed, such as davehttp, davetwitter, etc. "></outline>
-			<outline text="I have converted Little Outliner to use this backend. The app was only modified in how it's configured. Everything else remains the same. It uses the same api glue file that it used to access nodeStorage. "></outline>
-			</outline>
-		<outline text="### Configuring">
-			<outline text="Below is an example of config.json file that goes in the same directory as the appserver.js file."></outline>
-			</outline>
-		<outline text="### Example">
-			<outline text="&lt;%includeExample (&quot;example1&quot;)%&gt;"></outline>
-			</outline>
-		<outline text="### Explanation">
-			<outline text="The first section provides configuration information about and to the app that's running on the server's home page.  ">
-				<outline text="1. productName is an id that can be used to identify the product. No specified use."></outline>
-				<outline text="2. productNameForDisplay is what the app should use in its user interface."></outline>
-				<outline text="3. urlServerHomePageSource is the address of an HTML page that is served through the home page of the server. It can contain macros that plug in values from the server. "></outline>
-				<outline text="4. prefsPath is the name of the prefs file for the app. This is the file you should read and save to, to maintain the state of the app for the user. "></outline>
-				<outline text="5. docsPath is where the documents for this app are stored in the user's storage on the server."></outline>
-				<outline text="6. urlServerForClient is the address the app uses to call back to the server. "></outline>
-				<outline text="7. urlWebsocketServerForClient is the address of the web socket that reports on changes to files stored on the server. This address can be included in the app files so that apps that read the files can subbscribe to changes. "></outline>
-				</outline>
-			<outline text="The second section configures the HTTP server and the connection to Twitter for identity. ">
-				<outline text="1. port is the port the HTTP server will run on, unless process.env.PORT is specified. It overrides the port choice in the config file."></outline>
-				<outline text="2. flWebsocketEnabled, a boolean, determines whether or not we initialize the websocket server, if it's true then websocketPort is the port it's listening on. "></outline>
-				<outline text="3. myDomain, the domain assigned to this app. It's the domain you'd use to access the home page. If that includes a port, include the port in this value."></outline>
-				<outline text="4. twitterConsumerKey and twitterConsumerSecret are the values that identify the app for Twitter, as assigned on developer.twitter.com. "></outline>
-				</outline>
-			</outline>
-		<outline created="Wed, 15 Sep 2021 14:19:02 GMT" text="### Updates">
-			<outline created="Sat, 28 May 2022 18:54:36 GMT" text="#### v0.5.48 -- 3/18/22 by DW">
-				<outline created="Sat, 28 May 2022 18:54:39 GMT" text="Exports three routines: fileExists, readWholeFile, writeWholeFile."></outline>
-				</outline>
-			<outline created="Fri, 18 Mar 2022 14:21:28 GMT" text="#### v0.5.44 -- 3/18/22 by DW">
-				<outline created="Fri, 18 Mar 2022 14:21:59 GMT" text="New callback, config.publishFile. If defined we call back with the file, screenname, relpath, flprivate, filetext and the url of the file if it's public."></outline>
-				<outline created="Fri, 18 Mar 2022 14:22:36 GMT" text="It's called when we handle a /publishfile or /writewholefile message."></outline>
-				</outline>
-			<outline created="Sat, 04 Dec 2021 21:29:57 GMT" text="#### v0.5.32 -- 12/4/21 by DW">
-				<outline created="Sat, 04 Dec 2021 21:30:33 GMT" text="Added a new callback, publicFileSaved, which is called when the user updates a public file. "></outline>
-				<outline created="Sat, 04 Dec 2021 21:29:58 GMT" text="Fixed a bug where a user couldn't create a new file if their public files folder was empty. "></outline>
-				</outline>
-			<outline created="Wed, 15 Sep 2021 14:19:10 GMT" text="#### v0.5.32 -- 9/26/21 by DW">
-				<outline created="Wed, 15 Sep 2021 14:19:12 GMT" text="Fixed the example app to require &quot;../appserver.js&quot; instead of &quot;lib/daveappserver.js&quot; which only exists on my development machine. "></outline>
-				</outline>
-			<outline created="Wed, 15 Sep 2021 14:19:10 GMT" text="#### v0.5.31 -- 9/15/21 by DW">
-				<outline created="Wed, 15 Sep 2021 14:19:12 GMT" text="writeWholeFile was meant to be sure the path to the file exists before writing the file. It wasn't doing it, now it does. "></outline>
-				</outline>
-			</outline>
-		</body>
-	</opml>