[gofetch.git] / gopher.sh

#!/bin/sh

# $0 [server] ([selector]) ([port]) ([mode])
# 	server: the gopher server to dig to
#	selector: the gopher selector (default is empty)
#	port: the port to use (default is 70)
#	mode: the filetype mode (default depends upon selector)
#		0: plain text
#		1: menu (dir-like)
#		...
#		download: fake mode to download the result without changes

# Manual:
# 	When asked for a number (non-dialog uses only), you can also
#	enter 'n' or 'p' to get the next or previous item (+1 or -1)

# ENV variables:
# 	USE_DIALOG: force the usage of the command 'dialog'
#		  : true if dialog is found
#		0 : do not
#		1 : force the use of dialog
#	LINK_COLOR: escape sequences colour (def: 2)
#		- : means no escape sequence
#		1 : means colour 1
#		2 : means colour 2
#		[...]
# 	INVERT    : invert the output for image viewing (for white backgrounds)
# 		0 : do not invert (default)
#		1 : invert 

# EXIT Codes:
#	  0: ok
#	  1: syntax error
#	  2: cannot contact server
#	  3: unknown selector mode
#	255: special exit more 'q'

SERVER="$1"
SELECTOR="$2"
PORT="$3"
MODE="$4"

PREFIX="[0-9hIg+]"

# Defaults:
[ "$PORT" = "" ] && PORT=70
if [ "$MODE" = "" ]; then
	# "" or dir-like selector? -> 1 ; if not -> 0 
	echo "$SELECTOR" | grep "/$" >/dev/null && MODE=1 || MODE=0
	[ "$SELECTOR" = "" ] && MODE=1
	
	# check explicit modes:
	if echo "$SELECTOR" | grep "^/\($PREFIX\|download\)/" >/dev/null; then
		MODE="`echo "$SELECTOR" | cut -f2 -d/`"
		SELECTOR="`echo "$SELECTOR" | sed 's:^/[^/]*/::'`"
	fi
fi

if [ "$SERVER" = "" ]; then
	echo "Syntax error: $0 [SERVER] ([SELECTOR]) ([PORT]) ([MODE])" >&2
	exit 1
fi

# can be "-" for no escape sequences
[ "$LINK_COLOR" = ""  ] && LINK_COLOR=2

# Start and end link tags
SL=
EL=
if [ "$LINK_COLOR" != "-" ]; then
	SL="`tput setf $LINK_COLOR``tput setaf $LINK_COLOR`"
	EL="`tput init`"
	export LESS="${LESS}-R"
fi

# 'dialog' or text
if [ "$USE_DIALOG" = "" ]; then
	if dialog --help >/dev/null 2>&1; then
		USE_DIALOG=1
	else
		USE_DIALOG=0
	fi
fi

# Invert image viewer
if [ "$INVERT" = 1 ]; then
	INVERT="--invert"
else
	INVERT=
fi

# $0 [FILE] (dialog)
# Display a gopher menu for the given resource
cat_menu() {
	i=0
	cat "$1" | grep "^i\|^$PREFIX" | while read ln; do
		if echo "$ln" | grep "^i" >/dev/null 2>&1; then
			if [ "$2" != dialog ]; then
				echo "$ln" | sed "s:^.\([^\t]*\).*$:	\1:g"
			else
				echo "$ln" | sed 's:":'"''"':g;s:^.\([^\t]*\).*$:"      " "\1":g'
			fi
		elif echo "$ln" | grep "^$PREFIX" >/dev/null 2>&1; then
			i=`expr $i + 1`
			[ $i -le 9 ] && i=0$i 
			field="`echo "$ln" | cut -c1`"
			case "$field" in
				0) typ='TXT';;
				1) typ='DIR';; # menu, actually
				7) typ='(?)';; # query
				8) typ='TEL';; # TELnet (not TELephone)
				h) typ='WEB';; # HTML
				I) typ='IMG';;
				g) typ='GIF';;
				+) typ='SVR';; # redundant server
				*) typ='!!!';;
			esac
			if [ "$2" != dialog ]; then
				echo "$ln" | sed "s:^.\\([^\t]*\\).*:$typ $i	$SL\\1$EL:g"
			else
				echo "$ln" | sed "s:"'"'":'':g;s:^.\\([^\t]*\\).*:"'"'"$typ $i"'"'" "'"\1"'":g"
			fi
		fi
	done
}

# $0 [FILE] [INDEX] [FIELD]
# Get a field from the given-by-index link in FILE
#
# Fields:
# 	1 = type/name
# 	2 = selector
# 	3 = server
# 	4 = port
getsel() {
	cat "$1" | grep "^$PREFIX" | tail -n+"$2" | head -n 1 | cut -f"$3"
}

# Save page content to 'tmp' file
tmp="`mktemp -t gofetch.current_page.XXXXXX`"
finish() {
  rm -rf "$tmp" "$tmp.jpg" "$tmp.menu" "$tmp.choice"
}
trap finish EXIT

echo "$SELECTOR" | nc "$SERVER" "$PORT" > "$tmp"
if [ $? != 0 ]; then
	echo Cannot contact gopher server "[$SERVER]" >&2
	exit 2
fi

if [ $MODE = 1 ]; then
	sed --in-place 's:\r::g' "$tmp"
fi

# Process page content
case "$MODE" in
download)
	# Special, fake mode, only from top-level
	cat "$tmp"
;;
0)
	cat "$tmp" | less
;;
1|+)
	CHOICE=0
	while [ "$CHOICE" != "" ]; do
		if [ "$USE_DIALOG" = 1 ]; then
			> "$tmp.menu"
			cat_menu "$tmp" dialog | while read ln; do
				echo -n " $ln" >> "$tmp.menu"
			done
			[ "$LINES"   = "" ] && LINES=`tput lines`
			[ "$COLUMNS" = "" ] && COLUMNS=`tput cols`
			title="$SERVER: $SELECTOR"
			dialog	--extra-button --extra-label Back \
				--cancel-label Exit \
				--no-shadow \
				--menu "$title" \
				"$LINES" "$COLUMNS" "$LINES" \
				--file "$tmp.menu" 2>"$tmp.choice"
			val=$?
			clear
			
			if [ $val = 3 ]; then
				CHOICE=""
			elif [ $val = 1 ]; then
				CHOICE="q"
			else
				CHOICE="`cat "$tmp.choice" | cut -c5-`"
			fi
			
			rm "$tmp.menu"
			rm "$tmp.choice"
		else
			cat_menu "$tmp" | less
			read -p "[$SELECTOR]: " NEW_CHOICE
			if [ "$NEW_CHOICE" = p ]; then
				CHOICE=`expr "$CHOICE" - 1 2>/dev/null`
				if [ "$CHOICE" -lt 0 ]; then
					CHOICE=`cat "$tmp" | grep "^$PREFIX" | wc --lines`
				fi
			elif [ "$NEW_CHOICE" = n ]; then
				CHOICE=`expr "$CHOICE" + 1 2>/dev/null`
			else
				CHOICE="$NEW_CHOICE"
			fi
		fi
		
		[ "$CHOICE" = q ] && exit 255 # force-quit
		index="`expr 1 \* "$CHOICE" 2>/dev/null`"
		if [ "$index" != "" ]; then
			goto_server="`getsel "$tmp" $index 3`"
			goto_sel="`getsel "$tmp" $index 2`"
			goto_port="`getsel "$tmp" $index 4`"
			goto_mode="`getsel "$tmp" $index 1 | cut -c1`"
			echo "Digging to [$goto_server:$goto_port] $index [$goto_sel]..."
			sh "$0" "$goto_server" "$goto_sel" "$goto_port" "$goto_mode"
			[ $? = 255 ] && exit 255 # force-quit
		fi
	done
;;
7)
	read -p "Query: " SEARCH
	selQuery="$SELECTOR	$SEARCH"
	
	exec sh "$0" "$SERVER" "$selQuery" "$PORT" 1
;;
8)
	telnet -l "$SELECTOR" "$SERVER" "$PORT"
	read DUMMY
;;
9)
	echo "<BINARY FILE>" | less
;;
g|I)
	if img2aa --help >/dev/null 2>&1; then
		img2aa --mode=DITHERING \
			$INVERT \
			--width=74 "$tmp" | less
	elif jp2a -h >/dev/null 2>&1; then
		if convert -h >/dev/null 2>&1; then
			convert "$tmp" "$tmp.jpg"
			jp2a --border --chars=" .-+=o8#"\
				$INVERT \
				--width=74 "$tmp.jpg" | less
		else
			echo "required program not found to view images: convert" \
				| less
		fi
	else
		echo "required program not found to view images:" \
			jp2a or img2aa | less
	fi
;;
*)
	echo "unknwon selector mode: <$MODE>" | less
	exit 3
;;
esac
Commit	Line	Data
0eb21b21 NR	1	#!/bin/sh
0eb21b21 NR	2
7f7487a6 NR	3	# $0 [server] ([selector]) ([port]) ([mode])
	4	# server: the gopher server to dig to
	5	# selector: the gopher selector (default is empty)
	6	# port: the port to use (default is 70)
	7	# mode: the filetype mode (default depends upon selector)
	8	# 0: plain text
	9	# 1: menu (dir-like)
	10	# ...
	11	# download: fake mode to download the result without changes
	12
05ea999a NR	13	# Manual:
	14	# When asked for a number (non-dialog uses only), you can also
	15	# enter 'n' or 'p' to get the next or previous item (+1 or -1)
	16
c6852b70	17	# ENV variables:
370b6826 NR	18	# USE_DIALOG: force the usage of the command 'dialog'
	19	# : true if dialog is found
	20	# 0 : do not
	21	# 1 : force the use of dialog
c6852b70 NR	22	# LINK_COLOR: escape sequences colour (def: 2)
	23	# - : means no escape sequence
	24	# 1 : means colour 1
	25	# 2 : means colour 2
	26	# [...]
3c2abf21 NR	27	# INVERT : invert the output for image viewing (for white backgrounds)
	28	# 0 : do not invert (default)
	29	# 1 : invert
c6852b70	30
528c6011 NR	31	# EXIT Codes:
	32	# 0: ok
	33	# 1: syntax error
	34	# 2: cannot contact server
	35	# 3: unknown selector mode
	36	# 255: special exit more 'q'
	37
0eb21b21 NR	38	SERVER="$1"
	39	SELECTOR="$2"
	40	PORT="$3"
	41	MODE="$4"
	42
61fcec09 NR	43	PREFIX="[0-9hIg+]"
61fcec09 NR	44
0eb21b21 NR	45	# Defaults:
	46	[ "$PORT" = "" ] && PORT=70
	47	if [ "$MODE" = "" ]; then
	48	# "" or dir-like selector? -> 1 ; if not -> 0
	49	echo "$SELECTOR" \| grep "/$" >/dev/null && MODE=1 \|\| MODE=0
	50	[ "$SELECTOR" = "" ] && MODE=1
61fcec09 NR	51
	52	# check explicit modes:
	53	if echo "$SELECTOR" \| grep "^/\($PREFIX\\|download\)/" >/dev/null; then
	54	MODE="`echo "$SELECTOR" \| cut -f2 -d/`"
	55	SELECTOR="`echo "$SELECTOR" \| sed 's:^/[^/]*/::'`"
	56	fi
0eb21b21 NR	57	fi
	58
	59	if [ "$SERVER" = "" ]; then
	60	echo "Syntax error: $0 [SERVER] ([SELECTOR]) ([PORT]) ([MODE])" >&2
528c6011	61	exit 1
0eb21b21 NR	62	fi
0eb21b21 NR	63
c6852b70 NR	64	# can be "-" for no escape sequences
c6852b70 NR	65	[ "$LINK_COLOR" = "" ] && LINK_COLOR=2
050494fa NR	66
	67	# Start and end link tags
	68	SL=
	69	EL=
c6852b70	70	if [ "$LINK_COLOR" != "-" ]; then
050494fa	71	SL="`tput setf $LINK_COLOR``tput setaf $LINK_COLOR`"
1ad44e82	72	EL="`tput init`"
8210ebed	73	export LESS="${LESS}-R"
050494fa NR	74	fi
050494fa NR	75
370b6826 NR	76	# 'dialog' or text
	77	if [ "$USE_DIALOG" = "" ]; then
	78	if dialog --help >/dev/null 2>&1; then
	79	USE_DIALOG=1
	80	else
	81	USE_DIALOG=0
	82	fi
	83	fi
	84
3c2abf21 NR	85	# Invert image viewer
	86	if [ "$INVERT" = 1 ]; then
	87	INVERT="--invert"
	88	else
	89	INVERT=
	90	fi
	91
370b6826	92	# $0 [FILE] (dialog)
050494fa	93	# Display a gopher menu for the given resource
0eb21b21 NR	94	cat_menu() {
0eb21b21 NR	95	i=0
7f7487a6	96	cat "$1" \| grep "^i\\|^$PREFIX" \| while read ln; do
0eb21b21	97	if echo "$ln" \| grep "^i" >/dev/null 2>&1; then
370b6826 NR	98	if [ "$2" != dialog ]; then
	99	echo "$ln" \| sed "s:^.\([^\t]\).$: \1:g"
	100	else
	101	echo "$ln" \| sed 's:":'"''"':g;s:^.\([^\t]\).$:" " "\1":g'
	102	fi
7f7487a6	103	elif echo "$ln" \| grep "^$PREFIX" >/dev/null 2>&1; then
0eb21b21	104	i=`expr $i + 1`
1ad44e82	105	[ $i -le 9 ] && i=0$i
0eb21b21 NR	106	field="`echo "$ln" \| cut -c1`"
	107	case "$field" in
	108	0) typ='TXT';;
7f7487a6 NR	109	1) typ='DIR';; # menu, actually
	110	7) typ='(?)';; # query
	111	8) typ='TEL';; # TELnet (not TELephone)
	112	h) typ='WEB';; # HTML
7f7487a6	113	I) typ='IMG';;
1ad44e82	114	g) typ='GIF';;
7f7487a6	115	+) typ='SVR';; # redundant server
050494fa	116	*) typ='!!!';;
0eb21b21	117	esac
370b6826 NR	118	if [ "$2" != dialog ]; then
	119	echo "$ln" \| sed "s:^.\\([^\t]\\).:$typ $i $SL\\1$EL:g"
	120	else
	121	echo "$ln" \| sed "s:"'"'":'':g;s:^.\\([^\t]\\).:"'"'"$typ $i"'"'" "'"\1"'":g"
	122	fi
0eb21b21 NR	123	fi
	124	done
	125	}
	126
0eb21b21	127	# $0 [FILE] [INDEX] [FIELD]
050494fa NR	128	# Get a field from the given-by-index link in FILE
050494fa NR	129	#
0eb21b21 NR	130	# Fields:
	131	# 1 = type/name
	132	# 2 = selector
	133	# 3 = server
	134	# 4 = port
	135	getsel() {
7f7487a6	136	cat "$1" \| grep "^$PREFIX" \| tail -n+"$2" \| head -n 1 \| cut -f"$3"
0eb21b21 NR	137	}
0eb21b21 NR	138
da184edf	139	# Save page content to 'tmp' file
bb019694	140	tmp="`mktemp -t gofetch.current_page.XXXXXX`"
0eb21b21	141	finish() {
370b6826	142	rm -rf "$tmp" "$tmp.jpg" "$tmp.menu" "$tmp.choice"
0eb21b21 NR	143	}
	144	trap finish EXIT
	145
528c6011 NR	146	echo "$SELECTOR" \| nc "$SERVER" "$PORT" > "$tmp"
	147	if [ $? != 0 ]; then
	148	echo Cannot contact gopher server "[$SERVER]" >&2
	149	exit 2
	150	fi
	151
0eb21b21	152	if [ $MODE = 1 ]; then
528c6011	153	sed --in-place 's:\r::g' "$tmp"
0eb21b21 NR	154	fi
0eb21b21 NR	155
da184edf	156	# Process page content
0eb21b21	157	case "$MODE" in
7f7487a6 NR	158	download)
	159	# Special, fake mode, only from top-level
	160	cat "$tmp"
	161	;;
0eb21b21 NR	162	0)
	163	cat "$tmp" \| less
	164	;;
1ad44e82	165	1\|+)
05ea999a	166	CHOICE=0
0eb21b21	167	while [ "$CHOICE" != "" ]; do
370b6826 NR	168	if [ "$USE_DIALOG" = 1 ]; then
	169	> "$tmp.menu"
	170	cat_menu "$tmp" dialog \| while read ln; do
	171	echo -n " $ln" >> "$tmp.menu"
	172	done
	173	[ "$LINES" = "" ] && LINES=`tput lines`
	174	[ "$COLUMNS" = "" ] && COLUMNS=`tput cols`
	175	title="$SERVER: $SELECTOR"
	176	dialog --extra-button --extra-label Back \
	177	--cancel-label Exit \
	178	--no-shadow \
	179	--menu "$title" \
	180	"$LINES" "$COLUMNS" "$LINES" \
	181	--file "$tmp.menu" 2>"$tmp.choice"
370b6826	182	val=$?
3c2abf21 NR	183	clear
3c2abf21 NR	184
370b6826 NR	185	if [ $val = 3 ]; then
	186	CHOICE=""
	187	elif [ $val = 1 ]; then
	188	CHOICE="q"
	189	else
	190	CHOICE="`cat "$tmp.choice" \| cut -c5-`"
	191	fi
	192
	193	rm "$tmp.menu"
	194	rm "$tmp.choice"
	195	else
	196	cat_menu "$tmp" \| less
05ea999a NR	197	read -p "[$SELECTOR]: " NEW_CHOICE
	198	if [ "$NEW_CHOICE" = p ]; then
	199	CHOICE=`expr "$CHOICE" - 1 2>/dev/null`
	200	if [ "$CHOICE" -lt 0 ]; then
	201	CHOICE=`cat "$tmp" \| grep "^$PREFIX" \| wc --lines`
	202	fi
	203	elif [ "$NEW_CHOICE" = n ]; then
	204	CHOICE=`expr "$CHOICE" + 1 2>/dev/null`
	205	else
	206	CHOICE="$NEW_CHOICE"
	207	fi
370b6826 NR	208	fi
370b6826 NR	209
1ad44e82	210	[ "$CHOICE" = q ] && exit 255 # force-quit
0eb21b21 NR	211	index="`expr 1 \* "$CHOICE" 2>/dev/null`"
	212	if [ "$index" != "" ]; then
	213	goto_server="`getsel "$tmp" $index 3`"
	214	goto_sel="`getsel "$tmp" $index 2`"
	215	goto_port="`getsel "$tmp" $index 4`"
	216	goto_mode="`getsel "$tmp" $index 1 \| cut -c1`"
fcda6ae3	217	echo "Digging to [$goto_server:$goto_port] $index [$goto_sel]..."
0eb21b21	218	sh "$0" "$goto_server" "$goto_sel" "$goto_port" "$goto_mode"
1ad44e82	219	[ $? = 255 ] && exit 255 # force-quit
0eb21b21 NR	220	fi
	221	done
	222	;;
	223	7)
	224	read -p "Query: " SEARCH
	225	selQuery="$SELECTOR $SEARCH"
	226
	227	exec sh "$0" "$SERVER" "$selQuery" "$PORT" 1
	228	;;
	229	8)
	230	telnet -l "$SELECTOR" "$SERVER" "$PORT"
	231	read DUMMY
	232	;;
	233	9)
	234	echo "<BINARY FILE>" \| less
	235	;;
da184edf	236	g\|I)
5afd6400 NR	237	if img2aa --help >/dev/null 2>&1; then
5afd6400 NR	238	img2aa --mode=DITHERING \
3c2abf21	239	$INVERT \
5afd6400 NR	240	--width=74 "$tmp" \| less
	241	elif jp2a -h >/dev/null 2>&1; then
	242	if convert -h >/dev/null 2>&1; then
da184edf	243	convert "$tmp" "$tmp.jpg"
538b88d6	244	jp2a --border --chars=" .-+=o8#"\
3c2abf21	245	$INVERT \
da184edf NR	246	--width=74 "$tmp.jpg" \| less
da184edf NR	247	else
5afd6400 NR	248	echo "required program not found to view images: convert" \
5afd6400 NR	249	\| less
da184edf NR	250	fi
da184edf NR	251	else
5afd6400 NR	252	echo "required program not found to view images:" \
5afd6400 NR	253	jp2a or img2aa \| less
da184edf NR	254	fi
da184edf NR	255	;;
0eb21b21 NR	256	*)
	257	echo "unknwon selector mode: <$MODE>" \| less
	258	exit 3
	259	;;
	260	esac
1ad44e82	261