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        require to trace new newsgroups.  Using ctlinnd
X        command "newgroup" takes care of this problem
X        (see below).  Editing the active file with an
X        editor has one drawback - the file active.times
X        is not automatically updated.  This creates problems
X        for some newsreader (Trumpet being one of them) 
X        that use this file to alert users to new groups.
X
Using ctlinnd command "newgroup" (see Part IV.3.b)
X        corrects this problem. 
X
c. Run inncheck (see #11) to check the new active file
X       for errors. 
X
d. Type: "ctlinnd reload active 'new active'".
X
e. Type: "ctlinnd go 'edit active'".
X
X
------------------------------
[Source: INN FAQ Part 6 Archive-name: usenet/software/inn-faq/part6]
[Last Changed: $Date: 1997/07/01 01:25:41 $ $Revision: 2.21 $]
[Copyright: 1997 Heiko Rupp, portions by Tom Limoncelli, Rich Salz, et al.]
X
Subject: (6.3) Safe way to edit the "active" file?
X
X
First of all, you could manipulate the active file using the ctlinnd
"newgroup", "rmgroup" and "changegroup" commands. However, sometimes
you just need to do a lot of editing all at once:
X
The following sequence is the shortest:
X
ctlinnd pause "edit active"
X	[do something to the active file]
X	inncheck
X	ctlinnd reload active "edit active"
X	ctlinnd go "edit active"
X
X
Simple! No need to "flush" since the "pause" does that.
X
> What if I need to delete 3000 lines from my active file?
X
X
I would definitely edit the active file manually (using
the above procedure).
X
> What if I need to delete 10 lines from my active file?
X
X
For a couple quick changes, I recommend using "ctlinnd". This is a
little slow because all channels are closed and reopened after each
"rmgroup", "newgroup", and "changegroup". However, it's easier than
remembering the above sequence.
X
DO NOT THROTTLE THE SERVER WHEN DOING MULTIPLE rmgroup COMMANDS. There
is a bug in INN (all versions) that will shred your active file if you
do multiple "rmgroup" messages while the server if throttled. This is
a common mistake. People think the "rmgroup"'s will go faster if the
server is throttled. It will go faster, it will also shred your active
file.
X
If you have a large number of groups to remove or create, you can use
awk to write a script to do the work for you.
X
% cat thelist
X	alt.foo.bar
X	alt.delete.me
X	comp.sys.mac
X	% awk <thelist '{ print "ctlinnd rmgroup " $1 }'
X	ctlinnd rmgroup alt.foo.bar
X	ctlinnd rmgroup alt.delete.me
X	ctlinnd rmgroup comp.sys.mac
X
X
Now, you can either send the output of that to "| sh -x",
or you can redirect the output to a file, and "source" the
file.
X
If you want to create a bunch of newsgroups, the awk
command might be like this:
X
% awk <thelist \
X	'{ print "ctlinnd newgroup " $1 " y user@host" }' | sh -x
X
X
Be aware that news.daily also throttles the server at some time so
verify the state of the server before doing ctlinnd {rm,new}group.
X
SHAR_EOF
  (set 20 04 02 09 13 04 13 'suck/README2'; eval "$shar_touch") &&
  chmod 0444 'suck/README2' ||
  $echo 'restore of' 'suck/README2' 'failed'
  if ( md5sum --help 2>&1 | grep 'sage: md5sum \[' ) >/dev/null 2>&1 \
  && ( md5sum --version 2>&1 | grep -v 'textutils 1.12' ) >/dev/null; then
    md5sum -c << SHAR_EOF >/dev/null 2>&1 \
    || $echo 'suck/README2:' 'MD5 check failed'
3f70690711365e3fb5d02b27a7f30a9b  suck/README2
SHAR_EOF
  else
    shar_count="`LC_ALL= LC_CTYPE= LANG= wc -c < 'suck/README2'`"
    test 16623 -eq "$shar_count" ||
    $echo 'suck/README2:' 'original size' '16623,' 'current size' "$shar_count!"
  fi
fi
# ============= suck/setup_inn.sh ==============
if test -f 'suck/setup_inn.sh' && test "$first_param" != -c; then
  $echo 'x -' SKIPPING 'suck/setup_inn.sh' '(file already exists)'
else
  $echo 'x -' extracting 'suck/setup_inn.sh' '(text)'
  sed 's/^X//' << 'SHAR_EOF' > 'suck/setup_inn.sh' &&
#!/bin/bash
###############################################################################
# @(#)setup_inn.sh Version: 1.4 Date: 04/02/07 23:50:16  Author: PBS
# To contact the Author: lmrlnATbigfoot.com replace AT with @
# Copyright (C) 2003 Philip Baird Shearer
#
# 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.
#
# This text  is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# URL: http://www.gnu.org/copyleft/gpl.html#SEC3
###############################################################################
# Description
# One off customisation of inn so that it can be used by suck.
# Only to be run if inn has not been customised already.
#
# History
# 12 Nov 2002 Working Version    
###############################################################################
# These variables can be altered for example if the user name for the
# owner of innd is not  news then alter it here
#########################
NewsUser=news
EnvTmp=""
Org=inn_org
###############################################################################
print_fn()
{
X	if [ "$Verbose" == "-v" ]
X	then
X		echo $*
X	fi
}
###############################################################################
usage_fn()
{
X	echo "usage: $SN -h[elp]|-H[elp_more]|-u[ndo]|domainname" 2>&1
}
###############################################################################
introduction_fn()
{
cat <<- _EOB
X
X	This script "$SN" sets up a Redhat inn installation with the
X	basics that the suck setup script does not.
X	
X	It does this by looking if domain is set in $PATHETC/inn.conf
X
X	If you do not enter a domain name as a command line argument,
X	you will be asked for it interactively by the scrip. It is
X	the name of the domain you wish to be in, this is typically
X	"yousubdomain.ISPdomain".  You will be familiar with it as part
X	of your email address.	As an example suppose that your ISP gives
X	you an email address of [e-mail]
X	then the string needed here is "thesmiths.freeserve.co.uk"
X
X	If this script gets confused it will ERROR out and you will have to
X	figure out how to fix the error.
X
X	This is only a basic setup and it will not be the final one
X	which you need you MUST RTFM (Read the friendly manual).
X	The files which are altered are:
X	  $PATHETC/inn.conf
X	  $PATHETC/newsfeeds
X	  $PATHETC/readers.conf
X	  $PATHETC/storage.conf
X
X	-h[elp] usage
X	-H[elp] This page
X	-u[ndo] will move the original contents of the files back
X	        into place.
_EOB
}
################################################################################
who_am_i_fn()
{
X	WHOAMI=`which whomaix 2>/dev/null`
X	if [ $? -ne 0 ]
X	then
X		WHOAMI=`which id 2>/dev/null`
X		if [  $? -ne 0 ]
X		then
X			echo "ERROR:$SN:who_am_i_fn:1: could not find programs whoami or id -- bailing out" 1>&2
X			return 1 
X		fi
X		WHOAMI="$WHOAMI  -u -n"
X	fi
X
X	$WHOAMI
X	if [ $? -ne 0 ]
X	then
X		echo "ERROR:$SN:who_am_i_fn:2: do not know which user you are -- bailing out" 1>&2
X		return 1
X	fi
X	return 0
}
################################################################################
set_env_fn()
{
X	EnvTmp=$1
X	shift
X
X	if [ "$EnvTmp" != "" ]
X	then
X		return 0
X	fi
X
X	/bin/echo -n "$*"
X
X	while  [ -z "$EnvTmp" ]
X	do
X		read EnvTmp
X	done
X
X	set $EnvTmp
X	return 0
}
################################################################################
set_inn_conf_path_fn()
{
X	INN_CONF=${INN_CONF:=/etc/news/inn.conf}
X	while [ ! -f "$INN_CONF" ]
X	do
X		set_env_fn "" "Please enter the PARENT DIR of inn.conf: "
X		INN_CONF=$EnvTmp/inn.conf
X		if [ ! -f $INN_CONF]
X		then
X		print_fn "could not find $INN_CONF"
X		fi
X	done
}
################################################################################
get_innconf_fn()
{
X	grep $1 $INN_CONF | awk '{print $2;}'
}
################################################################################
get_innconf_vars()
{
X	PATHBIN=${PATHBIN:=`get_innconf_fn pathbin`}
X	if [ ! -x $PATHBIN/innconfval ]
X	then
X		return 1
X	else
X		#
X		## if the tool exists use it
X		#
X		$PATHBIN/innconfval -s >/tmp/$SN.$$
X		#
X		## include inn environment variables
X		#
X.			/tmp/$SN.$$ 
X		rm /tmp/$SN.$$
X	fi
X
X	return 0
}
################################################################################
all_innconf_set_fn() 
{
set "$DOMAIN" 
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	        DOMAIN=$DOMAIN
_EOB
}
################################################################################
#Main
####
SN=`basename $0`
##################################################################
#turn off verbose if not 
#####
case $# in 
0)
X	Verbose="-v"
;;
*) 
X	case $1 in
X	-* )
X	;;
X	* )
X		Verbose=${SUCK_VERBOSE:="-v"}
X	;;
X	esac
;;
esac
##################################################################
print_fn "lets see who i am:"
WHOAMI=`who_am_i_fn`
if [ $? -ne 0 ]
then
X	exit 1
fi
if [ "$WHOAMI" != "$NewsUser" ]
then
X	echo "ERROR:$SN:main:10:user $WHOAMI is NOT NewsUser $NewsUser --  bailing out" 1>&2 
X	exit 1
fi
print_fn "I am $WHOAMI"
X
##################################################################
# set up inn environment variables by looking in the INN_CONF file
#######################################
set_inn_conf_path_fn
print_fn "Setting up variables based on $INN_CONF"
get_innconf_vars
if [ $? -ne 0 ]
then
X	echo "ERROR:$SN:main:20:$PATHBIN/innconfval failed, check inn.conf --  bailing out" 1>&2 
X	exit 1
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
##################################################################
# 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		LIST="
X		inn.conf
X		newsfeeds
X		readers.conf
X		storage.conf
X		"
X
X		cd $PATHETC
X
X		for name in $LIST
X		do
X			if [ -f ${name}.$Org ]
X			then
X				mv ${name}.$Org ${name}
X			fi
X		done
X		exit 0
X	;;
X	*)
X		domain=$1
X	;;
X	esac
;;
* )
X	usage_fn
X	exit 1
;;
esac
X
##################################################################
if [ "$Verbose" == "-v" ] 
then
X	introduction_fn
fi
##################################################################
print_fn "checking the domain line in $PATHETC/inn.conf"
########
cd $PATHETC
if [ $? -ne 0 ]
then
X	echo "ERROR:$SN:main:20:cd $PATHETC failed -- bailing out" 1>&2
X	exit 1
fi
X
if [ "$DOMAIN" == "" ]
then
X        DOMAIN=$domain
X        while [ "$DOMAIN" == "" ]
X        do
X                set_env_fn "" "Please enter the local domain name: "
X                DOMAIN=$EnvTmp
X        done
X
X	if [ ! -f inn.conf.$Org ]
X	then
X		mv inn.conf inn.conf.$Org
X		sed \
X		-e "s/^domain:.*/domain:		$DOMAIN/" \
X		-e "s/^organization:.*/organization:	InterNetNews site $DOMAIN/" \
X		-e "s~^pathnews:.*~pathnews:	$HOME~" \
X		-e "s/^#*pathhost:.*/pathhost:	$DOMAIN/" \
X		-e "s/^server:.*/server:	$DOMAIN/" \