putmsg.cpp

/* Synchronet message/menu display routine */
// vi: tabstop=4

/* $Id: putmsg.cpp,v 1.68 2020/05/11 05:03:47 rswindell Exp $ */

/****************************************************************************
 * @format.tab-size 4		(Plain Text/Source Code File Header)			*
 * @format.use-tabs true	(see http://www.synchro.net/ptsc_hdr.html)		*
 *																			*
 * Copyright Rob Swindell - http://www.synchro.net/copyright.html			*
 *																			*
 * This program is free software; you can redistribute it and/or			*
 * modify it under the terms of the GNU General Public License				*
 * as published by the Free Software Foundation; either version 2			*
 * of the License, or (at your option) any later version.					*
 * See the GNU General Public License for more details: gpl.txt or			*
 * http://www.fsf.org/copyleft/gpl.html										*
 *																			*
 * Anonymous FTP access to the most recent released source is available at	*
 * ftp://vert.synchro.net, ftp://cvs.synchro.net and ftp://ftp.synchro.net	*
 *																			*
 * Anonymous CVS access to the development source and modification history	*
 * is available at cvs.synchro.net:/cvsroot/sbbs, example:					*
 * cvs -d :pserver:anonymous@cvs.synchro.net:/cvsroot/sbbs login			*
 *     (just hit return, no password is necessary)							*
 * cvs -d :pserver:anonymous@cvs.synchro.net:/cvsroot/sbbs checkout src		*
 *																			*
 * For Synchronet coding style and modification guidelines, see				*
 * http://www.synchro.net/source.html										*
 *																			*
 * You are encouraged to submit any modifications (preferably in Unix diff	*
 * format) via e-mail to mods@synchro.net									*
 *																			*
 * Note: If this box doesn't appear square, then you need to fix your tabs.	*
 ****************************************************************************/

#include "sbbs.h"
#include "wordwrap.h"
#include "utf8.h"
#include "zmodem.h"
#include "petdefs.h"

/****************************************************************************/
/* Outputs a NULL terminated string with @-code parsing,                    */
/* checking for message aborts, pauses, ANSI escape and ^A sequences.		*/
/* Changes local text attributes if necessary.                              */
/* Returns the last char of the buffer access.. 0 if not aborted.           */
/* If P_SAVEATR bit is set in mode, the attributes set by the message       */
/* will be the current attributes after the message is displayed, otherwise */
/* the attributes prior to displaying the message are always restored.      */
/* Stops parsing/displaying upon CTRL-Z (only in P_CPM_EOF mode).           */
/****************************************************************************/
char sbbs_t::putmsg(const char *buf, long mode, long org_cols, JSObject* obj)
{
	uint 	tmpatr;
	ulong 	orgcon=console;
	ulong	sys_status_sav=sys_status;
	enum output_rate output_rate = cur_output_rate;

	attr_sp=0;	/* clear any saved attributes */
	tmpatr=curatr;	/* was lclatr(-1) */
	if(!(mode&P_SAVEATR))
		attr(LIGHTGRAY);
	if(mode&P_NOPAUSE)
		sys_status|=SS_PAUSEOFF;

	char ret = putmsgfrag(buf, mode, org_cols, obj);
	if(!(mode&P_SAVEATR)) {
 		console=orgcon;
		attr(tmpatr);
	}
	if(!(mode&P_NOATCODES) && cur_output_rate != output_rate)
		set_output_rate(output_rate);

	if(mode&P_PETSCII)
		outcom(PETSCII_UPPERLOWER);

	attr_sp=0;	/* clear any saved attributes */

	/* Restore original settings of Forced Pause On/Off */
	sys_status&=~(SS_PAUSEOFF|SS_PAUSEON);
	sys_status|=(sys_status_sav&(SS_PAUSEOFF|SS_PAUSEON));
	return(ret);
}

// Print a message fragment, doesn't save/restore any console states (e.g. attributes, auto-pause)
char sbbs_t::putmsgfrag(const char* buf, long& mode, long org_cols, JSObject* obj)
{
	char 	tmp2[256],tmp3[128];
	char*	str=(char*)buf;
	uchar	exatr=0;
	char	mark = '\0';
	int 	i;
	long	col = column;
	ulong	l=0;
	uint	lines_printed = 0;
	struct mouse_hotspot hot_spot = {0};

	hot_attr = 0;
	hungry_hotspots = true;
	str = auto_utf8(str, mode);
	size_t len = strlen(str);

	long term = term_supports();
	if(!(mode&P_NOATCODES) && memcmp(str, "@WRAPOFF@", 9) == 0) {
		mode &= ~P_WORDWRAP;
		l += 9;
	}
	if(mode&P_WORDWRAP) {
		char* wrapoff = NULL;
		if(!(mode&P_NOATCODES)) {
			wrapoff = strstr((char*)str+l, "@WRAPOFF@");
			if(wrapoff != NULL)
				*wrapoff = 0;
		}
		char *wrapped;
		if(org_cols < TERM_COLS_MIN)
			org_cols = TERM_COLS_DEFAULT;
		if((wrapped=::wordwrap((char*)str+l, cols - 1, org_cols - 1, /* handle_quotes: */TRUE
			,/* is_utf8: */INT_TO_BOOL(mode&P_UTF8))) == NULL)
			errormsg(WHERE,ERR_ALLOC,"wordwrap buffer",0);
		else {
			truncsp_lines(wrapped);
			mode &= ~P_WORDWRAP;
			putmsgfrag(wrapped, mode);
			free(wrapped);
			l=strlen(str);
			if(wrapoff != NULL)
				l += 9;	// Skip "<NUL>WRAPOFF@"
		}
	}

	while(l < len && (mode&P_NOABORT || !msgabort()) && online) {
		switch(str[l]) {
			case '\r':
			case '\n':
			case FF:
			case CTRL_A:
				break;
			case ZHEX:
				if(l && str[l - 1] == ZDLE) {
					l++;
					continue;
				}
				// fallthrough
			default: // printing char
				if((mode & P_INDENT) && column < col)
					cursor_right(col - column);
				else if((mode&P_TRUNCATE) && column >= (cols - 1)) {
					l++;
					continue;
				} else if(mode&P_WRAP) {
					if(org_cols) {
						if(column > (org_cols - 1)) {
							CRLF;
						}
					} else {
						if(column >= (cols - 1)) {
							CRLF;
						}
					}
				}
				break;
		}
		if(mode & P_MARKUP) {
			const char* marks = "*/_#";
			if(((mark == 0) && strchr(marks, str[l]) != NULL) || str[l] == mark) {
				char* next = NULL;
				char following = '\0';
				if(mark == 0) {
					next = strchr(str + l + 1, str[l]);
					if(next != NULL)
						following = *(next + 1);
				}
				char *blank = strstr(str + l + 1, "\n\r");
				if(((l < 1 || ((IS_WHITESPACE(str[l - 1]) || IS_PUNCTUATION(str[l - 1])) && strchr(marks, str[l - 1]) == NULL))
						&& IS_ALPHANUMERIC(str[l + 1]) && mark == 0 && next != NULL
						&& (following == '\0' || IS_WHITESPACE(following) || (IS_PUNCTUATION(following) && strchr(marks, following) == NULL))
						&& (blank == NULL || next < blank))
					|| str[l] == mark) {
					if(mark == 0)
						mark = str[l];
					else {
						mark = 0;
						if(!(mode & P_HIDEMARKS))
							outchar(str[l]);
					}
					switch(str[l]) {
						case '*':
							attr(curatr ^ HIGH);
							break;
						case '/':
							attr(curatr ^ BLINK);
							break;							
						case '_':
							attr(curatr ^ (HIGH|BLINK));
							break;
						case '#':
							attr(((curatr&0x0f) << 4) | ((curatr&0xf0) >> 4));
							break;
					}
					if(mark != 0 && !(mode & P_HIDEMARKS))
						outchar(str[l]);
					l++;
					continue;
				}
			}
		}
		if(str[l]==CTRL_A && str[l+1]!=0) {
			if(str[l+1]=='"' && !(sys_status&SS_NEST_PF) && !(mode&P_NOATCODES)) {  /* Quote a file */
				l+=2;
				i=0;
				while(i<(int)sizeof(tmp2)-1 && IS_PRINTABLE(str[l]) && str[l]!='\\' && str[l]!='/')
					tmp2[i++]=str[l++];
				if(i > 0) {
					tmp2[i]=0;
					sys_status|=SS_NEST_PF; 	/* keep it only one message deep! */
					SAFEPRINTF2(tmp3,"%s%s",cfg.text_dir,tmp2);
					printfile(tmp3,0);
					sys_status&=~SS_NEST_PF;
				}
			}
			else if(str[l+1] == 'Z')	/* Ctrl-AZ==EOF (uppercase 'Z' only) */
				break;
			else if(str[l + 1] == '~') {
				l += 2;
				if(str[l] >= ' ')
					add_hotspot(str[l], /* hungry: */true);
				else
					add_hotspot('\r', /* hungry: */true);
			}
			else if(str[l + 1] == '`' && str[l + 2] >= ' ') {
				add_hotspot(str[l + 2], /* hungry: */false);
				l += 2;
			}
			else {
				bool was_tos = (row == 0);
				ctrl_a(str[l+1]);
				if(row == 0 && !was_tos && (sys_status&SS_ABORT) && !lines_printed)	/* Aborted at (auto) pause prompt (e.g. due to CLS)? */
					sys_status &= ~SS_ABORT;				/* Clear the abort flag (keep displaying the msg/file) */
				l+=2;
			}
		}
		else if(!(mode&P_NOXATTRS)
			&& (cfg.sys_misc&SM_PCBOARD) && str[l]=='@' && str[l+1]=='X'
			&& IS_HEXDIGIT(str[l+2]) && IS_HEXDIGIT(str[l+3])) {
			sprintf(tmp2,"%.2s",str+l+2);
			ulong val = ahtoul(tmp2);
			// @X00 saves the current color and @XFF restores that saved color
			static uchar save_attr;
			switch(val) {
				case 0x00:
					save_attr = curatr;
					break;
				case 0xff:
					attr(save_attr);
					break;
				default:
					attr(val);
					break;
			}
			exatr=1;
			l+=4;
		}
		else if(!(mode&P_NOXATTRS)
			&& (cfg.sys_misc&SM_WILDCAT) && str[l]=='@' && str[l+3]=='@'
			&& IS_HEXDIGIT(str[l+1]) && IS_HEXDIGIT(str[l+2])) {
			sprintf(tmp2,"%.2s",str+l+1);
			attr(ahtoul(tmp2));
			// exatr=1;
			l+=4;
		}
		else if(!(mode&P_NOXATTRS)
			&& (cfg.sys_misc&SM_RENEGADE) && str[l]=='|' && IS_DIGIT(str[l+1])
			&& IS_DIGIT(str[l+2]) && !(useron.misc&RIP)) {
			sprintf(tmp2,"%.2s",str+l+1);
			i=atoi(tmp2);
			if(i>=16) { 				/* setting background */
				i-=16;
				i<<=4;
				i|=(curatr&0x0f);		/* leave foreground alone */
			}
			else
				i|=(curatr&0xf0);		/* leave background alone */
			attr(i);
			exatr=1;
			l+=3;	/* Skip |xx */
		}
		else if(!(mode&P_NOXATTRS)
			&& (cfg.sys_misc&SM_CELERITY) && str[l]=='|' && IS_ALPHA(str[l+1])
			&& !(useron.misc&RIP)) {
			switch(str[l+1]) {
				case 'k':
					attr((curatr&0xf0)|BLACK);
					break;
				case 'b':
					attr((curatr&0xf0)|BLUE);
					break;
				case 'g':
					attr((curatr&0xf0)|GREEN);
					break;
				case 'c':
					attr((curatr&0xf0)|CYAN);
					break;
				case 'r':
					attr((curatr&0xf0)|RED);
					break;
				case 'm':
					attr((curatr&0xf0)|MAGENTA);
					break;
				case 'y':
					attr((curatr&0xf0)|YELLOW);
					break;
				case 'w':
					attr((curatr&0xf0)|LIGHTGRAY);
					break;
				case 'd':
					attr((curatr&0xf0)|BLACK|HIGH);
					break;
				case 'B':
					attr((curatr&0xf0)|BLUE|HIGH);
					break;
				case 'G':
					attr((curatr&0xf0)|GREEN|HIGH);
					break;
				case 'C':
					attr((curatr&0xf0)|CYAN|HIGH);
					break;
				case 'R':
					attr((curatr&0xf0)|RED|HIGH);
					break;
				case 'M':
					attr((curatr&0xf0)|MAGENTA|HIGH);
					break;
				case 'Y':   /* Yellow */
					attr((curatr&0xf0)|YELLOW|HIGH);
					break;
				case 'W':
					attr((curatr&0xf0)|LIGHTGRAY|HIGH);
					break;
				case 'S':   /* swap foreground and background - TODO: This sets foreground to BLACK! */
					attr((curatr&0x07)<<4);
					break;
			}
			exatr=1;
			l+=2;	/* Skip |x */
		}  /* Skip second digit if it exists */
		else if(!(mode&P_NOXATTRS)
			&& (cfg.sys_misc&SM_WWIV) && str[l]==CTRL_C && IS_DIGIT(str[l+1])) {
			exatr=1;
			switch(str[l+1]) {
				default:
					attr(LIGHTGRAY);
					break;
				case '1':
					attr(CYAN|HIGH);
					break;
				case '2':
					attr(BROWN|HIGH);
					break;
				case '3':
					attr(MAGENTA);
					break;
				case '4':
					attr(LIGHTGRAY|HIGH|BG_BLUE);
					break;
				case '5':
					attr(GREEN);
					break;
				case '6':
					attr(RED|HIGH|BLINK);
					break;
				case '7':
					attr(BLUE|HIGH);
					break;
				case '8':
					attr(BLUE);
					break;
				case '9':
					attr(CYAN);
					break;
			}
			l+=2;
		}
		else {
			if(!(mode&P_PETSCII) && str[l]=='\n') {
				if(exatr) 	/* clear at newline for extra attr codes */
					attr(LIGHTGRAY);
				if(l==0 || str[l-1]!='\r')	/* expand sole LF to CR/LF */
					outchar('\r');
				lines_printed++;
			}

			/* ansi escape sequence */
			if(outchar_esc >= ansiState_csi) {
				if(str[l]=='A' || str[l]=='B' || str[l]=='H' || str[l]=='J'
					|| str[l]=='f' || str[l]=='u')    /* ANSI anim */
					lncntr=0;			/* so defeat pause */
				if(str[l]=='"' || str[l]=='c') {
					l++;				/* don't pass on keyboard reassignment or Device Attributes (DA) requests */
					continue;
				}
			}
			if(str[l]=='!' && str[l+1]=='|' && useron.misc&RIP) /* RIP */
				lncntr=0;				/* so defeat pause */
			if(str[l]=='@' && !(mode&P_NOATCODES)) {
				if(memcmp(str+l, "@EOF@", 5) == 0)
					break;
				if(memcmp(str+l, "@CLEAR@", 7) == 0) {
					CLS;
					sys_status &= ~SS_ABORT;
					l += 7;
					while(str[l] != 0 && (str[l] == '\r' || str[l] == '\n'))
						l++;
					continue;
				}
				if(memcmp(str+l, "@CENTER@", 8) == 0) {
					l += 8;
					i=0;
					while(i<(int)sizeof(tmp2)-1 && str[l] != 0 && str[l] != '\r' && str[l] != '\n')
						tmp2[i++] = str[l++];
					tmp2[i] = 0;
					truncsp(tmp2);
					center(tmp2);
					if(str[l] == '\r')
						l++;
					if(str[l] == '\n')
						l++;
					continue;
				}
				if(memcmp(str+l, "@SYSONLY@", 9) == 0) {
					if(!SYSOP)
						console^=CON_ECHO_OFF;
					l += 9;
					continue;
				}
				if(memcmp(str+l, "@WORDWRAP@", 10) == 0) {
					l += 10;
					mode |= P_WORDWRAP;
					return putmsgfrag(str+l, mode, org_cols);
				}
				if(memcmp(str+l, "@QON@", 5) == 0) {	// Allow the file display to be aborted (PCBoard)
					l += 5;
					mode &= ~P_NOABORT;
					continue;
				}
				if(memcmp(str+l, "@QOFF@", 6) == 0) {	// Do not allow the display of teh file to be aborted (PCBoard)
					l += 6;
					mode |= P_NOABORT;
					continue;
				}
				bool was_tos = (row == 0);
 				i=show_atcode((char *)str+l, obj);	/* returns 0 if not valid @ code */
				l+=i;					/* i is length of code string */
				if(row > 0 && !was_tos && (sys_status&SS_ABORT) && !lines_printed)	/* Aborted at (auto) pause prompt (e.g. due to CLS)? */
					sys_status &= ~SS_ABORT;				/* Clear the abort flag (keep displaying the msg/file) */
				if(i)					/* if valid string, go to top */
					continue;
			}
			if(mode&P_CPM_EOF && str[l]==CTRL_Z)
				break;
			if(hot_attr) {
				if(curatr == hot_attr && str[l] > ' ') {
					hot_spot.y = row;
					if(!hot_spot.minx)
						hot_spot.minx = column;
					hot_spot.maxx = column;
					hot_spot.cmd[strlen(hot_spot.cmd)] = str[l];
				} else if(hot_spot.cmd[0]) {
					hot_spot.hungry = hungry_hotspots;
					add_hotspot(&hot_spot);
					memset(&hot_spot, 0, sizeof(hot_spot));
				}
			}
			size_t skip = sizeof(char);
			if(mode&P_PETSCII) {
				if(term&PETSCII) {
					outcom(str[l]);
					switch(str[l]) {
						case '\r':	// PETSCII "Return" / new-line
							column = 0;
							/* fall-through */
						case PETSCII_DOWN:
							lncntr++;
							break;
						case PETSCII_CLEAR:
						case PETSCII_HOME:
							row=0;
							column=0;
							lncntr=0;
							break;
						case PETSCII_BLACK:
						case PETSCII_WHITE:
						case PETSCII_RED:
						case PETSCII_GREEN:
						case PETSCII_BLUE:
						case PETSCII_ORANGE:
						case PETSCII_BROWN:
						case PETSCII_YELLOW:
						case PETSCII_CYAN:
						case PETSCII_LIGHTRED:
						case PETSCII_DARKGRAY:
						case PETSCII_MEDIUMGRAY:
						case PETSCII_LIGHTGREEN:
						case PETSCII_LIGHTBLUE:
						case PETSCII_LIGHTGRAY:
						case PETSCII_PURPLE:
						case PETSCII_UPPERLOWER:
						case PETSCII_UPPERGRFX:
						case PETSCII_FLASH_ON:
						case PETSCII_FLASH_OFF:
						case PETSCII_REVERSE_ON:
						case PETSCII_REVERSE_OFF:
							// No cursor movement
							break;
						default:
							inc_column(1);
							break;
					}
				} else
					petscii_to_ansibbs(str[l]);
			} else if((str[l]&0x80) && (mode&P_UTF8)) {
				if(term&UTF8)
					outcom(str[l]);
				else
					skip = print_utf8_as_cp437(str + l, len - l);
			} else {
				uint atr = curatr;
				outchar(str[l]);
				if(curatr != atr)	// We assume the attributes are retained between lines
					attr(atr);
			}
			l += skip;
		}
	}

	return str[l];
}