[gofetch.git] / gopher.sh

#!/bin/sh

# $0 [gopher uri] ([mode])
# 	uri: the gopher URI to dig to, e.g.:
#		- gopher://sdf.org:70/1/faq
#		- sdf.org/faq
#		- sdf.org/1/faq
#		- http://gopher.nikiroo.be:80/news
#		- ...
#		default port is 70 for gopher, 80 for http, 443 for https
#		default filetype 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'

URI="$1"

PREFIX="[0-9hIg+]"

PROTOCOL="`echo $URI | sed 's|^\([^:]*://\)\?\([^:/]*\)\(:[^/]*\)\?/\?\(.*\)\?|\1|g'`"
SERVER="`echo $URI | sed 's|^\([^:]*://\)\?\([^:/]*\)\(:[^/]*\)\?/\?\(.*\)\?|\2|g'`"
PORT="`echo $URI | sed 's|^\([^:]*://\)\?\([^:/]*\)\(:[^/]*\)\?/\?\(.*\)\?|\3|g'`"
SELECTOR="`echo $URI | sed 's|^\([^:]*://\)\?\([^:/]*\)\(:[^/]*\)\?/\?\(.*\)\?|\4|g'`"
MODE=

PORT="`echo "$PORT" | sed 's/^://'`"

# Defaults:
if [ "$PORT" = "" ];then
	if [ "$PROTOCOL" = http ]; then
		PORT=80
	elif [ "$PROTOCOL" = https ]; then
		PORT=443
	else
		PORT=70
	fi
fi

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" | sed 's:^/\?\([^/]*\)/\(.*\):\1:'`"
		SELECTOR="`echo "$SELECTOR" | sed 's:^/\?\([^/]*\)/\(.*\):\2:'`"
	fi
fi

if [ "$SERVER" = "" ]; then
	echo "Syntax error: $0 [gopher uri]" >&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" | sed 's:\\:\\\\\\\\:g' | 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

ok=true
if [ "$PROTOCOL" = gopher:// -o "$PROTOCOL" = "" ]; then
	echo "$SELECTOR" | nc "$SERVER" "$PORT" > "$tmp" || ok=false
else
	if wget -h >/dev/null 2>&1; then
		wget "${PROTOCOL}$SERVER:$PORT/$SELECTOR" -O "$tmp" >/dev/null 2>&1
	else
		curl "${PROTOCOL}$SERVER:$PORT/$SELECTOR" > "$tmp" 2>/dev/null
	fi
fi

if [ $ok = false ]; then
	echo Cannot contact gopher uri "[$URI]" >&2
	exit 2
fi

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