suck_040225.shar

Suck Wrappers are a set of UNIX script files that sets up inn, an NNTP server, on a local machine so

X	"$PATHARTICLES" \
X	"$PATHOUTGOING" \
X	"$PATHDB" \
X	"$PATHTMP"
X
X	while [ $1 ]
X	do
X		shift
X		if [ $# -eq 0 ]
X		then
X			return 0
X		fi
X	done
X
X	return $#
}
################################################################################
display_innconf_fn()
{
X
cat << _EOB
X	        PATHBIN=$PATHBIN
X	        PATHARTICLES=$PATHARTICLES
X	        PATHOUTGOING=$PATHOUTGOING
X	        PATHDB=$PATHDB
X	        PATHTMP=$PATHTMP
_EOB
}
################################################################################
create_suckenvrc_fn() 
{
if [ -f $HOME/suck/$SuckEnvRc ]
then
X	if [ ! -f $HOME/suck/$SuckEnvRc.$Org ]
X	then
X		cp -p $HOME/suck/$SuckEnvRc $HOME/suck/$SuckEnvRc.$Org
X	fi
fi
cat>$HOME/suck/$SuckEnvRc <<- _EOB
X 
X	NNTPSERVER=\${NNTPSERVER:=$NNTPSERVER}	# where to get/send news 
X	LOCALHOST=\${LOCALHOST:=$LOCALHOST}	# usually localhost 
X	NEWSFEED=\${NEWSFEED:=\$NNTPSERVER} 	# value "inn" newsfeed file
X	NET_ENQUIRE=\${NET_ENQUIRE:="${HostCmd}"} #give a dialup line time to come up
X	export NNTPSERVER LOCALHOST NEWSFEED NET_ENQUIRE
X
X	#
X	## Theses values were generated from the $INN_CONF if the values
X	## of inn.conf are changed so should these ether do it by hand,
X	## re-run the "$HOME/suck/$SN" script
X	##
X	## or the can be accessed uncommenting the next two lines
X	#  innconfval -s >$HOME/.innconfval
X	#  . $HOME/.innconfval 
X	PATHBIN=\${PATHBIN:=$PATHBIN}	# dir of news binaries
X	PATHARTICLES=\${PATHARTICLES:=$PATHARTICLES} # base directory for articles
X	PATHOUTGOING=\${PATHOUTGOING:=$PATHOUTGOING} # base directory for list of outgoing articles
X	PATHDB=\${PATHDB:=$PATHDB}	
X	PATHTMP=\${PATHTMP:=$PATHTMP}	# secure tmp dir
X	export PATHBIN PATHARTICLES PATHOUTGOING PATHDB PATHTMP
X
X	INN_HIST=\${INN_HIST:=\$PATHDB/history} # path to history file 
X	PATHSUCK=\${PATHSUCK:=$HOME/suck}	# base directory for suck scripts and data files 
X
X	SUCK_CONF=\${SUCK_CONF:=\$PATHSUCK/suck.conf}	# suck configuration file
X	RPOST_CONF=\${RPOST_CONF:=\$PATHSUCK/rpost.sm.conf}	# rpost configuration file with sm filter
X
X	export INN_HIST PATHSUCK SUCK_CONF RPOST_CONF
X
X	#
X	## used by put.news.sm (also use PATHTMP)
X	## The following are two parts of a sed script
X	## PUT_SED_HEAD_CMDS used by sed to strip out certain header lines
X	## PUT_SED_BODY_CMDS used by sed to skip the body of the message
X	#
X	PUT_SED_HEAD_CMDS=\${PUT_SED_HEAD_CMDS:=\$PATHSUCK/put.news.head.conf}
X	PUT_SED_BODY_CMDS=\${PUT_SED_BODY_CMDS:=\$PATHSUCK/put.news.body.conf}
X
X	export PUT_SED_HEAD_CMDS PUT_SED_BODY_CMDS RPOST_CONF
X
X	PATH=\${HOME}/suck:\${PATHBIN}:\${PATH}
X	export PATH
X
_EOB
}
################################################################################
#Main
####
SN=`basename $0`
##############################################
# command line
##########
case $# in
0 )
;;
1 )
X	case $1 in
X	-h* )
X		usage_fn
X		exit 0
X	;;
X	-H*)
X		usage_fn
X		introduction_fn
X		exit 0
X	;;
X	-u* )
X		set_inn_conf_path_fn
X		get_innconf_vars_fn
X
X	 	if [ -f $HOME/suck/$SuckEnvRc.$Org ]
X		then
X			#
X			## cp not mv as this file is linked
X			#
X			cp -p $HOME/suck/$SuckEnvRc.$Org $HOME/suck/$SuckEnvRc
X			rm -f $HOME/suck/$SuckEnvRc.$Org
X		fi
X
X		if [ -f $HOME/suck/active-ignore.$Org ]
X		then
X			mv $HOME/suck/active-ignore.$Org $HOME/suck/active-ignore
X		fi
X
X		if [ -f $PATHETC/newsfeeds.$Org ]
X		then
X			mv $PATHETC/newsfeeds.$Org $PATHETC/newsfeeds
X		fi
X
X		if [ -f $PATHDB/active.$Org ]
X		then
X			ctlinnd pause "reset active"
X			mv $PATHDB/active.$Org $PATHDB/active
X			ctlinnd reload active "reset active"  
X			ctlinnd go "reset active"  
X		fi
X		exit 0
X	;;
X	esac
;;
* )
X	usage_fn
X	exit 1
;;
esac
##################################################################
#check that suck is present
if [ ! -x /usr/bin/testhost ]
then
X	echo "ERROR:$SN:main:5:no /usr/bin/testhost is suck installed? --  bailing out" 1>&2 
X	exit 1
fi
##################################################################
X
X
if [ "$Verbose" == "-v" ] 
then
X	introduction_fn
fi
X
print_fn "lets see who i am:"
WHOAMI=`who_am_i_fn`
if [ $? -ne 0 ]
then
X	echo "ERROR:$SN:main:10:who_am_i_fn failed --  bailing out" 1>&2 
X	exit 1
fi
X
if [ "$WHOAMI" != "$NewsUser" ]
then
X	echo "ERROR:$SN:main:20:user $WHOAMI is NOT NewsUser $NewsUser --  bailing out" 1>&2 
X	exit 1
fi
X
print_fn "I am $WHOAMI"
X
print_fn "check that $HOME/suck exists"
if [ ! -d $HOME/suck ]
then
X	echo "ERROR:$SN:main:30:no dir $HOME/suck  --  bailing out" 1>&2 
X	exit 1
fi
X
print_fn "Yes $HOME/suck found"
X
##################################################################
# set up the paths used by get.news.inn script
# by looking in the INN_CONF dir for the
# true values
#######################################
set_inn_conf_path_fn
print_fn "Setting up variables based on $INN_CONF"
get_innconf_vars_fn
all_innconf_set_fn
if [ $? -ne 0 ]
then
X	display_innconf_fn
fi
X
#
## Add bin dir for inn to the PATH variable so that
## other commands can be called without the path variable 
## needing to be prepended to each one
#
PATH=$PATHBIN:${PATH}
X
##################################################################
print_fn "Checking on, and if needed setting up history"
########
INN_HIST=${INN_HIST:=$PATHDB/history}
if [ -f $INN_HIST ]
then
X	if [ "$Verbose" == "-v" ]
X	then
X		ls -l $PATHDB/history*
X	fi
else
X	print_fn "Attempting to create a history database"
X	makehistory
X	if [ $? -ne 0 ]
X	then
X		echo "ERROR:$SN:main:40:makehistory failed --  bailing out"  1>&2
X		exit 1
X	fi
X
X
X	makedbz -i
X	if [ $? -ne 0 ]
X	then
X		echo "ERROR:$SN:main:50:makedbz -i failed --  bailing out"  1>&2
X		exit 1
X	fi
X
X	cp -p $PATHDB/history.n.dir $PATHDB/history.dir
X	cp -p $PATHDB/history.n.hash $PATHDB/history.hash
X	cp -p $PATHDB/history.n.index $PATHDB/history.index
X	makedbz
X	if [ $? -ne 0 ]
X	then
X		echo "ERROR:$SN:main:60:makedbz failed --  bailing out"  1>&2
X		exit 1
X	fi
X
X	rm -f $PATHDB/history.n.*
fi
X
if [ ! -f $INN_HIST ]
then
X	echo "ERROR:$SN:main:70:$INN_HIST does not exist" 1>&2
X	exit 1
fi
X
##################################################################
print_fn check that innd is running
########
innd_pid=`pidofproc_fn innd`
if [ "$innd_pid" == "" ]
then
X	echo "ERROR:$SN:main:80:innd is not running ask root to start it  --  bailing out"  1>&2
X	exit 1
fi
X
##################################################################
print_fn "Setting up addresses to local and remote NTTP servers "
########
X
LOCALHOST=${LOCALHOST:=localhost}
X
print_fn "Checking if the environment variable NNTPSERVER is set: $NNTPSERVER"
set_env_fn "$NNTPSERVER" "Please enter your ISP server name eg \"news.theperfectisp.com\": "
NNTPSERVER=$EnvTmp
X
create_suckenvrc_fn
rm -f $HOME/$SuckEnvRc
ln $HOME/suck/$SuckEnvRc $HOME/$SuckEnvRc
X
################################################################# 
print_fn "Setup active active-ignore and sucknewsrc files "
########
TEST_NEWS_GROUP=${TEST_NEWS_GROUP:=alt.test}
#TEST_NEWS_GROUP=${TEST_NEWS_GROUP:=test.test.test}
TEST_NG_PATH=`echo $TEST_NEWS_GROUP | sed "s:\.:/:g"`
X
ctlinnd pause "edit active"
if [ $? -ne 0 ]
then
X	print_fn "Trying to restart with ctlinnd go \"edit active\""
X	ctlinnd go "edit active"
X	ctlinnd mode	
X	echo "ERROR:$SN:main:90:ctlinnd pause failed --  bailing out" 1>&2 
X	exit 1
fi
X
if [ ! -f $PATHDB/active ]
then
X	cat >$PATHDB/active <<- _EOB
X		control 0000000000 0000000001 n
X		control.cancel 0000000000 0000000001 n
X		control.checkgroups 0000000000 0000000001 n
X		control.newgroup 0000000000 0000000001 n
X		control.rmgroup 0000000000 0000000001 n
X		junk 0000000000 0000000001 n
X		$TEST_NEWS_GROUP 0000000000 0000000001 y
X	_EOB
else
X	grep -s "^$TEST_NEWS_GROUP" $PATHDB/active >/dev/null
X	case $? in
X	1 )
X		#
X		## no match append it on the bottom of the file
X		#
X		if [ ! -f $PATHDB/active.$Org ]
X		then
X			cp -p $PATHDB/active $PATHDB/active.$Org
X		fi
X		ctlinnd newgroup "$TEST_NEWS_GROUP" y news@$LOCALHOST
X		if [ $? -ne 0 ]
X		then
X			echo "ERROR:$SN:main:100:ctlinnd newgroup failed --  bailing out" 1>&2 
X			exit 1
X		fi
X	;;	
X	2 )
X		echo "ERROR:$SN:main:110:grep $PATHDB/active  failed -- bailing out" 1>&2
X		exit 1
X	;;
X	esac
fi
X
if [ ! -f $HOME/suck/active-ignore ]
then
X	#
X	## ignore all groups apart from $TEST_NEWS_GROUP
X	#
X	grep -v $TEST_NEWS_GROUP $PATHDB/active | sed "s/ .*//" >>$HOME/suck/active-ignore
else
X	#
X	## strip out $TEST_NEWS_GROUP if it is there because we need it.
X	#
X	if [ ! -f $HOME/suck/active-ignore.$Org ]
X	then
X		cp -p $HOME/suck/active-ignore $HOME/suck/active-ignore.$Org
X	fi
X	grep -v $TEST_NEWS_GROUP $HOME/suck/active-ignore >/tmp/$SN.$$
X	cp /tmp/$SN.$$ $HOME/suck/active-ignore 
X	rm /tmp/$SN.$$
fi
X
if [ "$Verbose" == "-v" ]
then
X	echo "Please fix by hand problems shown by $PATHBIN/inncheck" 
X	echo "inncheck start problem list ###############################"
X	inncheck
X	echo "inncheck end ##############################################"
fi
X
ctlinnd reload active "edit active"  
if [ $? -ne 0 ]
then
X	echo "ERROR:$SN:main:120:ctlinnd reload failed --  bailing out" 1>&2 
X	exit 1
fi
X
ctlinnd go "edit active"  
if [ $? -ne 0 ]
then
X	echo "ERROR:$SN:main:130:ctlinnd go failed --  bailing out" 1>&2 
X	exit 1
fi
##################################################################
print_fn "setup sucknewsrc $TEST_NEWS_GROUP"
#
## use host to bring up a connection if it is a dialup one
## run get.news.inn to set up a sucknewsrc with $TEST_NEWS_GROUP
## in it. It will not post messages yet because there is
## no entry in /etc/news/feeds
#
X
print_fn "get the records group $TEST_NEWS_GROUP"
########
SUCK_DEBUG="-D"
$HOME/suck/get.news.inn 
X
if [ -d $PATHARTICLES/$TEST_NG_PATH ]
then
X	PA=${PATHARTICLES}/$TEST_NG_PATH
else
X	PA=${PATHARTICLES}
fi
find $PA -type f -exec grep "^Path:" {} \;| 
sed -e "s/.[^\!]*\!//" -e "s/\![^!].*/!/" | \
sort -u | \
grep "!$" |
sed "s/!$//" >/tmp/$SN.1.$$
X
NUM_LINE=`wc -l /tmp/$SN.1.$$ | sed -e "s/ [^ ][^ ]*$//" -e "s/ //g"` 
X
case $NUM_LINE in
0 )
X	cat <<- _EOB
X	There is a problem this script has been unable to find a string to
X	use as a the remote host identifier.
X	
X	Each message which appears on the local host is stored in 
X	subdirectories under $PATHARTICLES so an article the news group
X	comp.os.linux.answers will be in
X	"$PATHARTICLES/comp/os/linux/answers". This script looks for articles
X	in $PATHARTICLES/$TEST_NG_PATH if that dir does not exist then it
X	looks at all articles on the local host from ${PATHARTICLES}.
X
X	That this message has been displayed shows that there are no articles
X	with a line starting Path: on the local host. To fix this problem
X	use your favourite news browser set to use news server of the ISP and
X	and post a test article to $TEST_NEWS_GROUP, then re-run this script,
X	if you come back to this page for a SECOND time, then there is a
X	problem which is beyond the scope of this script to fix for you. But
X	some of the things you should check are:
X	* Is the innd up and running?
X	* Does the active file exist?
X	* Is the line  "$TEST_NEWS_GROUP 0000000000 0000000001 y" exist in
X	  the active file?
X	* Check that in the suck dir that $TEST_NEWS_GROUP is NOT in the file
X	  active-ignore.
X	* If both are true then there is a problem with the paths to the 
X	  files.
X	* check that the history file exists. If not then there is a problem
X	  with the path to history.
X	* If there is a problem with paths use "innconfval -s" to check what
X	  the paths are. As this script uses "innconfval", if it can find it,
X	  then the script MUST be confused. Use "find / -name innconfval" to
X	  find all instances of "innconfval" on the local system and run each
X	  one in turn. Check for differences between them and when you