Tweaked build_nmh to work with Cygwin.
[mmh] / docs / contrib / build_nmh
1 #! /bin/sh
2 #
3 # Configures and builds nmh.
4 # * This script must be invoked from an nmh source directory.
5 # * This script retrieves configuration from the first existing nmh
6 #   installation on your $PATH, if any, as well as any $EDITOR/$VISUAL
7 #   and $PAGER environment variable settings.
8 # * Unless the -y option is provided, this script then interactively
9 #   walks you through confirmation of common configuration settings.
10 #
11 # Typical usage:
12 # The first time you invoke this script, use the -i option to install
13 # nmh in the specified location.  The script will walk you through the
14 # common nmh configuration settings.  The -v option will cause display
15 # of brief progress indicators.  Be sure to add the bin directory of
16 # the install location to your $PATH, if not already there.
17 # Subsequently, invoke this script with the -y option, to use the
18 # relevant configuration settings from the installed nmh without
19 # confirmation.
20 #
21 # Option summary:
22 #   First time use:
23 #     -i to install nmh
24 #     -v to display progress
25 #   Subsequent uses, assuming installed nmh bin directory is on $PATH:
26 #     -y to accept all configuration options without confirmation
27 #   Output control:
28 #     -l <logfile name>, default 'build_nmh.log'
29 #   Advanced/developer use:
30 #     -c to run 'make distcheck' instead of 'make check'
31 #     -d to build nmh with debug enabled
32 #     -s to use 'make superclean': requires recent autoconf and automake,
33 #        see docs/README.developers
34 #     -r to build rpm
35 #
36 # On Fedora, at least these rpms must be installed:
37 #   gdbm-devel
38 #   ncurses-devel
39 #   cyrus-sasl-devel, if using sasl
40 #   openssl-devel, if using TLS
41 #   autoconf and automake, with -s (see docs/README.developers for versions)
42 #   rpm-build, with -r
43
44
45 ####
46 #### OS-specific setup.
47 ####
48 which=which
49 ldd=ldd
50 locking=dot
51
52 os=${OSTYPE:-`uname -s`}
53 #### It'd be nice to have configure decide what locking style to use.
54 #### In the meantime, select it manually.  To determine what style
55 #### locking your system uses by default, try something like this,
56 #### assuming that strace is installed:
57 ####   $ echo test | strace -o /tmp/mail.strace mail -s test $LOGNAME
58 #### Then look in /tmp/mail.strace for fcntl, flock, and lockf system
59 #### calls and opens of dot files in the mail spool.
60 #### These might help but are old:
61 ####   https://bugzilla.mozilla.org/show_bug.cgi?id=239013#c9
62 ####   http://www.jwz.org/doc/movemail.html
63 case "$os" in
64   aix) locking=fcntl ;;
65   freebsd*) locking=flock ;;
66   linux* ) locking=fcntl ;;
67 esac
68
69
70 ####
71 #### Interpret command arguments.
72 ####
73 check=check
74 debug=0
75 install=0
76 logfile=build_nmh.log
77 build_rpm=0
78 superclean=0
79 verbose=0
80 yes=0
81 usage="usage: $0
82   [-c to run 'make distcheck' instead of 'make check']
83   [-d to build nmh with debug enabled]
84   [-i to install nmh]
85   [-l <logfile name>, default '$logfile']
86   [-r to build rpm]
87   [-s to use 'make superclean': requires recent autoconf and automake]
88   [-v to display progress]
89   [-y to accept all configuration options without confirmation]"
90
91 while getopts 'cdil:rsvy?' arg; do
92   case $arg in
93     c  ) check=distcheck ;;
94     d  ) debug=1 ;;
95     i  ) install=1 ;;
96     l  ) logfile=$OPTARG ;;
97     r  ) build_rpm=1 ;;
98     s  ) superclean=1 ;;
99     v  ) verbose=1 ;;
100     y  ) yes=1 ;;
101     '?') echo "$usage"; exit 0 ;;
102   esac
103 done
104 shift `expr $OPTIND - 1`
105
106 #### No command line arguments are supported.
107 if [ $# -gt 0 ]; then
108   echo "usage: $0"
109   exit 1
110 fi
111
112 #### Check to see that we're in a nmh source directory.
113 if ! grep 'the authors of nmh' COPYRIGHT >/dev/null; then
114   echo "$0: not in nmh source directory"
115   exit 1
116 fi
117
118 ####
119 #### Set up configure options.  Handle options that can have embedded
120 #### spaces (currently just smtpservers) specially.
121 ####
122
123 #### dotlocking, the usual default, requires chgrp and chmod of inc.
124 installpriv=
125 if [ $install -ge 1  -a  `id -u` -ne 0  -a  "$OSTYPE" != cygwin ]; then
126   if [ "x$locking" = x  -o  "$locking" = dot ]; then
127     echo "$0: "'install requires chgrp and chmod 2755'
128     echo 'so will sudo to install.  Terminate with Ctrl-C if unacceptable.'
129     installpriv=sudo
130   fi
131 fi
132
133
134 #### Here are the config options that we will try to detect, then
135 #### confirm, and finally set.
136 config_prefix=/usr/local/nmh
137 config_locking="$locking"
138 config_mts=smtp
139 config_smtpservers=localhost
140 config_sasl=n
141 config_tls=n
142 config_editor=vi
143 for i in more less most cat; do
144   if which $i >/dev/null 2>&1; then
145     config_pager=$i
146     break
147   fi
148 done
149 config_debug=n
150
151 if install-mh -check >/dev/null 2>&1; then
152   # Determine config options from installed nmh.
153   mhparam=`which mhparam`
154   mhbin=`dirname "$mhparam"`
155
156   config_prefix=`cd $mhbin/.. && pwd`
157
158   mtsconf=`dirname "$mhbin"`/etc/mts.conf
159   if [ -f "$mtsconf" ]; then
160     mts_entry=`grep '^mts:' $mtsconf`
161     if [ "mts_entry" ]; then
162       mts=`echo $mts_entry | sed -e 's/^mts: *//'`
163       if [ "$mts"  -a  "$mts" != smtp ]; then
164         config_mts="$mts"
165       fi
166     fi
167
168     mtsconfservers=`grep '^servers:' $mtsconf`
169     if [ "$mtsconfservers" ]; then
170       servers=`echo $mtsconfservers | sed -e 's/^servers: *//' -e 's/ /\\\ /g'`
171       [ "$servers" ]  &&  config_smtpservers="$servers"
172     fi
173   fi
174
175   if $ldd $mhbin/inc | grep sasl >/dev/null; then
176     config_sasl=y
177   fi
178
179   if $ldd $mhbin/inc | grep ssl >/dev/null; then
180     config_tls=y
181   fi
182 fi
183
184 if [ "$EDITOR" ]; then
185   config_editor="$EDITOR"
186 elif [ "$VISUAL" ]; then
187   config_editor="$VISUAL"
188 fi
189
190 [ "$PAGER" ]  &&  config_pager="$PAGER"
191
192 [ $debug -ge 1 ]  &&  config_debug=y
193
194 if [ $yes -eq 0 ]; then
195   #### Confirm each config setting with user.
196   printf 'Install prefix [%s]: ' $config_prefix
197   read prefix
198   [ "$prefix" ]  &&  config_prefix="$prefix"
199
200   printf 'Locking type (dot|fcntl|flock|lockf) [%s]: ' $config_locking
201   read locking
202   [ "$locking" ]  &&  config_locking="$locking"
203
204   printf 'MTS (smtp|sendmail) [%s]: ' $config_mts
205   read mts
206   [ "$mts" ]  &&  config_mts="$mts"
207
208   if [ ! "$mts"  -o  "$mts" = smtp ]; then
209     printf 'SMTP server(s), space separated [%s]: ' $config_smtpservers
210     read response
211     servers=`echo $response | sed -e 's/ /\\\ /g'`
212     [ "$servers" ]  &&  config_smtpservers="$servers"
213   fi
214
215   printf 'Cyrus SASL support [%s]: ' $config_sasl
216   read response
217   if [ "$response" = y  -o  "$response" = Y ]; then
218     config_sasl=y
219   elif [ "$response" = n  -o  "$response" = N ]; then
220     config_sasl=n
221   fi
222
223   printf 'TLS support [%s]: ' $config_tls
224   read response
225   if [ "$response" = y  -o  "$response" = Y ]; then
226     config_tls=y
227   elif [ "$response" = n  -o  "$response" = N ]; then
228     config_tls=n
229   fi
230
231   printf 'Default editor [%s]: ' $config_editor
232   read editor
233   [ "$editor" ]  &&  config_editor=$editor
234
235   printf 'Pager [%s]: ' $config_pager
236   read pager
237   [ "$pager" ]  &&  config_pager=$pager
238
239   #### Don't confirm debug here:  obey the -d option to this script.
240 fi
241
242 smtpservers=
243 config_opts="--prefix=$config_prefix"
244
245 [ "$config_locking" ]  &&  \
246   config_opts="$config_opts --with-locking=$config_locking"
247 [ "$config_mts"  -a  "$config_mts" != smtp ]  &&  \
248   config_opts="$config_opts --with-mts=$config_mts"
249 [ "$config_smtpservers"  -a  "$config_smtpservers" != localhost ]  &&  \
250   smtpservers="--with-smtpservers=$config_smtpservers"
251 [ "$config_sasl" = y ]  &&  \
252   config_opts="$config_opts --with-cyrus-sasl"
253 [ "$config_tls" = y ]  &&  \
254   config_opts="$config_opts --with-tls"
255 [ "$config_editor" ]  &&  \
256   config_opts="$config_opts --with-editor=$config_editor"
257 [ "$config_pager" ]  &&  \
258   config_opts="$config_opts --with-pager=$config_pager"
259 [ $config_debug = y ]  &&  \
260   config_opts="$config_opts --enable-debug"
261
262
263 ####
264 #### Clean up, and set up with autoconfig if necessary.
265 ####
266 if [ -f Makefile ]; then
267   [ $verbose -ge 1 ]  &&  echo cleaning . . .
268   if [ $superclean -ge 1 ]; then
269     make superclean >/dev/null
270   else
271     make distclean >/dev/null
272   fi
273 fi
274
275 /bin/rm -f $logfile
276 if [ -f configure  -a  -f Makefile.in ]; then
277   :
278 else
279   [ $verbose -ge 1 ]  &&  echo autoconfiguring . . .
280   ./autogen.sh >>$logfile 2>&1
281 fi
282
283
284 ####
285 #### Build.
286 ####
287 [ $verbose -ge 1 ]  &&  echo configuring . . .
288 echo ./configure $config_opts ${smtpservers:+"$smtpservers"} >>$logfile 2>&1
289 ./configure $config_opts ${smtpservers:+"$smtpservers"} >>$logfile 2>&1
290 status=$?
291
292 if [ $status -eq 0 ]; then
293   [ $verbose -ge 1 ]  &&  echo building . . .
294   make >>$logfile 2>&1
295   status=$?
296
297   if [ $status -eq 0 ]; then
298     [ $verbose -ge 1 ]  &&  echo testing . . .
299     checkoutput=`make $check SETGID_MAIL= 2>>$logfile`
300     status=$?
301
302     tests_summary=`echo "$checkoutput" | grep tests`
303     if [ "$tests_summary" ]; then
304       echo '===================' >>$logfile
305       echo $tests_summary >>$logfile
306       echo '===================' >>$logfile
307       [ "$check" = distcheck ]  &&  \
308         echo "$checkoutput" | tail -n 4 >>$logfile
309     fi
310
311     if [ $status -eq 0 ]; then
312       if [ $install -ge 1 ]; then
313         [ $verbose -ge 1 ]  &&  echo installing . . .
314         ($installpriv make install) >/dev/null 2>>$logfile
315         status=$?
316       fi
317
318       if [ $status -eq 0  -a  $build_rpm -ge 1 ]; then
319         [ $verbose -ge 1 ]  &&  echo building rpm . . .
320         make rpm >/dev/null 2>>$logfile
321         status=$?
322       fi
323     fi
324   fi
325 fi
326
327 grep -E 'Error|warn' $logfile
328 [ $status -ne 0 ]  &&  echo build failed!
329 [ $status -eq 0  -a  $verbose -ge 1 ]  &&  echo build completed successfully
330
331 exit $status