puvox-library 1.0.10 → 1.0.12

package/library_standard.js

@@ -10,6 +10,7 @@
  *  const helpers = new PuvoxLibrary();
  *         console.log ( helpers.get_last_child_of_array(array) );
  *         console.log ( helpers.get_visitor_ip() );
+ *         console.log ( helpers.telegramMessage("hello world", "1234567890", "BOTKEY123:456789") );
  *       ... etc
  *
 */
@@ -18,7 +19,7 @@ const puvox_library =
 {
 	// ########## ARRAY ########## //
 	arrayValue(obj_arr, key, default_){
-		return (key in obj_arr ? obj_arr[key] : default_);
+		return (obj_arr && key in obj_arr ? obj_arr[key] : default_);
 	},
 	arrayValueLower(obj_arr, key, default_){
 		const val = this.arrayValue(obj_arr, key, default_);
@@ -382,8 +383,9 @@ const puvox_library =
 	isArray(x)	{ return ( (!!x) && (x.constructor === Array) ) || (Array.isArray(x)); },	
 	
 	isSimpleVariableType(obj){ return this.isSimpleVariableTypeName(typeof obj); },
-	isSimpleVariableTypeName(type_){ return this.inArray( [ "boolean", "integer", "float", "double", "decimal", "string"], type_);  },
-	isNumericVariableTypeName(type_){ return this.inArray( [ "integer", "float", "double", "decimal"], type_); },
+	isSimpleVariableTypeName(typeName_){ return this.inArray( [ "boolean", "integer", "float", "double", "decimal", "string"], typeName_);  },
+	isNumericVariableType(obj){ return this.isNumericVariableTypeName(typeof obj); },
+	isNumericVariableTypeName(typeName_){ return this.inArray( [ "integer", "float", "double", "decimal"], typeName_); },
 
 	stringToBoolean(string){
 		switch(string.toLowerCase().trim()){
@@ -460,12 +462,18 @@ const puvox_library =
 	trimOnlyFromEnd(content){
 		return content.replace(/\s*$/,"");
 	},
+	startsWith(content, what){
+		return content.startsWith(what);
+	},
 	startsWithArray(content,array){
 		array.forEach(function(val){
 			if (content.startsWith(val)) return true;
 		})
 		return false;
 	},
+	endsWith(content, what){
+		return content.endsWith(what);
+	},
 	endsWithArray(content,array){
 		array.forEach(function(val){
 			if (content.endsWith(val)) return true;
@@ -1295,6 +1303,8 @@ const puvox_library =
 		)
 	},
 
+	milliseconds(){ return (new Date().getTime()); },
+
 	fancyTimeFormat(time)
 	{   
 		var time = time.toFixed(0);
@@ -2467,36 +2477,68 @@ const puvox_library =
 
 
 	// region ### TELEGRAM FUNCTIONS ###
-	// public function telegram($text) { return $helpers->telegram_message( ['chat_id'=>'-1001234567890', 'text'=>$text, 'parse_mode'=>'html', 'disable_web_page_preview'=>true ],   $bot_key ); }          | resp: pastebin_com/u0J1Cph3
-	async telegram_message(opts = {text: 'Hi', chat_id:'-1001234567890'}, bot_id, is_repeated_call=false){
-		opts['disable_web_page_preview'] = 'disable_web_page_preview' in opts ? opts['disable_web_page_preview'] : true;
-		// opts['chat_id'] = opts['chat_id'].toString().substring(0,4) == '-100' ? opts['chat_id'].toString() : '-100' + opts['chat_id'].toString(); opts['chat_id'] = parseInt(opts['chat_id']);
-		opts['text'] = this.stripTags(this.br2nl(opts['text']),'<b><strong><i><em><u><ins><s><strike><del><a><code><pre>'); // allowed: https://core.telegram.org/bots/api#html-style
-		opts['text'] = opts['text'].substring(0, 4095); //max telegram message length 4096
-		const responseText = await (await fetch('https://api.telegram.org/bot'+ bot_id +'/sendMessage', { method: 'POST', headers: { 'Content-Type': 'application/json' + (0 ? 'application/x-www-form-urlencoded':'') }, body: JSON.stringify(opts)})).text();  //'sendMessage?'.http_build_query($array, '');
+	async telegramMessage(text, chat_id, bot_key, extra_opts={}){
+		const is_repeated_call = 'is_repeated_call' in extra_opts;
+		const use_cache = 'cache' in extra_opts;
+		if (! ('parse_mode' in extra_opts)){
+			extra_opts['parse_mode'] = 'html';
+		}
+		if (! ('disable_web_page_preview' in extra_opts)){
+			extra_opts['disable_web_page_preview'] = true;
+		}
+		// whether it's without `-100` prefix
+		chat_id = chat_id.toString();
+		if (!this.startsWith(chat_id, '-100')) chat_id = '-100' + chat_id;
+		text = this.br2nl(text);
+		text = this.stripTags(text,'<b><strong><i><em><u><ins><s><strike><del><a><code><pre>'); // allowed: https://core.telegram.org/bots/api#html-style
+		text = text.substring(0, 4095); //max telegram message length 4096
+		const requestOpts = Object.assign({'chat_id':chat_id, 'text':text}, extra_opts);
+		delete requestOpts['cache'];
+		delete requestOpts['is_repeated_call'];
+		const responseText = await this.getRemoteData('https://api.telegram.org/bot'+ bot_key +'/sendMessage', requestOpts);  // pastebin_com/u0J1Cph3 //'sendMessage?'.http_build_query(opts, ''); 
 		try {
 			const responseJson = JSON.parse(responseText);
 			if (responseJson.ok){
-				return response;
-			} else {
-				//i.e. {"ok":false,"error_code":400,"description":"Bad Request: can't parse entities: Unsupported start tag \"br/\" at byte offset 43"} 
-				// for some reason, if still unsupported format submitted, resubmit the plain format
-				const txt = "Bad Request: can't parse entities";
-				if( response.description.indexOf (txt)> -1 ){
-					const newOpts = this.objectCopy(opts);
-					newOpts['text'] = "[SecondSend] \r\n". this.stripTags(newOpts['text']) ;
-					if ( ! repeated_call ){
-						return this.telegram_message(newOpts, bot_id, true);
-					} else {
-						return response; 
+				return responseJson;
+			} 
+			// for some reason, if still unsupported format submitted, resubmit the plain format
+			//i.e. {"ok":false,"error_code":400,"description":"Bad Request: can't parse entities: Unsupported start tag \"br/\" at byte offset 43"} 
+			else {
+				if( responseJson.description.indexOf ('Bad Request: can\'t parse entities')> -1 ){
+					if ( ! is_repeated_call ){
+						const extraOpts2 = this.objectCopy(opts);
+						text = "[SecondSend with stipped tags] \r\n" + this.stripTags(text) ;
+						extraOpts2['is_repeated_call'] = true;
+						return this.telegram_message(text, chat_id, bot_key, extraOpts2);
 					}
-				} else {
-					return response; 
 				}
+				return responseJson;
 			} 
 		} catch (ex) {
-			return {'ok': false, 'description': responseText };
+			return {'ok': false, 'description': ex.message + ':::' + responseText };
+		}
+	},
+
+	telegram_interval_ms: 50, // telegram seems to accept around 30 times per second, so we'd better wait around that milliseconds
+	telegram_last_sent_time: 0,
+
+	async telegramMessageCached(text, chat_id, bot_key, extra_opts={}){
+		const curMS  = this.milliseconds();
+		const goneMS = curMS - this.telegram_last_sent_time;
+		if ( goneMS < this.telegram_interval_ms ){
+			await this.sleep (this.telegram_interval_ms - goneMS);
+		}
+		this.telegram_last_sent_time = curMS;
+		const cacheId = this.cache.file.idForContent( text +'_'+ chat_id +'_'+ bot_key +'_'+ JSON.stringify(extra_opts) );
+		if (this.cache.file.addIdIfNotExists('function_telegram_message', cacheId) ){
+			return this.telegramMessage(text, chat_id, bot_key, extra_opts);
+		}
+		else {
+			return false;
 		}
+		//if(is_callable([$this,'notifications_db_entry'])) 
+		//	$this->notifications_db_entry($key, $array['chat_id'], $this->stringify($res), time(), $ok );
+		//return $res;
 	},
 
 	openUrlInBrowser(url)
@@ -2657,26 +2699,27 @@ const puvox_library =
 		// 	} catch (ex) { reject (ex); }
 		// });
 	},
-
-	
 	//  if(setHashInAddress) {	window.location.hash = id_or_Name;	}
 	
 
 	
 
 	// ######## CACHE ITEMS (client-side JS) ########
-	AppName : 'puvox_', //override with anything you want
-	setAppName (name){ this.AppName = name; },
-
-	cache : {
-		localStorage : {
-			parent(){ return puvox_library; },
-			AppName(){ return puvox_library.AppName; },
+	_privateAppName : null, //override with anything you want
+	setAppName (name){ this._privateAppName = name; },
+	getAppName(){ 
+		if (!this._privateAppName || this._privateAppName === ''){
+			throw new Error ('Before you start using caching functions, please at first define your appplication\'s name(identifier) at first with .setAppName("whatever_my_app_name"), so it will get its own cache-storage');
+		}
+		return this._privateAppName; 
+	},
 
+	cache: {
+		localStorage : { 
 			storage: typeof window !== 'undefined' ? window.localStorage : null,
 
 			get(name, defaultValue, expireSeconds = 0){
-				let appName = this.AppName();
+				let appName = puvox_library.getAppName();
 				let val = this.storage.getItem(appName + '_' + name);
 				let expireVal = this.storage.getItem(appName + '_createtime_' + name);
 				if (val === null) {
@@ -2696,15 +2739,17 @@ const puvox_library =
 			},
 			set(name, value){
 				try{ 
-					this.storage.setItem(this.AppName() + '_' +name, value); 
-					this.storage.setItem(this.AppName() + '_createtime_' +name, (new Date()).getTime()); 
+					const appName = puvox_library.getAppName();
+					this.storage.setItem(appName + '_' +name, value); 
+					this.storage.setItem(appName + '_createtime_' +name, (new Date()).getTime()); 
 					return true; 
 				}
 				catch(ex){ alert("Cache storage quote exceeded. can't save value. err598"); return false; }
 			},
-			remove(name, value){
-				this.storage.removeItem(this.AppName() + '_' +name); 
-				this.storage.removeItem(this.AppName() + '_createtime_' +name);
+			remove(name){
+				const appName = puvox_library.getAppName();
+				this.storage.removeItem(appName + '_' + name); 
+				this.storage.removeItem(appName + '_createtime_' + name);
 			},
 			getItem(name, subItemName, defaultValue){
 				let val = this.get(name, '{}');
@@ -2725,30 +2770,27 @@ const puvox_library =
 				return this.set(name, JSON.stringify(parsed) );
 			}
 		},
-		file : {
+		file: {
 			// ########## CACHE DIRS (server-side JS) ##########
-			parent(){ return puvox_library; },
-			AppName(){ return puvox_library.AppName; },
-
 			customCacheDir:null,
-			dirPath(){  
+			dir(){  
 				if (!this.customCacheDir){ 
-					this.customCacheDir = this.parent().file.getTempDir() + '/';
+					this.customCacheDir = puvox_library.file.getTempDir() + '/';
 				}
-				let finaldir = this.customCacheDir + '_cache' + this.AppName() + '/';
+				let finaldir = this.customCacheDir + '_cache_' + puvox_library.getAppName() + '/';
 				return finaldir; 
 			},
 			filePath(uniqFileName){
-				const parent = this.parent();
+				const parent = puvox_library;
 				uniqFileName = parent.isString(uniqFileName) || parent.isNumeric(uniqFileName) ? uniqFileName : JSON.stringify(uniqFileName);
 				uniqFileName = parent.sanitize_key_dashed(parent.getCharsFromStart(uniqFileName, 15)) + "_"+ parent.md5(uniqFileName);
-				filePath= this.dirPath() + uniqFileName + "_tmp"; //"/". 
+				filePath= this.dir() + uniqFileName + "_tmp"; //"/". 
 				return filePath;
 			},
 			//
 			get(uniqFileName, defaultContent ='', expire_seconds=8640000, decode = true)
 			{
-				const parent = this.parent();
+				const parent = puvox_library;
 				let filePath = this.filePath(uniqFileName);
 				if ( filePath.length < 3) return "too tiny filename";
 
@@ -2783,7 +2825,7 @@ const puvox_library =
 			},
 			set(uniqFileName, content)
 			{
-				const parent = this.parent();
+				const parent = puvox_library;
 				let filePath= this.filePath(uniqFileName);
 				let contentFinal = parent.isString(content) ? content : ((parent.isArray(content) || parent.isObject(content)) ? JSON.stringify(content) : content);
 				return parent.file.write(filePath, contentFinal);
@@ -2809,6 +2851,37 @@ const puvox_library =
 			// 		console.log("writeFileAppendJson", e); 
 			// 	}
 			// },
+			containerDefaultPrefix: "_cached_ids_",
+			tempIds:{},
+			idForContent(slugOrContent){
+				return puvox_library.md5(puvox_library.isSimpleVariableType(slugOrContent) ? slugOrContent : JSON.stringify(slugOrContent)); 
+			},
+			existsId(containerSlug, id){
+				return (id in this.getIds(containerSlug));
+			},
+			getIds(containerSlug) {
+				if (! (containerSlug in this.tempIds)) {
+					const content = puvox_library.file.read(this.dir() + this.containerDefaultPrefix + containerSlug, '{}');
+					this.tempIds[containerSlug] = JSON.parse(content);
+				}
+				return this.tempIds[containerSlug];
+			},
+			setIds(containerSlug, idsDict) {
+				this.tempIds[containerSlug] = idsDict;
+				return puvox_library.file.write(this.dir() + this.containerDefaultPrefix + containerSlug, JSON.stringify(this.tempIds[containerSlug]));
+			},
+			addId(containerSlug, id){
+				const ids = this.getIds(containerSlug);
+				ids[id] = 1;
+				this.setIds(containerSlug, ids);
+			},
+			addIdIfNotExists(containerSlug, id){
+				if (! this.existsId(containerSlug, id)){
+					this.addId(containerSlug, id);
+					return true;
+				}
+				return false;
+			},
 		}
 	}, 
 
@@ -2823,7 +2896,7 @@ const puvox_library =
 			return this._required_instances[name];
 		}
 	}, 
-	file : {
+	file: {
 		parent() {return puvox_library;},
 		fs() {return puvox_library.modules('fs');},
 		os() {return puvox_library.modules('os');},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "puvox-library",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "library-class-javascript",
   "main": "library_standard.js",
   "scripts": {

package/test.js

@@ -0,0 +1,8 @@
+const h = require('./library_standard.js');
+function c(...args){console.log(...args);} function cc(o){console.dir(o, {'maxArrayLength': null});} function x(...args){c(...args);process.exit();} function xx(o){cc(o);process.exit();}
+
+h.setAppName("myApp");
+async function x(){
+    c(await h.telegramMessageCached('Hello World', 1668904096, '1651207488:AAF0KDLW6tmDUElN7RxVbp5RwQK5u77znhU'));
+}
+x();