diff --git a/AUTHORS b/AUTHORS index c11291d..8ae57b8 100644 --- a/AUTHORS +++ b/AUTHORS @@ -2,3 +2,10 @@ AUTHORS ======= Graeme Walker + + +The source in "glib/gmd5.cpp" is "derived from the RSA Data +Security, Inc. MD5 Message-Digest Algorithm" by incorporating +the "RSA Data Security, Inc. MD5 Message-Digest Algorithm" which +is "Copyright (C) 1991, RSA Data Security, Inc. All rights reserved". + diff --git a/ChangeLog b/ChangeLog index 1e082da..43c5041 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,6 +1,22 @@ E-MailRelay Change Log ====================== +0.9.6 -> 0.9.7 +-------------- +* CRAM-MD5 authentication mechanism added. +* Revoke root permissions at start up, and reclaim them when needed. +* Allow mail pre-processing ("--filter") when started as root. +* Domain-override switch ("--domain") added. +* Non-privileged user switch ("--user") added. +* Better handling of NarrowPipe exception (ie. 8-bit message to 7-bit server). +* Allow null return path in MAIL-FROM. +* Reject recipients which look like "@localhost" (as used by fetchmail for local delivery). +* Treat recipients which look like "postmaster@localhost" or "postmaster@" as local postmaster. +* Optional timestamps on log output ("--log-time"). +* Fix EHLO to HELO fallback for 501/502 responses in client protocol. +* Submission utility "emailrelay-submit" added. +* HTML4.0 compliant HTML documentation, using CSS. + 0.9.5 -> 0.9.6 -------------- * SMTP AUTHentication extension -- LOGIN mechanism only. diff --git a/NEWS b/NEWS index c6b9fd5..5589d96 100644 --- a/NEWS +++ b/NEWS @@ -1,2 +1,7 @@ -no news + +To do... +* optionally enforce authentication by clients +* OS-X port +* better windows gui (esp. client side) +* sample pre-processor script for spamassassin diff --git a/bin/Makefile.am b/bin/Makefile.am index f2755d8..62667c7 100644 --- a/bin/Makefile.am +++ b/bin/Makefile.am @@ -1,7 +1,7 @@ noinst_SCRIPTS = emailrelay-doxygen-filter.sh emailrelay-test.sh emailrelay-soak.sh libexec_SCRIPTS = emailrelay.sh pkgdata_DATA = emailrelay-notify.sh emailrelay-deliver.sh emailrelay-process.sh -EXTRA_DIST = emailrelay-doxygen-filter.sh_ emailrelay-test.sh_ emailrelay-soak.sh_ emailrelay.sh_ txt2html.sh_ emailrelay-notify.sh_ emailrelay-deliver.sh_ emailrelay-process.sh_ +EXTRA_DIST = emailrelay-doxygen-filter.sh_ emailrelay-test.sh_ emailrelay-soak.sh_ emailrelay.sh_ txt2html.sh_ txt2mu.sh_ mu2html.sh_ expand.sh_ emailrelay-notify.sh_ emailrelay-deliver.sh_ emailrelay-process.sh_ CLEANFILES = $(noinst_SCRIPTS) $(libexec_SCRIPTS) $(pkgdata_DATA) TESTS = emailrelay-test.sh SUFFIXES = .sh_ .sh diff --git a/bin/Makefile.in b/bin/Makefile.in index 5ebf117..02a8b99 100644 --- a/bin/Makefile.in +++ b/bin/Makefile.in @@ -72,7 +72,7 @@ VERSION = @VERSION@ noinst_SCRIPTS = emailrelay-doxygen-filter.sh emailrelay-test.sh emailrelay-soak.sh libexec_SCRIPTS = emailrelay.sh pkgdata_DATA = emailrelay-notify.sh emailrelay-deliver.sh emailrelay-process.sh -EXTRA_DIST = emailrelay-doxygen-filter.sh_ emailrelay-test.sh_ emailrelay-soak.sh_ emailrelay.sh_ txt2html.sh_ emailrelay-notify.sh_ emailrelay-deliver.sh_ emailrelay-process.sh_ +EXTRA_DIST = emailrelay-doxygen-filter.sh_ emailrelay-test.sh_ emailrelay-soak.sh_ emailrelay.sh_ txt2html.sh_ txt2mu.sh_ mu2html.sh_ expand.sh_ emailrelay-notify.sh_ emailrelay-deliver.sh_ emailrelay-process.sh_ CLEANFILES = $(noinst_SCRIPTS) $(libexec_SCRIPTS) $(pkgdata_DATA) TESTS = emailrelay-test.sh SUFFIXES = .sh_ .sh diff --git a/bin/emailrelay-deliver.sh_ b/bin/emailrelay-deliver.sh_ index 8c42333..e8826f9 100644 --- a/bin/emailrelay-deliver.sh_ +++ b/bin/emailrelay-deliver.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License diff --git a/bin/emailrelay-doxygen-filter.sh_ b/bin/emailrelay-doxygen-filter.sh_ index 2056b85..c504983 100644 --- a/bin/emailrelay-doxygen-filter.sh_ +++ b/bin/emailrelay-doxygen-filter.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License diff --git a/bin/emailrelay-notify.sh_ b/bin/emailrelay-notify.sh_ index ba40840..8ce1077 100644 --- a/bin/emailrelay-notify.sh_ +++ b/bin/emailrelay-notify.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License diff --git a/bin/emailrelay-process.sh_ b/bin/emailrelay-process.sh_ index 18a6a7d..fb1c14d 100644 --- a/bin/emailrelay-process.sh_ +++ b/bin/emailrelay-process.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License diff --git a/bin/emailrelay-soak.sh_ b/bin/emailrelay-soak.sh_ index 48bae85..e127cb1 100644 --- a/bin/emailrelay-soak.sh_ +++ b/bin/emailrelay-soak.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License diff --git a/bin/emailrelay-test.sh_ b/bin/emailrelay-test.sh_ index 9594b0c..fa6e959 100644 --- a/bin/emailrelay-test.sh_ +++ b/bin/emailrelay-test.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License @@ -110,7 +110,7 @@ RunPoke() Content() { - echo "To: recipient-1@localhost, recipient-2@localhost" + echo "To: recipient-1@f.q.d.n, recipient-2@f.q.d.n" echo "Subject: test message 1" echo "From: sender" echo " " @@ -123,8 +123,8 @@ Envelope() echo "X-MailRelay-Content: 8bit" echo "X-MailRelay-From: sender" echo "X-MailRelay-ToCount: 2" - echo "X-MailRelay-To-Remote: recipient-1@localhost" - echo "X-MailRelay-To-Remote: recipient-2@localhost" + echo "X-MailRelay-To-Remote: recipient-1@f.q.d.n" + echo "X-MailRelay-To-Remote: recipient-2@f.q.d.n" echo "X-MailRelay-Authentication: " echo "X-MailRelay-Client: 127.0.0.1" echo "X-MailRelay-End: 1" @@ -162,18 +162,22 @@ CreateAuth() { mkdir -p "${base_dir}" + # encrypted version "joes_password" provided by emailrelay-passwd + key="2168297042.2818429713.1297528852.2023008371.2713943401.1997919265.1829599518.235099638" + file="${base_dir}/server.auth" echo "# server.auth" > ${file} - echo "login server fred freds_password" >> ${file} - echo "login server joe joe+00s_password" >> ${file} - echo "login client dummy pwd" >> ${file} - echo "cram-md5 client dummy digest" >> ${file} + echo "LOGIN server fred freds_password" >> ${file} + echo "CRAM-MD5 server joe ${key}" >> ${file} + echo "CRAM-MD5 server brian 1.1.1.1.2.2.2.2" >> ${file} - file="${base_dir}/client.auth" - echo "# client.auth" > ${file} - echo "cram-md5 client foo bar" >> ${file} - echo "login client joe joe+00s_password" >> ${file} - echo "login server abc def" >> ${file} + file="${base_dir}/client-fred.auth" + echo "# client-fred.auth" > ${file} + echo "LOGIN client fred freds_password" >> ${file} + + file="${base_dir}/client-joe.auth" + echo "# client-joe.auth" > ${file} + echo "CRAM-MD5 client joe ${key}" >> ${file} } trap "Trap ; exit" 1 2 3 13 15 @@ -182,8 +186,8 @@ trap "Trap 0 ; exit" 0 StartTimer CreateAuth RunServer ${pp}1 store-2 log-1 pid-1 -RunServer ${pp}2 store-2 log-2 pid-2 "--admin ${pp}9 --forward-to localhost:${pp}3" -RunServer ${pp}3 store-3 log-3 pid-3 "--immediate --forward-to localhost:${pp}4 --filter ${null_filter} --client-auth ${base_dir}/client.auth" +RunServer ${pp}2 store-2 log-2 pid-2 "--admin ${pp}9 --forward-to localhost:${pp}3 --client-auth ${base_dir}/client-joe.auth" +RunServer ${pp}3 store-3 log-3 pid-3 "--immediate --forward-to localhost:${pp}4 --filter ${null_filter} --client-auth ${base_dir}/client-fred.auth --server-auth ${base_dir}/server.auth" RunServer ${pp}4 store-4 log-4 pid-4 "--server-auth ${base_dir}/server.auth" CreateMessages RunClient localhost:${pp}1 store-1 log-c pid-5 diff --git a/bin/emailrelay.sh_ b/bin/emailrelay.sh_ index 684e504..5d9d2fa 100644 --- a/bin/emailrelay.sh_ +++ b/bin/emailrelay.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License diff --git a/bin/expand.sh_ b/bin/expand.sh_ new file mode 100644 index 0000000..4a44cf6 --- /dev/null +++ b/bin/expand.sh_ @@ -0,0 +1,89 @@ +#!/bin/sh +# +# Copyright (C) 2001-2002 Graeme Walker +# +# 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 program 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. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +# +# === +# +# expand.sh +# +# Expands "#include##" directives. +# +# Only does one sustitution per line. Directives which start the line are +# multi-line. Those within a line are one-line, expanded in-place. +# +# The "-t" switch can be used to suppress expansion of files +# with an extension of ".html". +# +# Bugs: Does not do nested expansion. Only supports one include statement +# per line. +# +# usage: expand.sh [-a ] [-t] +# + +awk="gawk" +if test "${1}" = "-a" +then + shift + awk="${1}" + shift +fi + +expand_html="1" +if test "${1}" = "-t" +then + shift + expand_html="0" +fi + +${awk} -v expand_html="${expand_html}" -v cat="${awk} '{print}'" ' +{ + line = $0 + if( match(line,"#include#[^#]*#") ) + { + rstart = RSTART + directive = substr(line,RSTART,RLENGTH) + path = substr(line,RSTART+9,RLENGTH-10) + + if( !expand_html && match(path,".html$") ) + { + print line + } + else + { + head = substr(line,1,rstart-1) + if( match(head,"^[[:space:]]*$") ) + { + system( cat " " path ) + } + else + { + getline text "/dev/fd/2" + sub( directive , text , line ) + print line + } + } + } + else + { + print line + } +} +' $@ + diff --git a/bin/mu2html.sh_ b/bin/mu2html.sh_ new file mode 100644 index 0000000..83e1c33 --- /dev/null +++ b/bin/mu2html.sh_ @@ -0,0 +1,279 @@ +#!/bin/sh +# +# Copyright (C) 2001-2002 Graeme Walker +# +# 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 program 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. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +# +# === +# +# mu2html.sh +# +# Mark-up to html converter. Converts the output of "txt2mu.sh" +# into html. (Also see "index.sh".) +# +# Does some in-line formatting independently of the line-based +# mark-up in the input. For example, it converts quoted words into +# "" tags, and it converts "*foo* [bar]" text into +# hypertext links. +# +# The "-x" flag suppresses the output of html header and +# footer sections. This is useful when the output is to be +# spliced into another html document. +# +# usage: mu2html.sh [-a ] [-x] [ [<stylesheet>]] +# +# (If the title is not supplied then the input is copied +# to a temporary file in order to extract the H1 header +# text for the title.) +# + +awk="gawk" +if test "${1}" = "-a" +then + shift + if test "${1}" != "" ; then awk="${1}" ; fi + shift +fi + +full="1" +if test "${1}" = "-x" +then + full="0" + shift +fi + +title="${1}" +stylesheet="${2}" + + +if test "${stylesheet}" != "" -a \! -f "${stylesheet}" +then + echo `basename $0`: warning: missing stylesheet: ${stylesheet} >&2 +fi + +Main() +{ + ${awk} -v prefix="`basename $0`" -v title="${1}" -v stylesheet="${2}" -v full="${3}" ' + BEGIN { + if( full ) + { + colour = "#ffffff" + dtd_name = "-//W3C//DTD HTML 4.01//EN" + dtd_ref = "http://www.w3.org/TR/html4/strict.dtd" + printf( "<!DOCTYPE HTML PUBLIC \"%s\" \"%s\">\n" , dtd_name , dtd_ref ) + printf( "<html>\n" ) + printf( " <head>\n" ) + printf( " <title>%s\n" , title ) + printf( " \n" ) + if( length(stylesheet) ) + printf( " \n" , stylesheet ) + printf( " \n" ) + printf( " \n" , colour ) + printf( " \n" , title ) + printf( "
\n" ) + } + } + function arg1( type ) + { + sub( "[^,]*," , "" , type ) + sub( ",.*" , "" , type ) + return type + } + function arg2( type ) + { + sub( "[^,]*," , "" , type ) + sub( "[^,]*," , "" , type ) + sub( ",.*" , "" , type ) + return type + } + function escape( line ) + { + gsub( "&" , "\\&" , line ) + gsub( "<" , "\\<" , line ) + gsub( ">" , "\\>" , line ) + return line + } + function dequote( line ) + { + quote = "\"" + not_quote = "[^" quote "]" + start_tag="" + end_tag="" + gsub( quote not_quote "*" quote , start_tag "&" end_tag , line ) + gsub( start_tag quote , start_tag , line ) + gsub( quote end_tag , end_tag , line ) + return line + } + function fn( line ) + { + gsub( "[^[:space:]][^[:space:]]*\\(\\)" , "&" , line ) + return line + } + { + pos = index( $0 , ":" ) + type = substr( $0 , 1 , pos ) + tail = substr( $0 , pos+1 ) + etail_raw = escape(tail) + etail = fn(dequote(escape(tail))) + + # h1 + if( match(type,"^h1[:,]") ) + { + printf( "

%s

" , arg1(type) , etail ) + printf( "\n" , arg1(type) , etail ) + } + + # h2 + else if( match(type,"^h2[:,]") ) + { + printf( "

%s

" , arg1(type) , arg2(type) , etail ) + printf( "\n" , arg1(type) , arg2(type) , etail ) + } + + # item + else if( match(type,"^item,1[:,]") ) + printf( "
    \n
  • %s
    • \n" , etail ) + else if( match(type,"^item[:,]") ) + printf( "
  • %s
    • \n" , etail ) + else if( match(type,"^item-end[:,]") ) + printf( "
\n" , etail ) + + # item-numbered + else if( match(type,"^item-numbered,1[:,]") ) + printf( "
    \n
  1. %s
    2. \n" , etail ) + else if( match(type,"^item-numbered[:,]") ) + printf( "
  2. %s
    3. \n" , etail ) + else if( match(type,"^item-numbered-end[:,]") ) + printf( "
\n" , etail ) + + # item-outer + else if( match(type,"^item-outer,1[:,]") ) + printf( "
    \n
  • %s
    • \n" , etail ) + else if( match(type,"^item-outer[:,]") ) + printf( "
  • %s
    • \n" , etail ) + else if( match(type,"^item-outer-end[:,]") ) + printf( "
\n" , etail ) + + # item-inner + else if( match(type,"^item-inner,1[:,]") ) + printf( "
    \n
  • %s
    • \n" , etail ) + else if( match(type,"^item-inner[:,]") ) + printf( "
  • %s
    • \n" , etail ) + else if( match(type,"^item-inner-end[:,]") ) + printf( "
\n" , etail ) + + # item-name + else if( match(type,"^item-name,1[:,]") ) + printf( "
\n
%s
\n" , etail ) + else if( match(type,"^item-name[:,]") ) + printf( "
%s
\n" , etail ) + else if( match(type,"^item-name-end[:,]") ) + printf( "
\n" , etail ) + + # item-detail + else if( match(type,"^item-detail,1[:,]") ) + printf( "
\n

\n %s\n" , etail ) + else if( match(type,"^item-detail[:,]") ) + printf( " %s\n" , etail ) + else if( match(type,"^item-detail-end[:,]") ) + printf( "

\n
\n" ) + else if( match(type,"^item-detail-blank[:,]") ) + printf( "

\n

\n" ) + + # code + else if( match(type,"^code,1[:,]") ) + printf( "

\n 
%s" , etail_raw )
+		else if( match(type,"^code[:,]") )
+			printf( "\n%s" , etail_raw )
+		else if( match(type,"^code-end[:,]") )
+			printf( "
\n
\n" ) + + # text + else if( match(type,"^text,1[:,]") ) + printf( "

\n %s\n" , etail ) + else if( match(type,"^text[:,]") ) + printf( " %s\n" , etail ) + else if( match(type,"^text-end[:,]") ) + printf( "

\n" , etail ) + + # footer-text + else if( match(type,"^footer,1[:,]") ) + printf( "
\n

\n %s\n" , etail ) + else if( match(type,"^footer[:,]") ) + printf( " %s\n" , etail ) + else if( match(type,"^footer-end[:,]") ) + printf( "

\n
\n" , etail ) + + # citation-text + else if( match(type,"^citation,1[:,]") ) + printf( "

\n %s\n" , etail ) + else if( match(type,"^citation[:,]") ) + printf( " %s\n" , etail ) + else if( match(type,"^citation-end[:,]") ) + printf( "

\n" , etail ) + + # author-text + else if( match(type,"^author,1[:,]") ) + printf( "

\n %s\n" , etail ) + else if( match(type,"^author[:,]") ) + printf( " %s\n" , etail ) + else if( match(type,"^author-end[:,]") ) + printf( "

\n" , etail ) + + # html + else if( match(type,"^html[:,]") ) + printf( "%s\n" , tail ) + + # image + else if( match(type,"^image[:,]") ) + printf( "\n" , tail ) + + # blank + else if( match(type,"^blank[:,]") ) + printf( "\n" ) + + # ignore + else if( match(type,"^ignore") ) + printf( "" ) + + else if( match(type,"[^[:space:]]") ) + printf( "%s: unrecognised mark-up tag on line %d: \"%s\"\n" , prefix , NR , type )>"/dev/fd/2" + } + END { + if( full ) + { + printf( "
\n" ) + printf( " \n" ) + printf( "\n" ) + } + } ' +} + +Anchorise() +{ + sed 's/\*\([^\*]*\)\* \[\([^]]*\)\]/\1<\/a>/g' +} + +if test "${title}" = "" +then + tmp="`basename $0`.tmp" + ${awk} '{print}' > ${tmp} + title="`${awk} '/^h1/ { sub(\"[^:]*:\",\"\") ; print ; exit }' ${tmp}`" + ${awk} '{print}' ${tmp} | Main "${title}" "${stylesheet}" "${full}" | Anchorise +else + Main "${title}" "${stylesheet}" "${full}" | Anchorise +fi + diff --git a/bin/txt2html.sh_ b/bin/txt2html.sh_ index c9fc771..cab317d 100644 --- a/bin/txt2html.sh_ +++ b/bin/txt2html.sh_ @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (C) 2001 Graeme Walker +# Copyright (C) 2001-2002 Graeme Walker # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License @@ -21,459 +21,76 @@ # # txt2html.sh # -# Converts plain-text to html. The plain-text has to use special -# formating conventions (see "function process()", Anchorise_1() etc). +# Converts specially-formatted plain-text to html. +# Uses "expand.sh", "txt2mu.sh" and "mu2html.sh". +# See also "index.sh". # -# Embeds comments in the html output which can be used by "index.sh" -# to create a document index. +# The "-t" (text-mode) switch can be used for +# non-technical input text. # -# Definition lists require a bullet graphic, "graphics/bullet.gif". +# The "-x" (exclude) switch excludes html header +# and footer from the output. # -# usage: txt2html.sh [-a ] [-x] [] -# -# The -x switch excludes header and footer stuff. +# usage: txt2html.sh [-a <awk-binary>] [-v] [-x] [-t] [<input-file> [<stylesheet> [<graphics-dir> [<title>]]]] # awk="gawk" if test "${1}" = "-a" then shift - if test "${1}" != "" - then - awk="${1}" - fi + if test "${1}" != "" ; then awk="${1}" ; fi shift fi -full="1" -if test "${1}" = "-x" +v="" +if test "${1}" = "-v" then shift - full="0" + v="-v" +fi + +x="" +if test "${1}" = "-x" +then + x="-x" + shift +fi + +t="" +if test "${1}" = "-t" +then + t="-t" + shift fi file="${1}" -if test "${file}" = "" +stylesheet="${2}" +graphics_dir="${3}" +title="${4}" + +if test "${v}" != "" -a "${file}" != "" then - echo usage: `basename $0` '<txt-file>' >&2 - exit 2 + echo `basename $0`: processing ${file} >&2 fi -if test \! -f "${file}" +if test "${file}" != "" -a \! -f "${file}" then echo `basename $0`: no such file: ${file} >&2 exit 1 fi -title="`grep -v '^[[:space:]]*$' ${file} | head -1`" -if test "${2}" != "" +if test "${stylesheet}" != "" -a \! -f "${stylesheet}" then - title="${2}" + echo `basename $0`: warning: missing stylesheet: "${stylesheet}" >&2 fi -# === -# Include() -# -# Expands #include# directives. Included text is then processed -# as plain text, just like the top-level file. An include directive -# within a line (ie. not on the lhs) is treated as an inline -# sustitution, like shell backticks. -# -Include() -{ -${awk} -v cat="${awk} '{print}'" ' -{ - line = $0 - if( match(line,"^#include#[^#]*#") ) - { - path = substr(line,10,RLENGTH-10) - system( cat " " path ) - } - else - { - print line - } -} -' -} +if test "${graphics_dir}" = "" +then + graphics_dir="graphics" +fi -# === -# Main() -# -# Does the bulk of the conversion. -# -Main() -{ -${awk} -v title="${1}" -v full="${2}" -v colour="${3}" ' -BEGIN { - if( full ) - { - dtd = "-//W3C//DTD HTML 4.01 Transitional//EN" - printf( "<!DOCTYPE HTML PUBLIC \"%s\">\n" , dtd ) - printf( "<html>\n" ) - printf( "<head>\n" ) - printf( "<title>%s\n" , title ) - printf( "\n" ) - printf( "\n" , colour ) - printf( "\n" , title ) - } -} - -function escape( line ) -{ - gsub( "&" , "\\&" , line ) - gsub( "<" , "\\<" , line ) - gsub( ">" , "\\>" , line ) - return line -} - -function dequote( line ) -{ - quote = "\"" - not_quote = "[^" quote "]" - #start_tag="" - #end_tag="" - start_tag="" - end_tag="" - gsub( quote not_quote "*" quote , start_tag "&" end_tag , line ) - gsub( start_tag quote , start_tag , line ) - gsub( quote end_tag , end_tag , line ) - return line -} - -function fn( line ) -{ - gsub( "[^[:space:]][^[:space:]]*\\(\\)" , "&" , line ) - return line -} - -function output( line ) -{ - printf( "%s\n" , fn(dequote(escape(line))) ) -} - -function tagOutput( line , tag ) -{ - printf( "<%s>%s\n" , tag , fn(dequote(escape(line))) , tag ) -} - -function tagOutputRaw( line , tag ) -{ - printf( "<%s>%s\n" , tag , escape(line) , tag ) -} - -function process( line , next_ ) -{ - tab = " " - is_blank = match( line , "^ *$" ) - is_heading = match( next_ , "^==* *$" ) - is_sub_heading = match( next_ , "^--* *$" ) - is_list_item = match( line , "^\\* " ) - is_definition_term = match( line , "^\\# " ) - is_definition_text = match( line , "^ [^- ]" ) - is_outer_list_item = match( line , "^+ " ) - is_inner_list_item = match( line , "^ - " ) - is_sub_list_item = match( line , "^ + " ) - is_numbered_item = match( line , "^\\([[:digit:]][[:digit:]]*\\)" ) - is_heading_line = match( line , "^==* *$" ) - is_sub_heading_line = match( line , "^--* *$" ) - is_code = match( line , "^" tab ) - - if( is_blank ) - { - printf( "

\n" ) - } - else if( is_code ) - { - tagOutputRaw( line , "pre" ) - } - else if( is_definition_term ) - { - gsub( "^# " , "" , line ) - tagOutput( line , "dt" ) - } - else if( is_definition_text ) - { - tagOutput( line , "dd" ) - } - else if( is_list_item ) - { - gsub( "^\\* " , "" , line ) - tagOutput( line , "li" ) - } - else if( is_outer_list_item ) - { - gsub( "^+ " , "" , line ) - tagOutput( line , "Li" ) - } - else if( is_inner_list_item ) - { - gsub( "^ - " , "" , line ) - tagOutput( line , "lI" ) - } - else if( is_numbered_item ) - { - gsub( "^\\([[:digit:]][[:digit:]]*\\) " , "" , line ) - tagOutput( line , "LI" ) - } - else if( is_heading ) - { - major += 1 - minor = 0 - printf( "

%s

" , major , line ) - printf( "\n" , major , line ) - } - else if( is_sub_heading ) - { - minor += 1 - printf( "

%s

" , major , minor , line ) - printf( "\n" , major , minor , line ) - } - else if( !is_heading_line && !is_sub_heading_line ) - { - output( line ) - } -} - -{ - if( NR != 1 ) - process( previous , $0 ) - previous = $0 -} - -END { - process( previous , "" ) - if( full ) - { - printf( "\n" ) - printf( "\n" ) - } -} ' -} - -# === -# AugmentLists() -# -# Adds list begin/end tags around a set of list items -# eg.
    and
tags either side of a set of -# contiguous
  • lines. -# -# The 'ignore' parameters can be used to make sure that -# list-item lines separated with 'ignore' patterns are -# treated as being contiguous. -# -AugmentLists() -{ -${awk} -v item_tag="${1}" -v list_tag="${2}" -v ignore_1_re="${3}" -v ignore_2_re="${4}" ' -{ - line = $0 - ignore_1 = length(ignore_1_re) && match( line , ignore_1_re ) - ignore_2 = length(ignore_2_re) && match( line , ignore_2_re ) - ignore = ignore_1 || ignore_2 - if( ignore ) - { - print - } - else - { - is_list_item = match( line , "^<" item_tag ">.*$" ) - - if( is_list_item && !in_list ) - printf( "<%s>\n" , list_tag ) - else if( in_list && !is_list_item ) - printf( "\n" , list_tag ) - - print - in_list = is_list_item - } -} ' -} - -# === -# Elide() -# -# Converts repeated lines of lineN into -# -# line1 -# line2 -# -# -# Useful for 
     and .
-#
-Elide()
-{
-${awk} -v tag="${1}" '
-{
-	line = $0
-	is_tag_line = match( line , "^<" tag ">.*$" )
-
-	core = substr( line , length(tag)+3 , length(line)-length(tag)-length(tag)-5 )
-
-	if( is_tag_line && !in_tag )
-		printf( "<%s>%s" , tag , core )
-	else if( is_tag_line && in_tag )
-		printf( "\n%s" , core )
-	else if( !is_tag_line && in_tag )
-		printf( "\n%s\n" , tag , line )
-	else
-		print line
-
-	in_tag = is_tag_line
-} '
-}
-
-# ===
-# Decorate()
-#
-# Adds additional stuff after a given opening tag
-# and optionally before a closing tag. The opening 
-# tag is expected to be at the start of the line.
-#
-Decorate()
-{
-${awk} -v tag="${1}" -v first="${2}" -v second="${3}" '
-{
-	line = $0
-	sub( "^<" tag ">" , "<" tag ">" first , line )
-	sub( "" , second "" , line )
-	print line
-} '
-}
-
-# ===
-# Compress()
-#
-# Removes blank lines near to headings (etc).
-#
-Compress()
-{
-${awk} '
-function process( previous , line , next_ )
-{
-	re_blank = "^

    $"
-	re_heading = "^<[Hh][[:digit:]]>"
-	re_dd = "^
    "
-	re_pre_start = "^
    "
-	re_pre_end = "
    $"
-
-	this_is_blank = match(line,re_blank)
-	next_is_special = match(next_,re_heading) || match(next_,re_dd)
-	previous_is_special = match(previous,re_heading) || match(previous,re_dd)
-	next_is_pre_start = match(next_,re_pre_start)
-
-	if( this_is_blank && ( next_is_special || previous_is_special ) )
-	{
-	}
-	else if( this_is_blank && next_is_pre_start )
-	{
-	}
-	else
-	{
-		print line
-	}
-}
-{
-	if( NR >= 2 )
-		process( l2 , l1 , $0 )
-	l2 = l1
-	l1 = $0
-}
-END {
-	process( l2 , l1 , "" )
-	process( l1 , "" , "" )
-}
-'
-}
-
-# ===
-# Anchorise_1()
-#
-# Converts "*foo* [bar]" to foo.
-#
-Anchorise_1()
-{
-	sed 's/\*\([^[:space:]]*\)\* \[\([^[:space:]]*\)\]/\1<\/a>/g'
-}
-
-# ===
-# Anchorise_2()
-#
-# Converts [[-foo-bar-]] to bar.
-# Deprecated.
-#
-Anchorise_2()
-{
-	sed 's/\[\[-\([^-]*\)-\([^-]*\)-\]\]/\2<\/a>/g'
-}
-
-# ===
-# Anchorise_3()
-#
-# Converts [[foo]] to foo.
-# Deprecated.
-#
-Anchorise_3()
-{
-	sed 's/\[\[\([^\]*\)\]\]/\1<\/a>/g'
-}
-
-# ===
-# Cat()
-#
-# An awk version of "cat" (cygwin cat is
-# broken).
-#
-Cat()
-{
-	${awk} '{print}' $@ | tr -d '\015'
-}
-
-# ===
-# MoveIndex()
-#
-# Moves the index comments to a line before
-# the header, rather than at the end of the
-# header line.
-#
-MoveIndex()
-{
-	${awk} '
-	{
-		line = $0
-		re = "