diff --git a/ChangeLog b/ChangeLog index fef2a1c..68ad20a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,6 +1,21 @@ E-MailRelay Change Log ====================== +1.0.2 -> 1.1.0 +-------------- +* In proxy mode unexpected client-side disconnects and timeouts do not leave ".bad" files [see also bug-id 659039]. +* By default proxy mode does not interpret addresses for local delivery ("--postmaster"). +* Polling option added ("--poll") to rescan the spool directory periodically. +* New special exit code (103) for the pre-processor to trigger immediate polling; 100 to 107 now reserved. +* Orphaned zero-length content files are deleted properly if the server-side dialogue is cut short. +* The "--interface" switch applies to the "--admin" interface too. +* Improved internal event architecture using slot/signal design pattern, and fewer singleton classes. +* Event notification available through the administration interface. +* New "--hidden" switch for Windows. +* Syslog output includes process-id. +* Support for Sun WorkShop 5.0 added. +* Documentation overhaul. + 1.0.0 -> 1.0.2 -------------- * Support for trusted IP addresses, allowing certain clients to avoid authentication. @@ -39,7 +54,7 @@ E-MailRelay Change Log * More flexible logging options ("--verbose" and "--debug" work better). * File Hierarchy Standard (FHS) option for "configure" ("--enable-fhs"). * FHS-compatible RPMs. -* Spool files writeable by preprocessor when server started as root. +* Spool files writeable by pre-processor when server started as root. * Default directories in executables and scripts come from "configure". * The "init.d" script is renamed "emailrelay" (was "emailrelay.sh"). * Man pages are gzipped when installed. @@ -52,7 +67,7 @@ E-MailRelay Change Log 0.9.7 -> 0.9.8 -------------- -* Fix for running preprocessor ("--filter") as root. +* Fix for running pre-processor ("--filter") as root. * Ignore bogus "AUTH=LOGIN" lines in EHLO response. * Submit utility improved to work with mutt. * Installation of submit man page. @@ -101,7 +116,7 @@ Windows fixes and improvements... 0.9.2 -> 0.9.3 -------------- * Proxy mode ("--immediate" and "--as-proxy"). -* Message preprocessing ("--filter"). +* Message pre-processing ("--filter"). * Message store classes better separated using abstract interfaces. * Improved notification script, with MIME encoding. * Builds with old 2.91 version of gcc. diff --git a/INSTALL b/INSTALL index a1a5ca9..2fae9b2 100644 --- a/INSTALL +++ b/INSTALL @@ -1,24 +1,30 @@ Introduction ============ - What follows are generic installation instructions for doing a standard GNU -"./configure; make; make install" installation from source under Linux, FreeBSD -etc. The Windows installation instructions are in a separate document. + What follows are generic installation instructions for doing a +GNU-style "./configure; make; make install-strip" installation from +source under Linux, FreeBSD etc. The Windows installation instructions +are in a separate document. - A non-standard "configure" switch is available, "--enable-fhs", which overrides -all other directory modifiers, forcing compliance with the File Hierarchy Standard. -This switch is used in building the RPMs, and may become the default in future -releases. + The E-MailRelay "configure" script provides a few extra switches, +which are shown in the output of "./configure --help". The most +important of these is "--enable-fhs", which overrides all other +directory modifiers, forcing compliance with the File Hierarchy +Standard. This switch is used in building the RPMs, and may become the +default in future releases. - There are also a set of variables which can be defined on the "configure" command -line for controlling all the installation directories in more detail, augmenting -the standard command-line switches like "--sbindir" and "--libexecdir". For more -information refer to the E-MailRelay reference document under -"Files and directories". + There are also a set of variables which can be defined on the +"configure" command line for controlling all the installation +directories in more detail, augmenting the standard command-line +switches like "--sbindir" and "--libexecdir". For more information +refer to the E-MailRelay reference document under "Files and directories". - The E-MailRelay user guide describes what needs to be done after the "make -install" in order to get the emailrelay daemon to start up at boot-time, -automatically forward e-mail and bounce failed mail. + If compiling with something other than "gcc" then check for any +compiler-specific help in the relevant lib/ directory. + + The E-MailRelay user guide describes what needs to be done after the +"make install" in order to get the emailrelay daemon to start up at +boot-time, automatically forward e-mail and bounce failed mail. Basic Installation ================== diff --git a/Makefile.am b/Makefile.am index 636ef21..8f20b57 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# EXTRA_DIST = emailrelay.spec ChangeLog SUBDIRS = src bin lib doc e_doc_DATA = NEWS README changelog.gz diff --git a/Makefile.in b/Makefile.in index a6580a3..f65a79e 100644 --- a/Makefile.in +++ b/Makefile.in @@ -90,24 +90,8 @@ e_sbindir = @e_sbindir@ e_spooldir = @e_spooldir@ install_sh = @install_sh@ -# -# Copyright (C) 2001-2003 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. -# +# +# EXTRA_DIST = emailrelay.spec ChangeLog SUBDIRS = src bin lib doc e_doc_DATA = NEWS README changelog.gz diff --git a/README b/README index 112d570..56dc0b8 100644 --- a/README +++ b/README @@ -3,66 +3,69 @@ E-MailRelay Readme Abstract -------- -E-MailRelay is a simple SMTP store-and-forward message transfer agent (MTA). -It runs as an SMTP server, storing e-mail in a local spool directory, and -then forwarding the stored messages to the next SMTP server on request. -It can also run as a proxy server, forwarding (and optionally pre-processing) -e-mail as soon as it is received. It does not do any message routing, other -than to a local postmaster. Because of this functional simplicity it is -extremely easy to configure, typically only requiring the address of the -next-hop SMTP server to be put on the command line. +E-MailRelay is a simple SMTP proxy and store-and-forward message transfer agent +(MTA). When running as a proxy all e-mail messages can be passed through a +user-defined program, such as a spam filter, which can drop, re-address or edit +messages as they pass through. When running as a store-and-forward MTA incoming +messages are stored in a local spool directory, and then forwarded to the next +SMTP server on request. -C++ source code is available for Linux, FreeBSD (etc) and Windows. +Because of its functional simplicity E-MailRelay is easy to configure, typically +only requiring the address of the target SMTP server to be put on the command +line. + +C++ source code is available for Linux, FreeBSD, MacOS X etc, and Windows. Distribution is under the GNU General Public License. Quick start ----------- -E-MailRelay can be built and installed from source using the ususal -"./configure ; make ; make install" incantation. The program runs as an SMTP -server daemon using the "emailrelay --as-server" command, and stored mail is -forwarded to the next-hop server by running "emailrelay --as-client :smtp". +To run the program as a proxy use the "--as-proxy" command-line switch, followed by the +address of the target SMTP server. If you want to edit or filter e-mail as it passes +through the proxy then specify your pre-processor program with the "--filter" switch. +You can optionally change the listening port number using "--port" and the +spool directory using "--spool-dir". -The "--as-server" command is typically run automatically at boot time, using -the boot scripts under "/etc/init.d" or "/sbin/init.d", while the "--as-client" -command is normally put into pppd's "ip-up" script ("/etc/ppp/ip-up") -in place of "sendmail -q". +For example, to start up a local proxy which passes messages to some "addsig" script +and then forwards them to an MTA running on "smarthost", use a command like this: -The program can also run as a proxy server ("--as-proxy") so that e-mail -messages are forwarded immediately to the next-hop server -- usually the local -system's default MTA. This can be usefully combined with a mail pre-processor -program by using the "--filter" switch. + emailrelay --as-proxy smarthost:smtp --filter $HOME/bin/addsig --spooldir $HOME/tmp -The program requires a writeable spool directory to store e-mail messages. -The directory defaults to "/usr/local/var/spool/emailrelay", but it -can be changed by using the "--spool-dir" switch. +To use E-MailRelay as a store-and-forward MTA use the "--as-server" switch +to start the storage daemon in the background. And then trigger delivery of +spooled messages by running emailrelay with the "--as-client" switch, followed +by the address of the target SMTP server. -By default the server will try to listen on TCP port 25. If another SMTP -server is running then it will fail to start up, with a "cannot bind" error -message. The port number can be changed by using the "--port" switch. +For example, to start a storage daemon listening on port 10025 use a command +like this: -To test the program out without a full installation: -(1) run the server as "emailrelay --no-daemon --no-syslog --log --spool-dir ${HOME} --port 10025 &" -(2) reconfigure your e-mail client to use port 10025 rather than 25 ("smtp") -(3) send some test messages to addressees on the Internet -(4) connect to the Internet -(5) forward the stored messages using "emailrelay --spool-dir ${HOME} --as-client :smtp" -(6) clean up with "killall emailrelay ; rm ${HOME}/emailrelay.*" + emailrelay --as-server --port 10025 --spooldir $HOME/tmp + +And then to forward the spooled mail to "smarthost" run somthing like this: + + emailrelay --as-client smarthost:smtp --spooldir $HOME/tmp + +By default E-MailRelay will reject connections from remote machines. To +allow connections from anywhere use the "--remote-clients" switch. + +For more information on the command-line options refer to the reference guide +or run: + + emailrelay --help --verbose Documentation ------------- -The following documentation is provided in the source distribution: +The following documentation is provided: * README -- this document * COPYING -- the GNU General Public License * INSTALL -- build & install instructions (including the generic GNU text) * AUTHORS -- authors, credits and additional copyrights * copyright -- main copyright and GPL reference -* doc/userguide.txt -- user guide -* doc/reference.txt -- reference document +* userguide.txt -- user guide +* reference.txt -- reference document * ChangeLog -- change log for releases -Additional documents, including source-code documentation generated by -doxygen (www.doxygen.org), is available in a separate package, -"emailrelay-doc". +Source code documentation will be generated when building from source if +"doxygen" is available. Configurations -------------- @@ -78,21 +81,23 @@ and ported to Windows 98 using: Recent releases were developed on SuSE Linux 8.0 and RedHat Linux 8.0 using: -* gcc 2.95.3 and 3.2 +* gcc 2.95.3 and gcc 3.2 * autoconf 2.53 The code has also been built successfully on: -* Windows NT 4.0 * MacOS X * FreeBSD on Intel hardware -* Solaris 8, using gcc, on Sparc hardware * Linux on Alpha hardware (Debian 2.2) * Linux on Sparc hardware * Linux on RS6000 PPC hardware +* Solaris 8 using gcc on Sparc hardware +* Solaris 8 using WorkShop 5.0 +* Linux using intel c++ 6.0 +* Windows NT 4.0 using MSVC 6.0 Feedback -------- -Please feel free to email the author at +Please feel free to e-mail the author at "mailto:graeme_walker@users.sourceforge.net". diff --git a/acinclude.m4 b/acinclude.m4 index 5a14f02..f1fae27 100644 --- a/acinclude.m4 +++ b/acinclude.m4 @@ -73,18 +73,64 @@ AC_DEFUN([ACLOCAL_CHECK_LOCALTIME_R], fi ]) -dnl gcc version +dnl buggy ctime +dnl sunpro5 ctime + unistd.h doesnt compile -- fix with time.h first +dnl +AC_DEFUN([ACLOCAL_CHECK_BUGGY_CTIME], +[AC_CACHE_CHECK([for buggy ctime], aclocal_cv_buggy_ctime, +[ + AC_TRY_COMPILE( + [#include +#include ], + [] , + aclocal_cv_buggy_ctime=no , + aclocal_cv_buggy_ctime=yes ) +]) + if test $aclocal_cv_buggy_ctime = yes; then + AC_DEFINE(HAVE_BUGGY_CTIME,1,[Define if requires ]) + else + AC_DEFINE(HAVE_BUGGY_CTIME,0,[Define if requires ]) + fi +]) + +dnl compiler name and version dnl used for -Ilib/ -- only needed for pre 3.0 gcc dnl AC_DEFUN([ACLOCAL_COMPILER_VERSION], [ changequote(<<,>>) COMPILER_VERSION=`$CXX --version 2>/dev/null | sed q | sed 's/[^0-9 .]*//g;s/\./ /g;s/^ *//;s/ /./;s/ .*//;s/^/gcc/'` + if test -z "${COMPILER_VERSION}" + then + COMPILER_VERSION=`$CXX -V 2>&1 | sed q | grep WorkShop | sed 's/[^0-9]*//;s/[ \.].*//;s/^/sunpro/'` + fi changequote([,]) AC_SUBST(COMPILER_VERSION) ]) -dnl fhs +dnl enable-debug +dnl +AC_DEFUN([ENABLE_DEBUG], +[ +if test "$enable_debug" = "yes" +then + AC_DEFINE(_DEBUG,1,[Define to enable extra debug messages at compile-time]) +fi +]) + +dnl with-workshop +dnl +AC_DEFUN([WITH_WORKSHOP], +[ +if test "$with_workshop" = "yes" +then + chmod +x lib/sunpro5/xar + AR="`pwd`/lib/sunpro5/xar --cxx \"$CXX\"" + AC_SUBST(AR) +fi +]) + +dnl enable-fhs dnl AC_DEFUN([ENABLE_FHS], [ diff --git a/aclocal.m4 b/aclocal.m4 index 5cc779d..54efe20 100644 --- a/aclocal.m4 +++ b/aclocal.m4 @@ -86,18 +86,64 @@ AC_DEFUN([ACLOCAL_CHECK_LOCALTIME_R], fi ]) -dnl gcc version +dnl buggy ctime +dnl sunpro5 ctime + unistd.h doesnt compile -- fix with time.h first +dnl +AC_DEFUN([ACLOCAL_CHECK_BUGGY_CTIME], +[AC_CACHE_CHECK([for buggy ctime], aclocal_cv_buggy_ctime, +[ + AC_TRY_COMPILE( + [#include +#include ], + [] , + aclocal_cv_buggy_ctime=no , + aclocal_cv_buggy_ctime=yes ) +]) + if test $aclocal_cv_buggy_ctime = yes; then + AC_DEFINE(HAVE_BUGGY_CTIME,1,[Define if requires ]) + else + AC_DEFINE(HAVE_BUGGY_CTIME,0,[Define if requires ]) + fi +]) + +dnl compiler name and version dnl used for -Ilib/ -- only needed for pre 3.0 gcc dnl AC_DEFUN([ACLOCAL_COMPILER_VERSION], [ changequote(<<,>>) COMPILER_VERSION=`$CXX --version 2>/dev/null | sed q | sed 's/[^0-9 .]*//g;s/\./ /g;s/^ *//;s/ /./;s/ .*//;s/^/gcc/'` + if test -z "${COMPILER_VERSION}" + then + COMPILER_VERSION=`$CXX -V 2>&1 | sed q | grep WorkShop | sed 's/[^0-9]*//;s/[ \.].*//;s/^/sunpro/'` + fi changequote([,]) AC_SUBST(COMPILER_VERSION) ]) -dnl fhs +dnl enable-debug +dnl +AC_DEFUN([ENABLE_DEBUG], +[ +if test "$enable_debug" = "yes" +then + AC_DEFINE(_DEBUG,1,[Define to enable extra debug messages at compile-time]) +fi +]) + +dnl with-workshop +dnl +AC_DEFUN([WITH_WORKSHOP], +[ +if test "$with_workshop" = "yes" +then + chmod +x lib/sunpro5/xar + AR="`pwd`/lib/sunpro5/xar --cxx \"$CXX\"" + AC_SUBST(AR) +fi +]) + +dnl enable-fhs dnl AC_DEFUN([ENABLE_FHS], [ diff --git a/bin/Makefile.am b/bin/Makefile.am index 744f965..126b758 100644 --- a/bin/Makefile.am +++ b/bin/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# 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-resubmit.sh_ emailrelay-deliver.sh_ emailrelay-process.sh_ diff --git a/bin/Makefile.in b/bin/Makefile.in index 2e01e4e..5960ed2 100644 --- a/bin/Makefile.in +++ b/bin/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ diff --git a/bin/emailrelay-deliver.sh_ b/bin/emailrelay-deliver.sh_ index 7288a1b..03c4173 100644 --- a/bin/emailrelay-deliver.sh_ +++ b/bin/emailrelay-deliver.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/emailrelay-doxygen-filter.sh_ b/bin/emailrelay-doxygen-filter.sh_ index 5d83899..7325292 100644 --- a/bin/emailrelay-doxygen-filter.sh_ +++ b/bin/emailrelay-doxygen-filter.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/emailrelay-notify.sh_ b/bin/emailrelay-notify.sh_ index 62b87f0..e3ca4da 100644 --- a/bin/emailrelay-notify.sh_ +++ b/bin/emailrelay-notify.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/emailrelay-process.sh_ b/bin/emailrelay-process.sh_ index 0fb9bc6..f8cdc00 100644 --- a/bin/emailrelay-process.sh_ +++ b/bin/emailrelay-process.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/emailrelay-resubmit.sh_ b/bin/emailrelay-resubmit.sh_ index 47103b9..ef06907 100644 --- a/bin/emailrelay-resubmit.sh_ +++ b/bin/emailrelay-resubmit.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/emailrelay-soak.sh_ b/bin/emailrelay-soak.sh_ index a213111..77abff5 100644 --- a/bin/emailrelay-soak.sh_ +++ b/bin/emailrelay-soak.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/emailrelay-test.sh_ b/bin/emailrelay-test.sh_ index 00693f0..bd9cc30 100644 --- a/bin/emailrelay-test.sh_ +++ b/bin/emailrelay-test.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or @@ -31,18 +31,21 @@ # Once all the servers have been killed the separate log files are # concatenated into the summary log file "/tmp/emailrelay-test.out". # -# If this test takes more than a second or two then it has failed. +# If this test takes more a minute then it has failed. +# +# usage: emailrelay-test.sh [-v] [-d] [] # # configuration # -exe_dir="../src/main" -if test "${1}" != "" ; then exe_dir="${1}" ; fi +use_valgrind="0" ; if test "${1}" = "-v" ; then use_valgrind="1" ; shift ; fi +debug="" ; if test "${1}" = "-d" ; then debug="--debug" ; shift ; fi +exe_dir="../src/main" ; if test "${1}" != "" ; then exe_dir="${1}" ; fi exe="${exe_dir}/emailrelay" poke="${exe_dir}/emailrelay-poke" null_filter="/bin/touch" content_file="/etc/services" -pp="1001" # port-prefix +pp="201" # port-prefix # configuration fallback # @@ -56,16 +59,32 @@ fi base_dir="/tmp/`basename $0`.$$.tmp" summary_log="/tmp/`basename $0`.out" exit_code="1" +watchdog_pid="" +export MALLOC_CHECK_="2" +ulimit -c 1000000 +if test "${use_valgrind}" -eq 1 +then + exe="valgrind --logfile=${base_dir}/valgrind --trace-children=yes --num-callers=40 --leak-check=yes ${exe} --no-daemon" +fi Cleanup() { + ${poke} ${pp}11 terminate + ${poke} ${pp}12 terminate + ${poke} ${pp}13 terminate + ${poke} ${pp}14 terminate + ${poke} ${pp}15 terminate + ${poke} ${pp}16 terminate + sleep 2 + kill `cat ${base_dir}/pid-* 2>/dev/null` 2>/dev/null + if test -d ${base_dir} then grep "MailRelay-Reason" ${base_dir}/*/*envelope*bad > "${summary_log}" 2>/dev/null grep "." ${base_dir}/log-? >> "${summary_log}" 2>/dev/null ls -lR ${base_dir} >> "${summary_log}" 2>/dev/null - diff -w ${base_dir}/store-4/*content "${content_file}" >> "${summary_log}" 2>/dev/null + rm -rf ${base_dir} 2>/dev/null fi } @@ -78,14 +97,16 @@ Trap() RunServer() { port_="${1}" - spool_="${2}" - log_="${3}" - pidfile_="${4}" - extra_="${5}" + admin_port_="${2}" + spool_="${3}" + log_="${4}" + pidfile_="${5}" + extra_="${6}" mkdir -p ${base_dir}/${spool_} - ${exe} --log --no-syslog --port ${port_} --spool-dir ${base_dir}/${spool_} \ - --pid-file ${base_dir}/${pidfile_} ${extra_} 2> ${base_dir}/${log_} + ${exe} ${debug} --log --verbose --no-syslog --port ${port_} --spool-dir ${base_dir}/${spool_} \ + --admin ${admin_port_} --admin-terminate \ + --pid-file ${base_dir}/${pidfile_} ${extra_} 2> ${base_dir}/${log_} & } RunClient() @@ -137,18 +158,21 @@ CrLf() CheckResults() { - if test -f ${base_dir}/store-4/*.envelope -a -f ${base_dir}/store-4/*.content + store="${1}" + if test "`ls -1 ${base_dir}/${store}/emailrelay.*.content 2>/dev/null | wc -l`" -eq 2 -a \ + "`ls -1 ${base_dir}/${store}/emailrelay.*.envelope 2>/dev/null | wc -l`" -eq 2 then exit_code="0" echo `basename $0`: succeeded else - echo `basename $0`: failed: see ${summary_log} >&2 + false fi } -StartTimer() +StartWatchdog() { - ( sleep 30 ; Cleanup ) & + sleep 10 && kill `cat ${base_dir}/pid-* 2>/dev/null` 2>/dev/null & + watchdog_pid=$! } CreateMessages() @@ -156,6 +180,8 @@ CreateMessages() mkdir -p ${base_dir}/store-1 Content | CrLf > ${base_dir}/store-1/emailrelay.0.1.content Envelope | CrLf > ${base_dir}/store-1/emailrelay.0.1.envelope + Content | CrLf > ${base_dir}/store-1/emailrelay.0.2.content + Envelope | CrLf > ${base_dir}/store-1/emailrelay.0.2.envelope } CreateAuth() @@ -180,17 +206,48 @@ CreateAuth() echo "CRAM-MD5 client joe ${key}" >> ${file} } +CreateFilter() +{ +cat < ${base_dir}/filter.sh +_#!/bin/sh +_# filter.sh +_tmp="/tmp/`basename $0`.\$\$.tmp" +_tr 'a-z' 'A-Z' < \$1 > \$tmp && mv \$tmp \$1 +_exit 0 +EOF +chmod +x ${base_dir}/filter.sh +} + trap "Trap ; exit" 1 2 3 13 15 trap "Trap 0 ; exit" 0 -StartTimer +#StartWatchdog 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 --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 -RunPoke ${pp}9 log-p -CheckResults +CreateFilter + +RunServer ${pp}01 ${pp}10 store-2 log-1 pid-1 +RunServer ${pp}02 ${pp}12 store-2 log-2 pid-2 "--forward-to localhost:${pp}03 --client-auth ${base_dir}/client-joe.auth" +RunServer ${pp}03 ${pp}13 store-3 log-3 pid-3 "--immediate --forward-to localhost:${pp}04 --filter ${null_filter} --client-auth ${base_dir}/client-fred.auth --server-auth ${base_dir}/server.auth" +RunServer ${pp}04 ${pp}14 store-4 log-4 pid-4 "--server-auth ${base_dir}/server.auth" +RunServer ${pp}05 ${pp}15 store-4 log-5 pid-5 "--poll 1 --forward-to localhost:${pp}06" +RunServer ${pp}06 ${pp}16 store-6 log-6 pid-6 "--filter ${base_dir}/filter.sh" + +CreateMessages +RunClient localhost:${pp}01 store-1 log-c pid-5 +RunPoke ${pp}12 log-p + +for i in 0 1 2 3 4 5 6 7 8 9 +do + sleep 2 + CheckResults store-6 + if test $? -eq 0 ; then break ; fi +done +if test "${watchdog_pid}" != "" +then + kill "${watchdog_pid}" +fi +if test ${exit_code} -ne 0 +then + echo `basename $0`: failed: see ${summary_log} >&2 +fi diff --git a/bin/emailrelay.sh_ b/bin/emailrelay.sh_ index a16f0de..c0ca5e5 100644 --- a/bin/emailrelay.sh_ +++ b/bin/emailrelay.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or @@ -18,7 +18,7 @@ # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. # # === -# +# # emailrelay # # A shell-script wrapper for E-MailRelay designed for diff --git a/bin/expand.sh_ b/bin/expand.sh_ index 953936a..64e5e31 100644 --- a/bin/expand.sh_ +++ b/bin/expand.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/mu2html.sh_ b/bin/mu2html.sh_ index 2a55ebd..a8c8fec 100644 --- a/bin/mu2html.sh_ +++ b/bin/mu2html.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/txt2html.sh_ b/bin/txt2html.sh_ index 448512f..29ac139 100644 --- a/bin/txt2html.sh_ +++ b/bin/txt2html.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/bin/txt2mu.sh_ b/bin/txt2mu.sh_ index b39fbb0..8a11224 100644 --- a/bin/txt2mu.sh_ +++ b/bin/txt2mu.sh_ @@ -1,5 +1,5 @@ #!/bin/sh -# +# # Copyright (C) 2001-2003 Graeme Walker # # This program is free software; you can redistribute it and/or diff --git a/config.h.in b/config.h.in index 19c5714..4c0e47f 100644 --- a/config.h.in +++ b/config.h.in @@ -1,5 +1,8 @@ /* config.h.in. Generated from configure.ac by autoheader. */ +/* Define if requires */ +#undef HAVE_BUGGY_CTIME + /* Define to 1 if you have the header file, and it defines `DIR'. */ #undef HAVE_DIRENT_H @@ -83,3 +86,6 @@ /* Version number of package */ #undef VERSION + +/* Define to enable extra debug messages at compile-time */ +#undef _DEBUG diff --git a/configure b/configure index 6e9e62c..1866584 100755 --- a/configure +++ b/configure @@ -837,9 +837,15 @@ Optional Features: --enable-FEATURE[=ARG] include FEATURE [ARG=yes] --disable-dependency-tracking Speeds up one-time builds --enable-dependency-tracking Do not reject slow dependency extractors + --enable-debug enable extra debug messages at compile-time --enable-fhs force FHS-compliant directories, ignoring --prefix etc +Optional Packages: + --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] + --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) + --with-workshop use Sun WorkShop 'CC -xar' as the 'ar' tool + Some influential environment variables: CC C compiler command CFLAGS C compiler flags @@ -1453,7 +1459,7 @@ fi # Define the identity of the package. PACKAGE=emailrelay - VERSION=1.0.2 + VERSION=1.1 cat >>confdefs.h <<_ACEOF @@ -3269,6 +3275,10 @@ fi COMPILER_VERSION=`$CXX --version 2>/dev/null | sed q | sed 's/[^0-9 .]*//g;s/\./ /g;s/^ *//;s/ /./;s/ .*//;s/^/gcc/'` + if test -z "${COMPILER_VERSION}" + then + COMPILER_VERSION=`$CXX -V 2>&1 | sed q | grep WorkShop | sed 's/[^0-9]*//;s/[ \.].*//;s/^/sunpro/'` + fi @@ -4611,6 +4621,68 @@ _ACEOF fi +echo "$as_me:$LINENO: checking for buggy ctime" >&5 +echo $ECHO_N "checking for buggy ctime... $ECHO_C" >&6 +if test "${aclocal_cv_buggy_ctime+set}" = set; then + echo $ECHO_N "(cached) $ECHO_C" >&6 +else + + cat >conftest.$ac_ext <<_ACEOF +#line $LINENO "configure" +#include "confdefs.h" +#include +#include +#ifdef F77_DUMMY_MAIN +# ifdef __cplusplus + extern "C" +# endif + int F77_DUMMY_MAIN() { return 1; } +#endif +int +main () +{ + + ; + return 0; +} +_ACEOF +rm -f conftest.$ac_objext +if { (eval echo "$as_me:$LINENO: \"$ac_compile\"") >&5 + (eval $ac_compile) 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); } && + { ac_try='test -s conftest.$ac_objext' + { (eval echo "$as_me:$LINENO: \"$ac_try\"") >&5 + (eval $ac_try) 2>&5 + ac_status=$? + echo "$as_me:$LINENO: \$? = $ac_status" >&5 + (exit $ac_status); }; }; then + aclocal_cv_buggy_ctime=no +else + echo "$as_me: failed program was:" >&5 +cat conftest.$ac_ext >&5 +aclocal_cv_buggy_ctime=yes +fi +rm -f conftest.$ac_objext conftest.$ac_ext + +fi +echo "$as_me:$LINENO: result: $aclocal_cv_buggy_ctime" >&5 +echo "${ECHO_T}$aclocal_cv_buggy_ctime" >&6 + if test $aclocal_cv_buggy_ctime = yes; then + +cat >>confdefs.h <<\_ACEOF +#define HAVE_BUGGY_CTIME 1 +_ACEOF + + else + +cat >>confdefs.h <<\_ACEOF +#define HAVE_BUGGY_CTIME 0 +_ACEOF + + fi + echo "$as_me:$LINENO: checking for gmtime_r" >&5 echo $ECHO_N "checking for gmtime_r... $ECHO_C" >&6 if test "${aclocal_cv_gmtime_r+set}" = set; then @@ -4734,6 +4806,37 @@ _ACEOF fi +# Check whether --enable-debug or --disable-debug was given. +if test "${enable_debug+set}" = set; then + enableval="$enable_debug" + +fi; + +if test "$enable_debug" = "yes" +then + +cat >>confdefs.h <<\_ACEOF +#define _DEBUG 1 +_ACEOF + +fi + + + +# Check whether --with-workshop or --without-workshop was given. +if test "${with_workshop+set}" = set; then + withval="$with_workshop" + +fi; + +if test "$with_workshop" = "yes" +then + chmod +x lib/sunpro5/xar + AR="`pwd`/lib/sunpro5/xar --cxx \"$CXX\"" + +fi + + # Check whether --enable-fhs or --disable-fhs was given. if test "${enable_fhs+set}" = set; then enableval="$enable_fhs" @@ -4791,7 +4894,7 @@ fi SET_MAKE="" -ac_config_files="$ac_config_files Makefile src/Makefile src/glib/Makefile src/gnet/Makefile src/gsmtp/Makefile src/main/Makefile src/win32/Makefile lib/Makefile lib/gcc2.95/Makefile lib/msvc6.0/Makefile bin/Makefile doc/Makefile" +ac_config_files="$ac_config_files Makefile src/Makefile src/glib/Makefile src/gnet/Makefile src/gsmtp/Makefile src/main/Makefile src/win32/Makefile lib/Makefile lib/gcc2.95/Makefile lib/msvc6.0/Makefile lib/sunpro5/Makefile bin/Makefile doc/Makefile" cat >confcache <<\_ACEOF # This file is a shell script that caches the results of configure # tests run on this system so they can be shared between configure @@ -5290,6 +5393,7 @@ do "lib/Makefile" ) CONFIG_FILES="$CONFIG_FILES lib/Makefile" ;; "lib/gcc2.95/Makefile" ) CONFIG_FILES="$CONFIG_FILES lib/gcc2.95/Makefile" ;; "lib/msvc6.0/Makefile" ) CONFIG_FILES="$CONFIG_FILES lib/msvc6.0/Makefile" ;; + "lib/sunpro5/Makefile" ) CONFIG_FILES="$CONFIG_FILES lib/sunpro5/Makefile" ;; "bin/Makefile" ) CONFIG_FILES="$CONFIG_FILES bin/Makefile" ;; "doc/Makefile" ) CONFIG_FILES="$CONFIG_FILES doc/Makefile" ;; "depfiles" ) CONFIG_COMMANDS="$CONFIG_COMMANDS depfiles" ;; diff --git a/configure.ac b/configure.ac old mode 100644 new mode 100755 index bcdd787..74d6274 --- a/configure.ac +++ b/configure.ac @@ -1,4 +1,3 @@ -dnl dnl Copyright (C) 2001-2003 Graeme Walker dnl dnl This program is free software; you can redistribute it and/or @@ -19,9 +18,10 @@ dnl dnl === dnl dnl Process this file with autoconf to produce a configure script. +dnl AC_INIT(src/gsmtp/gsmtp.h) -AM_INIT_AUTOMAKE(emailrelay,1.0.2) +AM_INIT_AUTOMAKE(emailrelay,1.1) AM_CONFIG_HEADER(config.h) dnl === @@ -57,11 +57,24 @@ AC_CHECK_HEADERS(sys/time.h) AC_CHECK_FUNCS(glob) AC_LANG_CPLUSPLUS ACLOCAL_TYPE_SOCKLEN_T +ACLOCAL_CHECK_BUGGY_CTIME ACLOCAL_CHECK_GMTIME_R ACLOCAL_CHECK_LOCALTIME_R dnl === -dnl directory tweaking... +dnl "--enable-debug" +dnl +AC_ARG_ENABLE(debug,AC_HELP_STRING([--enable-debug],[enable extra debug messages at compile-time])) +ENABLE_DEBUG + +dnl === +dnl "--with-workshop" +dnl +AC_ARG_WITH(workshop,AC_HELP_STRING([--with-workshop],[use Sun WorkShop 'CC -xar' as the 'ar' tool])) +WITH_WORKSHOP + +dnl === +dnl directory tweaking and "--enable-fhs" ... dnl dnl not AC_PREFIX_DEFAULT([/usr]) AC_ARG_ENABLE(fhs,AC_HELP_STRING([--enable-fhs],[force FHS-compliant directories, ignoring --prefix etc])) @@ -83,10 +96,11 @@ ENABLE_FHS dnl === dnl attempt to fix recursive makes where make is gmake -- may break something else +dnl SET_MAKE="" dnl === dnl generate files... dnl -AC_OUTPUT(Makefile src/Makefile src/glib/Makefile src/gnet/Makefile src/gsmtp/Makefile src/main/Makefile src/win32/Makefile lib/Makefile lib/gcc2.95/Makefile lib/msvc6.0/Makefile bin/Makefile doc/Makefile) +AC_OUTPUT(Makefile src/Makefile src/glib/Makefile src/gnet/Makefile src/gsmtp/Makefile src/main/Makefile src/win32/Makefile lib/Makefile lib/gcc2.95/Makefile lib/msvc6.0/Makefile lib/sunpro5/Makefile bin/Makefile doc/Makefile) diff --git a/doc/Makefile.am b/doc/Makefile.am index 9884461..4701cac 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# stylesheet=emailrelay.css txt_files=developer.txt reference.txt userguide.txt windows.txt diff --git a/doc/Makefile.in b/doc/Makefile.in index 80c74a3..e24f8dc 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ diff --git a/doc/developer.txt b/doc/developer.txt index 0b53333..dd6d513 100644 --- a/doc/developer.txt +++ b/doc/developer.txt @@ -137,12 +137,6 @@ Sometimes only small parts of the implementation are system-specific. In these cases there are three source files per header. For example, "gsocket.cpp", "gsocket_win32.cpp" and "gsocket_unix.cpp" in the "src/gnet" directory. -Porting to other compilers --------------------------- -If porting to a good ANSI C++ compiler then start by removing files from the -"lib/gcc2.95" directory (or edit makefiles to remove the include path), and then -review the following header files "src/glib/gdef.h" and "src/gnet/gnet.h". - Compile-time features --------------------- The following features are available to source-code hackers: @@ -174,7 +168,7 @@ directory. Style ----- The commenting style used in header files is compatible with doxygen if passed -through the simple awk-based preprocessor "emailrelay-doxygen-filter.sh". A +through the simple awk-based pre-processor "emailrelay-doxygen-filter.sh". A "make" in the "doc" directory will run doxygen if it is found on your path. Patterns @@ -183,7 +177,7 @@ Gang-of-four Design Patterns (ISBN 0-201-63361-2): + Factory method - - GNet::EventSources::create() + - GNet::EventLoop::create() - GNet::Server::newPeer() - GSmtp::MessageStore::newMessage() @@ -197,8 +191,7 @@ Gang-of-four Design Patterns (ISBN 0-201-63361-2): - G::LogOutput - GGui::ApplicationInstance - - GNet::EventSources - - GSmtp::MessageStore + - GNet::EventLoop + Facade @@ -226,19 +219,18 @@ Lakos' Large Scale C++ Software Design patterns (ISBN 0-201-63362-0): - GSmtp::ProtocolMessage - GSmtp::ServerProtocol::Sender - GSmtp::ClientProtocol::Sender - - GSmtp::ClientProtocol::Callback - - GSmtp::ProtocolMessage::Callback - - GSmtp::Client::ClientCallback Meyer's More Effective C++ patterns (ISBN 0-201-63371-X): + Reference counting (Item 29) - GSmtp::MessageStore::Iterator + - G::Slot0 + Lazy evaluation (Item 17) - GNet::EventHandlerList::list() + - G::Date::weekday() Other patterns: @@ -246,6 +238,15 @@ Other patterns: - GSmtp::ServerProtocol ++ Slot/signal + + - G::Slot0 + - G::Signal0 + ++ Exception-safe assignment using swap + + - G::Slot0 + Idioms ------ The "<<=" operator defined in "src/glib/gmemory.h" is used idiomatically @@ -253,4 +254,5 @@ to reassign a std::auto_ptr<>. + Copyright (C) 2001-2003 Graeme Walker . All rights reserved. diff --git a/doc/emailrelay-passwd.1 b/doc/emailrelay-passwd.1 index 3ffa7df..80a213e 100644 --- a/doc/emailrelay-passwd.1 +++ b/doc/emailrelay-passwd.1 @@ -1,4 +1,3 @@ -.\" .\" Copyright (C) 2001-2003 Graeme Walker .\" .\" This program is free software; you can redistribute it and/or diff --git a/doc/emailrelay-poke.1 b/doc/emailrelay-poke.1 index ab16a93..5a74374 100644 --- a/doc/emailrelay-poke.1 +++ b/doc/emailrelay-poke.1 @@ -1,4 +1,3 @@ -.\" .\" Copyright (C) 2001-2003 Graeme Walker .\" .\" This program is free software; you can redistribute it and/or diff --git a/doc/emailrelay-submit.1 b/doc/emailrelay-submit.1 index 0b4aa84..e7dac79 100644 --- a/doc/emailrelay-submit.1 +++ b/doc/emailrelay-submit.1 @@ -1,4 +1,3 @@ -.\" .\" Copyright (C) 2001-2003 Graeme Walker .\" .\" This program is free software; you can redistribute it and/or @@ -29,7 +28,7 @@ emailrelay-submit \- a submission utility for E-MailRelay .RI [ to-address \ ...] .SH DESCRIPTION .I emailrelay-submit -is a utility which reads an RFC822 email message from the standard +is a utility which reads an RFC822 e-mail message from the standard input, with SMTP envelope recipient addresses passed on the command-line, and writes it into the .B E-MailRelay diff --git a/doc/emailrelay.1 b/doc/emailrelay.1 index 14af47b..62c6d08 100644 --- a/doc/emailrelay.1 +++ b/doc/emailrelay.1 @@ -1,4 +1,3 @@ -.\" .\" Copyright (C) 2001-2003 Graeme Walker .\" .\" This program is free software; you can redistribute it and/or @@ -64,7 +63,7 @@ Runs as a client, forwarding spooled mail to : equivalent to \fI--log\fR \ Runs as a proxy: equivalent to \fI--log\fR \fI--close-stderr\fR \fI--immediate\fR \fI--forward-to\fR. .TP .B \-d,--as-server -Runs as a server: equivalent to \fI--log\fR \fI--close-stderr\fR. +Runs as a server: equivalent to \fI--log\fR \fI--close-stderr\fR \fI--postmaster\fR. .TP .B \-C,--client-auth \fIfile\fR Enables authentication with remote server, using the given secrets file. @@ -120,9 +119,15 @@ Disables syslog output. .B \-i,--pid-file \fIpid-file\fR Records the daemon process-id in the given file. .TP +.B \-O,--poll \fIperiod\fR +Enables polling with the specified period (requires \fI--forward-to\fR). +.TP .B \-p,--port \fIport\fR Specifies the smtp listening port number. .TP +.B \-P,--postmaster +Deliver to postmaster and reject all other local mailbox addresses. +.TP .B \-r,--remote-clients Allows remote clients to connect. .TP diff --git a/doc/gnet-classes.png b/doc/gnet-classes.png index 8918a00..c94bbae 100644 Binary files a/doc/gnet-classes.png and b/doc/gnet-classes.png differ diff --git a/doc/gsmtp-classes.png b/doc/gsmtp-classes.png index 981b1b7..671d9db 100644 Binary files a/doc/gsmtp-classes.png and b/doc/gsmtp-classes.png differ diff --git a/doc/index.html b/doc/index.html index d164c13..a0f05c9 100644 --- a/doc/index.html +++ b/doc/index.html @@ -11,7 +11,7 @@
  • Readme
  • Change log
  • User guide
    • -
  • Reference manual
    • +
  • Reference
  • Windows installation guide
  • Notes for developers
  • Source code documentation (generated by doxygen, if available)
    • diff --git a/doc/reference.txt b/doc/reference.txt index f1b731b..894474d 100644 --- a/doc/reference.txt +++ b/doc/reference.txt @@ -23,7 +23,7 @@ where is: Runs as a proxy: equivalent to "--log --close-stderr --immediate --forward-to". # --as-server (-d) - Runs as a server: equivalent to "--log --close-stderr". + Runs as a server: equivalent to "--log --close-stderr --postmaster". # --client-auth (-C) Enables authentication with remote server, using the given secrets file. @@ -79,9 +79,15 @@ where is: # --pid-file (-i) Records the daemon process-id in the given file. +# --poll (-O) + Enables polling with the specified period (requires --forward-to). + # --port (-p) Specifies the smtp listening port number. +# --postmaster (-P) + Deliver to postmaster and reject all other local mailbox addresses. + # --remote-clients (-r) Allows remote clients to connect. @@ -106,11 +112,14 @@ where is: # --version (-V) Displays version information and exits. +Under Windows there are a few differences. Use "--help --verbose" +to see the complete list. + If no command-line switches are supplied at all then the default behaviour is: * to run as a daemon, detached from the terminal * listen on the standard SMTP port (25) -* store e-mail messages in "/usr/local/var/spool/emailrelay" +* store e-mail messages in "/usr/local/var/spool/emailrelay" or "/var/spool/emailrelay" * reject connections from remote clients * disable the administration interface * generate no logging or diagnostic messages @@ -121,7 +130,7 @@ the standard error stream is closed. To foward spooled messages to the ISP the command-line switch "--as-client" is provided to run the program... * in foreground, exiting when all spooled mail has been processed -* forwarding spooled mail from "/usr/local/var/spool/emailrelay" +* forwarding spooled mail from "/usr/local/var/spool/emailrelay" or "/var/spool/emailrelay" * without listening on any port * with error, warning and information messages sent to stderr * without using syslog @@ -134,9 +143,9 @@ file contains parameters relevant to the SMTP dialogue, and the content file contains the RFC822 headers and body text. The filenames used in the message store have a prefix of "emailrelay", followed -by a process-id and sequence number, followed by "envelope" or "content". The -envelope files then have an additional suffix to implement a simple locking -scheme. +by a process-id, timestamp and sequence number, followed by "envelope" or +"content". The envelope files then have an additional suffix to implement a +simple locking scheme. The envelope suffixes are: * ".new" -- while the envelope is first being written @@ -159,18 +168,16 @@ SMTP issues # Local delivery: - Recipient addresses like "postmaster", "postmaster@localhost" and "postmaster@fqdn" - (where "fqdn" is the host's fully qualified domain name) are treated as the local - postmaster, resulting in local delivery rather than mail forwarding. - - Recipient addresses (other than "postmaster" addresses) with no "at" sign (@) or - ending in "@localhost" will be rejected at the time the message is submitted by the - e-mail front-end. This is in line with E-MailRelay's intended purpose as a simple - mail relay, rather than a fully-fledged routing MTA. + In server mode (ie. with "--postmaster") recipient addresses like "postmaster", + "postmaster@localhost" and "postmaster@fqdn" (where "fqdn" is the host's fully + qualified domain name) are treated as the local postmaster, resulting in local + delivery rather than mail forwarding. Recipient addresses other than "postmaster" + addresses with no "at" sign (@) or ending in "@localhost" will be rejected at the + time the message is submitted by the client. Delivery of mail to a local "postmaster" is a feature of E-MailRelay which is - provided for completeness and for comformance to the SMTP specification. - Note that the E-MailRelay daemon does not actually deliver mail to the postmaster + provided for completeness and for comformance to the SMTP specification. But + note that the E-MailRelay daemon does not actually deliver mail to the postmaster mailbox. All it does is create an envelope and content file in the spool directory with a ".local" suffix. Some external system, such as a shell script run from cron calling "procmail", should be used to process the @@ -192,94 +199,43 @@ SMTP issues re-encode 8-bit messages into 7-bit messages if the next-hop server does not. -Address validation ------------------- -An address supplied to the SMTP commands "RCPT" and "VRFY" is normally accepted -if it contains an at sign, or if it is some sort of local "postmaster" address -(as described above). However, this behaviour can be modified by using an external -verifier program, using the "--verifier" command-line switch. - -The verifier program is passed a command-line containing the full address, the -user-name part of the address, the host-name part, the local host's fully -qualified domain name, the current "MAIL" command's "FROM:" address or the -empty string for the "VRFY" command, the IP address of the client connection, -the authentication mechanism used by the client ("NONE" if trusted), and either -the authentication name or the fourth field from authentication secrets file if -a trusted IP address. - -For valid local mailbox addresses the verifier is expected to write two lines to -the standard output -- the full name associated with the mailbox, and the -canonical mailbox name -- and then exit with a value of zero. For valid non-local -addresses the first line of output should be empty, the second line should be -copied from the first command-line argument, and the exit value should be one. -For invalid addresses the exit value should be greater than one, and anything -written to the standard output is taken as the failure reason. - -(Only the few few thousand characters are read from the verifier's standard -output stream; any more is thrown away.) - -In this simple example script all addresses are accepted as long as they contain -an at sign. This has the effect of removing the normal "postmaster" functionality, -which is in any case not very useful when running in proxy mode: - - #!/bin/sh - # verifier.sh - # An address verifier script for E-MailRelay. - address="${1}" - user="${2}" - host="${3}" - if test "${address}" != "${user}@${host}" ; then exit 2 ; fi - echo "${address}" - echo "${address}" # again - exit 1 # accept - -As another example, the following address verifier script accepts all recipient -addresses by default, but rejects remote addresses if the client has bypassed -authentication by connecting on a trusted IP address: - - #!/bin/sh - # verifier.sh - # An address verifier script for E-MailRelay. - host="$3" - local_domain="$4" - auth_mechanism="$7" - if test "${auth_mechanism}" = "NONE" -a "${host}" != "${local_domain}" - then - echo "cannot relay without authentication" - exit 2 # reject the recipient address - fi - echo "${address}" - echo "${address}" # again - exit 1 # accept the recipient address - Administration interface ------------------------ -If enabled, the server will provide a network interface for performing -administration tasks. This is a simple command-line interface which is -compatible with "telnet". +If enabled with the "--admin" command line switch, the E-MailRelay server will +provide a network interface for performing administration tasks. This is a +simple command-line interface which is compatible with "telnet": -Currently the only supported commands are "flush" and "info". The "flush" command -is used to forward spooled mail to the configured next-hop SMTP server. The -next-hop server address must have been defined on the "emailrelay" command -line at start-up using the "--forward-to" switch; it cannot be specified through -the administration interface. + $ emailrelay --as-server --port 125 --forward-to localhost:25 --admin 10026 + $ telnet localhost 10026 + E-MailRelay> help + E-MailRelay> quit -The "flush" command allows you to run a single process which combines the -functionality of storage daemon and forwarding client. This might be useful -in systems which are low on memory: the memory footprint of "telnet" or -"emailrelay-poke" will be much smaller than "emailrelay --as-client". +The "flush" command is used to get the E-MailRelay server to forward spooled +mail to the next SMTP server, as an alternative to running "emailrelay --as-client" +as a separate process. In proxy mode it is a way of getting the proxy +server to scan the spool-directory for new messages. + +The utility program "emailrelay-poke" can be used to issue the "flush" +command to an E-MailRelay server. For example: + + $ emailrelay --as-server --port 125 --forward-to localhost:25 --admin 10026 + $ emailrelay-poke 10026 + $ echo $? + +To use the "flush" command the next SMTP server address must have been defined +on the "emailrelay" command line at start-up using the "--forward-to" switch. + +Also, the "list" command lists the messages in the spool directory, the "info" +command provides network status information and activity statistics, and the +"notify" command enables asynchronous event notification. Mail processing --------------- -The "--filter" command-line switch allows you to specify a mail processor program -which operates on mail messages as they pass through the E-MailRelay system. The -mail processor program is run as soon as the mail message has been stored in the -spool directory, with the full path of the content file specified on the command -line. - -This can be combined with the "--immediate" (or "--as-proxy") switch to implement -personal mail processing, without replacing or reconfiguring the system's -default MTA. +The "--filter" command-line switch allows you to specify a mail pre-processor +program which operates on mail messages as they pass through the E-MailRelay +system. The mail pre-processor program is run as soon as the mail message has been +stored in the spool directory, with the full path of the content file specified +on the command line. For example, the following command will start a proxy server on port 10025 which processes mail using the specified filter program, and then forwards the mail on @@ -289,13 +245,26 @@ to the system's default MTA (on port 25): --filter ${HOME}/.emailrelay/filter \ --spool-dir ${HOME}/.emailrelay/spool -The mail processor program should terminate with an exit code of zero to indicate -success. An exit code of 100 can be used to cancel all further processing of the -message, and any other non-zero exit code is used to indicate an error. +The pre-processor program should terminate with an exit code of zero to indicate +success, or a value between 1 and 99 to indicate failure. Exit codes between +100 and 107 are reserved for special processing: 100 is used to cancel all +further processing of the message, and 103 has the effect of immediately expiring +any "--poll" timer. -For example, the following mail processor shell script examines the client's -IP address and conditionally dumps the message into "sendmail" (using the -sendmail command-line interface rather than SMTP): +The pre-processor program can edit any part of the message's envelope file or +content file: E-MailRelay remembers nothing about the message while the +pre-processor is running, except the filename. But if the message is deleted +by the pre-processor then E-MailRelay will be upset, unless the exit code +is 100. + +If the pre-processor program creates new messages in the spool directory then +they may not be processed immediately, or they may be completely ignored. To get +E-MailRelay to pick up new messages in the spool directory use the "--poll" +switch, or run "emailrelay --as-client" from within the pre-processor program. + +As an example, the following shell script examines the client's IP address and +conditionally dumps the message into "sendmail" (using the sendmail command-line +interface rather than SMTP): #!/bin/sh # @@ -310,15 +279,92 @@ sendmail command-line interface rather than SMTP): fi exit 0 -An example mail processor script which does simple rot-13 masking of messages is -also provided in the distribution ("share/emailrelay/emailrelay-process.sh"). -This could be used as a template for a more sophisticated message encryption -system. +The first thing this script does is convert the path of the content file which +it is given, into the corresponding envelope file. It then extracts the client's +IP address out of the envelope file using "awk". If this matches then it pipes the +message content into sendmail, deletes the message and exits with a value of 100. +The exit value of 100 tells E-MailRelay to forget the message, and not to +complain about the files disappearing. + +A more complex example script which does rot-13 masking is also provided in the +distribution ("emailrelay-process.sh"). This does some simple MIME encoding, and +could be used as a template for more sophisticated message encryption. + +Some points to note when writing "--filter" programs: +* The standard input and output are not used; the content filename is passed on the command line. +* Programs run with a reduced set of environment variables. +* The E-MailRelay process is completely blocked while the "--filter" program runs. +* E-MailRelay files use CR-LF line terminators, as required by the RFCs. + +Address verification +-------------------- +In proxy mode all addresses supplied to the SMTP commands "RCPT" and "VRFY" are +accepted by E-MailRelay as valid. In server mode (or more accurately when +"--postmater" is in effect) addresses are accepted if they contain an at sign +or if they are some sort of local "postmaster" address, as described in the SMTP +section above. + +However, this behaviour can be modified by using an external verifier program, +using the "--verifier" command-line switch. + +The verifier program is passed a command-line containing: (1) the full address, +(2) the user-name part of the address, (3) the host-name part, (4) the local +host's fully qualified domain name, (5) the current "MAIL" command's "FROM:" +address or the empty string for the "VRFY" command, (6) the IP address of the +client connection, (7) the authentication mechanism used by the client ("NONE" +if trusted), and (8) either the authentication name or the fourth field from +authentication secrets file if a trusted IP address. + +For valid local mailbox addresses the verifier is expected to write two lines to +the standard output -- the full name associated with the mailbox, and the +canonical mailbox name -- and then exit with a value of zero. For valid non-local +addresses the first line of output should be empty, the second line should be +copied from the first command-line argument, and the exit value should be one. +For invalid addresses the exit value should be greater than one, and anything +written to the standard output is taken as the failure reason. (Only the few +few thousand characters are read from the verifier's standard output stream; +any more is thrown away.) + +In this simple example script all addresses are accepted as long as they contain +an at sign. This is equivalent to removing the "--postmaster" command-line +switch: + + #!/bin/sh + # verifier.sh + address="${1}" + user="${2}" + host="${3}" + if test "${address}" != "${user}@${host}" ; then exit 2 ; fi + echo "${address}" + echo "${address}" # again + exit 1 # accept + +As another example, this verifier script accepts all recipient addresses by +default, but rejects remote addresses if the client has bypassed authentication +by connecting on a trusted IP address: + + #!/bin/sh + # verifier.sh + host="$3" + local_domain="$4" + auth_mechanism="$7" + if test "${auth_mechanism}" = "NONE" -a "${host}" != "${local_domain}" + then + echo "cannot relay without authentication" + exit 2 # reject the recipient address + fi + echo "${address}" + echo "${address}" # again + exit 1 # accept the recipient address + +If this verifier script is used with a suitable "--server-auth" file then it can +be used to prevent open relay without restricting authenticated clients. Security issues --------------- -A major security concern is the use of an external mail processor (using the -"--filter" switch), and so the following precautions are taken: +A significant security concern is the use of external mail pre-processors and +address verifiers (using the "--filter" and "--verifier" switches), and so the +following precautions are taken: # effective userid @@ -332,14 +378,14 @@ A major security concern is the use of an external mail processor (using the # execution environment - The mail processor runs with an almost empty set of environment variables ("PATH" - and "IFS"), and with no open file descriptors other than "stdin"/"stdout"/"stderr" + The mail pre-processor runs with an almost empty set of environment variables + ("PATH" and "IFS"), and with no open file descriptors other than "stdin"/"stdout"/"stderr" open onto "/dev/null". # configuration - The mail processor filename has to be configured using a full path, so there is - no dependence on the current working directory or the PATH environment variable. + The mail pre-processor filename has to be configured using a full path, so there + is no dependence on the current working directory or the PATH environment variable. Security issues which relate to the SMTP protocol itself are beyond the scope of this document, but RFC2821 makes the following observation: "SMTP mail is @@ -355,7 +401,7 @@ Some other points are: * Strings are dynamically allocated, so buffer overflow/truncation issues are avoided. * By default connections to the SMTP and administrative ports will be rejected if they come from remote machines. * No configuration parameters can be changed through the administrative interface. -* No exec(), system() or popen() calls are used other than execve() to spawn the mail processor and address verifier. +* No exec(), system() or popen() calls are used other than execve() to spawn the mail pre-processor and/or address verifier. * The submit utility is installed as set-group-id with group ownership of "daemon". Authentication @@ -375,16 +421,27 @@ fields: "mechanism", "client-or-server", "userid", and "secret". The "mechanism" field must be "LOGIN" or "CRAM-MD5" (case-insensitive); the "client-or-server" field must be "client" or "server"; the "userid" field is xtext-encoded user identifier; and the "secret" field is the xtext-encoded "LOGIN" password or -"CRAM-MD5" key. The "xtext" encoding scheme is defined in RFC1891. The -"CRAM-MD5" keys can be generated using the "emailrelay-passwd" utility. +"CRAM-MD5" key. -A client-side secrets file should contain at least one "LOGIN client" or -"CRAM-MD5 client" entry. A server-side secrets file should contain zero or -more "LOGIN server" or "CRAM-MD5 server" entries. The same secrets file may -be specified for both "--auth-client" and "--auth-server" switches. +The "xtext" encoding scheme is defined properly in RFC1891, but basically it +says that non alphanumeric characters should be represented in hexadecimal as +"+XX". -For example, the following secrets file defines "jsmith" as the username to be -used when E-MailRelay authenticates with a next-hop server, and defines two +The client-side secrets file specified with "--auth-client" is used when +E-MailRelay talks to a remove server. The file should contain at least one +"LOGIN client" or "CRAM-MD5 client" entry. + +A server-side secrets file specified with "--auth-server" is used when a remote +client tries to authenticate with E-MailRelay. The file should normally contain +several "LOGIN server" or "CRAM-MD5 server" entries. + +The same secrets file may be specified for both "--auth-client" and +"--auth-server" switches. + +The "CRAM-MD5" keys can be generated using the "emailrelay-passwd" utility. + +As an example, the following secrets file defines "jsmith" as the username to be +used when E-MailRelay authenticates with a remote SMTP server, and defines two usernames ("user1" and "user2") which can be used by clients when they authenticate with the E-MailRelay server: @@ -409,18 +466,12 @@ and then send them unencypted over a network. This is a bad thing. You should at least make sure that the secrets file has tight permissions, and that the passwords in it are not also used for anything important (such as root access). -On the server side authentication is advertised in the response to the SMTP -"EHLO" command if the "--auth-server" command-line switch is used, and -authentication by the client is mandatory unless the client's IP address is -configured as a trusted address. If the client does authenticate then -the authenticated user-id is stored with the message and then passed on to a -next-hop server using an "AUTH=userid" parameter on the SMTP "MAIL FROM" -command. If the client does not to authenticate then the submitted messages -will be forwarded using "AUTH=<>" on the "MAIL FROM" command. Note that any -"AUTH=userid" information on incoming submitted messages is ignored and -discarded: it is the authorised userid from the AUTH command which is -propagated, not the userid from the incoming "MAIL FROM" command's "AUTH=" -parameter. +On the server side authentication is advertised by E-MailRealy in the response +to the SMTP "EHLO" command if the "--auth-server" command-line switch is used. +Authentication by the client is mandatory unless the client's IP address is +configured as a trusted address. If the client does authenticate then the +authenticated user-id is stored with the message and then passed on to the next +SMTP server using an "AUTH=userid" parameter on the SMTP "MAIL FROM" command. Trusted IP addresses are configured with lines in the secrets file having "NONE" in the first field, "server" in the second field, a wildcarded IP address in @@ -428,11 +479,21 @@ the third field, and an arbitrary keyword in the fourth field. The keyword is passed to any external address verifier program specified by the "--verifier" command-line switch. -On the client side authentication is performed when the client has connected to +For example this secrets file allows any client connecting from the 192.168.0.0 +domain to connect without authentication desipte the "--auth-server" switch: + + # + # emailrelay secrets file + # + NONE server 192.168.0.* localdomain + LOGIN server user1 secret + LOGIN server user2 e+3Dmc2 + +On the client side authentication is performed when E-MailRelay has connected to a server which supports the AUTH extension with the LOGIN or CRAM-MD5 mechanism. If client authentication is enabled (with the "--auth-client" switch) but the server does not support the AUTH extension, or does not support the LOGIN or -CRAM-MD5 mechanism, then the client will fail the first message and terminate +CRAM-MD5 mechanism, then E-MailRelay will fail the first message and terminate with an error message. Note that some ISPs require separate POP/IMAP authentication before SMTP access @@ -449,21 +510,39 @@ Application notes set sendmail="/usr/local/libexec/emailrelay-submit" + or + + set sendmail="/usr/sbin/emailrelay-submit" + + This puts the messages in the E-MailRelay spool-directory, but note that in + proxy mode they will be ignored unless you use "--poll". Or you could use + "--admin" plus "flush"/"emailrelay-poke". + # *Spam Assassin* [http://spamassassin.taint.org] - The E-MailRelay server can use Spam Assasin to mark potential spam by having + The E-MailRelay server can use Spam Assassin to mark potential spam by having a small shell script which calls spamassassin's "spamc" program installed - as the E-MailRelay mail processor (using the "--filter" command-line switch). + as the E-MailRelay mail pre-processor (using the "--filter" command-line switch). - The shell script would look something like this: + Your "--filter" shell script would look something like this: #!/bin/sh - tmp="`basename $0`.$$.tmp" - cat ${1} | spamc > ${tmp} && mv ${tmp} ${1} + tmp="/tmp/`basename $0`.$$.tmp" + pre="dos2unix" + post="unix2dos" + ${pre} < ${1} | spamc > ${tmp} + if test $? -eq 0 ; then ${post} < ${tmp} > ${1} ; fi + rm -f ${tmp} 2>/dev/null + exit 0 + + This just pipes the content file into "spamc", using "dos2unix" to remove + carriage-returns. The output is saved in a temporary file, and then put back + into the content file using "unix2dos" to restore the carriage-returns. Files and directories --------------------- -By default "make install" installs files in the following locations: +Following a normal build from source, a "make install" puts files in the +following locations: * /usr/local/libexec/emailrelay * /usr/local/libexec/emailrelay-deliver.sh * /usr/local/libexec/emailrelay-notify.sh @@ -499,7 +578,8 @@ This directory structure is constrained by the GNU/"autoconf" conventions rather than the Filesystem Hierarchy Standard (FHS). To force FHS compliance you can use the "--enable-fhs" switch when running -"configure". This results in the following file locations: +"configure", as is done for the RPMs. This results in the following file +locations: * /etc/init.d/emailrelay * /usr/lib/emailrelay/emailrelay-poke * /usr/sbin/emailrelay @@ -558,15 +638,15 @@ However this will not affect the default spool directory path built into the scripts and executables; the spool directory path will have to be explicitly defined at run-time. -For example, building with "configure --enable-fhs ; make ; make install DESTDIR=/root" -would create a spool directory "/root/var/spool/emailrelay", but the server -run as "/root/usr/sbin/emailrelay --as-server" would expect a spool directory -of "/var/spool/emailrelay". This could be fixed by either adding -"--spool-dir /root/var/spool/emailrelay" to the server command-line, or by -creating the "/var/spool/emailrelay" directory manually. +For example, building with "configure --enable-fhs ; make ; make install DESTDIR=/export" +would create a spool directory "/export/var/spool/emailrelay", but the server +run as "/export/usr/sbin/emailrelay --as-server" would expect a spool directory of +"/var/spool/emailrelay". The fix is to add "--spool-dir /export/var/spool/emailrelay" +to the emailrelay command-line. + +The "emailrelay" start/stop script in "init.d" creates a pid file in "/var/run" +if the directory exists, or in "/tmp" otherwise. -The "emailrelay" script in "init.d" creates a pid file in "/var/run" if the -directory exists, or in "/tmp" otherwise. diff --git a/doc/userguide.txt b/doc/userguide.txt index 08148b9..ceed015 100644 --- a/doc/userguide.txt +++ b/doc/userguide.txt @@ -3,112 +3,114 @@ E-MailRelay User Guide What is it? ----------- -E-MailRelay is a simple store-and-forward e-mail transfer agent. It's a program -which runs in the background and accepts e-mail from front-ends (KMail, Outlook, -Netscape etc.), stores the messages on the hard disk, and when next connected -to the Internet forwards them to a next SMTP server for onward delivery. +E-MailRelay is a simple store-and-forward message transfer agent and proxy server. +It runs on Unix-like operating systems (including Linux), and on Windows. -The E-MailRelay program ("emailrelay") can run in two main modes: a storage -daemon, or a forwarding agent. As a storage daemon it waits for connections -from your e-mail front-end and stores the mail which it receives in a spool -directory. As a forwarding agent it pulls messages out of the spool directory -and passes them on to a remote server -- typically an ISP mail server. +When used as proxy server the E-MailRelay program ("emailrelay") runs in the +background and accepts e-mail from front-ends (KMail, Outlook etc.) or from +the outside world, using the SMTP protocol. As soon as an e-mail message is +received it is forwarded on to the next SMTP server for onward delivery. This +becomes more useful when you add in your own message processing: as each +message is received it can be passed one of your programs for editing, +filtering, encypting etc. -E-MailRelay uses the Simple Message Transfer Protocol (SMTP). When running as a -storage daemon it acts as an SMTP server, and when running as a forwarding -agent it acts as an SMTP client. - -The program can also run as a proxy server. In this mode e-mails submitted at -the server interface are passed on to the next server immediately, without -spooling. This can be useful when combined with mail pre-processing to do things -like encryption, message archiving, addition of digital signatures, etc. - -E-MailRelay runs on GNU/Linux, FreeBSD, Solaris and Windows. +When used as a store-and-forward transfer agent E-MailRelay runs in two modes: +the storage daemon part, and the forwarding agent. The storage daemon +waits for incoming mail and stores anything it receives in a spool directory. +As a forwarding agent E-MailRelay pulls messages out of the spool directory +and passes them on to a remote server -- perhaps your ISP mail server. What it's not ------------- -With a dial-up connection E-MailRelay does not get involved in processing -incoming e-mail messages; it only operates on outgoing messages. Incoming e-mail -messages will probably be retrieved from your ISP by your e-mail front-end -program, using the POP3 or IMAP protocols. +E-MailRelay is not a routing MTA. It forwards e-mail to a pre-configured SMTP +server, regardless of any message addressing or DNS redirects. -E-MailRelay is not a routing MTA. It is designed to be used in situations where -all outgoing e-mail message go out over the dial-up connection, so it is not an -appropriate choice if you send e-mail to other people who use the same machine -or to people who are on the same local area network. +E-MailRelay does not do POP3 or IMAP protocols. Many ISPs accept outgoing e-mail +using SMTP, but deliver mail to you using POP3 or IMAP. In this case E-MailRelay +does not get involved in processing incoming e-mail messages; it only operates +on outgoing messages. Incoming e-mail messages will probably be retrieved from +your ISP direcly by your e-mail front-end program. -Also be careful with programs like "fetchmail" which will fetch incoming mail -using POP3 or IMAP, but then use a local SMTP server to deliver to local -mailboxes. E-MailRelay does not act as a delivery agent, so if your local SMTP -server is E-MailRelay then your incoming e-mail will bounce back out. +E-MailRelay is not a delivery agent. Some programs like "fetchmail" send +locally-addressed e-mail to the local SMTP server in order to deliver them to +local mailboxes. E-MailRelay will not normally do this. Why use it? ----------- -The motivation for developing E-MailRelay is that e-mail store-and-forward -using SMTP is conceptually a very simple thing, but most popular MTAs are -complex. E-MailRelay just stores messages and then forwards them on to your -ISP, whereas a fully-featured MTA does clever things with address re-writing, -message routing, local delivery, loop detection, fancy DNS lookups etc. +E-MailRelay is a simple tool that does SMTP. For simple tasks it is likely +to be easier to understand and configure than a more general purpose MTA. -In particular the configuration of some popular MTAs is notoriously complex -and arcane, whereas the only thing the E-MailRelay system needs is the name of -your ISP's mail server. +E-MailRelay is designed to be policy-free, so that you can implement your own +policies for message retries, bounces, local mailbox delivery, spam filtering +etc. through external scripts. -Because E-MailRelay can act as a proxy server, it may be useful handling -incoming mail from a permanent Internet connection. In this configuration the -pre-processing feature could be used for spam filtering or virus checking. - -For outgoing mail pre-processing could be used to compensate for features, such -as encryption, which are not available in your e-mail client program. Or it -could be used to enforce formatting or legal requirements for all outgoing mail. +Typical applications of E-MailRelay include: +* spam filtering and virus checking incoming mail +* adding digital signatures or legal disclaimers to outgoing mail +* doing store-and-forward for outgoing mail across a dial-up internet connection +* adding authentication where the existing infrastructure does not support it +* simple proxying on a firewall host or DMZ Running E-MailRelay ------------------- -To run E-MailRelay as a storage daemon use the command: +To run the program as a proxy use the "--as-proxy" command-line switch, followed by the +address of the target SMTP server. If you want to edit or filter e-mail as it passes +through the proxy then specify your pre-processor program with the "--filter" switch. +You can optionally change the listening port number using "--port" and the +spool directory using "--spool-dir". - emailrelay --as-server +For example, to start up a local proxy which passes messages to some "addsig" script +and then forwards them to an MTA running on "smarthost", use a command like this: -To run E-MailRelay as a forwarding agent (once connected to the Internet), use -a command like this: + emailrelay --as-proxy smarthost:smtp --filter $HOME/bin/addsig --spooldir $HOME/tmp - emailrelay --as-client mail.myisp.net:smtp +To use E-MailRelay as a store-and-forward MTA use the "--as-server" switch +to start the storage daemon in the background. And then trigger delivery of +spooled messages by running emailrelay with the "--as-client" switch, followed +by the address of the target SMTP server. -where "mail.myisp.net" is replaced with the name of your ISP's SMTP server. +For example, to start a storage daemon listening on port 10025 use a command +like this: -To run E-MailRelay as a personal proxy server (on port 10025) to the system's -default MTA use a command something like this: + emailrelay --as-server --port 10025 --spooldir $HOME/tmp - emailrelay --as-proxy localhost:smtp --no-syslog --port 10025 --filter ${HOME}/.emailrelay/mailfilter --spool-dir ${HOME}/.emailrelay/spool +And then to forward the spooled mail to "smarthost" run somthing like this: -where "mailfilter" is a program which you have written to do the appropriate -mail processing. + emailrelay --as-client smarthost:smtp --spooldir $HOME/tmp + +By default E-MailRelay will reject connections from remote machines. To +allow connections from anywhere use the "--remote-clients" switch. For more information on the command-line options refer to the reference guide or run: - emailrelay --help + emailrelay --help --verbose Starting the daemon at boot-time -------------------------------- -The standard installation of E-MailRelay (using "make install") puts most of -the files into the right places, but it does not set things up so that the -daemon starts at boot time, or that e-mail gets forwarded automatically when -you connect to the Internet. You have to do those bits yourself because of the -differences between the various operating systems and distributions. +The standard installation of E-MailRelay (using "make install") puts most of the +files into the right places, but it does not set things up so that the daemon +starts at boot time. You have to do that yourself because of the differences +between the various operating systems and distributions. -Many systems, including the most popular GNU/Linux distributions, use the -System-V mechanism for starting daemons at boot time. The directory -"/etc/init.d" (or "/sbin/init.d") contains a start/stop script for each daemon -process, and then symbolic links in the "rc.d" subdirectories control which -scripts are run when entering or leaving a particular run-level (). The -links point back into the start/stop script in the parent directory, using a -"S" prefix for the starting link, and a "K" prefix for the stopping link. The -numeric part of the link name determines the order in which the links are -called. +Many systems provide GUI programs and command-line tools to make the necessary +links into the boot system: "ksysv" (KDE), "redhat-config-services", "insserv" +(Suse), "chkconfig" (Redhat), "install_initd" (LSB) are examples. -If you cannot use a GUI front-end as provided by GNOME and KDE, or a -command-line utility like "insserv", "chkconfig" or "/usr/lib/lsb/install_initd", -then you can follow the steps below to set up the necessary symbolic links. +If you do not have a suitable configuration tool you can set up the links +manually as described below. + +The "System-V" boot system has a base directory "/etc/init.d" (or "/sbin/init.d") +containing a start/stop script for each daemon process, and then symbolic links +in the "rc.d" subdirectories control which scripts are run when entering or +leaving a particular run-level (). The links point back into the start/stop +script in the parent directory, using a "S" prefix for the starting link, and a +"K" prefix for the stopping link. The numeric part of the link name determines +the order in which the links are called. + +So the goal is to set up symbolic links to the "emailrelay" start/stop script +(not the binary) which "make install" will have put in "/etc/init.d" or +"/usr/local/libexec". Before you start you will need to know where your "init.d" directory can be found and what your default run level is: @@ -117,8 +119,8 @@ found and what your default run level is: $ runlevel | awk '{print $2}' Assuming these are "/etc/init.d" and "5" you should (as root) copy the -E-MailRelay start/stop script into "/etc/init.d" (if it is not already -installed there): +E-MailRelay start/stop script into "/etc/init.d" (if it is not already installed +there): $ cp /usr/local/libexec/emailrelay /etc/init.d @@ -143,6 +145,10 @@ daemons compete for the standard SMTP listening port): Triggering onward delivery -------------------------- +If you are using E-MailRelay to store and forward e-mail over a dial-up link to +the internet, then you will need to set things up so that the dialler tells +E-MailRelay when to start forwarding. + This section assumes that you are using "pppd" to establish your dial-up Internet connection. (Note that KDE's "kppp" and Red Hat's "rp3" are graphical front-ends to the underlying "pppd" daemon.) @@ -162,47 +168,52 @@ If you find "sendmail -q" then it should be sufficient to replace it with this: where you substitute your ISP's SMTP server address for . Or if your "ip-up" calls out to "ip-up.local" then create a two-line -"ip-up.local" script like this: +"/etc/ppp/ip-up.local" script like this: - $ cd /etc/ppp - $ cat << EOF > ip-up.local #!/bin/sh exec /usr/local/sbin/emailrelay --as-client :smtp - EOF - $ chmod +x ip-up.local + +If you create "ip-up.local" yourself remember to make it executable. Notification of failed e-mails ------------------------------ If e-mail messages become corrupted or inaccessible within the spool directory -then they will get failed within the E-MailRelay system. In order to get failed -e-mails to 'bounce' back into your in-tray you will need to run the -"emailrelay-notify.sh" script (as "root") periodically. Note that this script -requires that you have "procmail" installed on your system to act as a -"delivery agent". +then they will get failed within the E-MailRelay system, with the envelope files +in the spool directory ending up with a ".bad" suffix. -There are not many ways in which an e-mail can fail within the E-MailRelay -system. If everything is set up correctly then perhaps the most likely case is -that you have run out of disk space. If you are not too worried about getting -failed mail to bounce, or if you do not have a suitable delivery agent, then -a simple check in your ".profile" script for "*.bad" files in the spool -directory may be sufficient: +If you are not too worried about getting failed mail to bounce, or if you do not +have a suitable delivery agent, then a simple check in your ".profile" script +for "*.bad" files in the spool directory may be sufficient: - $ cat <> ~/.profile - if test -f /var/spool/emailrelay/*.envelope.bad ; then echo Failed mail >&2 ; fi - EOF + if test -f /var/spool/emailrelay/*.envelope.bad + then + echo Failed mail >&2 + fi -If you want failed e-mails to be retried a few times before bouncing back into -your in-tray, you can run the "emailrelay-resubmit.sh" script. This simply -removes the ".bad" suffix from files in the spool directory, as long as they -have not been retried too many times already. +This will warn you that something failed, but you will have to look at the +failure reason written into the envelope files, and at the log files, to +find out what went wrong. + +Or you can get failed e-mails to 'bounce' back into your in-tray by running the +"emailrelay-notify.sh" script as "root" periodically. But note that this is +only approporiate if you are using E-MailRelay for outgoing traffic, and it +assumes that you have "procmail" installed on your system to act as a "delivery +agent". + +If you want failed e-mails to be retried a few times you can run the +"emailrelay-resubmit.sh" script periodically. This simply removes the ".bad" +suffix from files in the spool directory, as long as they have not been retried +too many times already. Logging ------- -The E-MailRelay program uses the "syslog" system to issue warnings and error messages, -using the "LOG_MAIL" facility. The "syslog" system is configured through the -"/etc/syslog.conf" file (try "man syslog.conf"), and in most cases you will find -that "LOG_MAIL" warnings and errors are directed to an appropriate log file (perhaps -"/var/log/messages"). +If the "--log" switch is used then E-MailRelay program issues warnings and error +messages to the "syslog" system using the "LOG_MAIL" facility. Under Windows NT +it writes to the "Application" event log. + +The "syslog" system is configured through the "/etc/syslog.conf" file (try +"man syslog.conf"), and in most cases you will find that "LOG_MAIL" warnings and +errors are directed to an appropriate log file (perhaps "/var/log/messages"). To get a file which will accumulate all E-MailRelay log messages (and messages from all other mail programs), add a line like this to "/etc/syslog.conf": @@ -297,10 +308,10 @@ from cygwin/bash on Win98 keeps stderr open (albeit with dreadful performance), whereas the standard command prompt does not. If necessary the environment variable "GLOGOUTPUT_FILE" can be defined as the name of a log file. -Preventing public mail relay ----------------------------- +Preventing open mail relay +-------------------------- If you are running E-MailRelay as a server with a permanent connection to the -Internet it is important to prevent public mail relay. By default public mail +Internet it is important to prevent open mail relay. By default public mail relaying is not possible because E-MailRelay does not accept IP connections from remote clients. However, if the "--remote-clients" switch is used then you need to be more careful. One option is to require all clients to authenticate, by @@ -312,38 +323,11 @@ mechanism of "NONE". Refer to the reference guide for more information. Taking it one stage further, you may want to allow clients to connect from any IP address without authentication, but only allow them to send mail to local users. You can do this by requiring authentication with the "--server-auth" -switch but then exempting all clients from authentication with a "NONE server *.*.*.* x" +switch but then exempt all clients from authentication with a "NONE server *.*.*.* x" line in the secrets file. To complete the solution you must have an address verifier script ("--verifier") which rejects remote addresses if the client has not authenticated. Again, refer to the reference guide for further details. -Glossary --------- - -# ISP - Internet Service Provider. - -# MTA - Message Transfer Agent. Something which accepts incoming e-mail messages - and passes them on either to a local user, or to another MTA. A sophisticated - MTA program, which is widely used on the Internet, is "sendmail". - -# SMTP - Simple Message Transfer Protocol. A set of rules which dictate how - e-mail messages are passed from one part of the e-mail system to the next. - The protocol rules are set out in the document "RFC2821". - -# POP3 - Post Office Protocol 3. A protocol for fetching incoming e-mail messages. - Many e-mail front-ends will fetch messages directly from an ISP using the POP - protocol, or a program like "fetchmail" may do it on their behalf. - -# IMAP - Internet Message Access Protocol. A newer alternative to POP3. - -# PPP - Point to Point Protocol. A low-level protocol used in dial-up connections - to an ISP. Usually implemented by the "pppd" program on GNU/Linux. diff --git a/doc/windows.txt b/doc/windows.txt index f1870f9..558902d 100644 --- a/doc/windows.txt +++ b/doc/windows.txt @@ -5,7 +5,8 @@ Introduction ------------ E-MailRelay was originally developed on Linux and so most of the documentation relates to Unix-like operating systems rather than Microsoft Windows. This -document provides some help on Windows installation and setup. +document provides some help on installing and setting up E-MailRelay as a +store-and-forward MTA on Windows. Quick start ------------ @@ -18,7 +19,6 @@ In summary, the Windows installation process is as follows: * Create a spool directory under "\spool", eg. "c:\win98\spool\emailrelay". * Configure your e-mail client (eg. Outlook) to use SMTP on the local machine for outgoing e-mail. * Run the forwarding client from the taskbar/desktop shortcut once connected to the Internet. -* Optionally register the server as a COM component using the "-regserver" command-line switch. These steps are explained in more detail below. @@ -105,4 +105,5 @@ taskbar, desktop or "Start->Programs->StartUp" shortcuts. + Copyright (C) 2001-2003 Graeme Walker . All rights reserved. diff --git a/emailrelay.spec b/emailrelay.spec index 93a3e41..867e461 100644 --- a/emailrelay.spec +++ b/emailrelay.spec @@ -1,25 +1,27 @@ Summary: Simple e-mail message transfer agent using SMTP Name: emailrelay -Version: 1.0.2 +Version: 1.1 Release: 1 Copyright: GPL Group: System Environment/Daemons -Source: http://emailrelay.sourceforge.net/.../emailrelay-src-1.0.2.tar.gz +Source: http://emailrelay.sourceforge.net/.../emailrelay-src-1.1.tar.gz BuildRoot: /tmp/emailrelay-install %define prefix /usr %description -E-MailRelay is a simple SMTP store-and-forward message transfer agent (MTA). -It runs as an SMTP server, storing e-mail in a local spool directory, and -then forwarding the stored messages to the next SMTP server on request. -It can also run as a proxy server, forwarding (and optionally pre-processing) -e-mail as soon as it is received. It does not do any message routing, other -than to a local postmaster. Because of this functional simplicity it is -extremely easy to configure, typically only requiring the address of the -next-hop SMTP server to be put on the command line. +E-MailRelay is a simple SMTP proxy and store-and-forward message transfer agent +(MTA). When running as a proxy all e-mail messages can be passed through a +user-defined program, such as a spam filter, which can drop, re-address or edit +messages as they pass through. When running as a store-and-forward MTA incoming +messages are stored in a local spool directory, and then forwarded to the next +SMTP server on request. -C++ source code is available for Linux, FreeBSD (etc) and Windows. +Because of its functional simplicity E-MailRelay is easy to configure, typically +only requiring the address of the target SMTP server to be put on the command +line. + +C++ source code is available for Linux, FreeBSD, MacOS X etc, and Windows. Distribution is under the GNU General Public License. %prep @@ -30,13 +32,13 @@ Distribution is under the GNU General Public License. make HAVE_DOXYGEN=no HAVE_MAN2HTML=no %install -make install destdir=$RPM_BUILD_ROOT DESTDIR=$RPM_BUILD_ROOT HAVE_DOXYGEN=no HAVE_MAN2HTML=no +make install-strip destdir=$RPM_BUILD_ROOT DESTDIR=$RPM_BUILD_ROOT HAVE_DOXYGEN=no HAVE_MAN2HTML=no %post -test -f /usr/lib/lsb/install_initd && cd /etc/init.d && /usr/lib/lsb/install_initd emailrelay +test -f /usr/lib/lsb/install_initd && cd /etc/init.d && /usr/lib/lsb/install_initd emailrelay || true %preun -test $1 -eq 0 && test -f /usr/lib/lsb/remove_initd && cd /etc/init.d && /usr/lib/lsb/remove_initd emailrelay +test $1 -eq 0 && test -f /usr/lib/lsb/remove_initd && cd /etc/init.d && /usr/lib/lsb/remove_initd emailrelay || true %clean rm -rf $RPM_BUILD_ROOT @@ -75,6 +77,6 @@ rm -rf $RPM_BUILD_ROOT %changelog -* Wed Jul 3 2003 Graeme Walker +* Wed Jul 3 2002 Graeme Walker - Initial version. diff --git a/lib/Makefile.am b/lib/Makefile.am index bdf914f..d2206a4 100644 --- a/lib/Makefile.am +++ b/lib/Makefile.am @@ -1,19 +1,20 @@ -# -# Copyright (C) 2001-2003 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. -# -SUBDIRS = gcc2.95 msvc6.0 +# +## Copyright (C) 2001-2003 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. +## +# +SUBDIRS = gcc2.95 msvc6.0 sunpro5 diff --git a/lib/Makefile.in b/lib/Makefile.in index 3ed3582..d749002 100644 --- a/lib/Makefile.in +++ b/lib/Makefile.in @@ -90,25 +90,9 @@ e_sbindir = @e_sbindir@ e_spooldir = @e_spooldir@ install_sh = @install_sh@ -# -# Copyright (C) 2001-2003 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. -# -SUBDIRS = gcc2.95 msvc6.0 +# +# +SUBDIRS = gcc2.95 msvc6.0 sunpro5 subdir = lib mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h diff --git a/lib/gcc2.95/Makefile.am b/lib/gcc2.95/Makefile.am index 38069ee..d3492f8 100644 --- a/lib/gcc2.95/Makefile.am +++ b/lib/gcc2.95/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# EXTRA_DIST = iostream limits sstream xlocale diff --git a/lib/gcc2.95/Makefile.in b/lib/gcc2.95/Makefile.in index dafd393..6b13ca8 100644 --- a/lib/gcc2.95/Makefile.in +++ b/lib/gcc2.95/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ diff --git a/lib/gcc2.95/iostream b/lib/gcc2.95/iostream index ba46864..e7d7a94 100644 --- a/lib/gcc2.95/iostream +++ b/lib/gcc2.95/iostream @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -30,7 +30,7 @@ namespace std { typedef ::ios ios_base ; -} ; +} #endif diff --git a/lib/gcc2.95/limits b/lib/gcc2.95/limits index 0b22578..abf730c 100644 --- a/lib/gcc2.95/limits +++ b/lib/gcc2.95/limits @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -27,7 +27,7 @@ namespace std { #include -} ; +} #endif diff --git a/lib/gcc2.95/sstream b/lib/gcc2.95/sstream index 478e71c..9adb3d0 100644 --- a/lib/gcc2.95/sstream +++ b/lib/gcc2.95/sstream @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -39,7 +39,7 @@ namespace std std::string str() const ; } ; typedef ostringstream stringstream ; -} ; +} inline std::ostringstream::ostringstream() diff --git a/lib/gcc2.95/xlocale b/lib/gcc2.95/xlocale index ed29464..7cc7c2a 100644 --- a/lib/gcc2.95/xlocale +++ b/lib/gcc2.95/xlocale @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or diff --git a/lib/msvc6.0/Makefile.am b/lib/msvc6.0/Makefile.am index fd13591..9b91936 100644 --- a/lib/msvc6.0/Makefile.am +++ b/lib/msvc6.0/Makefile.am @@ -1,20 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# + +EXTRA_DIST = cstdio cstdlib cstring ctime cmath -EXTRA_DIST = cstdio cstdlib cstring ctime diff --git a/lib/msvc6.0/Makefile.in b/lib/msvc6.0/Makefile.in index 8e3df15..1670a24 100644 --- a/lib/msvc6.0/Makefile.in +++ b/lib/msvc6.0/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ @@ -109,7 +93,7 @@ e_sbindir = @e_sbindir@ e_spooldir = @e_spooldir@ install_sh = @install_sh@ -EXTRA_DIST = cstdio cstdlib cstring ctime +EXTRA_DIST = cstdio cstdlib cstring ctime cmath subdir = lib/msvc6.0 mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_HEADER = $(top_builddir)/config.h diff --git a/lib/msvc6.0/cmath b/lib/msvc6.0/cmath new file mode 100644 index 0000000..914bda5 --- /dev/null +++ b/lib/msvc6.0/cmath @@ -0,0 +1,43 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// cmath +// + +#ifndef G_PORT_CMATH_H +#define G_PORT_CMATH_H + +#include + +namespace std +{ + using ::sin ; + using ::cos ; + using ::tan ; + using ::asin ; + using ::acos ; + using ::atan ; + using ::sqrt ; + using ::log ; + using ::log10 ; +} + +#endif + diff --git a/lib/msvc6.0/cstdio b/lib/msvc6.0/cstdio index 9e3ddda..7dc6024 100644 --- a/lib/msvc6.0/cstdio +++ b/lib/msvc6.0/cstdio @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -31,7 +31,7 @@ namespace std using ::rename ; using ::sscanf ; using ::sprintf ; -} ; +} #endif diff --git a/lib/msvc6.0/cstdlib b/lib/msvc6.0/cstdlib index d427799..014ee05 100644 --- a/lib/msvc6.0/cstdlib +++ b/lib/msvc6.0/cstdlib @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -32,6 +32,6 @@ namespace std using ::getenv ; using ::free ; using ::malloc ; -} ; +} #endif diff --git a/lib/msvc6.0/cstring b/lib/msvc6.0/cstring index 0bde778..6c73cef 100644 --- a/lib/msvc6.0/cstring +++ b/lib/msvc6.0/cstring @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -38,7 +38,7 @@ namespace std using ::strstr ; using ::strspn ; using ::strcspn ; -} ; +} #endif diff --git a/lib/msvc6.0/ctime b/lib/msvc6.0/ctime index 60e2246..77c7352 100644 --- a/lib/msvc6.0/ctime +++ b/lib/msvc6.0/ctime @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2001-2003 Graeme Walker // // This program is free software; you can redistribute it and/or @@ -35,7 +35,7 @@ namespace std using ::mktime ; using ::_tzset ; using ::strftime ; -} ; +} #endif diff --git a/lib/sunpro5/Makefile.am b/lib/sunpro5/Makefile.am new file mode 100644 index 0000000..629b17d --- /dev/null +++ b/lib/sunpro5/Makefile.am @@ -0,0 +1,20 @@ +# +## Copyright (C) 2001-2003 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. +## +# +EXTRA_DIST = xar diff --git a/lib/sunpro5/Makefile.in b/lib/sunpro5/Makefile.in new file mode 100644 index 0000000..ff3758c --- /dev/null +++ b/lib/sunpro5/Makefile.in @@ -0,0 +1,216 @@ +# Makefile.in generated by automake 1.6.3 from Makefile.am. +# @configure_input@ + +# Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 +# Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +SHELL = @SHELL@ + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +prefix = @prefix@ +exec_prefix = @exec_prefix@ + +bindir = @bindir@ +sbindir = @sbindir@ +libexecdir = @libexecdir@ +datadir = @datadir@ +sysconfdir = @sysconfdir@ +sharedstatedir = @sharedstatedir@ +localstatedir = @localstatedir@ +libdir = @libdir@ +infodir = @infodir@ +mandir = @mandir@ +includedir = @includedir@ +oldincludedir = /usr/include +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = ../.. + +ACLOCAL = @ACLOCAL@ +AUTOCONF = @AUTOCONF@ +AUTOMAKE = @AUTOMAKE@ +AUTOHEADER = @AUTOHEADER@ + +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_DATA = @INSTALL_DATA@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_HEADER = $(INSTALL_DATA) +transform = @program_transform_name@ +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : + +EXEEXT = @EXEEXT@ +OBJEXT = @OBJEXT@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +AMTAR = @AMTAR@ +AR = @AR@ +AWK = @AWK@ +CC = @CC@ +COMPILER_VERSION = @COMPILER_VERSION@ +CXX = @CXX@ +DEPDIR = @DEPDIR@ +GZIP = @GZIP@ +HAVE_DOXYGEN = @HAVE_DOXYGEN@ +HAVE_MAN2HTML = @HAVE_MAN2HTML@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +MAKE = @MAKE@ +PACKAGE = @PACKAGE@ +RANLIB = @RANLIB@ +STRIP = @STRIP@ +VERSION = @VERSION@ +am__include = @am__include@ +am__quote = @am__quote@ +e_docdir = @e_docdir@ +e_examplesdir = @e_examplesdir@ +e_initdir = @e_initdir@ +e_libexecdir = @e_libexecdir@ +e_man1dir = @e_man1dir@ +e_sbindir = @e_sbindir@ +e_spooldir = @e_spooldir@ +install_sh = @install_sh@ + +# +# +EXTRA_DIST = xar +subdir = lib/sunpro5 +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +DIST_SOURCES = +DIST_COMMON = Makefile.am Makefile.in +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: Makefile.am $(top_srcdir)/configure.ac $(ACLOCAL_M4) + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu lib/sunpro5/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe) +uninstall-info-am: +tags: TAGS +TAGS: + +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) + +top_distdir = ../.. +distdir = $(top_distdir)/$(PACKAGE)-$(VERSION) + +distdir: $(DISTFILES) + @list='$(DISTFILES)'; for file in $$list; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkinstalldirs) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile + +installdirs: + +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -rm -f Makefile $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +info: info-am + +info-am: + +install-data-am: + +install-exec-am: + +install-info: install-info-am + +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +uninstall-am: uninstall-info-am + +.PHONY: all all-am check check-am clean clean-generic distclean \ + distclean-generic distdir dvi dvi-am info info-am install \ + install-am install-data install-data-am install-exec \ + install-exec-am install-info install-info-am install-man \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic uninstall uninstall-am uninstall-info-am + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/lib/sunpro5/xar b/lib/sunpro5/xar new file mode 100644 index 0000000..49db66d --- /dev/null +++ b/lib/sunpro5/xar @@ -0,0 +1,16 @@ +#!/bin/sh +# +# xar +# +# A replacement for 'ar' that does 'CC -xar' ignoring +# autoconf's bogus "cru" switches. +# +# For example: +# $ chmod +x lib/sunpro5/xar +# $ ./configure --enable-whatever AR=`pwd`/lib/sunpro5/xar +# +CC="CC" +if test -x "${CXX}" ; then CC="${CXX}" ; fi +if test "${1}" = "--cxx" ; then CC="${2}" ; shift ; shift ; fi +shift # get rid of "cru" flags +exec ${CC} -xar -o "$@" diff --git a/src/Makefile.am b/src/Makefile.am index 2b3110c..eec40b6 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,19 +1,20 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# SUBDIRS = glib gnet gsmtp main win32 diff --git a/src/Makefile.in b/src/Makefile.in index ceb0bf2..d68bff7 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -90,24 +90,8 @@ e_sbindir = @e_sbindir@ e_spooldir = @e_spooldir@ install_sh = @install_sh@ -# -# Copyright (C) 2001-2003 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. -# +# +# SUBDIRS = glib gnet gsmtp main win32 subdir = src mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/src/glib/Makefile.am b/src/glib/Makefile.am index f055bef..3bd90de 100644 --- a/src/glib/Makefile.am +++ b/src/glib/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# EXTRA_DIST=\ garg_win32.cpp \ gcleanup_win32.cpp \ @@ -24,6 +25,7 @@ EXTRA_DIST=\ gdirectory_win32.cpp \ gfs_win32.cpp \ glogoutput_win32.cpp \ + gmd5_aladdin.cpp \ gprocess_win32.cpp \ gfile_win32.cpp \ gregistry_win32.cpp \ @@ -66,7 +68,7 @@ libglib_a_SOURCES = \ glogoutput.cpp \ glogoutput.h \ glogoutput_unix.cpp \ - gmd5.cpp \ + gmd5_rsa.cpp \ gmd5.h \ gmemory.h \ gnoncopyable.h \ @@ -79,6 +81,8 @@ libglib_a_SOURCES = \ groot.cpp \ groot.h \ gsetter.h \ + gslot.cpp \ + gslot.h \ gstatemachine.h \ gstr.cpp \ gstr.h \ diff --git a/src/glib/Makefile.in b/src/glib/Makefile.in index 3c117e6..9763adb 100644 --- a/src/glib/Makefile.in +++ b/src/glib/Makefile.in @@ -90,24 +90,8 @@ e_sbindir = @e_sbindir@ e_spooldir = @e_spooldir@ install_sh = @install_sh@ -# -# Copyright (C) 2001-2003 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. -# +# +# EXTRA_DIST = \ garg_win32.cpp \ gcleanup_win32.cpp \ @@ -116,6 +100,7 @@ EXTRA_DIST = \ gdirectory_win32.cpp \ gfs_win32.cpp \ glogoutput_win32.cpp \ + gmd5_aladdin.cpp \ gprocess_win32.cpp \ gfile_win32.cpp \ gregistry_win32.cpp \ @@ -159,7 +144,7 @@ libglib_a_SOURCES = \ glogoutput.cpp \ glogoutput.h \ glogoutput_unix.cpp \ - gmd5.cpp \ + gmd5_rsa.cpp \ gmd5.h \ gmemory.h \ gnoncopyable.h \ @@ -172,6 +157,8 @@ libglib_a_SOURCES = \ groot.cpp \ groot.h \ gsetter.h \ + gslot.cpp \ + gslot.h \ gstatemachine.h \ gstr.cpp \ gstr.h \ @@ -193,9 +180,10 @@ am_libglib_a_OBJECTS = garg.$(OBJEXT) garg_unix.$(OBJEXT) \ gdirectory.$(OBJEXT) gdirectory_unix.$(OBJEXT) \ gexception.$(OBJEXT) gfile.$(OBJEXT) gfile_unix.$(OBJEXT) \ gfs_unix.$(OBJEXT) ggetopt.$(OBJEXT) glog.$(OBJEXT) \ - glogoutput.$(OBJEXT) glogoutput_unix.$(OBJEXT) gmd5.$(OBJEXT) \ - gpath.$(OBJEXT) gpidfile.$(OBJEXT) gprocess_unix.$(OBJEXT) \ - groot.$(OBJEXT) gstr.$(OBJEXT) gtime.$(OBJEXT) + glogoutput.$(OBJEXT) glogoutput_unix.$(OBJEXT) \ + gmd5_rsa.$(OBJEXT) gpath.$(OBJEXT) gpidfile.$(OBJEXT) \ + gprocess_unix.$(OBJEXT) groot.$(OBJEXT) gslot.$(OBJEXT) \ + gstr.$(OBJEXT) gtime.$(OBJEXT) libglib_a_OBJECTS = $(am_libglib_a_OBJECTS) DEFS = @DEFS@ @@ -216,10 +204,12 @@ am__depfiles_maybe = depfiles @AMDEP_TRUE@ ./$(DEPDIR)/gfile_unix.Po ./$(DEPDIR)/gfs_unix.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/ggetopt.Po ./$(DEPDIR)/glog.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/glogoutput.Po \ -@AMDEP_TRUE@ ./$(DEPDIR)/glogoutput_unix.Po ./$(DEPDIR)/gmd5.Po \ -@AMDEP_TRUE@ ./$(DEPDIR)/gpath.Po ./$(DEPDIR)/gpidfile.Po \ +@AMDEP_TRUE@ ./$(DEPDIR)/glogoutput_unix.Po \ +@AMDEP_TRUE@ ./$(DEPDIR)/gmd5_rsa.Po ./$(DEPDIR)/gpath.Po \ +@AMDEP_TRUE@ ./$(DEPDIR)/gpidfile.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/gprocess_unix.Po ./$(DEPDIR)/groot.Po \ -@AMDEP_TRUE@ ./$(DEPDIR)/gstr.Po ./$(DEPDIR)/gtime.Po +@AMDEP_TRUE@ ./$(DEPDIR)/gslot.Po ./$(DEPDIR)/gstr.Po \ +@AMDEP_TRUE@ ./$(DEPDIR)/gtime.Po CXXCOMPILE = $(CXX) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) \ $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CXXFLAGS) $(CXXFLAGS) CXXLD = $(CXX) @@ -275,11 +265,12 @@ distclean-compile: @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/glog.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/glogoutput.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/glogoutput_unix.Po@am__quote@ -@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gmd5.Po@am__quote@ +@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gmd5_rsa.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gpath.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gpidfile.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gprocess_unix.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/groot.Po@am__quote@ +@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gslot.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gstr.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/gtime.Po@am__quote@ diff --git a/src/glib/garg.cpp b/src/glib/garg.cpp index 55dcd31..6d13d35 100644 --- a/src/glib/garg.cpp +++ b/src/glib/garg.cpp @@ -126,7 +126,7 @@ void G::Arg::removeAt( size_t sw_index , size_t sw_args ) G_ASSERT( sw_index > 0U && sw_index < m_array.size() ) ; if( sw_index > 0U && sw_index < m_array.size() ) { - Array::iterator p = m_array.begin() + sw_index ; + StringArray::iterator p = m_array.begin() + sw_index ; p = m_array.erase( p ) ; for( size_t i = 0U ; i < sw_args && p != m_array.end() ; i++ ) p = m_array.erase( p ) ; diff --git a/src/glib/garg.h b/src/glib/garg.h index b8bc55e..2fe750b 100644 --- a/src/glib/garg.h +++ b/src/glib/garg.h @@ -25,6 +25,7 @@ #define G_ARG_H #include "gdef.h" +#include "gstrings.h" #include #include @@ -121,8 +122,7 @@ private: static bool match( bool , const std::string & , const std::string & ) ; private: - typedef std::vector Array ; - Array m_array ; + StringArray m_array ; std::string m_prefix ; } ; diff --git a/src/glib/gcleanup_unix.cpp b/src/glib/gcleanup_unix.cpp index 11e7423..87e8710 100644 --- a/src/glib/gcleanup_unix.cpp +++ b/src/glib/gcleanup_unix.cpp @@ -28,6 +28,12 @@ #include "glog.h" #include +extern "C" +{ + void gcleanup_unix_handler_( int signum ) ; + typedef void (*Handler)( int ) ; +} + namespace G { class CleanupImp ; @@ -40,14 +46,13 @@ class G::CleanupImp { public: static void add( void (*fn)(const char*) , const char * ) ; + static void installDefault( int ) ; + static void callHandlers() ; private: static void init() ; - static void install( int , void (*fn)(int) ) ; + static void install( int , Handler ) ; static void installHandler( int ) ; - static void installDefault( int ) ; - static void callHandlers() ; - static void handler_( int ) ; static bool ignored( int ) ; private: @@ -104,7 +109,7 @@ void G::CleanupImp::installHandler( int signum ) if( ignored(signum) ) G_DEBUG( "G::CleanupImp::installHandler: signal " << signum << " is ignored" ) ; else - install( signum , handler_ ) ; + install( signum , gcleanup_unix_handler_ ) ; } void G::CleanupImp::installDefault( int signum ) @@ -121,7 +126,7 @@ bool G::CleanupImp::ignored( int signum ) return action.sa_handler == SIG_IGN ; } -void G::CleanupImp::install( int signum , void (*fn)(int) ) +void G::CleanupImp::install( int signum , Handler fn ) { static struct sigaction zero_action ; struct sigaction action( zero_action ) ; @@ -139,12 +144,13 @@ void G::CleanupImp::callHandlers() } } -void G::CleanupImp::handler_( int signum ) +extern "C" +void gcleanup_unix_handler_( int signum ) { try { - callHandlers() ; - installDefault( signum ) ; + G::CleanupImp::callHandlers() ; + G::CleanupImp::installDefault( signum ) ; ::raise( signum ) ; } catch(...) diff --git a/src/glib/gdaemon_unix.cpp b/src/glib/gdaemon_unix.cpp index 713d7bc..c988688 100644 --- a/src/glib/gdaemon_unix.cpp +++ b/src/glib/gdaemon_unix.cpp @@ -41,7 +41,7 @@ void G::Daemon::detach() ::_exit( 0 ) ; setsid() ; - (void) Process::cd( "/" , Process::NoThrow() ) ; + G_IGNORE Process::cd( "/" , Process::NoThrow() ) ; if( Process::fork() == Process::Parent ) ::_exit( 0 ) ; diff --git a/src/glib/gdate.cpp b/src/glib/gdate.cpp index 30c2cb3..d2785e3 100644 --- a/src/glib/gdate.cpp +++ b/src/glib/gdate.cpp @@ -24,8 +24,7 @@ #include "gdef.h" #include "gdate.h" #include "gdebug.h" -#include -#include +#include #include //static @@ -45,6 +44,11 @@ G::Date::Date() init( G::DateTime::utc(G::DateTime::now()) ) ; } +G::Date::Date( G::DateTime::EpochTime t ) +{ + init( G::DateTime::utc(t) ) ; +} + G::Date::Date( G::DateTime::EpochTime t , const LocalTime & ) { init( G::DateTime::local(t) ) ; @@ -88,12 +92,21 @@ std::string G::Date::string( Format format ) const { std::ostringstream ss ; if( format == yyyy_mm_dd_slash ) - ss << m_year << "/" << m_month << "/" << m_day ; + { + ss << yyyy() << "/" << mm() << "/" << dd() ; + } + else if( format == yyyy_mm_dd ) + { + ss << yyyy() << mm() << dd() ; + } + else if( format == mm_dd ) + { + ss << mm() << dd() ; + } else - ss - << m_year - << std::setw(2) << std::setfill('0') << m_month - << std::setw(2) << std::setfill('0') << m_day ; + { + G_ASSERT( !"enum error" ) ; + } return ss.str() ; } @@ -102,10 +115,17 @@ int G::Date::monthday() const return m_day ; } -std::string G::Date::monthdayString() const +std::string G::Date::dd() const { std::ostringstream ss ; - ss << m_day ; + ss << std::setw(2) << std::setfill('0') << m_day ; + return ss.str() ; +} + +std::string G::Date::mm() const +{ + std::ostringstream ss ; + ss << std::setw(2) << std::setfill('0') << m_month ; return ss.str() ; } @@ -132,7 +152,7 @@ G::Date::Weekday G::Date::weekday() const return m_weekday ; } -std::string G::Date::weekdayString( bool brief ) const +std::string G::Date::weekdayName( bool brief ) const { if( weekday() == sunday ) return brief ? "Sun" : "Sunday" ; if( weekday() == monday ) return brief ? "Mon" : "Monday" ; @@ -149,7 +169,7 @@ G::Date::Month G::Date::month() const return Month(m_month) ; } -std::string G::Date::monthString( bool brief ) const +std::string G::Date::monthName( bool brief ) const { if( month() == january ) return brief ? "Jan" : "January" ; if( month() == february ) return brief ? "Feb" : "February" ; @@ -171,10 +191,10 @@ int G::Date::year() const return m_year ; } -std::string G::Date::yearString() const +std::string G::Date::yyyy() const { std::ostringstream ss ; - ss << m_year ; + ss << std::setw(4) << std::setfill('0') << m_year ; return ss.str() ; } diff --git a/src/glib/gdate.h b/src/glib/gdate.h index e3b0b29..40d58e0 100644 --- a/src/glib/gdate.h +++ b/src/glib/gdate.h @@ -27,8 +27,7 @@ #include "gdef.h" #include "gdatetime.h" #include "gdebug.h" -#include -#include +#include #include namespace G @@ -54,7 +53,7 @@ public: august , september , october , november , december } ; enum Format - { yyyy_mm_dd_slash , yyyy_mm_dd } ; + { yyyy_mm_dd_slash , yyyy_mm_dd , mm_dd } ; static int yearUpperLimit() ; // Returns the smallest supported year value. @@ -73,6 +72,10 @@ public: Date( const G::DateTime::BrokenDownTime & tm ) ; // Constructor for the specified date. + explicit Date( G::DateTime::EpochTime t ) ; + // Constructor for the date in the UTC + // timezone as at the given epoch time. + Date( G::DateTime::EpochTime t , const LocalTime & ) ; // Constructor for the date in the local // timezone as at the given epoch time. @@ -86,27 +89,34 @@ public: Weekday weekday() const ; // Returns the day of the week. - std::string weekdayString( bool brief = false ) const ; + std::string weekdayName( bool brief = false ) const ; // Returns an english string representation of // the day of the week. + // (Was weekdayString().) int monthday() const ; // Returns the day of the month. - std::string monthdayString() const ; - // Returns a string representation of the day of the month. + std::string dd() const ; + // Returns the day of the month as a two-digit decimal string. + // (Was monthdayString().) Month month() const ; // Returns the month. - std::string monthString( bool brief = false ) const ; + std::string monthName( bool brief = false ) const ; // Returns the month as a string (in english). + // (Was monthString().) + + std::string mm() const ; + // Returns the month as a two-digit decimal string. int year() const ; // Returns the year. - std::string yearString() const ; - // Returns the year as a string. + std::string yyyy() const ; + // Returns the year as a four-digit decimal string. + // (Was yearString().) Date & operator++() ; // Increments the date by one day. diff --git a/src/glib/gdatetime.cpp b/src/glib/gdatetime.cpp index 74da122..723f40f 100644 --- a/src/glib/gdatetime.cpp +++ b/src/glib/gdatetime.cpp @@ -27,9 +27,12 @@ #include "gassert.h" #include -const time_t minute = 60U ; -const time_t hour = 60U * minute ; -const time_t day = 24U * hour ; +namespace +{ + const std::time_t minute = 60U ; + const std::time_t hour = 60U * minute ; + const std::time_t day = 24U * hour ; +} G::DateTime::EpochTime G::DateTime::now() { @@ -42,8 +45,8 @@ G::DateTime::EpochTime G::DateTime::epochTime( const BrokenDownTime & bdt_in ) BrokenDownTime bdt( bdt_in ) ; EpochTime start = std::mktime( &bdt ) ; // localtime - // iterate over all timezones - const time_t delta = minute * 30U ; + // iterate over all timezones -- brute force for now + const std::time_t delta = minute * 30U ; for( EpochTime t = (start-day-delta) ; t <= (start+day+delta) ; t += delta ) { if( equivalent( t , bdt_in ) ) diff --git a/src/glib/gdatetime.h b/src/glib/gdatetime.h index e71249f..0d67d23 100644 --- a/src/glib/gdatetime.h +++ b/src/glib/gdatetime.h @@ -76,7 +76,7 @@ private: static bool same( const BrokenDownTime & , const BrokenDownTime & ) ; static std::tm * gmtime_r( const std::time_t * , std::tm * ) ; static std::tm * localtime_r( const std::time_t * , std::tm * ) ; - DateTime() ; + DateTime() ; // not implemented } ; #endif diff --git a/src/glib/gdef.h b/src/glib/gdef.h index a1b9941..14ec2b0 100644 --- a/src/glib/gdef.h +++ b/src/glib/gdef.h @@ -38,20 +38,27 @@ #include - #if ! HAVE_GMTIME_R + #if HAVE_BUGGY_CTIME + #include #include - inline struct tm * gmtime_r( const time_t * tp , struct tm * tm_p ) + #endif + + #if ! HAVE_GMTIME_R || ! HAVE_LOCALTIME_R + #include + #endif + + #if ! HAVE_GMTIME_R + inline std::tm * gmtime_r( const std::time_t * tp , std::tm * tm_p ) { - * tm_p = * gmtime( tp ) ; + * tm_p = * std::gmtime( tp ) ; return tm_p ; } #endif #if ! HAVE_LOCALTIME_R - #include - inline struct tm * localtime_r( const time_t * tp , struct tm * tm_p ) + inline std::tm * localtime_r( const std::time_t * tp , std::tm * tm_p ) { - * tm_p = * localtime( tp ) ; + * tm_p = * std::localtime( tp ) ; return tm_p ; } #endif @@ -113,14 +120,13 @@ // pre-compilation) // #include - #include + #include #include - #include - #include - //#include + #include #include #include - #include + #include + #include // Define fixed-size types // @@ -142,19 +148,9 @@ typedef unsigned int pid_t ; #endif - // STL portability macros (no longer necessary) - // - #if 1 - #define GAllocator(T) - #define GLessAllocator(T1,T2) - #else - #define GAllocator(T) ,std::allocator - #define GLessAllocator(T1,T2) ,std::allocator,std::less - #endif - // Modify compiler error handling // - #ifdef G_COMPILER_IS_MICROSOFT + #if defined(G_COMPILER_IS_MICROSOFT) #pragma warning( disable : 4100 ) // unused formal parameter #pragma warning( disable : 4355 ) // 'this' in initialiser list #pragma warning( disable : 4511 ) // cannot create default copy ctor @@ -163,5 +159,15 @@ #pragma warning( disable : 4275 ) // dll-interface stuff in #endif + // A macro to explicitly ignore a function's return value. + // Some compilers complain when return values are ignored, and + // others complain when using a c-style cast... + // + #if 1 + #define G_IGNORE + #else + #define G_IGNORE (void) + #endif + #endif diff --git a/src/glib/gdirectory.h b/src/glib/gdirectory.h index 24ee65a..c4274bb 100644 --- a/src/glib/gdirectory.h +++ b/src/glib/gdirectory.h @@ -92,7 +92,7 @@ private: // Class: G::DirectoryIterator // Description: An iterator for Directory. // The iteration model is -/// while(iter.more()) { (void)iter.file() ; } +/// while(iter.more()) { (void)iter.filePath() ; } // class G::DirectoryIterator { diff --git a/src/glib/gdirectory_unix.cpp b/src/glib/gdirectory_unix.cpp index 6e2532d..d53d8e6 100644 --- a/src/glib/gdirectory_unix.cpp +++ b/src/glib/gdirectory_unix.cpp @@ -96,7 +96,6 @@ public: private: void operator=( const DirectoryIteratorImp & ) ; DirectoryIteratorImp( const DirectoryIteratorImp & ) ; - static int onError( const char * path , int errno_ ) ; } ; // === @@ -148,8 +147,7 @@ G::DirectoryIterator::~DirectoryIterator() // === -//static -int G::DirectoryIteratorImp::onError( const char * , int ) +extern "C" int gdirectory_unix_on_error_( const char * , int ) { const int abort = 1 ; return abort ; @@ -171,7 +169,7 @@ G::DirectoryIteratorImp::DirectoryIteratorImp( const Directory &dir , G_DEBUG( "G::DirectoryIteratorImp::ctor: glob(\"" << wild_path << "\")" ) ; int flags = 0 | GLOB_ERR ; - int error = ::glob( wild_path.pathCstr() , flags , onError , &m_glob ) ; + int error = ::glob( wild_path.pathCstr() , flags , gdirectory_unix_on_error_ , &m_glob ) ; if( error || m_glob.gl_pathv == NULL ) { G_DEBUG( "G::DirectoryIteratorImp::ctor: glob() error: " << error ) ; diff --git a/src/glib/gdirectory_win32.cpp b/src/glib/gdirectory_win32.cpp index f4d5dd9..7d2776e 100644 --- a/src/glib/gdirectory_win32.cpp +++ b/src/glib/gdirectory_win32.cpp @@ -39,7 +39,7 @@ bool G::Directory::valid( bool for_creation ) const DWORD attributes = ::GetFileAttributes( m_path.pathCstr() ) ; if( attributes == 0xFFFFFFFF ) { - (void)::GetLastError() ; + G_IGNORE ::GetLastError() ; return false ; } return ( attributes & FILE_ATTRIBUTE_DIRECTORY ) != 0 ; diff --git a/src/glib/gexception.h b/src/glib/gexception.h index 2095601..01b67b8 100644 --- a/src/glib/gexception.h +++ b/src/glib/gexception.h @@ -83,7 +83,6 @@ public: } ; #define G_EXCEPTION( class_name , description ) class class_name : public G::Exception { public: class_name() { m_what = description ; } public: explicit class_name ( std::ostream & stream ) { m_what = description ; append(stream) ; } public: explicit class_name( const char * more ) { m_what = description ; append(more) ; } public: explicit class_name( const std::string & more ) { m_what = description ; append(more) ; } } -#define G_EXCEPTION_ G_EXCEPTION #endif diff --git a/src/glib/gfile_win32.cpp b/src/glib/gfile_win32.cpp index 27904e0..e5665ef 100644 --- a/src/glib/gfile_win32.cpp +++ b/src/glib/gfile_win32.cpp @@ -62,9 +62,10 @@ std::string G::File::sizeString( g_uint32_t hi , g_uint32_t lo ) std::string s ; while( n != 0 ) { - size_t i = n % 10U ; - s.insert( 0U , 1U , '0' + i ) ; - n /= 10U ; + int i = static_cast( n % 10 ) ; + char c = static_cast( '0' + i ) ; + s.insert( 0U , 1U , c ) ; + n /= 10 ; } return s ; } diff --git a/src/glib/ggetopt.h b/src/glib/ggetopt.h index c2cf833..f895c7c 100644 --- a/src/glib/ggetopt.h +++ b/src/glib/ggetopt.h @@ -44,7 +44,6 @@ namespace G class G::GetOpt { public: - typedef std::vector StringArray ; struct Level // Used by G::GetOpt for extra type safety. { unsigned int level ; explicit Level(unsigned int l) : level(l) {} } ; G_EXCEPTION( InvalidSpecification , "invalid options specification string" ) ; @@ -162,9 +161,9 @@ private: valued(v_) , hidden(description_.empty()||level_==0U) , value_description(vd_) , level(level_) {} } ; - typedef std::map SwitchSpecMap ; + typedef std::map SwitchSpecMap ; typedef std::pair Value ; - typedef std::map SwitchMap ; + typedef std::map SwitchMap ; void operator=( const GetOpt & ) ; GetOpt( const GetOpt & ) ; diff --git a/src/glib/glog.cpp b/src/glib/glog.cpp index ea24de7..6ae6427 100644 --- a/src/glib/glog.cpp +++ b/src/glib/glog.cpp @@ -31,7 +31,7 @@ namespace G } // Class: LogImp -// Description: An implementation class used by Log. +// Description: An implementation class used by G::Log. // class G::LogImp { diff --git a/src/glib/glog.h b/src/glib/glog.h index 91aa50d..1982f8c 100644 --- a/src/glib/glog.h +++ b/src/glib/glog.h @@ -61,7 +61,7 @@ public: // Returns an End object which can be used to close off a quantum // of logging. (The End::op<<() function calls G::Log::onEnd().) - static Stream &stream() ; + static Stream & stream() ; // Returns a stream for streaming messages into. static void onEnd( Severity s ) ; @@ -77,8 +77,7 @@ private: namespace G { inline - std::ostream &operator<<( std::ostream &stream , - const G::Log::Line & ) + std::ostream & operator<<( std::ostream & stream , const G::Log::Line & ) { return stream ; } @@ -87,10 +86,9 @@ namespace G namespace G { inline - std::ostream &operator<<( std::ostream &stream , - const G::Log::End &end ) + std::ostream & operator<<( std::ostream & stream , const G::Log::End & end ) { - G::Log::onEnd( end.m_s ) ; + G::Log::onEnd( end.m_s ) ; return stream ; } } @@ -98,7 +96,7 @@ namespace G namespace G { inline - G::Log::Line::Line( const char *file , int line ) + G::Log::Line::Line( const char * file , int line ) { G::Log::setFile( file ) ; G::Log::setLine( line ) ; @@ -113,7 +111,12 @@ namespace G // then warning/error messages should also get raised by some another // independent means. // -#define G_LOG_OUTPUT( expr , severity ) do { G::Log::stream() << G::Log::Line(__FILE__,__LINE__) << expr << G::Log::end(severity) ; } while(0) +// (The G_LOG_OUTPUT implementation uses separate statements because +// some compilers dont do Koenig lookup with nested classes. They +// look for ::operator<<() or G::X::operator<<() rather than +// G::operator<<().) +// +#define G_LOG_OUTPUT( expr , severity ) do { G::Log::Stream & s_ = G::Log::stream() ; G::operator<<( s_ , G::Log::Line(__FILE__,__LINE__) ) ; s_ << expr ; G::operator<<( s_ , G::Log::end(severity) ) ; } while(0) #if defined(_DEBUG) && ! defined(G_NO_DEBUG) #define G_DEBUG( expr ) G_LOG_OUTPUT( expr , G::Log::s_Debug ) #else diff --git a/src/glib/glogoutput.cpp b/src/glib/glogoutput.cpp index a229a5a..4123183 100644 --- a/src/glib/glogoutput.cpp +++ b/src/glib/glogoutput.cpp @@ -30,7 +30,8 @@ G::LogOutput * G::LogOutput::m_this = NULL ; G::LogOutput::LogOutput( const std::string & prefix , bool enabled , bool summary_log , - bool verbose_log , bool debug , bool level , bool timestamp , bool strip ) : + bool verbose_log , bool debug , bool level , bool timestamp , bool strip , + bool use_syslog , SyslogFacility syslog_facility ) : m_prefix(prefix) , m_enabled(enabled) , m_summary_log(summary_log) , @@ -38,7 +39,8 @@ G::LogOutput::LogOutput( const std::string & prefix , bool enabled , bool summar m_debug(debug) , m_level(level) , m_strip(strip) , - m_syslog(false) , + m_syslog(use_syslog) , + m_facility(syslog_facility) , m_time(0) , m_timestamp(timestamp) , m_handle(0) , @@ -57,6 +59,7 @@ G::LogOutput::LogOutput( bool enabled_and_summary , bool verbose_and_debug ) : m_level(false) , m_strip(false) , m_syslog(false) , + m_facility(User) , m_time(0) , m_timestamp(false) , m_handle(0) , @@ -86,22 +89,6 @@ bool G::LogOutput::enable( bool enabled ) return was_enabled ; } -void G::LogOutput::timestamp() -{ - m_timestamp = true ; -} - -void G::LogOutput::syslog() -{ - syslog( User ) ; -} - -void G::LogOutput::syslog( SyslogFacility facility ) -{ - m_syslog = true ; - m_facility = facility ; -} - //static void G::LogOutput::output( Log::Severity severity , const char * file , unsigned int line , const char * text ) { diff --git a/src/glib/glogoutput.h b/src/glib/glogoutput.h index 020f011..c5c2f7b 100644 --- a/src/glib/glogoutput.h +++ b/src/glib/glogoutput.h @@ -45,7 +45,8 @@ public: LogOutput( const std::string & prefix , bool output , bool with_logging , bool with_verbose_logging , bool with_debug , bool with_level , - bool with_timestamp , bool strip_context ) ; + bool with_timestamp , bool strip_context , + bool use_syslog , SyslogFacility syslog_facility = User ) ; // Constructor. If there is no LogOutput object, // or if 'output' is false, then there is no // output of any sort. Otherwise at least @@ -78,16 +79,6 @@ public: // Enables or disables output. // Returns the previous setting. - void syslog() ; - // Enables logging to the syslog system under Unix. - - void timestamp() ; - // Enables timestamping. - - void syslog( SyslogFacility facility ) ; - // Enables logging to the syslog system under Unix, - // using the specified facility. - static void output( G::Log::Severity s , const char *file , unsigned line , const char *text ) ; // Generates output if there is an existing // LogOutput object which is enabled. Uses rawOutput(). diff --git a/src/glib/glogoutput_unix.cpp b/src/glib/glogoutput_unix.cpp index 9d362c6..908d69d 100644 --- a/src/glib/glogoutput_unix.cpp +++ b/src/glib/glogoutput_unix.cpp @@ -28,23 +28,26 @@ namespace { + int decode( G::LogOutput::SyslogFacility facility ) + { + if( facility == G::LogOutput::User ) return LOG_USER ; + if( facility == G::LogOutput::Daemon ) return LOG_DAEMON ; + if( facility == G::LogOutput::Mail ) return LOG_MAIL ; + if( facility == G::LogOutput::Cron ) return LOG_CRON ; + // etc... + return LOG_USER ; + } + int decode( G::Log::Severity severity ) + { + if( severity == G::Log::s_Warning ) return LOG_WARNING ; + if( severity == G::Log::s_Error ) return LOG_ERR ; + if( severity == G::Log::s_LogSummary ) return LOG_INFO ; + if( severity == G::Log::s_LogVerbose ) return LOG_INFO ; + return LOG_CRIT ; + } int mode( G::LogOutput::SyslogFacility facility , G::Log::Severity severity ) { - int m = 0 ; - - if( facility == G::LogOutput::User ) m |= LOG_USER ; - else if( facility == G::LogOutput::Daemon ) m |= LOG_DAEMON ; - else if( facility == G::LogOutput::Mail ) m |= LOG_MAIL ; - else if( facility == G::LogOutput::Cron ) m |= LOG_CRON ; - // etc... - - if( severity == G::Log::s_Warning ) m |= LOG_WARNING ; - else if( severity == G::Log::s_Error ) m |= LOG_ERR ; - else if( severity == G::Log::s_LogSummary ) m |= LOG_INFO ; - else if( severity == G::Log::s_LogVerbose ) m |= LOG_INFO ; - else m |= LOG_CRIT ; - - return m ; + return decode(facility) | decode(severity) ; } } @@ -59,9 +62,13 @@ void G::LogOutput::rawOutput( G::Log::Severity severity , const char *message ) void G::LogOutput::init() { + if( m_syslog ) + ::openlog( NULL , LOG_PID , decode(m_facility) ) ; } void G::LogOutput::cleanup() { + if( m_syslog ) + ::closelog() ; } diff --git a/src/glib/glogoutput_win32.cpp b/src/glib/glogoutput_win32.cpp index 92e0201..3777249 100644 --- a/src/glib/glogoutput_win32.cpp +++ b/src/glib/glogoutput_win32.cpp @@ -65,7 +65,7 @@ void G::LogOutput::rawOutput( G::Log::Severity severity , const char *message ) // (assume suitable string resources of 1001..1003) DWORD id = 0x400003E9L ; - DWORD type = EVENTLOG_INFORMATION_TYPE ; + WORD type = EVENTLOG_INFORMATION_TYPE ; if( severity == Log::s_Warning ) { id = 0x800003EAL ; @@ -78,7 +78,7 @@ void G::LogOutput::rawOutput( G::Log::Severity severity , const char *message ) } const char * p[] = { message , NULL } ; - (void) ::ReportEvent( m_handle, type, 0, id, NULL, 1, 0, p, NULL ) ; + G_IGNORE ::ReportEvent( m_handle, type, 0, id, NULL, 1, 0, p, NULL ) ; } } diff --git a/src/glib/gmd5_aladdin.cpp b/src/glib/gmd5_aladdin.cpp new file mode 100644 index 0000000..b28db82 --- /dev/null +++ b/src/glib/gmd5_aladdin.cpp @@ -0,0 +1,192 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gmd5_aladdin.cpp +// + +#include "gdef.h" +#include "gmd5.h" +#include "gstr.h" +#include "gstrings.h" +#include "gassert.h" + +#include "md5.h" + +namespace +{ + void init( md5_state_t & context ) + { + ::md5_init( &context ) ; + } + void update( md5_state_t & context , const std::string & input ) + { + char * p = const_cast(input.c_str()) ; + int size = static_cast( input.size() ) ; + ::md5_append( &context , reinterpret_cast(p) , size ) ; + } + std::string final( md5_state_t & context ) + { + const size_t L = 16U ; // output size + unsigned char buffer[L] ; + ::md5_finish( &context , buffer ) ; + const char * buffer_p = reinterpret_cast(buffer) ; + return std::string( buffer_p , L ) ; + } + std::string writeOut( const md5_state_t & context ) + { + G_ASSERT( sizeof context.abcd[0] <= sizeof(unsigned long) ) ; + return + G::Str::fromULong( context.abcd[0] ) + "." + + G::Str::fromULong( context.abcd[1] ) + "." + + G::Str::fromULong( context.abcd[2] ) + "." + + G::Str::fromULong( context.abcd[3] ) ; + } + void readIn( md5_state_t & context , G::Strings & s ) + { + static md5_state_t zero_context ; + context = zero_context ; + context.count[0] = 0x200 ; // magic number -- see cyrus sasl lib/md5.c + G_ASSERT( context.count[1] == 0 ) ; + context.abcd[0] = G::Str::toULong(s.front()) ; s.pop_front() ; + context.abcd[1] = G::Str::toULong(s.front()) ; s.pop_front() ; + context.abcd[2] = G::Str::toULong(s.front()) ; s.pop_front() ; + context.abcd[3] = G::Str::toULong(s.front()) ; s.pop_front() ; + G_ASSERT( context.buf[0] == 0 ) ; + } +} + +std::string G::Md5::xor_( const std::string & s1 , const std::string & s2 ) +{ + G_ASSERT( s1.length() == s2.length() ) ; + std::string::const_iterator p1 = s1.begin() ; + std::string::const_iterator p2 = s2.begin() ; + std::string result ; + for( ; p1 != s1.end() ; ++p1 , ++p2 ) + { + unsigned char c1 = static_cast(*p1) ; + unsigned char c2 = static_cast(*p2) ; + unsigned char c = c1 ^ c2 ; + result.append( 1U , static_cast(c) ) ; + } + return result ; +} + +std::string G::Md5::key64( std::string k ) +{ + const size_t B = 64U ; + if( k.length() > B ) + k = digest(k) ; + if( k.length() < B ) + k.append( std::string(B-k.length(),'\0') ) ; + G_ASSERT( k.length() == B ) ; + return k ; +} + +std::string G::Md5::ipad() +{ + const size_t B = 64U ; + return std::string( B , '\066' ) ; // 00110110 = 00,110,110 +} + +std::string G::Md5::opad() +{ + const size_t B = 64U ; + return std::string( B , '\134' ) ; // 01011100 = 01,011,100 +} + +std::string G::Md5::mask( const std::string & k ) +{ + std::string k64 = key64( k ) ; + return mask( k64 , ipad() ) + "." + mask( k64 , opad() ) ; +} + +std::string G::Md5::mask( const std::string & k64 , const std::string & pad ) +{ + md5_state_t context ; + init( context ) ; + update( context , xor_(k64,pad) ) ; + return writeOut( context ) ; +} + +std::string G::Md5::hmac( const std::string & masked_key , const std::string & input , Masked ) +{ + G::Strings part_list ; + G::Str::splitIntoTokens( masked_key , part_list , "." ) ; + if( part_list.size() != 8U ) + throw InvalidMaskedKey( masked_key ) ; + + md5_state_t inner_context ; + md5_state_t outer_context ; + readIn( inner_context , part_list ) ; + readIn( outer_context , part_list ) ; + update( inner_context , input ) ; + update( outer_context , final(inner_context) ) ; + return final( outer_context ) ; +} + +std::string G::Md5::hmac( const std::string & k , const std::string & input ) +{ + std::string k64 = key64( k ) ; + return digest( xor_(k64,opad()) , digest(xor_(k64,ipad()),input) ) ; +} + +std::string G::Md5::digest( const std::string & input ) +{ + return digest( input , NULL ) ; +} + +std::string G::Md5::digest( const std::string & input_1 , const std::string & input_2 ) +{ + return digest( input_1 , &input_2 ) ; +} + +std::string G::Md5::digest( const std::string & input_1 , const std::string * input_2 ) +{ + md5_state_t context ; + init( context ) ; + update( context , input_1 ) ; + if( input_2 != NULL ) + update( context , *input_2 ) ; + return final( context ) ; +} + +std::string G::Md5::printable( const std::string & input ) +{ + G_ASSERT( input.length() == 16U ) ; + + std::string result ; + const char * hex = "0123456789abcdef" ; + const size_t n = input.length() ; + for( size_t i = 0U ; i < n ; i++ ) + { + unsigned char c = static_cast(input.at(i)) ; + result.append( 1U , hex[(c>>4U)&0x0F] ) ; + result.append( 1U , hex[(c>>0U)&0x0F] ) ; + } + + return result ; +} + +// Source-file inclusion is not nice, but it means that the "md5.c" +// file can be left in its pristine state but still benefit (?) from +// portability tweaks in "gdef.h" etc. +// +#include "md5.c" + diff --git a/src/glib/gmd5.cpp b/src/glib/gmd5_rsa.cpp similarity index 99% rename from src/glib/gmd5.cpp rename to src/glib/gmd5_rsa.cpp index ad47984..82c3e50 100644 --- a/src/glib/gmd5.cpp +++ b/src/glib/gmd5_rsa.cpp @@ -18,7 +18,7 @@ // // === // -// gmd5.cpp +// gmd5_rsa.cpp // #include "gdef.h" diff --git a/src/glib/gpidfile.cpp b/src/glib/gpidfile.cpp index 4291db2..8c7deec 100644 --- a/src/glib/gpidfile.cpp +++ b/src/glib/gpidfile.cpp @@ -52,7 +52,8 @@ void G::PidFile::create( const Path & pid_file ) G_DEBUG( "G::PidFile::create: \"" << pid_file << "\"" ) ; Process::Umask readable(Process::Umask::Readable) ; std::ofstream file( pid_file.str().c_str() ) ; - file << Process::Id() << std::endl ; + Process::Id pid ; + file << pid.str() << std::endl ; if( !file.good() ) throw Error(std::string("cannot create file: ")+pid_file.str()) ; Cleanup::add( cleanup , strdup_(pid_file.str().c_str()) ) ; // (leaks) diff --git a/src/glib/gprocess_unix.cpp b/src/glib/gprocess_unix.cpp index 0483702..f610cab 100644 --- a/src/glib/gprocess_unix.cpp +++ b/src/glib/gprocess_unix.cpp @@ -282,8 +282,8 @@ void G::Process::beSpecial( Identity identity , bool change_group ) // gcc requires -D_BSD_SOURCE for seteuid() // Identity old_identity ; - (void) ::seteuid( identity.uid ) ; - if( change_group) (void) ::setegid( identity.gid ) ; + G_IGNORE ::seteuid( identity.uid ) ; + if( change_group) G_IGNORE ::setegid( identity.gid ) ; //G_DEBUG( "G::Process::beSpecial: " << old_identity << " -> " << Identity() ) ; old_identity.uid = 0 ; // pacify the compiler } @@ -391,7 +391,7 @@ std::string G::Process::Identity::str() const // === -class G::Process::Umask::UmaskImp +class G::Process::Umask::UmaskImp // A private implementation class used by G::Process::Umask. { public: mode_t m_old_mode ; @@ -406,7 +406,7 @@ G::Process::Umask::Umask( Mode mode ) : G::Process::Umask::~Umask() { - (void) ::umask( m_imp->m_old_mode ) ; + G_IGNORE ::umask( m_imp->m_old_mode ) ; delete m_imp ; } diff --git a/src/glib/gprocess_win32.cpp b/src/glib/gprocess_win32.cpp index f574fd2..3e18876 100644 --- a/src/glib/gprocess_win32.cpp +++ b/src/glib/gprocess_win32.cpp @@ -169,6 +169,11 @@ bool G::Process::cd( const Path & dir , NoThrow ) return 0 == ::_chdir( dir.str().c_str() ) ; } +int G::Process::errno_() +{ + return errno ; +} + int G::Process::spawn( Identity , const Path & exe , const Strings & args_ , std::string * pipe_result_p , int error_return ) { @@ -179,7 +184,9 @@ int G::Process::spawn( Identity , const Path & exe , const Strings & args_ , Strings args( args_ ) ; // non-const copy Pipe pipe( pipe_result_p != NULL ) ; if( pipe_result_p != NULL ) - args.push_front( Str::fromInt(pipe.fd()) ) ; // kludge -- child must write on specific fd passed as argv[1] + args.push_front( Str::fromInt(pipe.fd()) ) ; // kludge -- child must write on fd passed as argv[1] + + G_DEBUG( "G::Process::spawn: \"" << exe << "\": \"" << Str::join(args,"\",\"") << "\"" ) ; char ** argv = new char* [ args.size() + 2U ] ; argv[0U] = const_cast( exe.pathCstr() ) ; @@ -191,7 +198,9 @@ int G::Process::spawn( Identity , const Path & exe , const Strings & args_ , const int mode = _P_WAIT ; ::_flushall() ; int rc = ::_spawnv( mode , exe.str().c_str() , argv ) ; + int error = errno_() ; delete [] argv ; + G_DEBUG( "G::Process::spawn: _spawnv(): rc=" << rc << ": errno=" << error ) ; if( pipe_result_p != NULL ) *pipe_result_p = pipe.read() ; @@ -211,7 +220,6 @@ void G::Process::beSpecial( Identity , bool ) } // not implemented... -// int G::Process::errno_() // Who G::Process::fork() {} // Who G::Process::fork( Id & child ) {} // void G::Process::exec( const Path & exe , const std::string & arg ) {} diff --git a/src/glib/gregistry.h b/src/glib/gregistry.h index 27035e7..9c744be 100644 --- a/src/glib/gregistry.h +++ b/src/glib/gregistry.h @@ -159,6 +159,7 @@ private: std::pair getInfo() const ; std::string getData( g_uint32_t & type , bool & ) const ; size_t get( char * , size_t ) const ; + void set( g_uint32_t type , const void * p , size_t n ) ; private: const RegistryKey & m_hkey ; diff --git a/src/glib/gregistry_win32.cpp b/src/glib/gregistry_win32.cpp index 8a56b34..889a3d4 100644 --- a/src/glib/gregistry_win32.cpp +++ b/src/glib/gregistry_win32.cpp @@ -259,6 +259,30 @@ std::string G::RegistryValue::getString( const std::string & defolt , } } +g_uint32_t G::RegistryValue::getDword() const +{ + DWORD type = 0 ; + bool exists = true ; + std::string data = getData( type , exists ) ; + if( !exists ) throw MissingValue( m_key_name ) ; + if( type != REG_DWORD ) throw InvalidType( m_key_name ) ; + if( data.length() != 4U ) throw ValueError( m_key_name ) ; + g_uint32_t result = 0UL ; + for( int i = 3 ; i >= 0 ; i-- ) + { + result *= 256UL ; + result += static_cast(data[i]) ; + } + return result ; +} + +bool G::RegistryValue::getBool() const +{ + g_uint32_t n = getDword() ; + if( n != 0UL && n != 1UL ) throw ValueError( m_key_name ) ; + return !!n ; +} + std::string G::RegistryValue::getData( g_uint32_t & type , bool & exists ) const { exists = true ; @@ -334,14 +358,25 @@ void G::RegistryValue::set( const char * p ) void G::RegistryValue::set( const std::string & s ) { - DWORD type = REG_SZ ; + set( REG_SZ , reinterpret_cast(s.c_str()) , s.length()+1U ) ; +} - LONG rc = ::RegSetValueEx( m_hkey.imp().m_key , m_key_name.c_str() , 0 , - type , reinterpret_cast(s.c_str()) , - s.length() + 1U ) ; +void G::RegistryValue::set( bool b ) +{ + g_uint32_t n = b ? 1UL : 0UL ; + set( n ) ; +} +void G::RegistryValue::set( g_uint32_t n ) +{ + set( REG_DWORD , reinterpret_cast(&n) , 4UL ) ; +} + +void G::RegistryValue::set( g_uint32_t type , const void * vp , size_t n ) +{ + const BYTE * p = reinterpret_cast(vp) ; + LONG rc = ::RegSetValueEx( m_hkey.imp().m_key , m_key_name.c_str() , 0 , type , p , n ) ; if( rc != ERROR_SUCCESS ) throw ValueError( "RegSetValueEx" ) ; } - diff --git a/src/glib/groot.h b/src/glib/groot.h index ad0df2c..8d9d33b 100644 --- a/src/glib/groot.h +++ b/src/glib/groot.h @@ -37,7 +37,7 @@ namespace G // Description: A class which aquires special privileges. // The implementation uses G::Process. // -class G::Root : private noncopyable +class G::Root : private G::noncopyable { public: explicit Root( bool change_group = true ) ; diff --git a/src/glib/gsetter.h b/src/glib/gsetter.h index b51a307..33d0607 100644 --- a/src/glib/gsetter.h +++ b/src/glib/gsetter.h @@ -33,10 +33,10 @@ namespace G } // Class: G::Setter -// Description: A class to Manage a boolean flag +// Description: A class to manage a boolean flag // while in scope. // -class G::Setter : public G:: noncopyable +class G::Setter : public G::noncopyable { public: explicit Setter( bool & b ) ; diff --git a/src/glib/gslot.cpp b/src/glib/gslot.cpp new file mode 100644 index 0000000..f698319 --- /dev/null +++ b/src/glib/gslot.cpp @@ -0,0 +1,54 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gslot.cpp +// + +#include "gdef.h" +#include "gslot.h" + +G::SlotBase::~SlotBase() +{ +} + +G::SlotBase::SlotBase() : m_ref_count(1UL) +{ +} + +void G::SlotBase::up() +{ + m_ref_count++ ; +} + +void G::SlotBase::down() +{ + m_ref_count-- ; + if( m_ref_count == 0UL ) + delete this ; +} + +// === + +void G::SignalImp::check( const SlotBase * p ) +{ + if( p != NULL ) + throw AlreadyConnected() ; +} + diff --git a/src/glib/gslot.h b/src/glib/gslot.h new file mode 100644 index 0000000..90c1152 --- /dev/null +++ b/src/glib/gslot.h @@ -0,0 +1,415 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gslot.h +// +// Inspired by libsigc++, but simplified by: +// * not doing multicast +// * not detecting dangling references +// * not supporting global function callbacks +// * using only void returns +// +// The key to the implementation is that SlotImp<> is +// templated on the callback parameter P and the callback +// sink class T, but Slot<> is templated only on P, so +// the event-source class does not need to know the type +// of the event-sink. The SlotOp<> classes are used to +// resolve this mismatch, by downcasting to the T-specific +// SlotImp<> class. The Slot<> classes are reference-counting +// handles to SlotImp<> (via SlotBase), with an additional +// function pointer for the relevant SlotOp<> downcasting +// method. +// +// The overloaded template function slot<>() creates +// a Slot<> handle, passing it a suitable SlotBase body +// and casting function. The dynamic type of the SlotBase +// reference is a SlotImp<> class which knows about the +// specific sink class T, and the casting function knows +// how to access the derived class. The combination of +// SlotBase polymorphism and casting function isolates the +// slot class from the sink class. +// +// Usage: +/// class Source +/// { +/// public: +/// Signal1 m_signal ; +/// private: +/// void Source::raiseEvent() +/// { +/// int n = 123 ; +/// m_signal.emit( n ) ; +/// } +/// } ; +/// +/// class Sink +/// { +/// public: +/// void onEvent( int n ) ; +/// Sink( Source & source ) +/// { +/// source.m_signal.connect( slot(*this,&Sink::onEvent) ) ; +/// } +/// } ; +// + +#ifndef G_SLOT_H +#define G_SLOT_H + +#include "gdef.h" +#include "gexception.h" +#include "gnoncopyable.h" + +namespace G +{ + +// Class: SlotBase +// Description: Part of the slot/signal system. +// Used as a base class to all SlotImp<> classes +// allowing them to be used as bodies to the +// Slot<> reference-counting handle. +// +class SlotBase +{ +public: + virtual ~SlotBase() ; + // Destructor. + + SlotBase() ; + // Default constuctor. + + void up() ; + // Increments the reference count. + + void down() ; + // Decrements the reference count + // and does "delete this" on zero. + +private: + SlotBase( const SlotBase & ) ; // not implemented + void operator=( const SlotBase & ) ; // not implemented + +private: + unsigned long m_ref_count ; +} ; + + +// Class: SignalImp +// Description: Part of the slot/signal system. +// A static helper class used by Signal<> classes. +// +class SignalImp +{ +public: + G_EXCEPTION( AlreadyConnected , "signal already connected to a slot" ) ; + static void check( const SlotBase * p ) ; +private: + SignalImp() ; // not implemented +} ; + +template +inline +void swap_( T & t1 , T & t2 ) // no std::swap in gcc2.95 +{ + T temp( t1 ) ; + t1 = t2 ; + t2 = temp ; +} + +// === + +// Class: SlotImp0 +// Description: Part of the slot/signal system. +// An implementation class for Slot0<>. An instance +// is created by the slot<>() +// +template +class SlotImp0 : public SlotBase +{ + T & m_object ; + void (T::*m_fn)() ; +public: + SlotImp0( T & object , void (T::*fn)() ) : m_object(object) , m_fn(fn) {} + void callback() { (m_object.*m_fn)() ; } +} ; + +// Class: SlotOp0 +// Description: Part of the slot/signal system. +// +template +class SlotOp0 +{ +public: + static void callback( SlotBase * imp ) + { static_cast*>(imp)->callback() ; } +} ; + +// Class: Slot0 +// Description: Part of the slot/signal system. +// +class Slot0 +{ + SlotBase * m_imp ; + void (*m_op)( SlotBase * ) ; +public: + Slot0() : m_imp(0) , m_op(0) {} + Slot0( SlotBase * imp , void (*op)(SlotBase*) ) : m_imp(imp) , m_op(op) {} + ~Slot0() { if( m_imp ) m_imp->down() ; } + void callback() { if( m_imp ) (*m_op)( m_imp ) ; } + Slot0( const Slot0 & other ) : m_imp(other.m_imp) , m_op(other.m_op) { if(m_imp) m_imp->up() ; } + void swap( Slot0 & rhs ) { swap_(m_imp,rhs.m_imp) ; swap_(m_op,rhs.m_op) ; } + void operator=( const Slot0 & rhs ) { Slot0 tmp(rhs) ; swap(tmp) ; } + const SlotBase * base() const { return m_imp ; } +} ; + +// Class: Signal0 +// Description: Part of the slot/signal system. +// +class Signal0 : public noncopyable +{ + Slot0 m_slot ; +public: + Signal0() {} + void emit() { m_slot.callback() ; } + void connect( Slot0 slot ) { SignalImp::check(m_slot.base()) ; m_slot = slot ; } + void disconnect() { m_slot = Slot0() ; } +} ; + +// Function: slot +// Description: Part of the slot/signal system. +// +template +inline +Slot0 slot( T & object , void (T::*fn)() ) +{ + return Slot0( new SlotImp0(object,fn) , SlotOp0::callback ) ; +} + +// === + +// Class: SlotImp1 +// Description: Part of the slot/signal system. +// +template +class SlotImp1 : public SlotBase +{ + T & m_object ; + void (T::*m_fn)( P ) ; +public: + SlotImp1( T & object , void (T::*fn)(P) ) : m_object(object) , m_fn(fn) {} + void callback( P p ) { (m_object.*m_fn)(p) ; } +} ; + +// Class: SlotOp1 +// Description: Part of the slot/signal system. +// +template +class SlotOp1 +{ +public: + static void callback( SlotBase * imp , P p ) + { static_cast*>(imp)->callback( p ) ; } +} ; + +// Class: Slot1 +// Description: Part of the slot/signal system. +// +template +class Slot1 +{ + SlotBase * m_imp ; + void (*m_op)( SlotBase * , P ) ; +public: + Slot1() : m_imp(0) , m_op(0) {} + Slot1( SlotBase * imp , void (*op)(SlotBase*,P) ) : m_imp(imp) , m_op(op) {} + ~Slot1() { if( m_imp ) m_imp->down() ; } + void callback( P p ) { if( m_imp ) (*m_op)( m_imp , p ) ; } + Slot1( const Slot1

    & other ) : m_imp(other.m_imp) , m_op(other.m_op) { if(m_imp) m_imp->up() ; } + void swap( Slot1

    & rhs ) { swap_(m_imp,rhs.m_imp) ; swap_(m_op,rhs.m_op) ; } + void operator=( const Slot1

    & rhs ) { Slot1 tmp(rhs) ; swap(tmp) ; } + const SlotBase * base() const { return m_imp ; } +} ; + +// Class: Signal1 +// Description: Part of the slot/signal system. +// +template +class Signal1 : public noncopyable +{ + Slot1

    m_slot ; +public: + Signal1() {} + void emit( P p ) { m_slot.callback( p ) ; } + void connect( Slot1

    slot ) { SignalImp::check(m_slot.base()) ; m_slot = slot ; } + void disconnect() { m_slot = Slot1

    () ; } +} ; + +// Function: slot +// Description: Part of the slot/signal system. +// +template +inline +Slot1

    slot( T & object , void (T::*fn)(P) ) +{ + return Slot1

    ( new SlotImp1(object,fn) , SlotOp1::callback ) ; +} + +// === + +// Class: SlotImp2 +// Description: Part of the slot/signal system. +// +template +class SlotImp2 : public SlotBase +{ + T & m_object ; + void (T::*m_fn)( P1 , P2 ) ; +public: + SlotImp2( T & object , void (T::*fn)(P1,P2) ) : m_object(object) , m_fn(fn) {} + void callback( P1 p1 , P2 p2 ) { (m_object.*m_fn)(p1,p2) ; } +} ; + +// Class: SlotOp2 +// Description: Part of the slot/signal system. +// +template +class SlotOp2 +{ +public: + static void callback( SlotBase * imp , P1 p1 , P2 p2 ) + { static_cast*>(imp)->callback( p1 , p2 ) ; } +} ; + +// Class: Slot2 +// Description: Part of the slot/signal system. +// +template +class Slot2 +{ + SlotBase * m_imp ; + void (*m_op)( SlotBase * , P1 , P2 ) ; +public: + Slot2() : m_imp(0) , m_op(0) {} + Slot2( SlotBase * imp , void (*op)(SlotBase*,P1,P2) ) : m_imp(imp) , m_op(op) {} + ~Slot2() { if( m_imp ) m_imp->down() ; } + void callback( P1 p1 , P2 p2 ) { if( m_imp ) (*m_op)( m_imp , p1 , p2 ) ; } + Slot2( const Slot2 & other ) : m_imp(other.m_imp) , m_op(other.m_op) { if(m_imp) m_imp->up() ; } + void swap( Slot2 & rhs ) { swap_(m_imp,rhs.m_imp) ; swap_(m_op,rhs.m_op) ; } + void operator=( const Slot2 & rhs ) { Slot2 tmp(rhs) ; swap(tmp) ; } + const SlotBase * base() const { return m_imp ; } +} ; + +// Class: Signal2 +// Description: Part of the slot/signal system. +// +template +class Signal2 : public noncopyable +{ + Slot2 m_slot ; +public: + Signal2() {} + void emit( P1 p1 , P2 p2 ) { m_slot.callback( p1 , p2 ) ; } + void connect( Slot2 slot ) { SignalImp::check(m_slot.base()) ; m_slot = slot ; } + void disconnect() { m_slot = Slot2() ; } +} ; + +// Function: slot +// Description: Part of the slot/signal system. +// +template +inline +Slot2 slot( T & object , void (T::*fn)(P1,P2) ) +{ + return Slot2( new SlotImp2(object,fn) , SlotOp2::callback ) ; +} + +// === + +// Class: SlotImp3 +// Description: Part of the slot/signal system. +// +template +class SlotImp3 : public SlotBase +{ + T & m_object ; + void (T::*m_fn)( P1 , P2 , P3 ) ; +public: + SlotImp3( T & object , void (T::*fn)(P1,P2,P3) ) : m_object(object) , m_fn(fn) {} + void callback( P1 p1 , P2 p2 , P3 p3 ) { (m_object.*m_fn)(p1,p2,p3) ; } +} ; + +// Class: SlotOp3 +// Description: Part of the slot/signal system. +// +template +class SlotOp3 +{ +public: + static void callback( SlotBase * imp , P1 p1 , P2 p2 , P3 p3 ) + { static_cast*>(imp)->callback( p1 , p2 , p3 ) ; } +} ; + +// Class: Slot3 +// Description: Part of the slot/signal system. +// +template +class Slot3 +{ + SlotBase * m_imp ; + void (*m_op)( SlotBase * , P1 , P2 , P3 ) ; +public: + Slot3() : m_imp(0) , m_op(0) {} + Slot3( SlotBase * imp , void (*op)(SlotBase*,P1,P2,P3) ) : m_imp(imp) , m_op(op) {} + ~Slot3() { if( m_imp ) m_imp->down() ; } + void callback( P1 p1 , P2 p2 , P3 p3 ) { if( m_imp ) (*m_op)( m_imp , p1 , p2 , p3 ) ; } + Slot3( const Slot3 & other ) : m_imp(other.m_imp) , m_op(other.m_op) { if(m_imp) m_imp->up() ; } + void swap( Slot3 & rhs ) { swap_(m_imp,rhs.m_imp) ; swap_(m_op,rhs.m_op) ; } + void operator=( const Slot3 & rhs ) { Slot3 tmp(rhs) ; swap(tmp) ; } + const SlotBase * base() const { return m_imp ; } +} ; + +// Class: Signal3 +// Description: Part of the slot/signal system. +// +template +class Signal3 : public noncopyable +{ + Slot3 m_slot ; +public: + Signal3() {} + void emit( P1 p1 , P2 p2 , P3 p3 ) { m_slot.callback( p1 , p2 , p3 ) ; } + void connect( Slot3 slot ) { SignalImp::check(m_slot.base()) ; m_slot = slot ; } + void disconnect() { m_slot = Slot3() ; } +} ; + +// Function: slot +// Description: Part of the slot/signal system. +// +template +inline +Slot3 slot( T & object , void (T::*fn)(P1,P2,P3) ) +{ + return Slot3( new SlotImp3(object,fn) , SlotOp3::callback ) ; +} + +} // namespace + +#endif + diff --git a/src/glib/gstatemachine.h b/src/glib/gstatemachine.h index 251aca9..afdcc1c 100644 --- a/src/glib/gstatemachine.h +++ b/src/glib/gstatemachine.h @@ -152,7 +152,7 @@ private: Transition(State s1,State s2,Action a,State s3) : from(s1) , to(s2) , alt(s3) , action(a) {} } ; - typedef std::multimap Map ; + typedef std::multimap Map ; Map m_map ; State m_state ; State m_end ; diff --git a/src/glib/gstr.cpp b/src/glib/gstr.cpp index 4659acd..b65a32b 100644 --- a/src/glib/gstr.cpp +++ b/src/glib/gstr.cpp @@ -115,7 +115,7 @@ bool G::Str::isUShort( const std::string & s ) { try { - (void) toUShort(s) ; + G_IGNORE toUShort(s) ; } catch( Overflow & ) { @@ -132,7 +132,7 @@ bool G::Str::isUInt( const std::string & s ) { try { - (void) toUInt(s) ; + G_IGNORE toUInt(s) ; } catch( Overflow & ) { @@ -149,7 +149,7 @@ bool G::Str::isULong( const std::string & s ) { try { - (void) toULong(s) ; + G_IGNORE toULong(s) ; } catch( Overflow & ) { @@ -238,7 +238,7 @@ void G::Str::toLower( std::string &s ) { for( std::string::iterator p = s.begin() ; p != s.end() ; ++p ) { - *p = ::tolower( *p ) ; + *p = static_cast( ::tolower(*p) ) ; } } @@ -253,7 +253,7 @@ void G::Str::toUpper( std::string &s ) { for( std::string::iterator p = s.begin() ; p != s.end() ; ++p ) { - *p = ::toupper( *p ) ; + *p = static_cast( ::toupper(*p) ) ; } } diff --git a/src/glib/gstr.h b/src/glib/gstr.h index 8f4dc6c..7898f1c 100644 --- a/src/glib/gstr.h +++ b/src/glib/gstr.h @@ -45,7 +45,6 @@ class G::Str public: G_EXCEPTION( Overflow , "conversion error: over/underflow" ) ; G_EXCEPTION( InvalidFormat, "conversion error: invalid format" ) ; - typedef std::vector StringArray ; static bool replace( std::string &s , const std::string &from , const std::string &to , @@ -207,7 +206,7 @@ public: bool discard_bogus_escapes = true ) ; // Overload for vector. - static std::string join( const G::Strings & strings , const std::string & sep ) ; + static std::string join( const Strings & strings , const std::string & sep ) ; // Concatenates a set of strings. static std::string join( const StringArray & strings , const std::string & sep ) ; diff --git a/src/glib/gstrings.h b/src/glib/gstrings.h index 8a9e0f8..8bcffa7 100644 --- a/src/glib/gstrings.h +++ b/src/glib/gstrings.h @@ -24,8 +24,10 @@ #ifndef G_STRINGS_H #define G_STRINGS_H +#include "gdef.h" #include #include +#include namespace G { @@ -34,7 +36,12 @@ namespace G // Description: A std::list of std::strings. // See also: Str // -typedef std::list Strings ; +typedef std::list Strings ; + +// Typedef: StringArray +// Description: A std::vector of std::strings. +// +typedef std::vector StringArray ; } diff --git a/src/glib/gtime.cpp b/src/glib/gtime.cpp index 8dafdcb..1354f98 100644 --- a/src/glib/gtime.cpp +++ b/src/glib/gtime.cpp @@ -80,7 +80,7 @@ unsigned int G::Time::seconds() const return m_ss ; } -std::string G::Time::hhmmss( const char * sep ) +std::string G::Time::hhmmss( const char * sep ) const { if( sep == NULL ) sep = "" ; std::ostringstream ss ; @@ -88,7 +88,7 @@ std::string G::Time::hhmmss( const char * sep ) return ss.str() ; } -std::string G::Time::hhmm( const char * sep ) +std::string G::Time::hhmm( const char * sep ) const { if( sep == NULL ) sep = "" ; std::ostringstream ss ; @@ -96,3 +96,11 @@ std::string G::Time::hhmm( const char * sep ) return ss.str() ; } +std::string G::Time::ss() const +{ + std::ostringstream ss ; + ss << (m_ss/10U) << (m_ss%10U) ; + return ss.str() ; +} + + diff --git a/src/glib/gtime.h b/src/glib/gtime.h index f40c39a..94db8a2 100644 --- a/src/glib/gtime.h +++ b/src/glib/gtime.h @@ -44,17 +44,17 @@ public: class LocalTime // An overload discriminator class for Time constructors. {} ; + Time() ; + // Constructor, using UTC, for now. + explicit Time( const G::DateTime::BrokenDownTime & tm ) ; // Constructor for the given broken-down time. explicit Time( G::DateTime::EpochTime t ) ; - // Constructor for the given epoch time. - - Time() ; - // Constructor for now. + // Constructor, using UTC, for the given epoch time. Time( G::DateTime::EpochTime t , const LocalTime & ) ; - // Localtime constructor for the given epoch time. + // Constructor, using the local timezone, for the given epoch time. explicit Time( const LocalTime & ) ; // Localtime constructor for now. @@ -68,12 +68,15 @@ public: unsigned int seconds() const ; // Returns the seconds (0 <= s <= 61 [sic]). - std::string hhmmss( const char * sep = NULL ) ; + std::string hhmmss( const char * sep = NULL ) const ; // Returns a hhmmss string. - std::string hhmm( const char * sep = NULL ) ; + std::string hhmm( const char * sep = NULL ) const ; // Returns a hhmm string. + std::string ss() const ; + // Returns the seconds as a two-digit decimal seconds. + private: unsigned int m_hh ; unsigned int m_mm ; diff --git a/src/glib/md5c.c b/src/glib/md5c.c index a7b442f..77a628b 100644 --- a/src/glib/md5c.c +++ b/src/glib/md5c.c @@ -1,22 +1,23 @@ -// -// Copyright (C) 2001-2003 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. -// -// === +/* + Copyright (C) 2001-2003 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. + +*/ + /* MD5C.C - RSA Data Security, Inc., MD5 message-digest algorithm */ diff --git a/src/gnet/Makefile.am b/src/gnet/Makefile.am index 2743526..2231e6a 100644 --- a/src/gnet/Makefile.am +++ b/src/gnet/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# EXTRA_DIST=\ gclient_win32.cpp \ @@ -24,7 +25,9 @@ EXTRA_DIST=\ glocal_win32.cpp \ grequest.cpp \ gresolve_win32.cpp \ - gsocket_win32.cpp + gsocket_win32.cpp \ + gaddress_ipv6.cpp \ + gresolve_ipv6.cpp INCLUDES = -I$(top_srcdir)/lib/$(COMPILER_VERSION) -I$(top_srcdir)/src/glib noinst_LIBRARIES = libgnet.a libgnet_a_SOURCES = gaddress_ipv4.cpp \ diff --git a/src/gnet/Makefile.in b/src/gnet/Makefile.in index dc04fe7..fc07fdc 100644 --- a/src/gnet/Makefile.in +++ b/src/gnet/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ @@ -116,7 +100,9 @@ EXTRA_DIST = \ glocal_win32.cpp \ grequest.cpp \ gresolve_win32.cpp \ - gsocket_win32.cpp + gsocket_win32.cpp \ + gaddress_ipv6.cpp \ + gresolve_ipv6.cpp INCLUDES = -I$(top_srcdir)/lib/$(COMPILER_VERSION) -I$(top_srcdir)/src/glib noinst_LIBRARIES = libgnet.a diff --git a/src/gnet/gaddress.h b/src/gnet/gaddress.h index a6405b1..2195c07 100644 --- a/src/gnet/gaddress.h +++ b/src/gnet/gaddress.h @@ -52,6 +52,8 @@ public: G_EXCEPTION( BadString , "invalid ip address string" ) ; class Localhost // An overload discriminator class for GNet::Address. {} ; + class Broadcast // An overload discriminator class for GNet::Address. + {} ; Address( const Address &addr ) ; // Copy constructor. @@ -92,6 +94,11 @@ public: // the given port number. Throws an exception if // an invalid port number. See also: validPort() + Address( unsigned int port , Broadcast ) ; + // Constructor for a local INADDR_BROADCAST address with + // the given port number. Throws an exception if + // an invalid port number. See also: validPort() + explicit Address( const std::string & display_string ) ; // Constructor taking a string originally obtained // from displayString(). @@ -100,8 +107,8 @@ public: // // See also validString(). - Address( const std::string & host_or_ip , unsigned int port ) ; - // Constructor taking a host-name/ip-address and + Address( const std::string & ip , unsigned int port ) ; + // Constructor taking an ip-address and // a port number. // // Throws an exception if an invalid string. @@ -113,6 +120,10 @@ public: // Returns an invalid address. Should only be // needed by socket and resolver classes. + static Address broadcastAddress( unsigned int port ) ; + // Returns a broadcast address. Only useful + // for datagram sockets. + static Address localhost( unsigned int port = 0U ) ; // Returns a localhost ("loopback") address. // This is a convenience function as an diff --git a/src/gnet/gaddress_ipv4.cpp b/src/gnet/gaddress_ipv4.cpp index 9a9754f..a78b7de 100644 --- a/src/gnet/gaddress_ipv4.cpp +++ b/src/gnet/gaddress_ipv4.cpp @@ -24,7 +24,6 @@ #include "gdef.h" #include "gnet.h" #include "gaddress.h" -#include "gconvert.h" #include "gstrings.h" #include "gstr.h" #include "gassert.h" @@ -39,12 +38,14 @@ class GNet::AddressImp { public: typedef sockaddr_in address_type ; + typedef union { address_type specific ; struct sockaddr general ; } Sockaddr ; explicit AddressImp( unsigned int port ) ; // (not in_port_t -- see validPort(), setPort() etc) explicit AddressImp( const servent & s ) ; explicit AddressImp( const std::string & s ) ; AddressImp( const std::string & s , unsigned int port ) ; AddressImp( unsigned int port , Address::Localhost ) ; + AddressImp( unsigned int port , Address::Broadcast ) ; AddressImp( const hostent & h , unsigned int port ) ; AddressImp( const hostent & h , const servent & s ) ; AddressImp( const sockaddr * addr , size_t len ) ; @@ -67,7 +68,7 @@ public: private: void init() ; - void set( const sockaddr * specific ) ; + void set( const sockaddr * general ) ; bool setAddress( const std::string & display_string , std::string & reason ) ; static bool validPart( const std::string & s ) ; static bool validPortNumber( const std::string & s ) ; @@ -105,6 +106,13 @@ GNet::AddressImp::AddressImp( unsigned int port , Address::Localhost ) setPort( port ) ; } +GNet::AddressImp::AddressImp( unsigned int port , Address::Broadcast ) +{ + init() ; + m_inet.sin_addr.s_addr = htonl(INADDR_BROADCAST); + setPort( port ) ; +} + GNet::AddressImp::AddressImp( const hostent & h , unsigned int port ) { init() ; @@ -186,7 +194,7 @@ void GNet::AddressImp::setPort( unsigned int port ) if( ! validPort(port) ) throw Address::Error( "invalid port number" ) ; - const g_port_t in_port = G::Convert(port) ; + const g_port_t in_port = static_cast(port) ; m_inet.sin_port = htons( in_port ) ; } @@ -324,9 +332,11 @@ sockaddr * GNet::AddressImp::raw() return reinterpret_cast(&m_inet) ; } -void GNet::AddressImp::set( const sockaddr * specific ) +void GNet::AddressImp::set( const sockaddr * general ) { - m_inet = *(reinterpret_cast(specific)) ; + Sockaddr u ; + u.general = * general ; + m_inet = u.specific ; } // === @@ -337,6 +347,18 @@ GNet::Address GNet::Address::invalidAddress() return Address( 0U ) ; } +//static +GNet::Address GNet::Address::localhost( unsigned int port ) +{ + return Address( port , Localhost() ) ; +} + +//static +GNet::Address GNet::Address::broadcastAddress( unsigned int port ) +{ + return Address( port , Broadcast() ) ; +} + GNet::Address::Address( unsigned int port ) : m_imp( new AddressImp(port) ) { @@ -347,6 +369,11 @@ GNet::Address::Address( unsigned int port , Localhost dummy ) : { } +GNet::Address::Address( unsigned int port , Broadcast dummy ) : + m_imp( new AddressImp(port,dummy) ) +{ +} + GNet::Address::Address( const hostent & h , unsigned int port ) : m_imp( new AddressImp(h,port) ) { @@ -451,9 +478,3 @@ bool GNet::Address::validPort( unsigned int port ) return AddressImp::validPort( port ) ; } -//static -GNet::Address GNet::Address::localhost( unsigned int port ) -{ - return Address( port , Localhost() ) ; -} - diff --git a/src/gnet/gaddress_ipv6.cpp b/src/gnet/gaddress_ipv6.cpp new file mode 100644 index 0000000..9cd42b6 --- /dev/null +++ b/src/gnet/gaddress_ipv6.cpp @@ -0,0 +1,469 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gaddress_ipv6.cpp +// + +#include "gdef.h" +#include "gnet.h" +#include "gaddress.h" +#include "gstrings.h" +#include "gstr.h" +#include "gassert.h" +#include "gdebug.h" +#include +#include + +// Class: GNet::AddressImp +// Description: A pimple-pattern implementation class for GNet::Address. +// +class GNet::AddressImp +{ +public: + typedef sockaddr_in6 address_type ; + typedef union { address_type specific ; struct sockaddr general ; } Sockaddr ; + + explicit AddressImp( unsigned int port ) ; // (not in_port_t -- see validPort(), setPort() etc) + explicit AddressImp( const servent & s ) ; + explicit AddressImp( const std::string & s ) ; + AddressImp( const std::string & s , unsigned int port ) ; + AddressImp( unsigned int port , Address::Localhost ) ; + AddressImp( const hostent & h , unsigned int port ) ; + AddressImp( const hostent & h , const servent & s ) ; + AddressImp( const sockaddr * addr , size_t len ) ; + AddressImp( const AddressImp & other ) ; + + const sockaddr * raw() const ; + sockaddr * raw() ; + + unsigned int port() const ; + void setPort( unsigned int port ) ; + + static bool validString( const std::string & s , std::string * reason_p = NULL ) ; + static bool validPort( unsigned int port ) ; + + bool same( const AddressImp & other ) const ; + bool sameHost( const AddressImp & other ) const ; + + std::string displayString() const ; + std::string hostString() const ; + +private: + void init() ; + void set( const sockaddr * general ) ; + bool setAddress( const std::string & display_string , std::string & reason ) ; + + static bool validPortNumber( const std::string & s ) ; + static bool validNumber( const std::string & s ) ; + void setHost( const hostent & h ) ; + static bool sameAddr( const ::in6_addr & a , const ::in6_addr & b ) ; + +private: + address_type m_inet ; + static char m_port_separator ; +} ; + +char GNet::AddressImp::m_port_separator = ':' ; + +void GNet::AddressImp::init() +{ + ::memset( &m_inet, 0, sizeof(m_inet) ); + m_inet.sin6_family = AF_INET6 ; + m_inet.sin6_flowinfo = 0 ; + m_inet.sin6_port = 0 ; + + #if defined( SIN6_LEN ) + m_inet.sin6_len = sizeof(m_inet) ; + #endif +} + +GNet::AddressImp::AddressImp( unsigned int port ) +{ + init() ; + m_inet.sin6_addr = in6addr_any ; + setPort( port ) ; +} + +GNet::AddressImp::AddressImp( unsigned int port , Address::Localhost ) +{ + init() ; + m_inet.sin6_addr = in6addr_loopback ; + setPort( port ) ; +} + +GNet::AddressImp::AddressImp( const hostent & h , unsigned int port ) +{ + init() ; + setHost( h ) ; + setPort( port ) ; +} + +GNet::AddressImp::AddressImp( const hostent & h , const servent & s ) +{ + init() ; + setHost( h ) ; + m_inet.sin6_port = s.s_port ; +} + +GNet::AddressImp::AddressImp( const servent & s ) +{ + init() ; + m_inet.sin6_addr = in6addr_any ; + m_inet.sin6_port = s.s_port ; +} + +GNet::AddressImp::AddressImp( const sockaddr * addr , size_t len ) +{ + init() ; + + if( addr == NULL ) + throw Address::Error() ; + + if( addr->sa_family != AF_INET6 || len != sizeof(m_inet.sin6_addr) ) + throw Address::BadFamily( std::stringstream() << addr->sa_family ) ; + + set( addr ) ; +} + +GNet::AddressImp::AddressImp( const AddressImp & other ) +{ + m_inet = other.m_inet ; +} + +GNet::AddressImp::AddressImp( const std::string & s , unsigned int port ) +{ + init() ; + + std::string reason ; + if( ! setAddress( s + m_port_separator + "0" , reason ) ) + throw Address::BadString( reason + ": " + s ) ; + + setPort( port ) ; +} + +GNet::AddressImp::AddressImp( const std::string & s ) +{ + init() ; + + std::string reason ; + if( ! setAddress( s , reason ) ) + throw Address::BadString( reason + ": " + s ) ; +} + +bool GNet::AddressImp::setAddress( const std::string & display_string , std::string & reason ) +{ + if( !validString(display_string,&reason) ) + return false ; + + const size_t pos = display_string.rfind(m_port_separator) ; + std::string port_part = display_string.substr(pos+1U) ; + std::string host_part = display_string.substr(0U,pos) ; + + m_inet.sin6_family = AF_INET6 ; + + void * vp = & m_inet.sin6_addr ; + int rc = ::inet_pton( AF_INET6 , host_part.c_str() , vp ) ; + if( rc != 1 ) + return false ; // never gets here + + setPort( G::Str::toUInt(port_part) ) ; + + // sanity check + { + std::string s1 = displayString() ; G::Str::toLower(s1) ; + std::string s2 = display_string ; G::Str::toLower(s2) ; + if( s1 != s2 ) + { + G_ERROR( "GNet::AddressImp::setAddress: \"" << s1 << "\" != \"" << s2 << "\"" ) ; + throw Address::Error( "bad address string conversion" ) ; + } + } + + return true ; +} + +void GNet::AddressImp::setPort( unsigned int port ) +{ + if( ! validPort(port) ) + throw Address::Error( "invalid port number" ) ; + + const g_port_t in_port = static_cast(port) ; + m_inet.sin6_port = htons( in_port ) ; +} + +void GNet::AddressImp::setHost( const hostent & h ) +{ + if( h.h_addrtype != AF_INET6 || h.h_addr_list[0U] == NULL ) + throw Address::BadFamily( "setHost" ) ; + + const char * first = h.h_addr_list[0U] ; + const in6_addr * raw = reinterpret_cast(first) ; + m_inet.sin6_addr = *raw ; +} + +std::string GNet::AddressImp::displayString() const +{ + std::stringstream ss ; + ss << hostString() ; + ss << m_port_separator << port() ; + return ss.str() ; +} + +std::string GNet::AddressImp::hostString() const +{ + char buffer[INET6_ADDRSTRLEN+1U] ; + const void * vp = & m_inet.sin6_addr ; + const char * p = ::inet_ntop( AF_INET6 , vp , buffer , sizeof(buffer) ) ; + if( p == NULL ) + throw Address::Error( "inet_ntop() failure" ) ; + return std::string(buffer) ; +} + +//static +bool GNet::AddressImp::validPort( unsigned int port ) +{ + return port <= 0xFFFFU ; // port numbers are now explicitly 16 bits, not short ints +} + +//static +bool GNet::AddressImp::validString( const std::string & s , std::string * reason_p ) +{ + std::string buffer ; + if( reason_p == NULL ) reason_p = &buffer ; + std::string & reason = *reason_p ; + + const size_t pos = s.rfind(m_port_separator) ; + if( pos == std::string::npos ) + { + reason = "no port separator" ; + return false ; + } + + std::string port_part = s.substr(pos+1U) ; + if( !validPortNumber(port_part) ) + { + reason = "invalid port" ; + return false ; + } + + std::string host_part = s.substr(0U,pos) ; + address_type inet ; + void * vp = & inet.sin6_addr ; + int rc = ::inet_pton( AF_INET6 , host_part.c_str() , vp ) ; + const bool ok = rc == 1 ; + if( !ok ) + { + reason = "invalid format" ; + return false ; + } + + return true ; +} + +//static +bool GNet::AddressImp::validPortNumber( const std::string & s ) +{ + return validNumber(s) && G::Str::isUInt(s) && validPort(G::Str::toUInt(s)) ; +} + +//static +bool GNet::AddressImp::validNumber( const std::string & s ) +{ + return s.length() != 0U && G::Str::isNumeric(s) ; +} + +bool GNet::AddressImp::same( const AddressImp & other ) const +{ + return + m_inet.sin6_family == other.m_inet.sin6_family && + m_inet.sin6_family == AF_INET6 && + sameAddr( m_inet.sin6_addr , other.m_inet.sin6_addr ) && + m_inet.sin6_port == other.m_inet.sin6_port ; +} + +bool GNet::AddressImp::sameHost( const AddressImp & other ) const +{ + return + m_inet.sin6_family == other.m_inet.sin6_family && + m_inet.sin6_family == AF_INET6 && + sameAddr( m_inet.sin6_addr , other.m_inet.sin6_addr ) ; +} + +//static +bool GNet::AddressImp::sameAddr( const ::in6_addr & a , const ::in6_addr & b ) +{ + for( size_t i = 0 ; i < 16U ; i++ ) + { + if( a.s6_addr[i] != b.s6_addr[i] ) + return false ; + } + return true ; +} + +unsigned int GNet::AddressImp::port() const +{ + return ntohs( m_inet.sin6_port ) ; +} + +const sockaddr * GNet::AddressImp::raw() const +{ + return reinterpret_cast(&m_inet) ; +} + +sockaddr * GNet::AddressImp::raw() +{ + return reinterpret_cast(&m_inet) ; +} + +void GNet::AddressImp::set( const sockaddr * general ) +{ + Sockaddr u ; + u.general = * general ; + m_inet = u.specific ; +} + +// === + +//static +GNet::Address GNet::Address::invalidAddress() +{ + return Address( 0U ) ; +} + +GNet::Address::Address( unsigned int port ) : + m_imp( new AddressImp(port) ) +{ +} + +GNet::Address::Address( unsigned int port , Localhost dummy ) : + m_imp( new AddressImp(port,dummy) ) +{ +} + +GNet::Address::Address( const hostent & h , unsigned int port ) : + m_imp( new AddressImp(h,port) ) +{ +} + +GNet::Address::Address( const hostent & h , const servent & s ) : + m_imp( new AddressImp(h,s) ) +{ +} + +GNet::Address::Address( const servent & s ) : + m_imp( new AddressImp(s) ) +{ +} + +GNet::Address::Address( const sockaddr *addr , int len ) : + m_imp( new AddressImp(addr,len) ) +{ +} + +GNet::Address::Address( const Address & other ) : + m_imp( new AddressImp(*other.m_imp) ) +{ +} + +GNet::Address::Address( const std::string & s ) : + m_imp( new AddressImp(s) ) +{ +} + +GNet::Address::Address( const std::string & s , unsigned int port ) : + m_imp( new AddressImp(s,port) ) +{ +} + +GNet::Address::~Address() +{ + delete m_imp ; +} + +void GNet::Address::setPort( unsigned int port ) +{ + m_imp->setPort( port ) ; +} + +void GNet::Address::operator=( const Address & addr ) +{ + delete m_imp ; + m_imp = NULL ; + m_imp = new AddressImp(*addr.m_imp) ; +} + +bool GNet::Address::operator==( const Address & other ) const +{ + return m_imp->same(*other.m_imp) ; +} + +bool GNet::Address::sameHost( const Address & other ) const +{ + return m_imp->sameHost(*other.m_imp) ; +} + +std::string GNet::Address::displayString( bool with_port ) const +{ + return with_port ? m_imp->displayString() : m_imp->hostString() ; +} + +std::string GNet::Address::hostString() const +{ + return m_imp->hostString() ; +} + +//static +bool GNet::Address::validString( const std::string & s , std::string * reason_p ) +{ + return AddressImp::validString( s , reason_p ) ; +} + +sockaddr * GNet::Address::address() +{ + return m_imp->raw() ; +} + +const sockaddr * GNet::Address::address() const +{ + return m_imp->raw() ; +} + +int GNet::Address::length() const +{ + return sizeof(AddressImp::address_type) ; +} + +unsigned int GNet::Address::port() const +{ + return m_imp->port() ; +} + +//static +bool GNet::Address::validPort( unsigned int port ) +{ + return AddressImp::validPort( port ) ; +} + +//static +GNet::Address GNet::Address::localhost( unsigned int port ) +{ + return Address( port , Localhost() ) ; +} + diff --git a/src/gnet/gclient.cpp b/src/gnet/gclient.cpp index a5b671a..1fd2201 100644 --- a/src/gnet/gclient.cpp +++ b/src/gnet/gclient.cpp @@ -49,7 +49,7 @@ namespace GNet // Class: GNet::ClientResolver // Description: A resolver class which calls ClientImp::resolveCon() when done. // -class GNet::ClientResolver : public GNet:: Resolver +class GNet::ClientResolver : public GNet::Resolver { private: ClientImp & m_client_imp ; @@ -75,7 +75,7 @@ GNet::ClientResolver::ClientResolver( ClientImp & imp ) : // Class: GNet::ClientImp // Description: A pimple-pattern implementation class for GClient. // -class GNet::ClientImp : public GNet:: EventHandler +class GNet::ClientImp : public GNet::EventHandler { private: ClientResolver m_resolver ; diff --git a/src/gnet/gclient.h b/src/gnet/gclient.h index 0d13bf3..98ee608 100644 --- a/src/gnet/gclient.h +++ b/src/gnet/gclient.h @@ -44,7 +44,7 @@ namespace GNet // issues, and it reads incoming data. There is some support for flow-control // issues when writing data out to the server. // -class GNet::Client : public GNet:: Connection +class GNet::Client : public GNet::Connection { public: explicit Client( bool priviledged = false , bool quit_on_disconnect = false ) ; diff --git a/src/gnet/geventhandler.cpp b/src/gnet/geventhandler.cpp index 26ccd66..94a5713 100644 --- a/src/gnet/geventhandler.cpp +++ b/src/gnet/geventhandler.cpp @@ -151,9 +151,7 @@ void GNet::EventHandlerList::unlock() m_lock-- ; if( m_lock == 0U && m_copied ) { - G_DEBUG( "GNet::EventHandlerList::unlock: " << m_type << "-list: " - << "commiting deferred changes: before=" << asString(m_list) - << ": after=" << asString(m_copy) ) ; + //G_DEBUG( "GNet::EventHandlerList::unlock: " << m_type << "-list: commiting: " << asString(m_copy) ) ; m_list = m_copy ; m_copied = false ; } diff --git a/src/gnet/geventhandler.h b/src/gnet/geventhandler.h index 91df8c0..183971c 100644 --- a/src/gnet/geventhandler.h +++ b/src/gnet/geventhandler.h @@ -96,7 +96,7 @@ GNet::EventHandlerListItem::EventHandlerListItem( Descriptor fd , EventHandler * namespace GNet { - typedef std::list< EventHandlerListItem GAllocator(EventHandlerListItem) > + typedef std::list EventHandlerListImp ; } diff --git a/src/gnet/geventloop_unix.cpp b/src/gnet/geventloop_unix.cpp index ceb7b6c..8ca2d2d 100644 --- a/src/gnet/geventloop_unix.cpp +++ b/src/gnet/geventloop_unix.cpp @@ -46,7 +46,7 @@ namespace GNet // Description: A concrete implementation of GNet::EventLoop using // ::select() in the implementation. // -class GNet::Select : public GNet:: EventLoop , public G::noncopyable +class GNet::Select : public GNet::EventLoop , public G::noncopyable { public: G_EXCEPTION( Error , "select() error" ) ; @@ -62,6 +62,7 @@ public: virtual void dropRead( Descriptor fd ) ; virtual void dropWrite( Descriptor fd ) ; virtual void dropException( Descriptor fd ) ; + private: void runOnce() ; virtual void setTimeout( G::DateTime::EpochTime t ) ; @@ -84,9 +85,10 @@ public: EventHandlerList & m_list ; explicit Lock( EventHandlerList & list ) ; ~Lock() ; + private: - Lock( const Lock & ) ; - void operator=( const Lock & ) ; + Lock( const Lock & ) ; // not implemented + void operator=( const Lock & ) ; // not implemented } ; // Class: GNet::FdSet @@ -100,7 +102,7 @@ public: static void raiseEvents( fd_set * set , EventHandlerList & list , void (EventHandler::*method)() , const char * type ) ; private: - FdSet() ; + FdSet() ; // not implemented } ; // === @@ -123,6 +125,8 @@ GNet::Lock::~Lock() //static int GNet::FdSet::init( int n , fd_set * set , const EventHandlerList & list ) { + // copy the event-handler-list into the fd-set + FD_ZERO( set ) ; const EventHandlerList::Iterator end = list.end() ; for( EventHandlerList::Iterator p = list.begin() ; p != end ; ++p ) @@ -139,6 +143,8 @@ int GNet::FdSet::init( int n , fd_set * set , const EventHandlerList & list ) void GNet::FdSet::raiseEvents( fd_set * set , EventHandlerList & list , void (EventHandler::*method)() , const char * /*type*/ ) { + // call the event-handler for fds in fd-set which are ISSET() + GNet::Lock lock( list ) ; // since event handlers may change the list while we iterate const EventHandlerList::Iterator end = list.end() ; for( EventHandlerList::Iterator p = list.begin() ; p != end ; ++p ) @@ -157,6 +163,7 @@ void GNet::FdSet::raiseEvents( fd_set * set , EventHandlerList & list , GNet::EventLoop * GNet::EventLoop::create() { + // factory-method pattern return new Select ; } @@ -202,11 +209,15 @@ void GNet::Select::quit() void GNet::Select::runOnce() { + // build fd-sets from handler lists + // int n = 1 ; fd_set r ; n = FdSet::init( n , &r , m_read_list ) ; fd_set w ; n = FdSet::init( n , &w , m_write_list ) ; fd_set e ; n = FdSet::init( n , &e , m_exception_list ) ; + // get a timeout interval() from TimerList + // Timeval timeout ; Timeval * timeout_p = NULL ; if( TimerList::instance(TimerList::NoThrow()) != NULL ) @@ -217,6 +228,8 @@ void GNet::Select::runOnce() timeout_p = infinite ? NULL : &timeout ; } + // debug + // const bool debug = false ; if( debug ) { @@ -227,23 +240,26 @@ void GNet::Select::runOnce() << "timeout=" << (timeout_p?G::Str::fromUInt(timeout_p->tv_sec):std::string("infinite")) ) ; } + // do the select() + // int rc = ::select( n , &r , &w , &e , timeout_p ) ; + if( rc < 0 ) + throw Error() ; + + // call the event handlers + // if( rc == 0 ) { G_DEBUG( "GNet::Select::runOnce: select() timeout" ) ; TimerList::instance().doTimeouts() ; } - else if( rc > 0 ) + else // rc > 0 { G_DEBUG( "GNet::Select::runOnce: detected event(s) on " << rc << " fd(s)" ) ; FdSet::raiseEvents( &r , m_read_list , & EventHandler::readEvent , "read" ) ; FdSet::raiseEvents( &w , m_write_list , & EventHandler::writeEvent , "write" ) ; FdSet::raiseEvents( &e , m_exception_list , & EventHandler::exceptionEvent , "exception" ) ; } - else - { - throw Error() ; - } } void GNet::Select::addRead( Descriptor fd , EventHandler & handler ) diff --git a/src/gnet/geventloop_win32.cpp b/src/gnet/geventloop_win32.cpp index fccfcdd..464179b 100644 --- a/src/gnet/geventloop_win32.cpp +++ b/src/gnet/geventloop_win32.cpp @@ -49,7 +49,7 @@ namespace GNet // application's main message queue, and these messages have // to be passed on the the WinSock layer. // -class GNet::Winsock : public EventLoop +class GNet::Winsock : public GNet::EventLoop { public: Winsock() ; diff --git a/src/gnet/geventserver.h b/src/gnet/geventserver.h index 6dfe453..8166ea4 100644 --- a/src/gnet/geventserver.h +++ b/src/gnet/geventserver.h @@ -40,7 +40,7 @@ namespace GNet // may be created. // See also: GNet::EventLoop // -class GNet::EventServer : public GNet:: Server +class GNet::EventServer : public GNet::Server { public: explicit EventServer( unsigned int listening_port ) ; diff --git a/src/gnet/gmonitor.cpp b/src/gnet/gmonitor.cpp index c4731d3..a43d046 100644 --- a/src/gnet/gmonitor.cpp +++ b/src/gnet/gmonitor.cpp @@ -35,9 +35,9 @@ class GNet::MonitorImp public: typedef const Client * C_p ; typedef const ServerPeer * S_p ; - typedef std::set Clients ; + typedef std::set Clients ; typedef std::pair ClientInsertion ; - typedef std::set ServerPeers ; + typedef std::set ServerPeers ; typedef std::pair ServerPeerInsertion ; explicit MonitorImp( Monitor & monitor ) ; @@ -87,14 +87,14 @@ void GNet::Monitor::add( const Client & client ) MonitorImp::ClientInsertion rc = m_imp->m_clients.insert( &client ) ; if( rc.second ) m_imp->m_client_adds++ ; - onEvent( "out" , "start" ) ; + m_signal.emit( "out" , "start" ) ; } void GNet::Monitor::remove( const Client & client ) { if( m_imp->m_clients.erase( &client ) ) m_imp->m_client_removes++ ; - onEvent( "out" , "end" ) ; + m_signal.emit( "out" , "end" ) ; } void GNet::Monitor::add( const ServerPeer & peer ) @@ -102,14 +102,14 @@ void GNet::Monitor::add( const ServerPeer & peer ) MonitorImp::ServerPeerInsertion rc = m_imp->m_server_peers.insert( & peer ) ; if( rc.second ) m_imp->m_server_peer_adds++ ; - onEvent( "in" , "start" ) ; + m_signal.emit( "in" , "start" ) ; } void GNet::Monitor::remove( const ServerPeer & peer ) { if( m_imp->m_server_peers.erase( & peer ) ) m_imp->m_server_peer_removes++ ; - onEvent( "in" , "end" ) ; + m_signal.emit( "in" , "end" ) ; } void GNet::Monitor::report( std::ostream & s , const std::string & px , const std::string & eol ) @@ -135,14 +135,14 @@ void GNet::Monitor::report( std::ostream & s , const std::string & px , const st { s << px << "IN: " - << (*p)->localAddress().second.displayString() << " -> " + << (*p)->localAddress().second.displayString() << " <- " << (*p)->peerAddress().second.displayString() << eol ; } } } -void GNet::Monitor::onEvent( const std::string & , const std::string & ) +G::Signal2 & GNet::Monitor::signal() { - ; // default implementation + return m_signal ; } diff --git a/src/gnet/gmonitor.h b/src/gnet/gmonitor.h index cc97db7..89e10c7 100644 --- a/src/gnet/gmonitor.h +++ b/src/gnet/gmonitor.h @@ -25,6 +25,7 @@ #define G_GNET_MONITOR_H #include "gdef.h" +#include "gslot.h" #include "gnet.h" #include "gnoncopyable.h" #include "gclient.h" @@ -70,15 +71,19 @@ public: const std::string & eol = std::string("\n") ) ; // Reports itself onto a stream. -protected: - virtual void onEvent( const std::string & , const std::string & ) ; - // Called when the monitor's state has - // changed. The default implementation - // does nothing. + G::Signal2 & signal() ; + // Provides a callback signal which can be connect()ed + // to a slot. + // + // The signal emits events with two + // string parameters: the first + // is "in" or "out", and the second + // is "start" or "stop". private: static Monitor * m_this ; MonitorImp * m_imp ; + G::Signal2 m_signal ; } ; #endif diff --git a/src/gnet/grequest.h b/src/gnet/grequest.h index 2d09777..6ff5d10 100644 --- a/src/gnet/grequest.h +++ b/src/gnet/grequest.h @@ -89,7 +89,7 @@ private: // Class: GNet::HostRequest // Description: A derivation of GNet::Request used for hostname lookup requests. // -class GNet::HostRequest : public GNet:: Request +class GNet::HostRequest : public GNet::Request { public: HostRequest( std::string host_name , HWND hwnd , unsigned msg ) ; @@ -111,7 +111,7 @@ private: // Class: GNet::ServiceRequest // Description: A derivation of GNet::Request used for service (port) lookup requests. // -class GNet::ServiceRequest : public GNet:: Request +class GNet::ServiceRequest : public GNet::Request { public: ServiceRequest( std::string service_name , bool udp , diff --git a/src/gnet/gresolve.cpp b/src/gnet/gresolve.cpp index f5ebbee..2f3adfc 100644 --- a/src/gnet/gresolve.cpp +++ b/src/gnet/gresolve.cpp @@ -72,7 +72,7 @@ GNet::Resolver::HostInfoPair GNet::Resolver::resolve( const std::string & host_n if( !valid_host ) { G_DEBUG( "GNet::Resolver::resolve: host error: \"" << host_name << "\"" ) ; - return HostInfoPair( HostInfo() , "invalid hostname" ) ; + return HostInfoPair( HostInfo() , std::string("invalid hostname: \"" + host_name + "\"" ) ) ; } std::string error ; diff --git a/src/gnet/gresolve_ipv6.cpp b/src/gnet/gresolve_ipv6.cpp new file mode 100644 index 0000000..573846f --- /dev/null +++ b/src/gnet/gresolve_ipv6.cpp @@ -0,0 +1,78 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gresolve_ipv6.cpp +// + +#include "gdef.h" +#include "gresolve.h" +#include "gdebug.h" +#include "glog.h" + +#if defined( AI_DEFAULT ) +// RFC 2553 + +//static +bool GNet::Resolver::resolveHost( const std::string & host_name , HostInfo & host_info ) +{ + hostent * host = NULL ; + try + { + int error = 0 ; + host = ::getipnodebyname( host_name.c_str() , AF_INET6 , AI_DEFAULT , &error ) ; + if( host != NULL ) + { + host_info.canonical_name = std::string(host->h_name) ; + host_info.address = Address( *host , 0U ) ; + ::freehostent( host ) ; + } + return host != NULL ; + } + catch(...) + { + if( host != NULL ) ::freehostent( host ) ; + throw ; + } +} + +#else +// RFC 2133 (obsolete) + +#include // requires -D_USE_BSD +extern "C" { struct hostent * gethostbyname2( const char * , int ) ; } ; + +//static +bool GNet::Resolver::resolveHost( const std::string & host_name , HostInfo & host_info ) +{ + res_init() ; + _res.options |= RES_USE_INET6 ; + + hostent * host = ::gethostbyname2( host_name.c_str() , AF_INET6 ) ; + if( host != NULL ) + { +G_DEBUG( "GNet::Resolver::resolveHost: canonical name of \"" << host_name << "\" is \"" << host->h_name << "\"" ) ; + host_info.canonical_name = std::string(host->h_name) ; + host_info.address = Address( *host , 0U ) ; + } + return host != NULL ; +} + +#endif + diff --git a/src/gnet/gresolve_unix.cpp b/src/gnet/gresolve_unix.cpp index cf7a127..491ee31 100644 --- a/src/gnet/gresolve_unix.cpp +++ b/src/gnet/gresolve_unix.cpp @@ -33,7 +33,7 @@ // Class: GNet::ResolverImp // Description: A pimple-pattern implementation class for GNet::Resolver. // -class GNet::ResolverImp : public GNet:: EventHandler +class GNet::ResolverImp : public GNet::EventHandler { public: ResolverImp( Resolver & resolver , unsigned int port ) ; diff --git a/src/gnet/gserver.cpp b/src/gnet/gserver.cpp index d36a48b..5461265 100644 --- a/src/gnet/gserver.cpp +++ b/src/gnet/gserver.cpp @@ -29,14 +29,15 @@ #include "gdebug.h" #include "gassert.h" #include "gmemory.h" +#include // std::find() -GNet::ServerPeer::ServerPeer( StreamSocket * s , Address a ) : - m_ref_count(1U) , - m_address(a) , - m_socket(s) +GNet::ServerPeer::ServerPeer( Server::PeerInfo peer_info ) : + m_address(peer_info.m_address) , + m_socket(peer_info.m_socket) , + m_handle(peer_info.m_handle) { - G_ASSERT( m_socket != NULL ) ; - G_DEBUG( "GNet::ServerPeer::ctor: fd " << m_socket->asString() << ": " << m_address.displayString() ) ; + G_ASSERT( m_socket.get() != NULL ) ; + G_DEBUG( "GNet::ServerPeer::ctor: [" << this << "]: fd " << asString() << ": " << m_address.displayString() ) ; m_socket->addReadHandler( *this ) ; m_socket->addExceptionHandler( *this ) ; if( Monitor::instance() ) Monitor::instance()->add(*this) ; @@ -44,11 +45,10 @@ GNet::ServerPeer::ServerPeer( StreamSocket * s , Address a ) : GNet::ServerPeer::~ServerPeer() { - G_DEBUG( "GNet::ServerPeer::dtor: fd " << m_socket->asString() ) ; + G_DEBUG( "GNet::ServerPeer::dtor: [" << this << "]: fd " << asString() ) ; if( Monitor::instance() ) Monitor::instance()->remove(*this) ; + m_handle->reset() ; m_socket->dropReadHandler() ; - delete m_socket ; - m_socket = NULL ; } std::string GNet::ServerPeer::asString() const @@ -58,13 +58,13 @@ std::string GNet::ServerPeer::asString() const GNet::StreamSocket & GNet::ServerPeer::socket() { - G_ASSERT( m_socket != NULL ) ; - return *m_socket ; + G_ASSERT( m_socket.get() != NULL ) ; + return *m_socket.get() ; } void GNet::ServerPeer::readEvent() { - G_DEBUG( "GNet::ServerPeer::readEvent: " << (void*)this ) ; + //G_DEBUG( "GNet::ServerPeer::readEvent: peer=" << this ) ; char buffer[500] ; buffer[0] = '\0' ; @@ -88,7 +88,7 @@ void GNet::ServerPeer::readEvent() void GNet::ServerPeer::exceptionEvent() { - G_DEBUG( "GNet::Server::exceptionEvent: " << (void*)this ) ; + G_DEBUG( "GNet::Server::exceptionEvent: peer=" << this ) ; doDelete() ; } @@ -98,20 +98,9 @@ void GNet::ServerPeer::doDelete() delete this ; } -void GNet::ServerPeer::up() -{ - m_ref_count++ ; -} - -bool GNet::ServerPeer::down() -{ - m_ref_count-- ; - return m_ref_count == 0U ; -} - std::pair GNet::ServerPeer::localAddress() const { - G_ASSERT( m_socket != NULL ) ; + G_ASSERT( m_socket.get() != NULL ) ; return m_socket->getLocalAddress() ; } @@ -132,7 +121,8 @@ GNet::Server::Server( const Address & listening_address ) init( listening_address ) ; } -GNet::Server::Server() +GNet::Server::Server() : + m_cleaned_up(false) { } @@ -143,18 +133,48 @@ void GNet::Server::init( unsigned int listening_port ) void GNet::Server::init( const Address & listening_address ) { + m_cleaned_up = false ; m_socket <<= new StreamSocket ; G_DEBUG( "GNet::Server::init: listening on " << listening_address.displayString() ) ; G::Root claim_root ; if( ! m_socket->bind( listening_address ) ) throw CannotBind( listening_address.displayString() ) ; - if( ! m_socket->listen() ) + if( ! m_socket->listen(3) ) throw CannotListen() ; m_socket->addReadHandler( *this ) ; } GNet::Server::~Server() { + serverCleanup() ; +} + +void GNet::Server::serverCleanup() +{ + try + { + if( ! m_cleaned_up ) + { + m_cleaned_up = true ; + serverCleanupCore() ; + } + } + catch(...) // since always called from dtor + { + } +} + +void GNet::Server::serverCleanupCore() +{ + for( PeerList::iterator p = m_peer_list.begin() ; p != m_peer_list.end() ; ++p ) + { + ServerPeerHandle handle = *p ; + if( handle.peer() != NULL ) + { + G_DEBUG( "GNet::Server::serverCleanupCore: deleting peer: [" << handle.peer() << "]" ) ; + delete handle.peer() ; + } + } } std::pair GNet::Server::address() const @@ -169,8 +189,11 @@ void GNet::Server::readEvent() { // read-event-on-listening-port => new connection to accept - G_DEBUG( "GNet::Server::readEvent: " << (void*)this ) ; + G_DEBUG( "GNet::Server::readEvent: " << this ) ; G_ASSERT( m_socket.get() != NULL ) ; + + collectGarbage() ; + G::Root claim_root ; AcceptPair pair = m_socket->accept() ; if( pair.first.get() == NULL ) @@ -180,9 +203,42 @@ void GNet::Server::readEvent() else { G_DEBUG( "GNet::Server::readEvent: new connection from " << pair.second.displayString() ) ; - ServerPeer * peer = newPeer(pair.first.release(),pair.second) ; - if( peer != NULL ) + m_peer_list.push_back( ServerPeerHandle() ) ; + + PeerInfo peer_info ; + peer_info.m_socket = pair.first ; // auto_ptr + peer_info.m_address = pair.second ; + peer_info.m_handle = &m_peer_list.back() ; + + ServerPeer * peer = newPeer(peer_info) ; + if( peer == NULL ) + { + m_peer_list.pop_back() ; + } + else + { + m_peer_list.back().set( peer ) ; G_DEBUG( "GNet::Server::readEvent: new connection accepted onto fd " << peer->asString() ) ; + } + } +} + +void GNet::Server::collectGarbage() +{ + // cleanup empty handles, where peer objects have deleted themselves + G_DEBUG( "GNet::Server::collectGarbage" ) ; + for( PeerList::iterator p = m_peer_list.begin() ; p != m_peer_list.end() ; ) + { + ServerPeerHandle handle = *p ; + if( handle.peer() == NULL ) + { + G_DEBUG( "GNet::Server::collectGarbage: [" << handle.old() << "]" ) ; + p = m_peer_list.erase( p ) ; + } + else + { + ++p ; + } } } @@ -196,3 +252,40 @@ void GNet::Server::exceptionEvent() G_DEBUG( "GNet::Server::exceptionEvent" ) ; } +// === + +GNet::Server::PeerInfo::PeerInfo() : + m_address(Address::invalidAddress()) , + m_handle(NULL) +{ +} + +// === + +GNet::ServerPeerHandle::ServerPeerHandle() : + m_p(NULL) , + m_old(NULL) +{ +} + +void GNet::ServerPeerHandle::reset() +{ + m_p = NULL ; +} + +GNet::ServerPeer * GNet::ServerPeerHandle::peer() +{ + return m_p ; +} + +GNet::ServerPeer * GNet::ServerPeerHandle::old() +{ + return m_old ; +} + +void GNet::ServerPeerHandle::set( ServerPeer * p ) +{ + m_p = p ; + m_old = p ; +} + diff --git a/src/gnet/gserver.h b/src/gnet/gserver.h index 006cc70..0a966bc 100644 --- a/src/gnet/gserver.h +++ b/src/gnet/gserver.h @@ -38,20 +38,60 @@ namespace GNet { class Server ; class ServerPeer ; + class ServerPeerHandle ; } +// Class: GNet::ServerPeerHandle +// Description: A structure used in the implementation of GNet::Server. +// The server holds a list of handles which refer to all its peer objects. +// When a peer object deletes itself it resets the handle, without changing +// the server's list. The server uses its list to delete all peer objects +// from within its destructor. The server does garbage collection occasionally, +// deleting handles which have been reset. +// +class GNet::ServerPeerHandle +{ +public: + ServerPeerHandle() ; + // Default constructor. + + void set( ServerPeer * p ) ; + // Sets the pointer. + + void reset() ; + // Resets the pointer. + + ServerPeer * peer() ; + // Returns the pointer. + + ServerPeer * old() ; + // Returns the pointer value before it was reset(). + // Used in debugging. + +private: + ServerPeer * m_p ; + ServerPeer * m_old ; +} ; + // Class: GNet::Server -// Description: An application-level class for implementing a -// simple TCP server. The user must instantiate a separate -// event-source object (such as GNet::Select) for event handling. +// Description: A network server class which listens on a specific +// port and spins off ServerPeer objects for each incoming connection. // See also: GNet::ServerPeer // -class GNet::Server : public GNet:: EventHandler +class GNet::Server : public GNet::EventHandler { public: G_EXCEPTION( CannotBind , "cannot bind the listening port" ) ; G_EXCEPTION( CannotListen , "cannot listen" ) ; + struct PeerInfo // A structure used in GNet::Server::newPeer(). + { + std::auto_ptr m_socket ; + Address m_address ; + ServerPeerHandle * m_handle ; + PeerInfo() ; + } ; + explicit Server( unsigned int listening_port ) ; // Constructor taking a port number. The server // listens on all local interfaces. @@ -77,22 +117,31 @@ public: // is false if not properly init()ialised. protected: - virtual ServerPeer * newPeer( StreamSocket * socket , - Address peer_address ) = 0 ; - // A factory method which new()s a ServerPeer-derived - // object. This method is called when a new connection - // comes into this server. The new ServerPeer object - // is used to represent the state of the client/server - // connection. - // - // The 'socket' parameter points to a socket - // object on the heap. Ownership is transferred. - // - // The implementation shoud pass the 'socket' and - // 'peer_address' parameters through to the ServerPeer - // base-class constructor. - // - // May return NULL. + virtual ServerPeer * newPeer( PeerInfo ) = 0 ; + // A factory method which new()s a ServerPeer-derived + // object. This method is called when a new connection + // comes into this server. The new ServerPeer object + // is used to represent the state of the client/server + // connection. + // + // The new ServerPeer object manages its own lifetime + // doing a "delete this" when the network connection + // disappears. But the Server also deletes remaining + // peers during its destruction. + // + // The 'socket' parameter points to a socket + // object on the heap. Ownership is transferred. + // + // The implementation shoud pass the 'PeerInfo' + // parameter through to the ServerPeer + // base-class constructor. + // + // May return NULL. + + void serverCleanup() ; + // May be called from the derived class destructor + // in order to trigger early deletion of peer objects, + // before the derived part of the server disappears. private: Server( const Server & ) ; // not implemented @@ -100,9 +149,14 @@ private: virtual void readEvent() ; // from EventHandler virtual void writeEvent() ; // from EventHandler virtual void exceptionEvent() ; // from EventHandler + void serverCleanupCore() ; + void collectGarbage() ; private: + typedef std::list PeerList ; std::auto_ptr m_socket ; + PeerList m_peer_list ; + bool m_cleaned_up ; } ; // Class: GNet::ServerPeer @@ -112,27 +166,14 @@ private: // delete themselves when the connection is lost. // See also: GNet::Server, GNet::EventHandler // -class GNet::ServerPeer : public GNet:: EventHandler , public GNet:: Connection +class GNet::ServerPeer : public GNet::EventHandler , public GNet::Connection { public: - ServerPeer( StreamSocket * , Address ) ; + explicit ServerPeer( Server::PeerInfo ) ; // Constructor. This constructor is // only used from within the // override of GServer::newPeer(). - void up() ; - // Increases this object's internal reference - // count. See also down(). Reference counting - // is provided for the convenience of - // reference-counting wrappers, but is - // not used by this library. - - bool down() ; - // Decreases this object's internal reference - // count. Returns true if the reference - // count is now zero. - // Usage: if(down()) doDelete() - void doDelete() ; // Does "onDelete(); delete this". @@ -149,12 +190,12 @@ public: virtual std::pair peerAddress() const ; // Returns the peer address. -protected: virtual ~ServerPeer() ; // Destructor. Note that objects will delete // themselves when they detect that the // connection has been lost -- see doDelete(). +protected: virtual void onDelete() = 0 ; // Called just before destruction. (Note // that the object typically deletes itself.) @@ -166,6 +207,11 @@ protected: // Returns a reference to the client-server // connection socket. + Server * server() ; + // Returns a pointer to the associated server + // object. Returns NULL if the server has + // been destroyed. + private: virtual void readEvent() ; // from EventHandler virtual void exceptionEvent() ; // from EventHandler @@ -173,9 +219,9 @@ private: void operator=( const ServerPeer & ) ; // not implemented private: - unsigned int m_ref_count ; Address m_address ; - StreamSocket * m_socket ; + std::auto_ptr m_socket ; + ServerPeerHandle * m_handle ; } ; #endif diff --git a/src/gnet/gsocket.cpp b/src/gnet/gsocket.cpp index 3c05f0c..382c6e7 100644 --- a/src/gnet/gsocket.cpp +++ b/src/gnet/gsocket.cpp @@ -31,7 +31,7 @@ GNet::Socket::Socket( int domain, int type, int protocol ) : m_reason( 0 ) { - (void)open( domain , type , protocol ) ; + G_IGNORE open( domain , type , protocol ) ; } bool GNet::Socket::open( int domain, int type, int protocol ) @@ -65,7 +65,13 @@ GNet::Socket::Socket( Descriptor s ) : GNet::Socket::~Socket() { - close() ; + try + { + close() ; + } + catch(...) + { + } } void GNet::Socket::drop() @@ -103,8 +109,7 @@ bool GNet::Socket::bind( const Address & local_address ) // optionally allow immediate re-use -- may cause problems setReuse() ; - G_DEBUG( "Socket::bind: binding " << local_address.displayString() - << " on fd " << m_socket ) ; + G_DEBUG( "Socket::bind: binding " << local_address.displayString() << " on fd " << m_socket ) ; int rc = ::bind( m_socket, local_address.address() , local_address.length() ) ; if( error(rc) ) @@ -123,8 +128,7 @@ bool GNet::Socket::bind( const Address & local_address ) return false ; } - G_DEBUG( "GNet::Socket::bind: bound " << pair.second.displayString() << " on fd " - << m_socket ) ; + G_DEBUG( "GNet::Socket::bind: bound " << pair.second.displayString() << " on fd " << m_socket ) ; } return true ; @@ -173,7 +177,7 @@ ssize_t GNet::Socket::write( const char *buf, size_t len ) m_reason = reason() ; } - G_DEBUG( "GNet::Socket::write: wrote " << nsent << "/" << len << " byte(s)" ) ; + //G_DEBUG( "GNet::Socket::write: wrote " << nsent << "/" << len << " byte(s)" ) ; return nsent; } @@ -183,22 +187,22 @@ void GNet::Socket::setNoLinger() options.l_onoff = 0 ; options.l_linger = 0 ; socklen_t sizeof_options = sizeof(options) ; - (void)::setsockopt( m_socket , SOL_SOCKET , SO_LINGER , - (char*)&options , sizeof_options ) ; + G_IGNORE ::setsockopt( m_socket , SOL_SOCKET , SO_LINGER , + reinterpret_cast(&options) , sizeof_options ) ; } void GNet::Socket::setKeepAlive() { int keep_alive = 1 ; - (void)::setsockopt( m_socket , SOL_SOCKET , - SO_KEEPALIVE , (char*)&keep_alive , sizeof(keep_alive) ) ; + G_IGNORE ::setsockopt( m_socket , SOL_SOCKET , + SO_KEEPALIVE , reinterpret_cast(&keep_alive) , sizeof(keep_alive) ) ; } void GNet::Socket::setReuse() { int on = 1 ; - (void)::setsockopt( m_socket , SOL_SOCKET , - SO_REUSEADDR , (char*)&on , sizeof(on) ) ; + G_IGNORE ::setsockopt( m_socket , SOL_SOCKET , + SO_REUSEADDR , reinterpret_cast(&on) , sizeof(on) ) ; } bool GNet::Socket::listen( int backlog ) @@ -219,7 +223,8 @@ std::pair GNet::Socket::getAddress( bool local ) const if( !valid() ) return error_pair ; - sockaddr saddr ; + static sockaddr saddr_zero ; + sockaddr saddr( saddr_zero ) ; socklen_t addr_length = sizeof(saddr) ; int rc = local ? @@ -330,6 +335,7 @@ bool GNet::StreamSocket::reopen() ssize_t GNet::StreamSocket::read( char *buf , size_t len ) { if( len == 0 ) return 0 ; + G_ASSERT( valid() ) ; ssize_t nread = ::recv( m_socket , buf , len , 0 ) ; if( sizeError(nread) ) { @@ -338,7 +344,7 @@ ssize_t GNet::StreamSocket::read( char *buf , size_t len ) return -1 ; } - G_DEBUG( "GNet::StreamSocket::read: fd " << m_socket << ": read " << nread << " bytes(s)" ) ; + //G_DEBUG( "GNet::StreamSocket::read: fd " << m_socket << ": read " << nread << " bytes(s)" ) ; return nread ; } @@ -395,7 +401,7 @@ ssize_t GNet::DatagramSocket::read( void *buf , size_t len , Address & src_addre { sockaddr sender ; socklen_t sender_len = sizeof(sender) ; - ssize_t nread = ::recvfrom( m_socket, (char*)buf, len, 0, &sender, &sender_len ) ; + ssize_t nread = ::recvfrom( m_socket, reinterpret_cast(buf), len, 0, &sender, &sender_len ) ; if( sizeError(nread) ) { m_reason = reason() ; diff --git a/src/gnet/gsocket.h b/src/gnet/gsocket.h index 291aeef..d281979 100644 --- a/src/gnet/gsocket.h +++ b/src/gnet/gsocket.h @@ -267,7 +267,7 @@ public: // Class: GNet::StreamSocket // Description: A derivation of Socket for a stream socket. // -class GNet::StreamSocket : public GNet:: Socket +class GNet::StreamSocket : public GNet::Socket { public: StreamSocket() ; @@ -309,7 +309,7 @@ private: // Description: A derivation of Socket for a connectionless // datagram socket. // -class GNet::DatagramSocket : public GNet:: Socket +class GNet::DatagramSocket : public GNet::Socket { public: DatagramSocket(); diff --git a/src/gnet/gtimer.cpp b/src/gnet/gtimer.cpp index 22775db..29f1b0f 100644 --- a/src/gnet/gtimer.cpp +++ b/src/gnet/gtimer.cpp @@ -166,8 +166,8 @@ void GNet::TimerList::update( G::DateTime::EpochTime t_old , const std::string & op ) { G::DateTime::EpochTime t_new = soonest() ; - G_DEBUG( "GNet::TimerList::update: " << op << ": " << t_old << " -> " << t_new ) ; - (void) op.length() ; // pacify the compiler + //G_DEBUG( "GNet::TimerList::update: " << op << ": " << t_old << " -> " << t_new ) ; + G_IGNORE op.length() ; // pacify the compiler if( t_old != t_new && EventLoop::exists() ) { EventLoop::instance().setTimeout( t_new ) ; diff --git a/src/gsmtp/Makefile.am b/src/gsmtp/Makefile.am index 336237e..ee5e2d2 100644 --- a/src/gsmtp/Makefile.am +++ b/src/gsmtp/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# EXTRA_DIST=\ gmessagestore_win32.cpp \ diff --git a/src/gsmtp/Makefile.in b/src/gsmtp/Makefile.in index 33e979e..321b05b 100644 --- a/src/gsmtp/Makefile.in +++ b/src/gsmtp/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ diff --git a/src/gsmtp/gadminserver.cpp b/src/gsmtp/gadminserver.cpp index 664462d..7dc41bf 100644 --- a/src/gsmtp/gadminserver.cpp +++ b/src/gsmtp/gadminserver.cpp @@ -29,27 +29,31 @@ #include "gmessagestore.h" #include "gstoredmessage.h" #include "gmonitor.h" +#include "gslot.h" #include "gstr.h" #include "gmemory.h" +#include // std::find() -GSmtp::AdminClient::AdminClient( AdminPeer & admin_peer ) : - Client(MessageStore::instance(),admin_peer,false) -{ -} - -// === - -GSmtp::AdminPeer::AdminPeer( GNet::StreamSocket * s , GNet::Address a , AdminServer & server , - const std::string & server_address ) : - GNet::ServerPeer( s , a ) , +GSmtp::AdminPeer::AdminPeer( GNet::Server::PeerInfo peer_info , AdminServer & server , + const std::string & server_address , bool with_terminate ) : + GNet::ServerPeer(peer_info) , m_buffer(crlf()) , m_server(server) , - m_server_address(server_address) + m_server_address(server_address) , + m_notifying(false) , + m_with_terminate(with_terminate) { - G_LOG_S( "GSmtp::AdminPeer: admin connection from " << a.displayString() ) ; + G_LOG_S( "GSmtp::AdminPeer: admin connection from " << peer_info.m_address.displayString() ) ; // dont prompt() here -- it confuses the poke program } +GSmtp::AdminPeer::~AdminPeer() +{ + // only safe because AdminServer::dtor calls serverCleanup() -- otherwise + // the derived part of the server may already be destroyed + m_server.unregister( this ) ; +} + void GSmtp::AdminPeer::clientDone( std::string s ) { if( s.empty() ) @@ -91,6 +95,11 @@ bool GSmtp::AdminPeer::processLine( const std::string & line ) info() ; prompt() ; } + else if( is(line,"NOTIFY") ) + { + m_notifying = true ; + prompt() ; + } else if( is(line,"LIST") ) { list() ; @@ -101,7 +110,7 @@ bool GSmtp::AdminPeer::processLine( const std::string & line ) doDelete() ; return false ; } - else if( is(line,"TERMINATE") && false ) + else if( is(line,"TERMINATE") && m_with_terminate ) { if( GNet::EventLoop::exists() ) GNet::EventLoop::instance().quit() ; @@ -135,7 +144,7 @@ bool GSmtp::AdminPeer::is( const std::string & line_in , const char * key ) void GSmtp::AdminPeer::help() { - send( "commands: FLUSH, HELP, INFO, LIST, QUIT" ) ; + send( "commands: flush, help, info, list, notify, quit" ) ; } void GSmtp::AdminPeer::flush( const std::string & address ) @@ -146,10 +155,17 @@ void GSmtp::AdminPeer::flush( const std::string & address ) { send( "error: still working" ) ; } + else if( address.empty() ) + { + send( "error: no remote server configured: use --forward-to" ) ; + } else { - m_client <<= new AdminClient( *this ) ; - std::string rc = m_client->init( address ) ; + const bool quit_on_disconnect = false ; + m_client <<= new Client( m_server.store() , m_server.secrets() , + quit_on_disconnect , m_server.responseTimeout() ) ; + m_client->doneSignal().connect( G::slot(*this,&AdminPeer::clientDone) ) ; + std::string rc = m_client->startSending( address , m_server.connectionTimeout() ) ; if( rc.length() != 0U ) { send( std::string("error: ") + rc ) ; @@ -173,6 +189,12 @@ void GSmtp::AdminPeer::send( std::string line ) doDelete() ; // onDelete() and "delete this" } +void GSmtp::AdminPeer::notify( const std::string & s0 , const std::string & s1 , const std::string & s2 ) +{ + if( m_notifying ) + send( crlf() + "EVENT: " + s0 + ": " + s1 + ": " + s2 ) ; +} + void GSmtp::AdminPeer::info() { std::ostringstream ss ; @@ -190,15 +212,12 @@ void GSmtp::AdminPeer::info() void GSmtp::AdminPeer::list() { std::ostringstream ss ; - if( MessageStore::exists() ) + MessageStore::Iterator iter( m_server.store().iterator(false) ) ; + for(;;) { - MessageStore::Iterator iter( MessageStore::instance().iterator(false) ) ; - for(;;) - { - std::auto_ptr message( iter.next() ) ; - if( message.get() == NULL ) break ; - ss << message->name() << crlf() ; - } + std::auto_ptr message( iter.next() ) ; + if( message.get() == NULL ) break ; + ss << message->name() << crlf() ; } std::string result = ss.str() ; @@ -210,17 +229,33 @@ void GSmtp::AdminPeer::list() // === -GSmtp::AdminServer::AdminServer( unsigned int port , bool allow_remote , const std::string & address ) : - GNet::Server( port ) , - m_allow_remote( allow_remote ) , - m_server_address( address ) +GSmtp::AdminServer::AdminServer( MessageStore & store , const Secrets & secrets , + const GNet::Address & listening_address , bool allow_remote , + const std::string & address , unsigned int response_timeout , + unsigned int connection_timeout , bool with_terminate ) : + GNet::Server( listening_address ) , + m_store( store ) , + m_secrets( secrets ) , + m_allow_remote( allow_remote ) , + m_server_address( address ) , + m_response_timeout( response_timeout ) , + m_connection_timeout( connection_timeout ) , + m_with_terminate( with_terminate ) { - G_DEBUG( "GSmtp::AdminServer: administrative interface listening on port " << port ) ; + G_DEBUG( "GSmtp::AdminServer: administrative interface listening on " << listening_address.displayString() ) ; } -GNet::ServerPeer * GSmtp::AdminServer::newPeer( GNet::StreamSocket * s , GNet::Address a ) +GSmtp::AdminServer::~AdminServer() { - return new AdminPeer( s , a , *this , m_server_address ) ; + // early cleanup so peers can call unregister() safely + serverCleanup() ; // GNet::Server +} + +GNet::ServerPeer * GSmtp::AdminServer::newPeer( GNet::Server::PeerInfo peer_info ) +{ + AdminPeer * peer = new AdminPeer( peer_info , *this , m_server_address , m_with_terminate ) ; + m_peers.push_back( peer ) ; + return peer ; } void GSmtp::AdminServer::report() const @@ -228,3 +263,40 @@ void GSmtp::AdminServer::report() const // no-op } +void GSmtp::AdminServer::notify( const std::string & s0 , const std::string & s1 , const std::string & s2 ) +{ + for( PeerList::iterator p = m_peers.begin() ; p != m_peers.end() ; ++p ) + { + G_DEBUG( "GSmtp::AdminServer::notify: " << (*p) << ": " << s0 << ": " << s1 ) ; + (*p)->notify( s0 , s1 , s2 ) ; + } +} + +void GSmtp::AdminServer::unregister( AdminPeer * peer ) +{ + G_DEBUG( "GSmtp::AdminServer::unregister: server=" << this << ": peer=" << peer ) ; + PeerList::iterator p = std::find( m_peers.begin() , m_peers.end() , peer ) ; + if( p != m_peers.end() ) + m_peers.erase( p ) ; +} + +GSmtp::MessageStore & GSmtp::AdminServer::store() +{ + return m_store ; +} + +const GSmtp::Secrets & GSmtp::AdminServer::secrets() const +{ + return m_secrets ; +} + +unsigned int GSmtp::AdminServer::responseTimeout() const +{ + return m_response_timeout ; +} + +unsigned int GSmtp::AdminServer::connectionTimeout() const +{ + return m_connection_timeout ; +} + diff --git a/src/gsmtp/gadminserver.h b/src/gsmtp/gadminserver.h index fd30733..c558abe 100644 --- a/src/gsmtp/gadminserver.h +++ b/src/gsmtp/gadminserver.h @@ -31,42 +31,37 @@ #include "gserverprotocol.h" #include "gsmtpclient.h" #include +#include #include namespace GSmtp { class AdminPeer ; class AdminServer ; - class AdminClient ; } -// Class: GSmtp::AdminClient -// Description: A private implementation class. -// -class GSmtp::AdminClient : public GSmtp:: Client -{ -public: - AdminClient( AdminPeer & admin_peer ) ; -} ; - -// === - // Class: GSmtp::AdminPeer // Description: A derivation of ServerPeer for the administration interface. // See also: AdminServer // -class GSmtp::AdminPeer : public GNet::ServerPeer , public GSmtp:: Client::ClientCallback +class GSmtp::AdminPeer : public GNet::ServerPeer { public: - AdminPeer( GNet::StreamSocket * , GNet::Address , AdminServer & server , const std::string & ) ; + AdminPeer( GNet::Server::PeerInfo , AdminServer & server , const std::string & , bool ) ; // Constructor. + virtual ~AdminPeer() ; + // Destructor. + + void notify( const std::string & s0 , const std::string & s1 , const std::string & s2 ) ; + // Called when something happens. + private: AdminPeer( const AdminPeer & ) ; void operator=( const AdminPeer & ) ; virtual void onDelete() ; // from GNet::ServerPeer virtual void onData( const char * , size_t ) ; // from GNet::ServerPeer - virtual void clientDone( std::string ) ; // from Client::ClientCallback + virtual void clientDone( std::string ) ; // Client::doneSignal() bool processLine( const std::string & line ) ; static bool is( const std::string & , const char * ) ; void flush( const std::string & ) ; @@ -80,8 +75,10 @@ private: private: GNet::LineBuffer m_buffer ; AdminServer & m_server ; - std::auto_ptr m_client ; + std::auto_ptr m_client ; std::string m_server_address ; + bool m_notifying ; + bool m_with_terminate ; } ; // Class: GSmtp::AdminServer @@ -90,20 +87,60 @@ private: class GSmtp::AdminServer : public GNet::Server { public: - AdminServer( unsigned int port , bool allow_remote , const std::string & server_address ) ; - // Constructor. + AdminServer( MessageStore & store , const Secrets & client_secrets , + const GNet::Address & listening_address , bool allow_remote , + const std::string & server_address , + unsigned int response_timeout , unsigned int connection_timeout , + bool with_terminate ) ; + // Constructor. The 'store' and 'client-secrets' references + // are kept. + + virtual ~AdminServer() ; + // Destructor. void report() const ; // Generates helpful diagnostics. + MessageStore & store() ; + // Returns a reference to the message store, as + // passed in to the constructor. + + const Secrets & secrets() const ; + // Returns a reference to the secrets object, as + // passed in to the constructor. Note that this is + // a "client-side" secrets file, used to authenticate + // ourselves with a remote server. + + unsigned int responseTimeout() const ; + // Returns the response timeout, as passed in to the + // constructor. + + unsigned int connectionTimeout() const ; + // Returns the connection timeout, as passed in to the + // constructor. + + void notify( const std::string & s0 , const std::string & s1 , const std::string & s2 ) ; + // Called when something happens which the admin + // user might be interested in. + + void unregister( AdminPeer * ) ; + // Called from the AdminPeer destructor. + private: - virtual GNet::ServerPeer * newPeer( GNet::StreamSocket * , GNet::Address ) ; + virtual GNet::ServerPeer * newPeer( GNet::Server::PeerInfo ) ; AdminServer( const AdminServer & ) ; void operator=( const AdminServer & ) ; private: + typedef std::list PeerList ; + PeerList m_peers ; + MessageStore & m_store ; + const Secrets & m_secrets ; bool m_allow_remote ; std::string m_server_address ; + unsigned int m_response_timeout ; + unsigned int m_connection_timeout ; + bool m_with_terminate ; } ; #endif diff --git a/src/gsmtp/gbase64.cpp b/src/gsmtp/gbase64.cpp index 8865688..1e8ec6a 100644 --- a/src/gsmtp/gbase64.cpp +++ b/src/gsmtp/gbase64.cpp @@ -88,17 +88,6 @@ std::string GSmtp::Base64::encode( const std::string & s_in , const std::string generate_6( n , i , result ) ; } - // delete when tested... - if( decode(result) != s_in ) - { - std::string decode_result = decode(result) ; - G_ERROR( "GSmtp::Base64::encode: mismatch: " - << "in \"" << G::Str::toPrintableAscii(s_in) << "\", " - << "encoded \"" << G::Str::toPrintableAscii(result) << "\", " - << "decoded \"" << G::Str::toPrintableAscii(decode_result) << "\"" ) ; - G_ASSERT( !"encode/decode mismatch" ) ; - } - return result ; } @@ -177,7 +166,7 @@ std::string GSmtp::Base64::decode( const std::string & s , bool & error ) bool GSmtp::Base64::valid( const std::string & s ) { bool error = false ; - (void) decode( s , error ) ; + G_IGNORE decode( s , error ) ; return !error ; } diff --git a/src/gsmtp/gclientprotocol.cpp b/src/gsmtp/gclientprotocol.cpp index e03f9fc..6f9f132 100644 --- a/src/gsmtp/gclientprotocol.cpp +++ b/src/gsmtp/gclientprotocol.cpp @@ -36,37 +36,40 @@ #include "glog.h" #include "gassert.h" -GSmtp::ClientProtocol::ClientProtocol( Sender & sender , const std::string & thishost_name , - unsigned int timeout , bool must_authenticate ) : +GSmtp::ClientProtocol::ClientProtocol( Sender & sender , const Secrets & secrets , + const std::string & thishost_name , unsigned int timeout , bool must_authenticate ) : m_sender(sender) , + m_secrets(secrets) , m_thishost(thishost_name) , m_state(sStart) , - m_callback(NULL) , m_server_has_8bitmime(false) , m_said_hello(false) , m_message_is_8bit(false) , m_authenticated_with_server(false) , m_must_authenticate(must_authenticate) , - m_timeout(timeout) + m_timeout(timeout) , + m_signalled(false) { } void GSmtp::ClientProtocol::start( const std::string & from , const G::Strings & to , bool eight_bit , - std::string authentication , std::string server_name , - std::auto_ptr content , Callback & callback ) + std::string authentication , std::string server_name , std::auto_ptr content ) { G_DEBUG( "GSmtp::ClientProtocol::start" ) ; + + // reinitialise for the new message & server + m_signalled = false ; m_to = to ; m_from = from ; m_content = content ; - m_callback = &callback ; m_message_is_8bit = eight_bit ; m_message_authentication = authentication ; m_reply = Reply() ; - m_sasl <<= new SaslClient( server_name ) ; + m_sasl <<= new SaslClient( m_secrets , server_name ) ; if( m_state != sStart && m_state != sEnd ) throw NotReady() ; + // say hello if this is the first message on the current connection if( m_said_hello ) { m_state = sSentMail ; @@ -149,7 +152,7 @@ void GSmtp::ClientProtocol::sendMail() std::string reason = "cannot send 8-bit message to 7-bit server" ; G_WARNING( "GSmtp::ClientProtocol: " << reason ) ; m_state = sEnd ; - doCallback( false , false , reason ) ; + raiseDoneSignal( false , false , reason ) ; } else { @@ -198,13 +201,15 @@ void GSmtp::ClientProtocol::applyEvent( const Reply & reply ) reply.is(Reply::SyntaxError_501) || reply.is(Reply::NotImplemented_502) ) ) { + // it didn't like EHLO so fall back to HELO m_state = sSentHelo ; send( std::string("HELO ") + m_thishost ) ; } else if( (m_state==sSentEhlo || m_state==sSentHelo) && reply.is(Reply::Ok_250) ) { G_ASSERT( m_sasl.get() != NULL ) ; - G_DEBUG( "GSmtp::ClientProtocol::applyEvent: ehlo reply \"" << G::Str::toPrintableAscii(reply.text()) << "\"" ) ; + G_DEBUG( "GSmtp::ClientProtocol::applyEvent: ehlo reply \"" + << G::Str::toPrintableAscii(reply.text()) << "\"" ) ; m_auth_mechanism = m_sasl->preferred( serverAuthMechanisms(reply) ) ; m_server_has_8bitmime = m_state == sSentEhlo && reply.textContains("\n8BITMIME") ; @@ -220,7 +225,7 @@ void GSmtp::ClientProtocol::applyEvent( const Reply & reply ) std::string reason = "cannot do mandatory authentication" ; // eg. no suitable mechanism G_WARNING( "GSmtp::ClientProtocol: " << reason ) ; m_state = sEnd ; - doCallback( false , true , reason ) ; + raiseDoneSignal( false , true , reason ) ; } else { @@ -251,7 +256,7 @@ void GSmtp::ClientProtocol::applyEvent( const Reply & reply ) if( !m_authenticated_with_server && m_must_authenticate ) { m_state = sEnd ; - doCallback( false , true , "mandatory authentication failed" ) ; + raiseDoneSignal( false , true , "mandatory authentication failed" ) ; } else { @@ -286,7 +291,7 @@ void GSmtp::ClientProtocol::applyEvent( const Reply & reply ) { G_WARNING( "GSmtp::ClientProtocol: recipient rejected" ) ; m_state = sEnd ; - doCallback( false , false , reply.text() ) ; + raiseDoneSignal( false , false , reply.text() ) ; } else if( m_state == sSentData && reply.is(Reply::OkForData_354) ) { @@ -294,24 +299,27 @@ void GSmtp::ClientProtocol::applyEvent( const Reply & reply ) size_t n = sendLines() ; - G_LOG( "GSmtp::ClientProtocol: tx>>: [" << n << " line(s) of content]" ) ; + const bool log_content = false ; // set true here and in sendLine() if debugging + if( !log_content ) + G_LOG( "GSmtp::ClientProtocol: tx>>: [" << n << " line(s) of content]" ) ; + if( endOfContent() ) { m_state = sDone ; - send( "." , true ) ; + send( "." , true , log_content ) ; } } else if( m_state == sDone ) { const bool ok = reply.is(Reply::Ok_250) ; m_state = sEnd ; - doCallback( ok , false , ok ? std::string() : reply.text() ) ; + raiseDoneSignal( ok , false , ok ? std::string() : reply.text() ) ; } else { G_WARNING( "GSmtp::ClientProtocol: failure in client protocol: " << static_cast(m_state) ) ; m_state = sEnd ; - doCallback( false , true , std::string("unexpected response: ")+reply.text() ) ; + raiseDoneSignal( false , true , std::string("unexpected response: ")+reply.text() ) ; } } @@ -319,7 +327,7 @@ void GSmtp::ClientProtocol::onTimeout() { G_WARNING( "GSmtp::ClientProtocol: timeout" ) ; m_state = sEnd ; - doCallback( false , false , "timeout" ) ; + raiseDoneSignal( false , false , "timeout" ) ; } G::Strings GSmtp::ClientProtocol::serverAuthMechanisms( const ClientProtocolReply & reply ) const @@ -335,14 +343,15 @@ G::Strings GSmtp::ClientProtocol::serverAuthMechanisms( const ClientProtocolRepl return result ; } -void GSmtp::ClientProtocol::doCallback( bool ok , bool abort , const std::string & reason ) +void GSmtp::ClientProtocol::raiseDoneSignal( bool ok , bool abort , const std::string & reason ) { + G_DEBUG( "GSmtp::ClientProtocol::raiseDoneSignal: " << ok << ": \"" << reason << "\"" ) ; + cancelTimer() ; m_content <<= 0 ; - if( m_callback ) + if( ! m_signalled ) { - Callback * cb = m_callback ; - m_callback = NULL ; - cb->protocolDone( ok , abort , reason ) ; + m_signalled = true ; + m_signal.emit( ok , abort , reason ) ; } } @@ -376,14 +385,14 @@ bool GSmtp::ClientProtocol::sendLine( std::string & line ) bool GSmtp::ClientProtocol::send( const std::string & line , bool eot , bool log ) { - const bool add_prefix = !eot && line.length() && line.at(0U) == '.' ; - const std::string prefix( add_prefix ? "." : "" ) ; - if( log ) - G_LOG( "GSmtp::ClientProtocol: tx>>: \"" << prefix << G::Str::toPrintableAscii(line) << "\"" ) ; - if( m_timeout != 0U ) startTimer( m_timeout ) ; + bool add_prefix = !eot && line.length() && line.at(0U) == '.' ; + std::string prefix( add_prefix ? "." : "" ) ; + if( log ) + G_LOG( "GSmtp::ClientProtocol: tx>>: \"" << prefix << G::Str::toPrintableAscii(line) << "\"" ) ; + return m_sender.protocolSend( prefix + line + crlf() ) ; } @@ -394,6 +403,11 @@ const std::string & GSmtp::ClientProtocol::crlf() return s ; } +G::Signal3 & GSmtp::ClientProtocol::doneSignal() +{ + return m_signal ; +} + // === GSmtp::ClientProtocolReply::ClientProtocolReply( const std::string & line ) : @@ -510,9 +524,4 @@ GSmtp::ClientProtocol::Sender::~Sender() { } -// === - -GSmtp::ClientProtocol::Callback::~Callback() -{ -} diff --git a/src/gsmtp/gclientprotocol.h b/src/gsmtp/gclientprotocol.h index b2bf007..2a34eb2 100644 --- a/src/gsmtp/gclientprotocol.h +++ b/src/gsmtp/gclientprotocol.h @@ -30,6 +30,7 @@ #include "gmessagestore.h" #include "gsasl.h" #include "gsecrets.h" +#include "gslot.h" #include "gstrings.h" #include "gtimer.h" #include "gexception.h" @@ -149,32 +150,15 @@ public: // Returns false if not all of the string // was sent, either due to flow control // or disconnection. After false is returned - // the user should call sendDone() once - // the full string has been sent. + // ClientProtocol::sendDone() should be called + // as soon as the full string has been sent. private: void operator=( const Sender & ) ; // not implemented public: virtual ~Sender() ; } ; - class Callback // A callback interface used by ClientProtocol. - { - public: virtual void protocolDone( bool ok , bool abort , const std::string & reason ) = 0 ; - // Called once the protocol has finished with - // a given message. See ClientProtocol::start(). - // - // If 'ok' is false then 'abort' indicates - // whether there is any point in trying to - // send more messages to the same server. - // The 'abort' parameter will be true if, - // for example, authentication failed -- if - // it failed for one message then it will - // fail for all the others. - - private: void operator=( const Callback & ) ; // not implemented - public: virtual ~Callback() ; - } ; - - ClientProtocol( Sender & sender , const std::string & thishost_name , + ClientProtocol( Sender & sender , const Secrets & secrets , + const std::string & thishost_name , unsigned int timeout , bool must_authenticate ) ; // Constructor. The 'sender' and 'secrets' references // are kept. @@ -185,12 +169,25 @@ public: // The 'thishost_name' parameter is used in the // SMTP EHLO request. + G::Signal3 & doneSignal() ; + // Returns a signal which is raised once the protocol has + // finished with a given message. The signal parameters + // are 'ok', 'abort' and 'reason'. + // + // If 'ok' is false then 'abort' indicates + // whether there is any point in trying to + // send more messages to the same server. + // The 'abort' parameter will be true if, + // for example, authentication failed -- if + // it failed for one message then it will + // fail for all the others. + void start( const std::string & from , const G::Strings & to , bool eight_bit , std::string authentication , std::string server_name , - std::auto_ptr content , Callback & callback ) ; + std::auto_ptr content ) ; // Starts transmission of the given message. // - // The 'callback' parameter is used to signal that the + // The doneSignal() is used to indicate that the // message has been processed. // // The 'server_name' parameter is passed to the SASL @@ -217,7 +214,7 @@ private: static const std::string & crlf() ; void applyEvent( const Reply & event ) ; static bool parseReply( Reply & , const std::string & , std::string & ) ; - void doCallback( bool , bool , const std::string & ) ; + void raiseDoneSignal( bool , bool , const std::string & ) ; G::Strings serverAuthMechanisms( const ClientProtocolReply & reply ) const ; void onTimeout() ; @@ -225,11 +222,11 @@ private: enum State { sStart , sSentEhlo , sSentHelo , sAuth1 , sAuth2 , sSentMail , sSentRcpt , sSentData , sData , sDone , sEnd , sReset } ; Sender & m_sender ; + const Secrets & m_secrets ; std::string m_thishost ; State m_state ; std::string m_from ; G::Strings m_to ; - Callback * m_callback ; std::auto_ptr m_content ; bool m_server_has_8bitmime ; bool m_said_hello ; @@ -241,6 +238,8 @@ private: std::auto_ptr m_sasl ; bool m_must_authenticate ; unsigned int m_timeout ; + G::Signal3 m_signal ; + bool m_signalled ; } ; #endif diff --git a/src/gsmtp/gfilestore.cpp b/src/gsmtp/gfilestore.cpp index a04348e..e32c359 100644 --- a/src/gsmtp/gfilestore.cpp +++ b/src/gsmtp/gfilestore.cpp @@ -49,7 +49,7 @@ namespace GSmtp // iterators by value, and therefore return them // from MessageStore::iterator(). // -class GSmtp::FileIterator : public GSmtp:: MessageStore::IteratorImp , public G::noncopyable +class GSmtp::FileIterator : public GSmtp::MessageStore::IteratorImp , public G::noncopyable { public: FileIterator( FileStore & store , const G::Directory & dir , bool lock ) ; @@ -169,7 +169,8 @@ G::Path GSmtp::FileStore::envelopeWorkingPath( unsigned long seq ) const std::string GSmtp::FileStore::filePrefix( unsigned long seq ) const { std::ostringstream ss ; - ss << "emailrelay." << G::Process::Id() << "." << m_pid_modifier << "." << seq ; + G::Process::Id pid ; + ss << "emailrelay." << pid.str() << "." << m_pid_modifier << "." << seq ; return ss.str() ; } @@ -244,14 +245,14 @@ std::auto_ptr GSmtp::FileStore::newMessage( const std::string return std::auto_ptr( new NewFile(from,*this) ) ; } -void GSmtp::FileStore::updated() +void GSmtp::FileStore::updated( bool action ) { - onEvent() ; + m_signal.emit( action ) ; } -void GSmtp::FileStore::onEvent() +G::Signal1 & GSmtp::FileStore::signal() { - ; // default implementation + return m_signal ; } // === diff --git a/src/gsmtp/gfilestore.h b/src/gsmtp/gfilestore.h index becd4b5..069b542 100644 --- a/src/gsmtp/gfilestore.h +++ b/src/gsmtp/gfilestore.h @@ -30,6 +30,7 @@ #include "gdatetime.h" #include "gexception.h" #include "gnoncopyable.h" +#include "gslot.h" #include "groot.h" #include "gpath.h" #include @@ -47,7 +48,7 @@ namespace GSmtp // interface, dealing in flat files. Passes out unique sequence // numbers, filesystem paths and i/o streams to NewMessageImp. // -class GSmtp::FileStore : public GSmtp:: MessageStore +class GSmtp::FileStore : public GSmtp::MessageStore { public: G_EXCEPTION( InvalidDirectory , "invalid spool directory" ) ; @@ -102,13 +103,15 @@ public: // implemented by this class. If n is -1 then // it returns the previous format (etc.). - void updated() ; - // Called by associated classes to trigger onEvent(). + void updated( bool action = false ) ; + // Called by associated classes to raise the signal(). -protected: - virtual void onEvent() ; - // Called when something might have changed. The - // default implementation does nothing. + G::Signal1 & signal() ; + // Provides a signal which is activated when something might + // have changed in the file store. + // + // The signal parameter is used to indicate that some + // action is requested. private: static void checkPath( const G::Path & dir ) ; @@ -125,6 +128,7 @@ private: bool m_optimise ; bool m_empty ; // mutable unsigned long m_pid_modifier ; + G::Signal1 m_signal ; } ; // Class: GSmtp::FileReader diff --git a/src/gsmtp/gmessagestore.cpp b/src/gsmtp/gmessagestore.cpp index d271deb..1b9ed43 100644 --- a/src/gsmtp/gmessagestore.cpp +++ b/src/gsmtp/gmessagestore.cpp @@ -27,30 +27,8 @@ #include "glog.h" #include "gassert.h" -GSmtp::MessageStore * GSmtp::MessageStore::m_this = NULL ; - -GSmtp::MessageStore::MessageStore() -{ - if( m_this == NULL ) - m_this = this ; -} - -GSmtp::MessageStore & GSmtp::MessageStore::instance() -{ - if( m_this == NULL ) - throw NoInstance() ; - return * m_this ; -} - GSmtp::MessageStore::~MessageStore() { - if( m_this == this ) - m_this = NULL ; -} - -bool GSmtp::MessageStore::exists() -{ - return m_this != NULL ; } // === diff --git a/src/gsmtp/gmessagestore.h b/src/gsmtp/gmessagestore.h index 164e814..00b248f 100644 --- a/src/gsmtp/gmessagestore.h +++ b/src/gsmtp/gmessagestore.h @@ -38,7 +38,7 @@ namespace GSmtp } // Class: GSmtp::MessageStore -// Description: A singleton class which allows SMTP messages +// Description: A class which allows SMTP messages // (envelope+content) to be stored and retrieved. // // The implementation puts separate envelope and content @@ -55,7 +55,6 @@ class GSmtp::MessageStore public: G_EXCEPTION( WriteError , "error writing file" ) ; G_EXCEPTION( StorageError , "error storing message" ) ; - G_EXCEPTION( NoInstance , "no message store instance" ) ; G_EXCEPTION( FormatError , "format error" ) ; class IteratorImp // A base class for MessageStore::Iterator implementations. { @@ -77,20 +76,11 @@ public: public: Iterator & operator=( const Iterator & ) ; } ; - static MessageStore & instance() ; - // Singleton access. - - static bool exists() ; - // Returns true if an instance exists. - static G::Path defaultDirectory() ; // Returns a default spool directory, such as // "/usr/local/var/spool/emailrelay". (Typically // has an os-specific implementation.) - MessageStore() ; - // Default constructor. - virtual ~MessageStore() ; // Destructor. @@ -125,11 +115,7 @@ public: // or deleted (if they have no recipients). private: - MessageStore( const MessageStore & ) ; - void operator=( const MessageStore & ) ; - -private: - static MessageStore * m_this ; + void operator=( const MessageStore & ) ; // not implemented } ; #endif diff --git a/src/gsmtp/gnewfile.cpp b/src/gsmtp/gnewfile.cpp index 9f3d70a..10872b2 100644 --- a/src/gsmtp/gnewfile.cpp +++ b/src/gsmtp/gnewfile.cpp @@ -41,7 +41,9 @@ G::Path GSmtp::NewFile::m_preprocessor ; GSmtp::NewFile::NewFile( const std::string & from , FileStore & store ) : m_store(store), m_from(from) , - m_eight_bit(false) + m_eight_bit(false), + m_saved(false) , + m_repoll(false) { m_seq = store.newSeq() ; @@ -54,7 +56,14 @@ GSmtp::NewFile::NewFile( const std::string & from , FileStore & store ) : GSmtp::NewFile::~NewFile() { - m_store.updated() ; + try + { + cleanup() ; + m_store.updated( m_repoll ) ; + } + catch(...) + { + } } void GSmtp::NewFile::addTo( const std::string & to , bool local ) @@ -126,10 +135,9 @@ bool GSmtp::NewFile::store( const std::string & auth_id , const std::string & cl // commit the envelope, or rollback the content // FileWriter claim_writer ; - if( ! ok || ! G::File::rename(p0,p1,G::File::NoThrow() ) ) + if( !ok || !commit(p0,p1) ) { - G_ASSERT( m_content_path.str().length() != 0U ) ; - G::File::remove( m_content_path , G::File::NoThrow() ) ; + rollback() ; if( !cancelled ) throw GSmtp::MessageStore::StorageError( reason ) ; } @@ -137,29 +145,58 @@ bool GSmtp::NewFile::store( const std::string & auth_id , const std::string & cl return cancelled ; } +bool GSmtp::NewFile::commit( const G::Path & p0 , const G::Path & p1 ) +{ + m_saved = G::File::rename( p0 , p1 , G::File::NoThrow() ) ; + return m_saved ; +} + +void GSmtp::NewFile::rollback() +{ + G::File::remove( m_content_path , G::File::NoThrow() ) ; +} + +void GSmtp::NewFile::cleanup() +{ + if( !m_saved ) + { + FileWriter claim_writer ; + G::File::remove( m_content_path , G::File::NoThrow() ) ; + } +} + bool GSmtp::NewFile::preprocess( const G::Path & path , bool & cancelled ) { - if( m_preprocess ) + if( ! m_preprocess ) return true ; + + int exit_code = preprocessCore( path ) ; + + bool is_ok = exit_code == 0 ; + bool is_special = exit_code >= 100 && exit_code <= 107 ; + bool is_failure = !is_ok && !is_special ; + + if( is_special && ((exit_code-100)&2) != 0 ) { - int exit_code = preprocessCore( path ) ; - if( exit_code == 100 ) - { - // a special exit-code for pre-processors which - // do their own message handling -- the pre-processor - // should delete the files before returning this - // exit code - // - cancelled = true ; - G_LOG( "GSmtp::NewFile: message processing cancelled by preprocessor" ) ; - return false ; - } - else if( exit_code != 0 ) - { - G_WARNING( "GSmtp::NewFile::preprocess: pre-processing failed: exit code " << exit_code ) ; - return false ; - } + m_repoll = true ; + } + + // ok, fail or cancel + // + if( is_special && ((exit_code-100)&1) == 0 ) + { + cancelled = true ; + G_LOG( "GSmtp::NewFile: message processing cancelled by preprocessor" ) ; + return false ; + } + else if( is_failure ) + { + G_WARNING( "GSmtp::NewFile::preprocess: pre-processing failed: exit code " << exit_code ) ; + return false ; + } + else + { + return true ; } - return true ; } int GSmtp::NewFile::preprocessCore( const G::Path & path ) diff --git a/src/gsmtp/gnewfile.h b/src/gsmtp/gnewfile.h index 5893845..02fb366 100644 --- a/src/gsmtp/gnewfile.h +++ b/src/gsmtp/gnewfile.h @@ -41,7 +41,7 @@ namespace GSmtp // NewMessage interface. Writes itself to the i/o streams // supplied by MessageStoreImp. // -class GSmtp::NewFile : public GSmtp:: NewMessage +class GSmtp::NewFile : public GSmtp::NewMessage { public: G_EXCEPTION( InvalidPath , "invalid path -- must be absolute" ) ; @@ -79,6 +79,8 @@ private: std::auto_ptr m_content ; G::Path m_content_path ; bool m_eight_bit ; + bool m_saved ; + bool m_repoll ; static bool m_preprocess ; static G::Path m_preprocessor ; @@ -90,6 +92,9 @@ private: void deliver( const G::Strings & , const G::Path & , const G::Path & , const G::Path & ) ; bool preprocess( const G::Path & , bool & ) ; int preprocessCore( const G::Path & ) ; + bool commit( const G::Path & , const G::Path & ) ; + void rollback() ; + void cleanup() ; } ; #endif diff --git a/src/gsmtp/gprotocolmessage.cpp b/src/gsmtp/gprotocolmessage.cpp index 73dc8be..6610dad 100644 --- a/src/gsmtp/gprotocolmessage.cpp +++ b/src/gsmtp/gprotocolmessage.cpp @@ -29,9 +29,3 @@ GSmtp::ProtocolMessage::~ProtocolMessage() { } -// === - -GSmtp::ProtocolMessage::Callback::~Callback() -{ -} - diff --git a/src/gsmtp/gprotocolmessage.h b/src/gsmtp/gprotocolmessage.h index 659b414..30ac1a2 100644 --- a/src/gsmtp/gprotocolmessage.h +++ b/src/gsmtp/gprotocolmessage.h @@ -26,6 +26,7 @@ #include "gdef.h" #include "gsmtp.h" +#include "gslot.h" #include "gstrings.h" #include "gverifier.h" #include @@ -47,20 +48,19 @@ namespace GSmtp class GSmtp::ProtocolMessage { public: - class Callback // A callback interface used by ProtocolMessage::process(). - { - public: virtual ~Callback() ; - public: virtual void processDone( bool success , unsigned long id , const std::string & reason ) = 0 ; - // Signals that ProtocolMessage::process() has completed. - // As a special case, if success is true and id is zero then - // the message processing was cancelled. - - private: void operator=( const Callback & ) ; // not implemented - } ; virtual ~ProtocolMessage() ; // Destructor. + virtual G::Signal3 & doneSignal() = 0 ; + // Returns a signal which is raised once process() has + // completed. + // + // The signal parameters are 'success', 'id' and 'reason'. + // + // As a special case, if success is true and id is zero then + // the message processing was cancelled. + virtual void clear() = 0 ; // Clears the message state and terminates // any asynchronous message processing. @@ -93,13 +93,13 @@ public: virtual std::string from() const = 0 ; // Returns the setFrom() string. - virtual void process( Callback & callback , const std::string & authenticated_client_id , + virtual void process( const std::string & authenticated_client_id , const std::string & peer_ip_address ) = 0 ; // Starts asynchronous processing of the // message. Once processing is complete the - // message state is cleared and the callback - // is triggered. The callback may be called - // before process() returns. + // message state is cleared and the doneSignal() + // is raised. The signal may be raised before + // process() returns. // // The client-id parameter is used to propogate // authentication information from the SMTP diff --git a/src/gsmtp/gprotocolmessageforward.cpp b/src/gsmtp/gprotocolmessageforward.cpp index 326393f..91ebe1f 100644 --- a/src/gsmtp/gprotocolmessageforward.cpp +++ b/src/gsmtp/gprotocolmessageforward.cpp @@ -31,16 +31,28 @@ #include "gassert.h" #include "glog.h" -GSmtp::ProtocolMessageForward::ProtocolMessageForward( const std::string & server ) : - m_server(server) , - m_callback(NULL) +GSmtp::ProtocolMessageForward::ProtocolMessageForward( MessageStore & store , + const Secrets & client_secrets , const std::string & server , + unsigned int response_timeout , unsigned int connection_timeout ) : + m_store(store) , + m_client_secrets(client_secrets) , + m_pm(store) , + m_server(server) , + m_response_timeout(response_timeout) , + m_connection_timeout(connection_timeout) { + m_pm.doneSignal().connect( G::slot(*this,&ProtocolMessageForward::processDone) ) ; } GSmtp::ProtocolMessageForward::~ProtocolMessageForward() { } +G::Signal3 & GSmtp::ProtocolMessageForward::doneSignal() +{ + return m_signal ; +} + void GSmtp::ProtocolMessageForward::clear() { m_pm.clear() ; @@ -72,14 +84,13 @@ std::string GSmtp::ProtocolMessageForward::from() const return m_pm.from() ; } -void GSmtp::ProtocolMessageForward::process( ProtocolMessage::Callback & callback , const std::string & auth_id , +void GSmtp::ProtocolMessageForward::process( const std::string & auth_id , const std::string & client_ip ) { - m_callback = & callback ; - m_pm.process( *this , auth_id , client_ip ) ; + m_pm.process( auth_id , client_ip ) ; } -void GSmtp::ProtocolMessageForward::processDone( bool success , unsigned long id , const std::string & reason_in ) +void GSmtp::ProtocolMessageForward::processDone( bool success , unsigned long id , std::string reason_in ) { std::string reason( reason_in ) ; bool nothing_to_do = success && id == 0UL ; @@ -91,10 +102,7 @@ void GSmtp::ProtocolMessageForward::processDone( bool success , unsigned long id if( nothing_to_do || !success ) { - G_ASSERT( m_callback != NULL ) ; - if( m_callback ) - m_callback->processDone( success , id , reason ) ; - m_callback = NULL ; + m_signal.emit( success , id , reason ) ; } } @@ -106,7 +114,7 @@ bool GSmtp::ProtocolMessageForward::forward( unsigned long id , bool & nothing_t *reason_p = std::string() ; G_DEBUG( "GSmtp::ProtocolMessageForward::forward: forwarding message " << id ) ; - std::auto_ptr message = GSmtp::MessageStore::instance().get( id ) ; + std::auto_ptr message = m_store.get( id ) ; bool ok = true ; if( message->remoteRecipientCount() == 0U ) @@ -117,8 +125,9 @@ bool GSmtp::ProtocolMessageForward::forward( unsigned long id , bool & nothing_t } else { - m_client <<= new GSmtp::Client( message , *this ) ; - std::string reason = m_client->init( m_server ) ; + m_client <<= new GSmtp::Client( message , m_client_secrets , m_response_timeout ) ; + m_client->doneSignal().connect( G::slot(*this,&ProtocolMessageForward::clientDone) ) ; + std::string reason = m_client->startSending( m_server , m_connection_timeout ) ; ok = reason.empty() ; if( !ok && reason_p != NULL ) @@ -138,12 +147,6 @@ void GSmtp::ProtocolMessageForward::clientDone( std::string reason ) { G_DEBUG( "GSmtp::ProtocolMessageForward::clientDone: \"" << reason << "\"" ) ; const bool ok = reason.empty() ; - - G_ASSERT( m_callback != NULL ) ; - if( m_callback ) - { - m_callback->processDone( ok , m_id , reason ) ; - m_callback = NULL ; - } + m_signal.emit( ok , m_id , reason ) ; } diff --git a/src/gsmtp/gprotocolmessageforward.h b/src/gsmtp/gprotocolmessageforward.h index e06810a..26bcaf5 100644 --- a/src/gsmtp/gprotocolmessageforward.h +++ b/src/gsmtp/gprotocolmessageforward.h @@ -28,7 +28,9 @@ #include "gsmtp.h" #include "gprotocolmessage.h" #include "gprotocolmessagestore.h" +#include "gsecrets.h" #include "gsmtpclient.h" +#include "gmessagestore.h" #include "gnewmessage.h" #include #include @@ -49,17 +51,21 @@ namespace GSmtp // // See also: ProtocolMessageStore // -class GSmtp::ProtocolMessageForward : public GSmtp:: ProtocolMessage , - private GSmtp:: ProtocolMessage::Callback , - private GSmtp:: Client::ClientCallback +class GSmtp::ProtocolMessageForward : public GSmtp::ProtocolMessage { public: - explicit ProtocolMessageForward( const std::string & server_address ) ; - // Constructor. + ProtocolMessageForward( MessageStore & store , const Secrets & client_secrets , + const std::string & server_address , unsigned int response_timeout , + unsigned int connection_timeout ) ; + // Constructor. The 'store' and 'client-secrets' references + // are kept. virtual ~ProtocolMessageForward() ; // Destructor. + virtual G::Signal3 & doneSignal() ; + // See ProtocolMessage. + virtual void clear() ; // See ProtocolMessage. @@ -78,22 +84,25 @@ public: virtual std::string from() const ; // See ProtocolMessage. - virtual void process( ProtocolMessage::Callback & callback , const std::string & auth_id , - const std::string & client_ip ) ; - // See ProtocolMessage. + virtual void process( const std::string & auth_id , const std::string & client_ip ) ; + // See ProtocolMessage. private: void operator=( const ProtocolMessageForward & ) ; // not implemented - virtual void processDone( bool , unsigned long , const std::string & ) ; // from ProtocolMessage::Callback - virtual void clientDone( std::string ) ; // from Client::ClientCallback + void processDone( bool , unsigned long , std::string ) ; // ProtocolMessage::doneSignal() + void clientDone( std::string ) ; // Client::doneSignal() bool forward( unsigned long , bool & , std::string * ) ; private: + MessageStore & m_store ; + const Secrets & m_client_secrets ; ProtocolMessageStore m_pm ; std::string m_server ; - ProtocolMessage::Callback * m_callback ; std::auto_ptr m_client ; unsigned long m_id ; + unsigned int m_response_timeout ; + unsigned int m_connection_timeout ; + G::Signal3 m_signal ; } ; #endif diff --git a/src/gsmtp/gprotocolmessagestore.cpp b/src/gsmtp/gprotocolmessagestore.cpp index a762133..13f3e48 100644 --- a/src/gsmtp/gprotocolmessagestore.cpp +++ b/src/gsmtp/gprotocolmessagestore.cpp @@ -30,7 +30,8 @@ #include "gassert.h" #include "glog.h" -GSmtp::ProtocolMessageStore::ProtocolMessageStore() +GSmtp::ProtocolMessageStore::ProtocolMessageStore( MessageStore & store ) : + m_store(store) { } @@ -54,7 +55,7 @@ bool GSmtp::ProtocolMessageStore::setFrom( const std::string & from ) G_ASSERT( m_msg.get() == NULL ) ; clear() ; // just in case - std::auto_ptr new_message( MessageStore::instance().newMessage(from) ) ; + std::auto_ptr new_message( m_store.newMessage(from) ) ; m_msg <<= new_message.release() ; m_from = from ; @@ -106,8 +107,7 @@ std::string GSmtp::ProtocolMessageStore::from() const return m_msg.get() ? m_from : std::string() ; } -void GSmtp::ProtocolMessageStore::process( Callback & callback , const std::string & auth_id , - const std::string & client_ip ) +void GSmtp::ProtocolMessageStore::process( const std::string & auth_id , const std::string & client_ip ) { try { @@ -121,14 +121,19 @@ void GSmtp::ProtocolMessageStore::process( Callback & callback , const std::stri id = m_msg->id() ; } clear() ; - callback.processDone( true , id , std::string() ) ; + m_signal.emit( true , id , std::string() ) ; } catch( std::exception & e ) { G_ERROR( "GSmtp::ProtocolMessage::process: error: " << e.what() ) ; clear() ; - callback.processDone( false , 0UL , e.what() ) ; + m_signal.emit( false , 0UL , e.what() ) ; } } +G::Signal3 & GSmtp::ProtocolMessageStore::doneSignal() +{ + return m_signal ; +} + diff --git a/src/gsmtp/gprotocolmessagestore.h b/src/gsmtp/gprotocolmessagestore.h index d7eb48d..e372724 100644 --- a/src/gsmtp/gprotocolmessagestore.h +++ b/src/gsmtp/gprotocolmessagestore.h @@ -27,7 +27,9 @@ #include "gdef.h" #include "gsmtp.h" #include "gprotocolmessage.h" +#include "gmessagestore.h" #include "gnewmessage.h" +#include "gslot.h" #include #include @@ -42,15 +44,18 @@ namespace GSmtp // messages in the message store. // See also: ProtocolMessageForward // -class GSmtp::ProtocolMessageStore : public GSmtp:: ProtocolMessage +class GSmtp::ProtocolMessageStore : public GSmtp::ProtocolMessage { public: - ProtocolMessageStore() ; + explicit ProtocolMessageStore( MessageStore & store ) ; // Constructor. virtual ~ProtocolMessageStore() ; // Destructor. + virtual G::Signal3 & doneSignal() ; + // See ProtocolMessage. + virtual void clear() ; // See ProtocolMessage. @@ -69,16 +74,17 @@ public: virtual std::string from() const ; // See ProtocolMessage. - virtual void process( ProtocolMessage::Callback & callback , const std::string & auth_id , - const std::string & client_ip ) ; - // See ProtocolMessage. + virtual void process( const std::string & auth_id , const std::string & client_ip ) ; + // See ProtocolMessage. private: void operator=( const ProtocolMessageStore & ) ; // not implemented private: + MessageStore & m_store ; std::auto_ptr m_msg ; std::string m_from ; + G::Signal3 m_signal ; } ; #endif diff --git a/src/gsmtp/gsasl.h b/src/gsmtp/gsasl.h index a6c34bd..3f0b276 100644 --- a/src/gsmtp/gsasl.h +++ b/src/gsmtp/gsasl.h @@ -36,70 +36,20 @@ namespace GSmtp { - class Sasl ; - class SaslImp ; class SaslClient ; class SaslClientImp ; class SaslServer ; class SaslServerImp ; } -// Class: GSmtp::Sasl -// Description: A singleton class representing the SASL library. -// The SASL challenge/response concept is described in RFC2222. -// See also: GSmtp::SaslClient, GSmtp::SaslServer, RFC2554, RFC2222 -// -class GSmtp::Sasl -{ -public: - G_EXCEPTION( Error , "sasl library error" ) ; - - Sasl( const std::string & application_name , - const G::Path & client_secrets , const G::Path & server_secrets ) ; - // Constructor. - - ~Sasl() ; - // Destructor. - - static Sasl & instance() ; - // Singleton access. - - const Secrets & clientSecrets() const ; - // Returns a reference to the client-side secrets object. - - const Secrets & serverSecrets() const ; - // Returns a reference to the server-side secrets object. - - void check( const std::string & op , int rc , const char * more = NULL ) const ; - // Used by implementation classes to check function - // return codes. - - std::string errorString( const std::string & op , int rc , const char * more = NULL ) const ; - // Used by implementation classes to interpret function - // return codes. - -private: - Sasl( const Sasl & ) ; // not implemented - void operator=( const Sasl & ) ; // not implemented - typedef std::map Map ; - void insert( int , const std::string & ) ; - void initMap() ; - void initClient( const G::Path & ) ; - void initServer( const std::string & , const G::Path & ) ; - -private: - static Sasl * m_this ; - Map m_map ; - std::auto_ptr m_client_secrets ; - std::auto_ptr m_server_secrets ; -} ; - // Class: GSmtp::SaslServer // Description: A class for implementing the server-side SASL -// challenge/response concept, as described in RFC2222. +// challenge/response concept. SASL is described in RFC2222, +// and the SMTP extension for authentication is described +// in RFC2554. // // Usage: -/// SaslServer sasl ; +/// SaslServer sasl( secrets ) ; /// if( sasl.init("MD5") ) /// { /// client.send( sasl.initialChallenge() ) ; @@ -119,8 +69,8 @@ private: class GSmtp::SaslServer { public: - SaslServer() ; - // Default constructor. + explicit SaslServer( const Secrets & ) ; + // Constructor. The reference is kept. ~SaslServer() ; // Destructor. @@ -160,7 +110,7 @@ public: std::string mechanisms( char sep = ' ' ) const ; // Returns a list of supported mechanisms. - bool trusted( GNet::Address ) ; + bool trusted( GNet::Address ) const ; // Returns true if a trusted client that // does not need to authenticate. @@ -174,14 +124,16 @@ private: // Class: GSmtp::SaslClient // Description: A class for implementing the client-side SASL -// challenge/response concept. +// challenge/response concept. SASL is described in RFC2222, +// and the SMTP extension for authentication is described +// in RFC2554. // See also: GSmtp::SaslServer, RFC2222, RFC2554. // class GSmtp::SaslClient { public: - explicit SaslClient( const std::string & server_name ) ; - // Constructor. + SaslClient( const Secrets & secrets , const std::string & server_name ) ; + // Constructor. The secrets reference is kept. ~SaslClient() ; // Destructor. diff --git a/src/gsmtp/gsasl_cyrus.cpp b/src/gsmtp/gsasl_cyrus.cpp index 0de225c..4ee8608 100644 --- a/src/gsmtp/gsasl_cyrus.cpp +++ b/src/gsmtp/gsasl_cyrus.cpp @@ -17,475 +17,6 @@ // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. // // === -// -// gsasl_cyrus.cpp -// -// An incomplete implementation of GSmtp::Sasl using Carnegie Mellon's "cyrus" -// SASL library (http://www.cmu.edu/computing). -// -// This is work-in-progress which will probably never get completed because -// the cyrus documentation is not good enough. -// -#include "gdef.h" -#include "gsmtp.h" -#include "gsasl.h" -#include "gstr.h" -#include "glocal.h" -#include "gmemory.h" -#include "gdebug.h" -#include - -extern "C" -{ -#include -} ; - -// === - -// Class: GSmtp::SaslClientImp -// Description: A private pimple-pattern implementation class used by GSmtp::SaslClient. -// -class GSmtp::SaslClientImp -{ -public: - SaslClientImp( const std::string & server_name ) ; - ~SaslClientImp() ; - bool active() const ; - std::string response( const std::string & mechanism , - const std::string & challenge , bool & done , bool & error ) const ; - std::string preferred( const G::Strings & mechanism_list ) const ; - -private: - ::sasl_conn_t * m_connection_p ; -} ; - -// === - -// Class: GSmtp::SaslServerImp -// Description: A private pimple-pattern implementation class used by GSmtp::SaslServer. -// -class GSmtp::SaslServerImp -{ -public: - SaslServerImp() ; - ~SaslServerImp() ; - bool active() const ; - bool init( const std::string & mechanism ) ; - bool mustChallenge() const ; - std::string initialChallenge() const ; - std::string apply( const std::string & response , bool & done ) ; - bool authenticated() const ; - std::string id() const ; - std::string mechanisms( char sep = ' ' ) const ; - -private: - std::string step( const std::string & response , bool & done ) const ; - -private: - ::sasl_conn_t * m_connection_p ; - std::string m_mechanism ; - bool m_first ; - bool m_done ; -} ; - -// === - -GSmtp::SaslServerImp::SaslServerImp() : - m_first(true) , - m_done(false) -{ - std::string fqdn = GNet::Local::fqdn() ; - int flags = 0 ; // SASL_SECURITY_LAYER - int rc = ::sasl_server_new( "smtp" , fqdn.c_str() , NULL , NULL , flags , &m_connection_p ) ; - Sasl::instance().check( "sasl_server_new" , rc ) ; -} - -GSmtp::SaslServerImp::~SaslServerImp() -{ - ::sasl_dispose( &m_connection_p ) ; -} - -bool GSmtp::SaslServerImp::mustChallenge() const -{ - return false ; // <= can have an initial response -} - -bool GSmtp::SaslServerImp::active() const -{ - return Sasl::instance().serverSecrets().valid() ; -} - -bool GSmtp::SaslServerImp::authenticated() const -{ - return m_done ; -} - -std::string GSmtp::SaslServerImp::id() const -{ - return "" ; // for now -} - -std::string GSmtp::SaslServerImp::mechanisms( char sep ) const -{ - char * list = NULL ; - unsigned int listlen = 0U ; - unsigned int count = 0U ; - int rc = ::sasl_listmech( m_connection_p , NULL , "" , "," , "" , &list , &listlen , &count ) ; - Sasl::instance().check( "sasl_listmech" , rc ) ; - - std::string result ; - if( list != NULL && listlen != 0 ) - { - G::Strings word_list ; - G::Str::splitIntoFields( std::string(list,listlen) , word_list , "," ) ; - for( G::Strings::iterator p = word_list.begin() ; p != word_list.end() ; ++p ) - { - if( result.length() ) - result.append( 1U , sep ) ; - result.append( *p ) ; - } - } - return result ; -} - -bool GSmtp::SaslServerImp::init( const std::string & mechanism ) -{ - m_mechanism = mechanism ; - m_first = true ; - m_done = false ; - return true ; -} - -std::string GSmtp::SaslServerImp::step( const std::string & response , bool & done ) const -{ - const char * error = NULL ; - char * out = NULL ; - unsigned int outlen = 0U ; - const char * response_data = response.length() ? response.data() : NULL ; - int rc = 0 ; - const char * op = m_first ? "sasl_server_start" : "sasl_server_step" ; - if( m_first ) - { - const_cast(this)->m_first = false ; // mutable m_first - rc = ::sasl_server_start( m_connection_p , m_mechanism.c_str() , - response_data , response.length() , - &out , &outlen , &error ) ; - } - else - { - rc = ::sasl_server_step( m_connection_p , - response_data , response.length() , - &out , &outlen , &error ) ; - } - Sasl::instance().check( op , rc , error ) ; - G_ASSERT( rc == SASL_OK || rc == SASL_CONTINUE ) ; - done = rc == SASL_OK ; - - std::string result ; - if( !done && out != NULL && outlen != 0U ) - result = std::string( out , outlen ) ; - return result ; -} - -std::string GSmtp::SaslServerImp::apply( const std::string & response , bool & done ) -{ - std::string challenge = step( response , done ) ; - m_done = done ; - return challenge ; -} - -std::string GSmtp::SaslServerImp::initialChallenge() const -{ - bool done = false ; - std::string challenge = step( "" , done ) ; - if( done ) - throw Sasl::Error( "no initial challenge" ) ; - return challenge ; -} - -// === - -GSmtp::SaslClientImp::SaslClientImp( const std::string & server_name ) : - m_connection_p(NULL) -{ - int flags = 0 ; - int rc = ::sasl_client_new( "smtp" , server_name.c_str() , NULL , flags , &m_connection_p ) ; - Sasl::instance().check( "sasl_client_new" , rc ) ; -} - -GSmtp::SaslClientImp::~SaslClientImp() -{ - ::sasl_dispose( &m_connection_p ) ; -} - -bool GSmtp::SaslClientImp::active() const -{ - return Sasl::instance().clientSecrets().valid() ; -} - -std::string GSmtp::SaslClientImp::preferred( const G::Strings & mechanism_list ) const -{ - std::string list ; - const char * sep = "" ; - for( G::Strings::const_iterator mp = mechanism_list.begin() ; mp != mechanism_list.end() ; ++mp , sep = " " ) - { - list = std::string(sep) + (*mp) ; - } - - int rc ; - ::sasl_interact_t * interaction_p = NULL ; - char * out = NULL ; - unsigned int outlen = 0U ; - const char * chosen = NULL ; - rc = ::sasl_client_start( m_connection_p , list.c_str() , NULL , &interaction_p , &out , &outlen , &chosen ) ; - Sasl::instance().check( "sasl_client_start" , rc ) ; - - std::string result ; - if( chosen != NULL ) - result = std::string(chosen) ; - return result ; -} - -std::string GSmtp::SaslClientImp::response( const std::string & mechanism , - const std::string & challenge , bool & done , bool & error ) const -{ - ::sasl_interact_t * interaction_p = NULL ; - char * out = NULL ; - unsigned int outlen = 0U ; - int rc = ::sasl_client_step( m_connection_p , challenge.data() , challenge.length() , &interaction_p , - &out , &outlen ) ; - done = rc == SASL_OK ; - error = rc != SASL_OK && rc != SASL_CONTINUE ; - if( error ) - G_WARNING( "GSmtp::SaslClient: authentication error: " << - Sasl::instance().errorString("sasl_client_step",rc) ) ; - - std::string result ; - if( !error && !done && out != NULL && outlen != 0U ) - result = std::string( out , outlen ) ; - return result ; -} - -// === - -GSmtp::Sasl * GSmtp::Sasl::m_this = NULL ; - -GSmtp::Sasl::Sasl( const std::string & app_name , const G::Path & client_path , const G::Path & server_path ) -{ - if( m_this == NULL ) - { - m_this = this ; - - initMap() ; - initClient( client_path ) ; - initServer( app_name , server_path ) ; - } -} - -void GSmtp::Sasl::initClient( const G::Path & path ) -{ - m_client_secrets <<= new Secrets(path) ; - if( m_client_secrets->valid() ) - { - static sasl_callback_t callbacks[] = - { - { SASL_CB_GETREALM , NULL , NULL } , - { SASL_CB_USER , NULL , NULL } , - { SASL_CB_AUTHNAME , NULL , NULL } , - { SASL_CB_PASS , NULL , NULL } , - { SASL_CB_LIST_END , NULL , NULL } - } ; - - int rc = ::sasl_client_init( callbacks ) ; - check( "sasl_client_init" , rc ) ; - } -} - -void GSmtp::Sasl::initServer( const std::string & app_name , const G::Path & path ) -{ - m_server_secrets <<= new Secrets(path) ; - if( m_server_secrets->valid() ) - { - static sasl_callback_t callbacks[] = - { - { SASL_CB_GETREALM , NULL , NULL } , - { SASL_CB_USER , NULL , NULL } , - { SASL_CB_AUTHNAME , NULL , NULL } , - { SASL_CB_PASS , NULL , NULL } , - { SASL_CB_LIST_END , NULL , NULL } - } ; - - int rc = ::sasl_server_init( callbacks , app_name.c_str() ) ; - check( "sasl_server_init" , rc ) ; - } -} - -GSmtp::Sasl::~Sasl() -{ - if( m_this == this ) - { - m_this = NULL ; - ::sasl_done() ; - } -} - -GSmtp::Sasl & GSmtp::Sasl::instance() -{ - if( m_this == NULL ) - throw Error( "no instance" ) ; - return * m_this ; -} - -void GSmtp::Sasl::check( const std::string & op , int rc , const char * more_p ) const -{ - if( rc != SASL_OK && rc != SASL_CONTINUE ) - { - throw Error( errorString(op,rc,more_p) ) ; - } -} - -std::string GSmtp::Sasl::errorString( const std::string & op , int rc , const char * more_p ) const -{ - std::string text = "unknown error" ; - Map::const_iterator map_p = m_map.find( rc ) ; - if( map_p != m_map.end() ) - text = (*map_p).second ; - - if( more_p != NULL ) - { - text.append( ": " ) ; - text.append( std::string(more_p) ) ; - } - - return op + ": " + text ; -} - -void GSmtp::Sasl::insert( int first , const std::string & second ) -{ - m_map.insert( std::make_pair(first,second) ) ; -} - -const GSmtp::Secrets & GSmtp::Sasl::clientSecrets() const -{ - G_ASSERT( m_client_secrets.get() != NULL ) ; - return *m_client_secrets.get() ; -} - -const GSmtp::Secrets & GSmtp::Sasl::serverSecrets() const -{ - G_ASSERT( m_server_secrets.get() != NULL ) ; - return *m_server_secrets.get() ; -} - -void GSmtp::Sasl::initMap() -{ - insert( SASL_CONTINUE , "another step is needed in authentication" ) ; - insert( SASL_OK , "successful result" ) ; - insert( SASL_FAIL , "generic failure" ) ; - insert( SASL_NOMEM , "memory shortage failure" ) ; - insert( SASL_BUFOVER , "overflowed buffer" ) ; - insert( SASL_NOMECH , "mechanism not supported" ) ; - insert( SASL_BADPROT , "bad protocol / cancel" ) ; - insert( SASL_NOTDONE , "cant request info until later in exchange" ) ; - insert( SASL_BADPARAM , "invalid parameter supplied" ) ; - insert( SASL_TRYAGAIN , "transient failure (e.g., weak key)" ) ; - insert( SASL_BADMAC , "integrity check failed" ) ; - insert( SASL_INTERACT , "needs user interaction" ) ; - insert( SASL_BADSERV , "server failed mutual authentication step" ) ; - insert( SASL_WRONGMECH , "mechanism doesnt support requested feature" ) ; - insert( SASL_NEWSECRET , "new secret needed" ) ; - insert( SASL_BADAUTH , "authentication failure" ) ; - insert( SASL_NOAUTHZ , "authorization failure" ) ; - insert( SASL_TOOWEAK , "mechanism too weak for this user" ) ; - insert( SASL_ENCRYPT , "encryption needed to use mechanism" ) ; - insert( SASL_TRANS , "One time use of a plaintext password will enable requested mechanism for user" ) ; - insert( SASL_EXPIRED , "passphrase expired, has to be reset" ) ; - insert( SASL_DISABLED , "account disabled" ) ; - insert( SASL_NOUSER , "user not found" ) ; - insert( SASL_PWLOCK , "password locked" ) ; - insert( SASL_NOCHANGE , "requested change was not needed" ) ; - insert( SASL_BADVERS , "version mismatch with plug-in" ) ; - insert( SASL_NOPATH , "path not set" ) ; -} - -// === - -GSmtp::SaslClient::SaslClient( const std::string & server_name ) : - m_imp( new SaslClientImp(server_name) ) -{ -} - -GSmtp::SaslClient::~SaslClient() -{ - delete m_imp ; -} - -bool GSmtp::SaslClient::active() const -{ - return m_imp->active() ; -} - -std::string GSmtp::SaslClient::response( const std::string & mechanism , - const std::string & challenge , bool & done , bool & error ) const -{ - return m_imp->response( mechanism , challenge , done , error ) ; -} - -std::string GSmtp::SaslClient::preferred( const G::Strings & mechanism_list ) const -{ - return m_imp->preferred( mechanism_list ) ; -} - -// === - -GSmtp::SaslServer::SaslServer() : - m_imp(new SaslServerImp) -{ -} - -GSmtp::SaslServer::~SaslServer() -{ - delete m_imp ; -} - -std::string GSmtp::SaslServer::mechanisms( char c ) const -{ - return m_imp->mechanisms() ; -} - -bool GSmtp::SaslServer::active() const -{ - return m_imp->active() ; -} - -bool GSmtp::SaslServer::mustChallenge() const -{ - m_imp->mustChallenge() ; -} - -bool GSmtp::SaslServer::init( const std::string & mechanism ) -{ - m_imp->init( mechanism ) ; -} - -std::string GSmtp::SaslServer::initialChallenge() const -{ - return m_imp->initialChallenge() ; -} - -std::string GSmtp::SaslServer::apply( const std::string & response , bool & done ) -{ - return m_imp->apply( response , done ) ; -} - -bool GSmtp::SaslServer::authenticated() const -{ - return m_imp->authenticated() ; -} - -std::string GSmtp::SaslServer::id() const -{ - return m_imp->id() ; -} +#error not used diff --git a/src/gsmtp/gsasl_native.cpp b/src/gsmtp/gsasl_native.cpp index 4bed71f..216a96f 100644 --- a/src/gsmtp/gsasl_native.cpp +++ b/src/gsmtp/gsasl_native.cpp @@ -39,8 +39,6 @@ namespace const char * login_challenge_2 = "Password:" ; } -// === - // Class: GSmtp::SaslServerImp // Description: A private pimple-pattern implementation class used by GSmtp::SaslServer. // @@ -48,22 +46,36 @@ class GSmtp::SaslServerImp { public: bool m_first ; + const Secrets & m_secrets ; std::string m_mechanism ; std::string m_challenge ; bool m_authenticated ; std::string m_id ; std::string m_trustee ; - SaslServerImp() ; + explicit SaslServerImp( const Secrets & ) ; bool init( const std::string & mechanism ) ; bool validate( const std::string & secret , const std::string & response ) const ; - bool trusted( GNet::Address ) ; - bool trustedCore( const std::string & , const std::string & ) ; + bool trusted( GNet::Address ) const ; + bool trustedCore( const std::string & , const std::string & ) const ; static std::string clientResponse( const std::string & secret , const std::string & challenge , bool & error ) ; } ; -GSmtp::SaslServerImp::SaslServerImp() : +// Class: GSmtp::SaslClientImp +// Description: A private pimple-pattern implementation class used by GSmtp::SaslClient. +// +class GSmtp::SaslClientImp +{ +public: + const Secrets & m_secrets ; + explicit SaslClientImp( const Secrets & ) ; +} ; + +// === + +GSmtp::SaslServerImp::SaslServerImp( const Secrets & secrets ) : m_first(true) , + m_secrets(secrets) , m_authenticated(false) { } @@ -135,11 +147,11 @@ std::string GSmtp::SaslServerImp::clientResponse( const std::string & secret , return std::string() ; } -bool GSmtp::SaslServerImp::trusted( GNet::Address address ) +bool GSmtp::SaslServerImp::trusted( GNet::Address address ) const { std::string ip = address.displayString(false) ; G_DEBUG( "GSmtp::SaslServerImp::trusted: \"" << ip << "\"" ) ; - G::Str::StringArray part ; + G::StringArray part ; G::Str::splitIntoFields( ip , part , "." ) ; if( part.size() == 4U ) { @@ -156,16 +168,16 @@ bool GSmtp::SaslServerImp::trusted( GNet::Address address ) } } -bool GSmtp::SaslServerImp::trustedCore( const std::string & full , const std::string & key ) +bool GSmtp::SaslServerImp::trustedCore( const std::string & full , const std::string & key ) const { G_DEBUG( "GSmtp::SaslServerImp::trustedCore: \"" << full << "\", \"" << key << "\"" ) ; - std::string secret = Sasl::instance().serverSecrets().secret("NONE",key) ; + std::string secret = m_secrets.secret("NONE",key) ; bool trusted = ! secret.empty() ; if( trusted ) { G_LOG( "GSmtp::SaslServer::trusted: trusting \"" << full << "\" " << "(matched on NONE/server/" << key << "/" << secret << ")" ) ; - m_trustee = secret ; + const_cast(this)->m_trustee = secret ; } return trusted ; } @@ -179,14 +191,25 @@ std::string GSmtp::SaslServer::mechanisms( char c ) const return s ; } -GSmtp::SaslServer::SaslServer() : - m_imp(new SaslServerImp) +std::string GSmtp::SaslServer::mechanism() const +{ + return m_imp->m_mechanism ; +} + +bool GSmtp::SaslServer::trusted( GNet::Address a ) const +{ + G_DEBUG( "GSmtp::SaslServer::trusted: checking \"" << a.displayString(false) << "\"" ) ; + return m_imp->trusted(a) ; +} + +GSmtp::SaslServer::SaslServer( const Secrets & secrets ) : + m_imp(new SaslServerImp(secrets)) { } bool GSmtp::SaslServer::active() const { - return Sasl::instance().serverSecrets().valid() ; + return m_imp->m_secrets.valid() ; } GSmtp::SaslServer::~SaslServer() @@ -201,19 +224,9 @@ bool GSmtp::SaslServer::mustChallenge() const bool GSmtp::SaslServer::init( const std::string & mechanism ) { - G_DEBUG( "GSmtp::SaslServer::init: mechanism \"" << mechanism << "\"" ) ; - return m_imp->init( mechanism ) ; -} - -std::string GSmtp::SaslServer::mechanism() const -{ - return m_imp->m_mechanism ; -} - -bool GSmtp::SaslServer::trusted( GNet::Address a ) -{ - G_DEBUG( "GSmtp::SaslServer::trusted: checking \"" << a.displayString(false) << "\"" ) ; - return m_imp->trusted(a) ; + bool rc = m_imp->init( mechanism ) ; + G_DEBUG( "GSmtp::SaslServer::init: \"" << mechanism << "\" -> \"" << m_imp->m_mechanism << "\"" ) ; + return rc ; } std::string GSmtp::SaslServer::initialChallenge() const @@ -238,7 +251,7 @@ std::string GSmtp::SaslServer::apply( const std::string & response , bool & done { m_imp->m_id = part_list.front() ; G_DEBUG( "GSmtp::SaslServer::apply: id \"" << m_imp->m_id << "\"" ) ; - std::string secret = Sasl::instance().serverSecrets().secret(m_imp->m_mechanism,m_imp->m_id) ; + std::string secret = m_imp->m_secrets.secret(m_imp->m_mechanism,m_imp->m_id) ; m_imp->m_authenticated = m_imp->validate( secret , part_list.back() ) ; } done = true ; @@ -252,7 +265,7 @@ std::string GSmtp::SaslServer::apply( const std::string & response , bool & done } else { - std::string secret = Sasl::instance().serverSecrets().secret(m_imp->m_mechanism,m_imp->m_id) ; + std::string secret = m_imp->m_secrets.secret(m_imp->m_mechanism,m_imp->m_id) ; m_imp->m_first = true ; m_imp->m_authenticated = !response.empty() && response == secret ; done = true ; @@ -274,20 +287,28 @@ std::string GSmtp::SaslServer::id() const // === -GSmtp::SaslClient::SaslClient( const std::string & server_name ) : - m_imp(NULL) +GSmtp::SaslClientImp::SaslClientImp( const Secrets & secrets ) : + m_secrets(secrets) { - G_DEBUG( "GSmtp::SaslClient::ctor: \"" << server_name << "\"" ) ; - (void) server_name.length() ; // pacify compiler +} + +// === + +GSmtp::SaslClient::SaslClient( const Secrets & secrets , const std::string & server_name ) : + m_imp(new SaslClientImp(secrets) ) +{ + G_DEBUG( "GSmtp::SaslClient::ctor: server-name=\"" << server_name << "\", active=" << active() ) ; + G_IGNORE server_name.length() ; // pacify compiler } GSmtp::SaslClient::~SaslClient() { + delete m_imp ; } bool GSmtp::SaslClient::active() const { - return Sasl::instance().clientSecrets().valid() ; + return m_imp->m_secrets.valid() ; } std::string GSmtp::SaslClient::response( const std::string & mechanism , @@ -299,8 +320,8 @@ std::string GSmtp::SaslClient::response( const std::string & mechanism , std::string rsp ; if( mechanism == "CRAM-MD5" ) { - std::string id = Sasl::instance().clientSecrets().id(mechanism) ; - std::string secret = Sasl::instance().clientSecrets().secret(mechanism) ; + std::string id = m_imp->m_secrets.id(mechanism) ; + std::string secret = m_imp->m_secrets.secret(mechanism) ; error = id.empty() || secret.empty() ; if( !error ) rsp = id + " " + SaslServerImp::clientResponse( secret , challenge , error ) ; @@ -309,13 +330,13 @@ std::string GSmtp::SaslClient::response( const std::string & mechanism , } else if( challenge == login_challenge_1 ) { - rsp = Sasl::instance().clientSecrets().id(mechanism) ; + rsp = m_imp->m_secrets.id(mechanism) ; error = rsp.empty() ; done = false ; } else if( challenge == login_challenge_2 ) { - rsp = Sasl::instance().clientSecrets().secret(mechanism) ; + rsp = m_imp->m_secrets.secret(mechanism) ; error = rsp.empty() ; done = true ; } @@ -331,6 +352,8 @@ std::string GSmtp::SaslClient::response( const std::string & mechanism , std::string GSmtp::SaslClient::preferred( const G::Strings & mechanism_list ) const { + G_DEBUG( "GSmtp::SaslClient::preferred: server's mechanisms: " << G::Str::join(mechanism_list,",") ) ; + // short-circuit if no secrets // if( !active() ) @@ -346,7 +369,6 @@ std::string GSmtp::SaslClient::preferred( const G::Strings & mechanism_list ) co { std::string mechanism = *p ; G::Str::toUpper( mechanism ) ; - G_DEBUG( "GSmtp::SaslClient::preferred: \"" << mechanism << "\"" ) ; if( mechanism == login ) has_login = true ; else if( mechanism == cram ) @@ -356,18 +378,23 @@ std::string GSmtp::SaslClient::preferred( const G::Strings & mechanism_list ) co // prefer cram-md5 over login... // std::string result = has_cram ? cram : ( has_login ? login : std::string() ) ; + G_DEBUG( "GSmtp::SaslClient::preferred: we prefer \"" << result << "\"" ) ; // ... but only if a secret is defined for it // - if( !result.empty() && Sasl::instance().clientSecrets().id(result).empty() ) + if( !result.empty() && m_imp->m_secrets.id(result).empty() ) { + G_DEBUG( "GSmtp::SaslClient::preferred: .. but no secret" ) ; result = std::string() ; if( has_cram && has_login ) { result = login ; - if( Sasl::instance().clientSecrets().id(login).empty() ) + if( m_imp->m_secrets.id(login).empty() ) result = std::string() ; } + G_DEBUG( "GSmtp::SaslClient::preferred: we now prefer \"" << result << "\"" ) ; + + // one-shot warning static bool first = true ; if( first ) G_WARNING( "GSmtp::SaslClient: missing \"login\" or \"cram-md5\" entry in secrets file" ) ; first = false ; @@ -375,42 +402,4 @@ std::string GSmtp::SaslClient::preferred( const G::Strings & mechanism_list ) co return result ; } -// === - -GSmtp::Sasl * GSmtp::Sasl::m_this = NULL ; - -GSmtp::Sasl::Sasl( const std::string & /*app*/ , const G::Path & client_path , const G::Path & server_path ) -{ - if( m_this == NULL ) - m_this = this ; - - m_client_secrets <<= new Secrets(client_path) ; - m_server_secrets <<= new Secrets(server_path) ; -} - -GSmtp::Sasl::~Sasl() -{ - if( m_this == this ) - m_this = NULL ; -} - -GSmtp::Sasl & GSmtp::Sasl::instance() -{ - if( m_this == NULL ) - throw Error( "no instance" ) ; - return * m_this ; -} - -const GSmtp::Secrets & GSmtp::Sasl::clientSecrets() const -{ - return *m_client_secrets.get() ; -} - -const GSmtp::Secrets & GSmtp::Sasl::serverSecrets() const -{ - return *m_server_secrets.get() ; -} - -// not implemented... -//void GSmtp::Sasl::check( const std::string & op , int rc ) const {} diff --git a/src/gsmtp/gsecrets.cpp b/src/gsmtp/gsecrets.cpp index e097053..77cc2cf 100644 --- a/src/gsmtp/gsecrets.cpp +++ b/src/gsmtp/gsecrets.cpp @@ -29,9 +29,11 @@ #include "gstr.h" #include -GSmtp::Secrets::Secrets( const G::Path & path ) +GSmtp::Secrets::Secrets( const G::Path & path , const std::string & debug_name ) : + m_path(path) , + m_debug_name(debug_name) { - G_DEBUG( "GSmtp::Secrets: \"" << path << "\"" ) ; + G_DEBUG( "GSmtp::Secrets: " << m_debug_name << ": \"" << path << "\"" ) ; if( path.str().empty() ) { @@ -65,7 +67,7 @@ void GSmtp::Secrets::read( std::istream & file ) G::Str::trim( line , ws ) ; if( !line.empty() && line.at(0U) != '#' ) { - G::Str::StringArray word_array ; + G::StringArray word_array ; G::Str::splitIntoTokens( line , word_array , ws ) ; if( word_array.size() == 4U ) process( word_array[0U] , word_array[1U] , word_array[2U] , word_array[3U] ) ; @@ -104,10 +106,11 @@ bool GSmtp::Secrets::valid() const std::string GSmtp::Secrets::id( const std::string & mechanism ) const { Map::const_iterator p = m_map.find( mechanism+" client" ) ; - if( p == m_map.end() || (*p).second.find(" ") == std::string::npos ) - return std::string() ; - else - return Xtext::decode( (*p).second.substr(0U,(*p).second.find(" ")) ) ; + std::string result ; + if( p != m_map.end() && (*p).second.find(" ") != std::string::npos ) + result = Xtext::decode( (*p).second.substr(0U,(*p).second.find(" ")) ) ; + G_DEBUG( "GSmtp::Secrets::id: " << m_debug_name << ": \"" << mechanism << "\" -> \"" << result << "\"" ) ; + return result ; } std::string GSmtp::Secrets::secret( const std::string & mechanism ) const diff --git a/src/gsmtp/gsecrets.h b/src/gsmtp/gsecrets.h index 0ce75e1..4928b07 100644 --- a/src/gsmtp/gsecrets.h +++ b/src/gsmtp/gsecrets.h @@ -39,14 +39,14 @@ namespace GSmtp // Class: GSmtp::Secrets // Description: A simple interface to a store of secrets as used in // authentication. -// See also: GSmtp::Sasl +// See also: GSmtp::SaslClient, GSmtp::SaslServer // class GSmtp::Secrets { public: G_EXCEPTION( OpenError , "cannot read secrets file" ) ; - explicit Secrets( const G::Path & path ) ; + explicit Secrets( const G::Path & path , const std::string & debug_name = std::string() ) ; // Constructor. ~Secrets() ; @@ -70,9 +70,13 @@ public: private: void read( std::istream & ) ; void process( std::string , std::string , std::string , std::string ) ; + Secrets( const Secrets & ) ; // not implemented + void operator=( const Secrets & ) ; // not implemented private: - typedef std::map Map ; + typedef std::map Map ; + G::Path m_path ; + std::string m_debug_name ; bool m_valid ; Map m_map ; } ; diff --git a/src/gsmtp/gserverprotocol.cpp b/src/gsmtp/gserverprotocol.cpp index 3607b83..f890dfe 100644 --- a/src/gsmtp/gserverprotocol.cpp +++ b/src/gsmtp/gserverprotocol.cpp @@ -34,15 +34,18 @@ #include GSmtp::ServerProtocol::ServerProtocol( Sender & sender , Verifier & verifier , ProtocolMessage & pmessage , - const std::string & thishost , GNet::Address peer_address ) : + const Secrets & secrets , const std::string & thishost , GNet::Address peer_address ) : m_sender(sender) , m_pmessage(pmessage) , m_verifier(verifier) , m_fsm(sStart,sEnd,s_Same,s_Any) , m_thishost(thishost) , m_peer_address(peer_address) , - m_authenticated(false) + m_authenticated(false) , + m_sasl(secrets) { + m_pmessage.doneSignal().connect( G::slot(*this,&ServerProtocol::processDone) ) ; + // (dont send anything to the peer from this ctor -- the Sender // object is not fuly constructed) @@ -81,17 +84,21 @@ void GSmtp::ServerProtocol::sendGreeting( const std::string & thishost , const s bool GSmtp::ServerProtocol::apply( const std::string & line ) { + bool log_content = false ; if( m_fsm.state() == sData ) { if( isEndOfText(line) ) { - G_LOG( "GSmtp::ServerProtocol: rx<<: [message content not logged]" ) ; + if( !log_content ) + G_LOG( "GSmtp::ServerProtocol: rx<<: [message content not logged]" ) ; G_LOG( "GSmtp::ServerProtocol: rx<<: \"" << G::Str::toPrintableAscii(line) << "\"" ) ; m_fsm.reset( sProcessing ) ; - m_pmessage.process( *this , m_sasl.id() , m_peer_address.displayString(false) ) ; // -> processDone() callback + m_pmessage.process( m_sasl.id() , m_peer_address.displayString(false) ) ; // -> processDone() } else { + if( log_content ) + G_LOG( "GSmtp::ServerProtocol: rx<<: \"" << G::Str::toPrintableAscii(line) << "\"" ) ; m_pmessage.addText( isEscaped(line) ? line.substr(1U) : line ) ; } return false ; @@ -119,7 +126,7 @@ bool GSmtp::ServerProtocol::apply( const std::string & line ) } } -void GSmtp::ServerProtocol::processDone( bool success , unsigned long , const std::string & reason ) +void GSmtp::ServerProtocol::processDone( bool success , unsigned long , std::string reason ) { G_ASSERT( m_fsm.state() == sProcessing ) ; // (a RSET will call m_pmessage.clear() to cancel the callback) if( m_fsm.state() == sProcessing ) // just in case @@ -209,7 +216,7 @@ void GSmtp::ServerProtocol::doHelo( const std::string & line , bool & predicate void GSmtp::ServerProtocol::doAuth( const std::string & line , bool & predicate ) { - G::Str::StringArray word_array ; + G::StringArray word_array ; G::Str::splitIntoTokens( line , word_array , " \t" ) ; std::string mechanism = word_array.size() > 1U ? word_array[1U] : std::string() ; @@ -443,7 +450,7 @@ void GSmtp::ServerProtocol::sendUnrecognised( const std::string & line ) void GSmtp::ServerProtocol::sendAuthRequired() { - send( "530 Authentication required" ) ; + send( "530 authentication required" ) ; } void GSmtp::ServerProtocol::sendNoRecipients() @@ -588,10 +595,10 @@ std::string GSmtp::ServerProtocol::receivedLine() const << "BY " << m_thishost << " " << "WITH ESMTP " << "; " - << date.weekdayString(true) << ", " + << date.weekdayName(true) << ", " << date.monthday() << " " - << date.monthString(true) << " " - << date.year() << " " + << date.monthName(true) << " " + << date.yyyy() << " " << time.hhmmss(":") << " " << zone ; return ss.str() ; diff --git a/src/gsmtp/gserverprotocol.h b/src/gsmtp/gserverprotocol.h index 873c99a..1a475fc 100644 --- a/src/gsmtp/gserverprotocol.h +++ b/src/gsmtp/gserverprotocol.h @@ -60,7 +60,7 @@ namespace GSmtp // // See also: ProtocolMessage, RFC2821 // -class GSmtp::ServerProtocol : private GSmtp:: ProtocolMessage::Callback +class GSmtp::ServerProtocol { public: class Sender // An interface used by ServerProtocol to send protocol replies. @@ -72,7 +72,7 @@ public: } ; ServerProtocol( Sender & sender , Verifier & verifier , ProtocolMessage & pmessage , - const std::string & thishost , GNet::Address peer_address ) ; + const Secrets & secrets , const std::string & thishost , GNet::Address peer_address ) ; // Constructor. // // The Verifier interface is used to verify recipient @@ -142,7 +142,7 @@ private: std::string commandWord( const std::string & line ) const ; std::string commandLine( const std::string & line ) const ; static std::string crlf() ; - virtual void processDone( bool , unsigned long , const std::string & ) ; // from ProtocolMessage + void processDone( bool , unsigned long , std::string ) ; // ProtocolMessage::doneSignal() bool isEndOfText( const std::string & ) const ; bool isEscaped( const std::string & ) const ; void doNoop( const std::string & , bool & ) ; @@ -172,13 +172,13 @@ private: void sendRcptReply() ; void sendDataReply() ; void sendCompletionReply( bool ok , const std::string & ) ; + void sendAuthRequired() ; void sendNoRecipients() ; void sendMissingParameter() ; void sendVerified( const std::string & ) ; void sendNotVerified( const std::string & ) ; void sendWillAccept( const std::string & ) ; void sendAuthDone( bool ok ) ; - void sendAuthRequired() ; void sendOk() ; std::string parseFrom( const std::string & ) const ; std::string parseTo( const std::string & ) const ; diff --git a/src/gsmtp/gsmtpclient.cpp b/src/gsmtp/gsmtpclient.cpp index 5cdf73d..a199dbb 100644 --- a/src/gsmtp/gsmtpclient.cpp +++ b/src/gsmtp/gsmtpclient.cpp @@ -39,82 +39,105 @@ namespace const bool must_authenticate = true ; } -unsigned int GSmtp::Client::m_response_timeout = 0U ; -unsigned int GSmtp::Client::m_connection_timeout = 0U ; - //static std::string GSmtp::Client::crlf() { return std::string("\015\012") ; } -GSmtp::Client::Client( MessageStore & store , ClientCallback & callback , - bool quit_on_disconnect ) : +GSmtp::Client::Client( MessageStore & store , const Secrets & secrets , + bool quit_on_disconnect , unsigned int response_timeout ) : GNet::Client(false,quit_on_disconnect) , m_store(&store) , m_buffer(crlf()) , - m_protocol(*this,GNet::Local::fqdn(),m_response_timeout,must_authenticate) , + m_protocol(*this,secrets,GNet::Local::fqdn(),response_timeout,must_authenticate) , m_socket(NULL) , - m_callback(&callback) , m_connect_timer(*this) , m_message_index(0U) , + m_busy(true) , m_force_message_fail(false) { + m_protocol.doneSignal().connect( G::slot(*this,&Client::protocolDone) ) ; } -GSmtp::Client::Client( std::auto_ptr message , ClientCallback & callback ) : - GNet::Client(false,false) , - m_store(NULL) , - m_message(message) , - m_buffer(crlf()) , - m_protocol(*this,GNet::Local::fqdn(),m_response_timeout,must_authenticate) , - m_socket(NULL) , - m_callback(&callback) , - m_connect_timer(*this) , - m_message_index(0U) , - m_force_message_fail(true) +GSmtp::Client::Client( std::auto_ptr message , const Secrets & secrets , + unsigned int response_timeout ) : + GNet::Client(false,false) , + m_store(NULL) , + m_message(message) , + m_buffer(crlf()) , + m_protocol(*this,secrets,GNet::Local::fqdn(),response_timeout,must_authenticate) , + m_socket(NULL) , + m_connect_timer(*this) , + m_message_index(0U) , + m_busy(true) , + m_force_message_fail(false) { - // The m_force_message_fail flag is set true here so that in proxy - // mode any unexpected disconnects etc on the client side result - // in failed ".bad" message files which can be retried. Strictly - // this is not correct behaviour since the proxy's client will - // get an error message which indicates that the proxy has not - // yet accepted responsibility for the message. So this behaviour - // may lead to unwanted message duplication, but pragmatically it - // may be better to have duplicated messages, rather than dropped - // ones. + // The m_force_message_fail member could be set true here to accommodate + // clients which ignore return codes. If set true the message is + // failed rather than deleted if the connection is lost during + // submission. + + m_protocol.doneSignal().connect( G::slot(*this,&Client::protocolDone) ) ; } -std::string GSmtp::Client::init( const std::string & s ) +std::string GSmtp::Client::startSending( const std::string & s , unsigned int connection_timeout ) { size_t pos = s.find(':') ; if( pos == std::string::npos ) return "invalid address string: no colon (:)" ; - return init( s.substr(0U,pos) , s.substr(pos+1U) ) ; + return init( s.substr(0U,pos) , s.substr(pos+1U) , connection_timeout ) ; } -std::string GSmtp::Client::init( const std::string & host , const std::string & service ) +std::string GSmtp::Client::init( const std::string & host , const std::string & service , + unsigned int connection_timeout ) { m_message_index = 0U ; m_host = host ; - if( m_store != NULL && m_store->empty() ) - return "no messages to send" ; + std::string result ; + bool empty = m_store != NULL && m_store->empty() ; + if( empty ) + { + result = none() ; + } + else + { + raiseEventSignal( "connecting" , host ) ; - raiseEvent( "connecting" , host ) ; + if( connection_timeout != 0U ) + m_connect_timer.startTimer( connection_timeout ) ; - if( m_connection_timeout != 0U ) - m_connect_timer.startTimer( m_connection_timeout ) ; + bool ok = connect( host , service , &result ) ; + if( !ok ) + { + result = result.empty() ? std::string("error") : result ; // just in case + raiseEventSignal( "failed" , result ) ; + } + } + if( !result.empty() ) + { + m_busy = false ; + } + return result ; +} - std::string error ; - bool rc = connect( host , service , &error ) ; - return rc ? std::string() : error ; +//static +std::string GSmtp::Client::none() +{ + return "no messages to send" ; +} + +//static +bool GSmtp::Client::nothingToSend( const std::string & reason ) +{ + return reason == none() ; } bool GSmtp::Client::busy() const { - return m_callback != NULL ; // (was GNet::Client::connected()) + return m_busy ; // (was GNet::Client::connected()) } bool GSmtp::Client::protocolSend( const std::string & line ) @@ -143,7 +166,7 @@ void GSmtp::Client::onConnect( GNet::Socket & socket ) { m_connect_timer.cancelTimer() ; - raiseEvent( "connected" , + raiseEventSignal( "connected" , socket.getPeerAddress().second.displayString() ) ; m_socket = &socket ; @@ -181,7 +204,7 @@ bool GSmtp::Client::sendNext() void GSmtp::Client::start( StoredMessage & message ) { m_message_index++ ; - raiseEvent( "sending" , message.name() ) ; + raiseEventSignal( "sending" , message.name() ) ; std::string server_name = peerName() ; // (from GNet::Client) if( server_name.empty() ) @@ -189,12 +212,12 @@ void GSmtp::Client::start( StoredMessage & message ) std::auto_ptr content_stream( message.extractContentStream() ) ; m_protocol.start( message.from() , message.to() , message.eightBit() , - message.authentication() , server_name , content_stream , *this ) ; + message.authentication() , server_name , content_stream ) ; } -void GSmtp::Client::protocolDone( bool ok , bool abort , const std::string & reason ) +void GSmtp::Client::protocolDone( bool ok , bool abort , std::string reason ) { - G_DEBUG( "GSmtp::Client::protocolDone: " << ok << ": " << reason ) ; + G_DEBUG( "GSmtp::Client::protocolDone: " << ok << ": \"" << reason << "\"" ) ; std::string error_message ; if( ok ) @@ -216,17 +239,36 @@ void GSmtp::Client::protocolDone( bool ok , bool abort , const std::string & rea void GSmtp::Client::messageDestroy() { if( m_message.get() != NULL ) - m_message->destroy() ; + m_message.get()->destroy() ; m_message <<= 0 ; } void GSmtp::Client::messageFail( const std::string & reason ) { if( m_message.get() != NULL ) - m_message->fail( reason ) ; + m_message.get()->fail( reason ) ; m_message <<= 0 ; } +void GSmtp::Client::onDisconnect() +{ + std::string reason = "connection to server lost" ; + if( m_force_message_fail ) + messageFail( reason ) ; + + finish( reason , false ) ; +} + +void GSmtp::Client::onTimeout( GNet::Timer & ) +{ + G_DEBUG( "GSmtp::Client::onTimeout" ) ; + std::string reason = "connection timeout" ; + if( m_force_message_fail ) + messageFail( reason ) ; + + finish( reason ) ; +} + GNet::Socket & GSmtp::Client::socket() { if( m_socket == NULL ) @@ -245,18 +287,9 @@ void GSmtp::Client::onData( const char * data , size_t size ) } } -void GSmtp::Client::onDisconnect() -{ - std::string reason = "connection to server lost" ; - if( m_force_message_fail ) - messageFail( reason ) ; - - finish( reason , false ) ; -} - void GSmtp::Client::onError( const std::string & error ) { - G_WARNING( "GSmtp::Client: smtp client error: \"" << error << "\"" ) ; + G_LOG( "GSmtp::Client: smtp client error: \"" << error << "\"" ) ; // was warning std::string reason = "error on connection to server: " ; reason += error ; @@ -266,37 +299,28 @@ void GSmtp::Client::onError( const std::string & error ) finish( reason , false ) ; } -void GSmtp::Client::onTimeout( GNet::Timer & ) -{ - std::string reason = "connection timeout" ; - if( m_force_message_fail ) - messageFail( reason ) ; - - finish( reason ) ; -} - void GSmtp::Client::finish( const std::string & reason , bool do_disconnect ) { - doCallback( reason ) ; + raiseDoneSignal( reason ) ; if( do_disconnect ) disconnect() ; // GNet::Client::disconnect() m_socket = NULL ; } -void GSmtp::Client::doCallback( const std::string & reason ) +void GSmtp::Client::raiseDoneSignal( const std::string & reason ) { - if( m_callback != NULL ) + if( m_busy ) { - m_callback->clientEvent( "done" , reason ) ; - m_callback->clientDone( reason ) ; - m_callback = NULL ; + m_event_signal.emit( "done" , reason ) ; + m_done_signal.emit( reason ) ; + m_busy = false ; } } -void GSmtp::Client::raiseEvent( const std::string & s1 , const std::string & s2 ) +void GSmtp::Client::raiseEventSignal( const std::string & s1 , const std::string & s2 ) { - if( m_callback != NULL ) - m_callback->clientEvent( s1 , s2 ) ; + if( m_busy ) + m_event_signal.emit( s1 , s2 ) ; } void GSmtp::Client::onWriteable() @@ -307,28 +331,13 @@ void GSmtp::Client::onWriteable() } } -unsigned int GSmtp::Client::responseTimeout( unsigned int new_timeout ) +G::Signal1 & GSmtp::Client::doneSignal() { - unsigned int previous = m_response_timeout ; - m_response_timeout = new_timeout ; - return previous ; + return m_done_signal ; } -unsigned int GSmtp::Client::connectionTimeout( unsigned int new_timeout ) -{ - unsigned int previous = m_connection_timeout ; - m_connection_timeout = new_timeout ; - return previous ; -} - -// === - -GSmtp::Client::ClientCallback::~ClientCallback() -{ -} - -void GSmtp::Client::ClientCallback::clientEvent( const std::string & , - const std::string & ) +G::Signal2 & GSmtp::Client::eventSignal() { + return m_event_signal ; } diff --git a/src/gsmtp/gsmtpclient.h b/src/gsmtp/gsmtpclient.h index 54d5e3c..f834ac8 100644 --- a/src/gsmtp/gsmtpclient.h +++ b/src/gsmtp/gsmtpclient.h @@ -34,6 +34,7 @@ #include "gmessagestore.h" #include "gstoredmessage.h" #include "gsocket.h" +#include "gslot.h" #include "gtimer.h" #include "gstrings.h" #include "gexception.h" @@ -51,68 +52,70 @@ namespace GSmtp // messages from a message store and forwarding them to // a remote SMTP server. // -class GSmtp::Client : private GNet::Client , private GNet::TimeoutHandler , - private GSmtp:: ClientProtocol::Sender , - private GSmtp:: ClientProtocol::Callback +class GSmtp::Client : private GNet::Client , private GNet::TimeoutHandler , private GSmtp::ClientProtocol::Sender { public: G_EXCEPTION( NotConnected , "not connected" ) ; - class ClientCallback // A callback interface used by GSmtp::Client. - { - public: virtual void clientDone( std::string ) = 0 ; - public: virtual void clientEvent( const std::string & , const std::string & ) ; - public: virtual ~ClientCallback() ; - private: void operator=( const ClientCallback & ) ; // not implemented - } ; - Client( MessageStore & store , ClientCallback & callback , bool quit_on_disconnect ) ; - // Constructor. The message-store and callback + Client( MessageStore & store , const Secrets & secrets , + bool quit_on_disconnect , unsigned int response_timeout ) ; + // Constructor. The 'store' and 'secrets' // references are kept. // - // The callback is used to signal that + // The doneSignal() is used to indicate that // all message processing has finished // or that the server connection has // been lost. - Client( std::auto_ptr message , ClientCallback & callback ) ; + Client( std::auto_ptr message , const Secrets & secrets , + unsigned int response_timeout ) ; // Constructor for sending a single message. + // The 'secrets' reference is kept. // - // The callback is used to signal that - // all message processing has finished - // or that the server connection has - // been lost. + // The doneSignal() is used to indicate that all + // message processing has finished or that the + // server connection has been lost. // - // With this constructor the message is fail()ed - // if the connection to the downstream server - // cannot be made. + // With this constructor (designed for proxying) the + // message is fail()ed if the connection to the + // downstream server cannot be made. - std::string init( const std::string & server_address_string ) ; - // Starts the sending process. Messages - // are extracted from the message store - // (as passed in the ctor) and forwarded - // on to the specified server. + G::Signal1 & doneSignal() ; + // Returns a signal which indicates that client processing + // is complete. + // + // The signal parameter is a failure reason, or the + // empty string on success. + + G::Signal2 & eventSignal() ; + // Returns a signal which indicates something interesting. + // + // The first signal parameter is one of "connecting", + // "failed", "connected", "sending", or "done". + + std::string startSending( const std::string & server_address_string , unsigned int connection_timeout ) ; + // Starts the sending process. Messages are extracted + // from the message store (as passed in the ctor) and + // forwarded on to the specified server. // // To be called once (only) after construction. // // Returns an error string if there are no messages // to be sent, or if the network connection // cannot be initiated. Returns the empty - // string on success. + // string on success. The error string can + // be partially interpreted by calling + // nothingToSend(). + + static bool nothingToSend( const std::string & reason ) ; + // Returns true if the given reason string -- obtained + // from startSending() -- is the fairly benign + // 'no messages to send'. bool busy() const ; // Returns true after construction and while // message processing is going on. Returns - // false once the clientDone() callback - // has been fired. - - static unsigned int responseTimeout( unsigned int new_timeout ) ; - // Sets the response timeout value. Returns the - // previous value. - - static unsigned int connectionTimeout( unsigned int new_timeout ) ; - // Sets the connection timeout value. Returns the - // previous value. - + // false once the doneSignal() has been emited. private: virtual void onConnect( GNet::Socket & socket ) ; // GNet::Client @@ -121,18 +124,19 @@ private: virtual void onWriteable() ; // GNet::Client virtual void onError( const std::string & error ) ; // GNet::Client virtual bool protocolSend( const std::string & ) ; // ClientProtocol::Sender - virtual void protocolDone( bool , bool , const std::string & ) ; // ClientProtocol::Callback + void protocolDone( bool , bool , std::string ) ; // ClientProtocol::doneSignal() virtual void onTimeout( GNet::Timer & ) ; // GNet::TimeoutHandler - std::string init( const std::string & , const std::string & ) ; + std::string init( const std::string & , const std::string & , unsigned int ) ; GNet::Socket & socket() ; static std::string crlf() ; bool sendNext() ; void start( StoredMessage & ) ; - void doCallback( const std::string & ) ; - void raiseEvent( const std::string & , const std::string & ) ; + void raiseDoneSignal( const std::string & ) ; + void raiseEventSignal( const std::string & , const std::string & ) ; void finish( const std::string & reason = std::string() , bool do_disconnect = true ) ; void messageFail( const std::string & reason ) ; void messageDestroy() ; + static std::string none() ; private: MessageStore * m_store ; @@ -142,13 +146,13 @@ private: ClientProtocol m_protocol ; GNet::Socket * m_socket ; std::string m_pending ; - ClientCallback * m_callback ; + G::Signal1 m_done_signal ; + G::Signal2 m_event_signal ; std::string m_host ; GNet::Timer m_connect_timer ; unsigned int m_message_index ; + bool m_busy ; bool m_force_message_fail ; - static unsigned int m_response_timeout ; - static unsigned int m_connection_timeout ; } ; #endif diff --git a/src/gsmtp/gsmtpserver.cpp b/src/gsmtp/gsmtpserver.cpp index bed261c..d1b38bc 100644 --- a/src/gsmtp/gsmtpserver.cpp +++ b/src/gsmtp/gsmtpserver.cpp @@ -33,17 +33,18 @@ #include "gassert.h" #include -GSmtp::ServerPeer::ServerPeer( GNet::StreamSocket * socket , GNet::Address peer_address , +GSmtp::ServerPeer::ServerPeer( GNet::Server::PeerInfo peer_info , Server & server , std::auto_ptr pmessage , const std::string & ident , - const Verifier & verifier ) : - GNet::ServerPeer( socket , peer_address ) , + const Secrets & server_secrets , const Verifier & verifier ) : + GNet::ServerPeer( peer_info ) , m_server( server ) , m_buffer( crlf() ) , m_verifier( verifier ) , m_pmessage( pmessage ) , - m_protocol( *this, m_verifier, *m_pmessage.get(), thishost(), peer_address ) + m_protocol( *this , m_verifier , *m_pmessage.get() , server_secrets , + thishost(), peer_info.m_address ) { - G_LOG_S( "GSmtp::ServerPeer: smtp connection from " << peer_address.displayString() ) ; + G_LOG_S( "GSmtp::ServerPeer: smtp connection from " << peer_info.m_address.displayString() ) ; m_protocol.init( ident ) ; } @@ -111,13 +112,22 @@ void GSmtp::ServerPeer::protocolDone() // === -GSmtp::Server::Server( unsigned int port , const AddressList & interfaces , - bool allow_remote , const std::string & ident , - const std::string & downstream_server , const Verifier & verifier ) : - m_ident( ident ) , +GSmtp::Server::Server( MessageStore & store , + const Secrets & server_secrets , const Verifier & verifier , + const std::string & ident , bool allow_remote , + unsigned int port , const AddressList & interfaces , + const std::string & downstream_server , + unsigned int response_timeout , unsigned int connection_timeout , + const Secrets & client_secrets ) : + m_store(store) , + m_ident(ident) , m_allow_remote( allow_remote ) , - m_downstream_server(downstream_server) , + m_server_secrets(server_secrets) , m_verifier(verifier) , + m_downstream_server(downstream_server) , + m_response_timeout(response_timeout) , + m_connection_timeout(connection_timeout) , + m_client_secrets(client_secrets) , m_gnet_server_1( *this ) , m_gnet_server_2( *this ) , m_gnet_server_3( *this ) @@ -160,16 +170,14 @@ void GSmtp::Server::report() const } } -GNet::ServerPeer * GSmtp::Server::newPeer( GNet::StreamSocket * socket , GNet::Address peer_address ) +GNet::ServerPeer * GSmtp::Server::newPeer( GNet::Server::PeerInfo peer_info ) { - std::auto_ptr socket_ptr(socket) ; - if( ! m_allow_remote && - !peer_address.sameHost(GNet::Local::canonicalAddress()) && - !peer_address.sameHost(GNet::Local::localhostAddress()) ) + !peer_info.m_address.sameHost(GNet::Local::canonicalAddress()) && + !peer_info.m_address.sameHost(GNet::Local::localhostAddress()) ) { G_WARNING( "GSmtp::Server: configured to reject non-local connection: " - << peer_address.displayString(false) << " is not one of " + << peer_info.m_address.displayString(false) << " is not one of " << GNet::Local::canonicalAddress().displayString(false) << "," << GNet::Local::localhostAddress().displayString(false) ) ; return NULL ; @@ -179,10 +187,11 @@ GNet::ServerPeer * GSmtp::Server::newPeer( GNet::StreamSocket * socket , GNet::A std::auto_ptr pmessage( immediate ? - static_cast(new ProtocolMessageForward(m_downstream_server)) : - static_cast(new ProtocolMessageStore) ) ; + static_cast(new ProtocolMessageForward(m_store, + m_client_secrets,m_downstream_server,m_response_timeout,m_connection_timeout)) : + static_cast(new ProtocolMessageStore(m_store)) ) ; - return new ServerPeer( socket_ptr.release() , peer_address , *this , pmessage , m_ident , m_verifier ) ; + return new ServerPeer( peer_info , *this , pmessage , m_ident , m_server_secrets , m_verifier ) ; } // === @@ -192,8 +201,8 @@ GSmtp::ServerImp::ServerImp( GSmtp::Server & server ) : { } -GNet::ServerPeer * GSmtp::ServerImp::newPeer( GNet::StreamSocket * socket , GNet::Address peer_address ) +GNet::ServerPeer * GSmtp::ServerImp::newPeer( GNet::Server::PeerInfo peer_info ) { - return m_server.newPeer( socket , peer_address ) ; + return m_server.newPeer( peer_info ) ; } diff --git a/src/gsmtp/gsmtpserver.h b/src/gsmtp/gsmtpserver.h index 1c53934..5c374a9 100644 --- a/src/gsmtp/gsmtpserver.h +++ b/src/gsmtp/gsmtpserver.h @@ -30,6 +30,7 @@ #include "gserver.h" #include "glinebuffer.h" #include "gverifier.h" +#include "gmessagestore.h" #include "gserverprotocol.h" #include "gprotocolmessage.h" #include "gexception.h" @@ -50,12 +51,12 @@ namespace GSmtp // Instances are created on the heap by Server (only). // See also: GSmtp::Server // -class GSmtp::ServerPeer : public GNet::ServerPeer , private GSmtp:: ServerProtocol::Sender +class GSmtp::ServerPeer : public GNet::ServerPeer , private GSmtp::ServerProtocol::Sender { public: - ServerPeer( GNet::StreamSocket * socket , GNet::Address address , - Server & server , std::auto_ptr pmessage , - const std::string & ident , const Verifier & verifier ) ; + ServerPeer( GNet::Server::PeerInfo , Server & server , + std::auto_ptr pmessage , + const std::string & ident , const Secrets & , const Verifier & verifier ) ; // Constructor. private: @@ -86,7 +87,7 @@ public: explicit ServerImp( GSmtp::Server & ) ; // Constructor. - virtual GNet::ServerPeer * newPeer( GNet::StreamSocket * , GNet::Address ) ; + virtual GNet::ServerPeer * newPeer( GNet::Server::PeerInfo ) ; // ServerPeer factory method. private: @@ -106,22 +107,33 @@ public: typedef std::list AddressList ; G_EXCEPTION( Overflow , "too many interface addresses" ) ; - Server( unsigned int port , const AddressList & interfaces , - bool allow_remote , const std::string & ident , + Server( MessageStore & store , + const Secrets & server_secrets , const Verifier & verifier , + const std::string & ident , bool allow_remote , + unsigned int port , const AddressList & interfaces , const std::string & downstream_server_address , - const Verifier & verifier ) ; + unsigned int response_timeout , + unsigned int connection_timeout , + const Secrets & client_secrets ) ; // Constructor. Listens on the given port number // using INET_ANY if 'interfaces' is empty, or // on specific interfaces otherwise. Currently // only three interface addresses are supported. // // If the 'downstream-server-address' parameter is - // given then all messages are forwarded immediately. + // given then all messages are forwarded immediately, + // using the specified client-side timeout values + // and client-side secrets. + // + // If the 'downstream-server-address' parameter is + // empty then the timeout values are ignored. + // + // The 'store' and 'secrets' references are kept. void report() const ; // Generates helpful diagnostics after construction. - GNet::ServerPeer * newPeer( GNet::StreamSocket * , GNet::Address ) ; + GNet::ServerPeer * newPeer( GNet::Server::PeerInfo ) ; // ServerPeer factory method used by ServerImp. private: @@ -129,10 +141,15 @@ private: ServerImp & imp( size_t n ) ; private: + MessageStore & m_store ; std::string m_ident ; bool m_allow_remote ; - std::string m_downstream_server ; + const Secrets & m_server_secrets ; Verifier m_verifier ; + std::string m_downstream_server ; + unsigned int m_response_timeout ; + unsigned int m_connection_timeout ; + const Secrets & m_client_secrets ; ServerImp m_gnet_server_1 ; ServerImp m_gnet_server_2 ; ServerImp m_gnet_server_3 ; diff --git a/src/gsmtp/gstoredfile.cpp b/src/gsmtp/gstoredfile.cpp index a1349eb..3500f5f 100644 --- a/src/gsmtp/gstoredfile.cpp +++ b/src/gsmtp/gstoredfile.cpp @@ -249,6 +249,7 @@ bool GSmtp::StoredFile::lock() m_old_envelope_path = src ; m_locked = true ; } + m_store.updated() ; return ok ; } @@ -261,6 +262,7 @@ void GSmtp::StoredFile::unlock() G::File::rename( m_envelope_path , m_old_envelope_path ) ; m_envelope_path = m_old_envelope_path ; m_locked = false ; + m_store.updated() ; } } diff --git a/src/gsmtp/gstoredfile.h b/src/gsmtp/gstoredfile.h index 16a2ef1..7c35f1a 100644 --- a/src/gsmtp/gstoredfile.h +++ b/src/gsmtp/gstoredfile.h @@ -43,7 +43,7 @@ namespace GSmtp // Description: A concete derived class implementing the // StoredMessage interface. // -class GSmtp::StoredFile : public GSmtp:: StoredMessage +class GSmtp::StoredFile : public GSmtp::StoredMessage { public: G_EXCEPTION( InvalidFormat , "invalid format field in envelope" ) ; diff --git a/src/gsmtp/gverifier.cpp b/src/gsmtp/gverifier.cpp index 60d3d31..3152ecb 100644 --- a/src/gsmtp/gverifier.cpp +++ b/src/gsmtp/gverifier.cpp @@ -33,8 +33,10 @@ #include "gassert.h" #include "glog.h" -GSmtp::Verifier::Verifier( const G::Path & path ) : - m_path(path) +GSmtp::Verifier::Verifier( const G::Path & path , bool deliver_to_postmaster , bool reject_local ) : + m_path(path) , + m_deliver_to_postmaster(deliver_to_postmaster) , + m_reject_local(reject_local) { } @@ -71,7 +73,9 @@ GSmtp::Verifier::Status GSmtp::Verifier::verifyInternal( const std::string & add const std::string & host , const std::string & fqdn ) const { Status status ; - if( user == "POSTMASTER" && ( host.empty() || host == "LOCALHOST" || host == fqdn ) ) + bool is_postmaster = user == "POSTMASTER" && ( host.empty() || host == "LOCALHOST" || host == fqdn ) ; + bool is_local = host.empty() || host == "LOCALHOST" ; + if( is_postmaster && m_deliver_to_postmaster ) { // accept 'postmaster' for local delivery status.is_valid = true ; @@ -79,12 +83,12 @@ GSmtp::Verifier::Status GSmtp::Verifier::verifyInternal( const std::string & add status.full_name = "Local postmaster " ; status.address = "postmaster" ; } - else if( host.empty() || host == "LOCALHOST" ) + else if( is_local && m_reject_local ) { // reject local addressees status.is_valid = false ; status.is_local = true ; - status.reason = "invalid local mailbox (not postmaster)" ; + status.reason = "invalid local mailbox" ; } else { @@ -117,7 +121,7 @@ GSmtp::Verifier::Status GSmtp::Verifier::verifyExternal( const std::string & add int rc = G::Process::spawn( G::Root::nobody() , m_path , args , &response ) ; G::Str::trim( response , "\r\n\t" ) ; - G_LOG( "GSmtp::Verifier: " << rc << ": \"" << response << "\"" ) ; + G_LOG( "GSmtp::Verifier: " << rc << ": \"" << G::Str::toPrintableAscii(response) << "\"" ) ; G::Strings response_parts ; G::Str::splitIntoFields( response , response_parts , "\n" ) ; diff --git a/src/gsmtp/gverifier.h b/src/gsmtp/gverifier.h index 2b4d980..5a4fad6 100644 --- a/src/gsmtp/gverifier.h +++ b/src/gsmtp/gverifier.h @@ -26,8 +26,8 @@ #include "gdef.h" #include "gsmtp.h" -#include "gpath.h" #include "gaddress.h" +#include "gpath.h" #include namespace GSmtp @@ -53,10 +53,19 @@ public: std::string reason ; } ; - explicit Verifier( const G::Path & exe ) ; - // Constructor. + Verifier( const G::Path & exe , bool deliver_to_postmaster , bool reject_local ) ; + // Constructor. If an executable path is given (ie. not + // G::Path()) then it is used for external verification. + // Otherwise the internal verifier is used, controlled + // by the two boolean flags. The deliver-to-postmaster + // flag enables the special treatment of local "postmaster" + // addresses, as dictated by the RFC. If reject-local + // is true then local mailbox addresses (ie. without + // an at-sign) are rejected. If reject-local is false + // then all addresses are treated as remote, and no + // local delivery is attempted. - Status verify( const std::string & rcpt_to_parameter , + Status verify( const std::string & rcpt_to_parameter , const std::string & mail_from_parameter , const GNet::Address & client_ip , const std::string & auth_mechanism , const std::string & auth_extra ) const ; // Checks a recipient address returning @@ -91,6 +100,8 @@ private: private: G::Path m_path ; + bool m_deliver_to_postmaster ; + bool m_reject_local ; } ; #endif diff --git a/src/main/Makefile.am b/src/main/Makefile.am index 5fbec13..5ff373e 100644 --- a/src/main/Makefile.am +++ b/src/main/Makefile.am @@ -1,23 +1,24 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# -# force symbol stripping on 'make install' +# force symbol stripping on 'make install' -- see also make 'install-strip' AM_INSTALL_PROGRAM_FLAGS=-s EXTRA_DIST=\ @@ -32,12 +33,18 @@ EXTRA_DIST=\ icon2.ico \ icon3.ico \ icon4.ico \ - main_win32.cpp \ messages.mc \ passwd.dsp \ poke.dsp \ resource.h \ - submit.dsp + submit.dsp \ + winapp.cpp \ + winapp.h \ + winform.cpp \ + winform.h \ + winmain.cpp \ + winmenu.cpp \ + winmenu.h INCLUDES = -I$(top_srcdir)/lib/$(COMPILER_VERSION) -I$(top_srcdir)/src/glib -I$(top_srcdir)/src/gnet -I$(top_srcdir)/src/gsmtp -DG_SPOOLDIR=\"$(e_spooldir)\" @@ -46,7 +53,7 @@ e_libexec_PROGRAMS = emailrelay-poke e_spool_DATA = emailrelay_SOURCES = \ - main_unix.cpp \ + main.cpp \ configuration.cpp \ configuration.h \ legal.cpp \ diff --git a/src/main/Makefile.in b/src/main/Makefile.in index a463613..4aedc63 100644 --- a/src/main/Makefile.in +++ b/src/main/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ @@ -109,7 +93,7 @@ e_sbindir = @e_sbindir@ e_spooldir = @e_spooldir@ install_sh = @install_sh@ -# force symbol stripping on 'make install' +# force symbol stripping on 'make install' -- see also make 'install-strip' AM_INSTALL_PROGRAM_FLAGS = -s EXTRA_DIST = \ @@ -124,12 +108,18 @@ EXTRA_DIST = \ icon2.ico \ icon3.ico \ icon4.ico \ - main_win32.cpp \ messages.mc \ passwd.dsp \ poke.dsp \ resource.h \ - submit.dsp + submit.dsp \ + winapp.cpp \ + winapp.h \ + winform.cpp \ + winform.h \ + winmain.cpp \ + winmenu.cpp \ + winmenu.h INCLUDES = -I$(top_srcdir)/lib/$(COMPILER_VERSION) -I$(top_srcdir)/src/glib -I$(top_srcdir)/src/gnet -I$(top_srcdir)/src/gsmtp -DG_SPOOLDIR=\"$(e_spooldir)\" @@ -139,7 +129,7 @@ e_libexec_PROGRAMS = emailrelay-poke e_spool_DATA = emailrelay_SOURCES = \ - main_unix.cpp \ + main.cpp \ configuration.cpp \ configuration.h \ legal.cpp \ @@ -178,7 +168,7 @@ e_sbin_PROGRAMS = emailrelay$(EXEEXT) emailrelay-submit$(EXEEXT) \ emailrelay-passwd$(EXEEXT) PROGRAMS = $(e_libexec_PROGRAMS) $(e_sbin_PROGRAMS) -am_emailrelay_OBJECTS = main_unix.$(OBJEXT) configuration.$(OBJEXT) \ +am_emailrelay_OBJECTS = main.$(OBJEXT) configuration.$(OBJEXT) \ legal.$(OBJEXT) run.$(OBJEXT) commandline.$(OBJEXT) \ commandline_unix.$(OBJEXT) emailrelay_OBJECTS = $(am_emailrelay_OBJECTS) @@ -211,7 +201,7 @@ am__depfiles_maybe = depfiles @AMDEP_TRUE@DEP_FILES = ./$(DEPDIR)/commandline.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/commandline_unix.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/configuration.Po ./$(DEPDIR)/legal.Po \ -@AMDEP_TRUE@ ./$(DEPDIR)/main_unix.Po ./$(DEPDIR)/passwd.Po \ +@AMDEP_TRUE@ ./$(DEPDIR)/main.Po ./$(DEPDIR)/passwd.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/poke.Po ./$(DEPDIR)/run.Po \ @AMDEP_TRUE@ ./$(DEPDIR)/submit.Po COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) \ @@ -312,7 +302,7 @@ distclean-compile: @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/commandline_unix.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/configuration.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/legal.Po@am__quote@ -@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/main_unix.Po@am__quote@ +@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/main.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/passwd.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/poke.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/run.Po@am__quote@ diff --git a/src/main/auth.cfg b/src/main/auth.cfg deleted file mode 100644 index 1e57f2d..0000000 --- a/src/main/auth.cfg +++ /dev/null @@ -1,9 +0,0 @@ - - -NONE server 192.168.0.* local -NONE server 192.168.*.* local -NONE server 192.168.0.3 local -NONE server *.*.*.* any -LOGIN server john secret -LOGIN server jane password - diff --git a/src/main/commandline.cpp b/src/main/commandline.cpp index 52fcbe4..aaacd70 100644 --- a/src/main/commandline.cpp +++ b/src/main/commandline.cpp @@ -39,7 +39,7 @@ std::string Main::CommandLine::switchSpec() ss << osSwitchSpec() << "|" << "q!as-client!runs as a client, forwarding spooled mail to : equivalent to \"--log --no-syslog --no-daemon --dont-serve --forward --forward-to\"!" << "1!host:port!1|" - << "d!as-server!runs as a server: equivalent to \"--log --close-stderr\"!0!!1|" + << "d!as-server!runs as a server: equivalent to \"--log --close-stderr --postmaster\"!0!!1|" << "y!as-proxy!runs as a proxy: equivalent to \"--log --close-stderr --immediate --forward-to\"!1!host:port!1|" << "v!verbose!generates more verbose output (works with --help and --log)!0!!1|" << "h!help!displays help text and exits!0!!1|" @@ -66,7 +66,10 @@ std::string Main::CommandLine::switchSpec() << "m!immediate!forwards each message as soon as it is received (requires --forward-to)!0!!3|" << "I!interface!listen on a specific interface!1!ip-address!3|" << "i!pid-file!records the daemon process-id in the given file!1!pid-file!3|" - << "Z!verifier!defines an external program for validating recipient addresses!1!program!3|" + << "O!poll!enables polling with the specified period (requires --forward-to)!1!period!3|" + << "P!postmaster!deliver to postmaster and reject all other local mailbox addresses!0!!3|" + << "Z!verifier!defines an external address verifier program!1!program!3|" + << "Q!admin-terminate!!0!!0|" ; return ss.str() ; } @@ -102,7 +105,7 @@ void Main::CommandLine::showUsage( bool e ) const if( m_getopt.contains("verbose") ) level = G::GetOpt::levelDefault() ; else - introducer = std::string("abbreviated ") + G::GetOpt::introducerDefault() ; + introducer = std::string("abbreviated ") + introducer ; size_t tab_stop = 33U ; size_t columns = ttyColumns() ; @@ -142,20 +145,26 @@ std::string Main::CommandLine::semanticError() const "be absolute paths" ; } - if( !m_getopt.contains("forward-to") && ( + const bool forward_to = + m_getopt.contains("as-proxy") || + m_getopt.contains("as-client") || + m_getopt.contains("forward-to") ; + + if( ! forward_to && ( m_getopt.contains("forward") || - m_getopt.contains("immediate") || - m_getopt.contains("admin") ) ) + m_getopt.contains("poll") || + m_getopt.contains("immediate") ) ) { - return "the --forward, --immediate and --admin switches require --forward-to" ; + return "the --forward, --immediate and --poll switches require --forward-to" ; } - if( m_getopt.contains("verbose") && ! ( - m_getopt.contains("help") || + const bool log = m_getopt.contains("log") || m_getopt.contains("as-server") || m_getopt.contains("as-client") || - m_getopt.contains("as-proxy") ) ) + m_getopt.contains("as-proxy") ; + + if( m_getopt.contains("verbose") && ! ( m_getopt.contains("help") || log ) ) { return "the --verbose switch must be used with --log, --help, --as-client, --as-server or --as-proxy" ; } @@ -165,6 +174,11 @@ std::string Main::CommandLine::semanticError() const return "the --interface switch cannot be used with --as-client or --dont-serve" ; } + if( cfg().daemon() && m_getopt.contains("hidden") ) // (win32) + { + return "the --hidden switch requires --no-daemon or --as-client" ; + } + return std::string() ; } diff --git a/src/main/commandline.h b/src/main/commandline.h index 1c49177..e1d438d 100644 --- a/src/main/commandline.h +++ b/src/main/commandline.h @@ -104,8 +104,8 @@ private: G::Arg m_arg ; G::GetOpt m_getopt ; -private: - class Show +public: + class Show // A private implementation class used by Main::CommandLine. { public: explicit Show( bool e ) ; public: std::ostream & s() ; diff --git a/src/main/commandline_win32.cpp b/src/main/commandline_win32.cpp index 43af8ea..427a8ad 100644 --- a/src/main/commandline_win32.cpp +++ b/src/main/commandline_win32.cpp @@ -48,7 +48,8 @@ std::string Main::CommandLine::osSwitchSpec() << "l!log!writes log information on standard error and event log!0!!2|" << "t!no-daemon!use an ordinary window, not the system tray!0!!3|" << "n!no-syslog!dont use the event log!0!!3|" - << "I!icon!selects the application icon!1!0^|1^|2^|3!3" + << "I!icon!selects the application icon!1!0^|1^|2^|3!3|" + << "H!hidden!hides the application window (requires --no-daemon)!0!!3" ; return ss.str() ; diff --git a/src/main/common.dsp b/src/main/common.dsp index 63b143c..ea891f3 100644 --- a/src/main/common.dsp +++ b/src/main/common.dsp @@ -157,6 +157,10 @@ SOURCE=..\glib\gdatetime_win32.cpp # End Source File # Begin Source File +SOURCE=..\win32\gdc.cpp +# End Source File +# Begin Source File + SOURCE=..\gnet\gdescriptor_win32.cpp # End Source File # Begin Source File @@ -237,7 +241,7 @@ SOURCE=..\glib\glogoutput_win32.cpp # End Source File # Begin Source File -SOURCE=..\glib\gmd5.cpp +SOURCE=..\glib\gmd5_rsa.cpp # End Source File # Begin Source File @@ -337,6 +341,10 @@ SOURCE=..\gsmtp\gserverprotocol.cpp # End Source File # Begin Source File +SOURCE=..\glib\gslot.cpp +# End Source File +# Begin Source File + SOURCE=..\gsmtp\gsmtpclient.cpp # End Source File # Begin Source File @@ -403,6 +411,10 @@ SOURCE=legal.cpp # Begin Group "Header Files" # PROP Default_Filter "h;hpp;hxx;hm;inl" +# Begin Source File + +SOURCE=..\glib\gslot.h +# End Source File # End Group # End Target # End Project diff --git a/src/main/configuration.cpp b/src/main/configuration.cpp index de89650..882e2df 100644 --- a/src/main/configuration.cpp +++ b/src/main/configuration.cpp @@ -82,6 +82,7 @@ std::string Main::Configuration::str( const std::string & p , const std::string << p << "connect timeout: " << connectionTimeout() << "s" << eol << p << "response timeout: " << responseTimeout() << "s" << eol << p << "domain override: " << na(fqdn()) << eol + << p << "polling period: " << (pollingTimeout()?(G::Str::fromUInt(pollingTimeout())+"s"):na()) << eol ; return ss.str() ; } @@ -179,6 +180,16 @@ bool Main::Configuration::doServing() const return !m_cl.contains("dont-serve") && !m_cl.contains("as-client") ; } +bool Main::Configuration::doPolling() const +{ + return m_cl.contains("poll") ; +} + +unsigned int Main::Configuration::pollingTimeout() const +{ + return m_cl.contains("poll") ? G::Str::toUInt(m_cl.value("poll")) : 0U ; +} + bool Main::Configuration::doSmtp() const { return !m_cl.contains("dont-listen") ; @@ -225,6 +236,11 @@ unsigned int Main::Configuration::icon() const return n ; } +bool Main::Configuration::hidden() const +{ + return m_cl.contains("hidden") ; +} + std::string Main::Configuration::clientSecretsFile() const { return m_cl.contains("client-auth") ? m_cl.value("client-auth") : std::string() ; @@ -264,3 +280,23 @@ G::Path Main::Configuration::verifier() const return m_cl.contains("verifier") ? G::Path(m_cl.value("verifier")) : G::Path() ; } +bool Main::Configuration::deliverToPostmaster() const +{ + return + m_cl.contains("postmaster") || + m_cl.contains("as-server") ; +} + +bool Main::Configuration::rejectLocalMailboxes() const +{ + return + m_cl.contains("postmaster") || + m_cl.contains("as-server") ; +} + +bool Main::Configuration::withTerminate() const +{ + return m_cl.contains("admin-terminate") ; +} + + diff --git a/src/main/configuration.h b/src/main/configuration.h index a65f908..e193a96 100644 --- a/src/main/configuration.h +++ b/src/main/configuration.h @@ -120,7 +120,10 @@ public: // Returns the pre-processor's path. unsigned int icon() const ; - // Returns the icon selector. + // Returns the icon selector (win32). + + bool hidden() const ; + // Returns true if the main window is hidden (win32). unsigned int responseTimeout() const ; // Returns the client-side protocol timeout value. @@ -146,6 +149,24 @@ public: G::Path verifier() const ; // Returns the path of an external address verifier program. + bool deliverToPostmaster() const ; + // Returns true if the internal address verifier should accept + // local postmaster addresses for local delivery. + + bool rejectLocalMailboxes() const ; + // Returns true if the internal address verifier should reject + // local mailbox addresses. + + bool doPolling() const ; + // Returns true if doing client polling. + + unsigned int pollingTimeout() const ; + // Returns the polling timeout. + + bool withTerminate() const ; + // Returns true if the admin interface should support the + // terminate command. + private: const CommandLine & m_cl ; diff --git a/src/main/doxygen.cfg b/src/main/doxygen.cfg old mode 100644 new mode 100755 index 1381e5e..4cd6a9c --- a/src/main/doxygen.cfg +++ b/src/main/doxygen.cfg @@ -3,7 +3,7 @@ # General configuration options #--------------------------------------------------------------------------- PROJECT_NAME = E-MailRelay -PROJECT_NUMBER = 1.0.2 +PROJECT_NUMBER = 1.1 OUTPUT_DIRECTORY = OUTPUT_LANGUAGE = English EXTRACT_ALL = YES @@ -60,6 +60,8 @@ FILE_PATTERNS = *.cpp \ RECURSIVE = YES EXCLUDE_PATTERNS = \ */win32/* \ + */win*.cpp \ + */win*.h \ */*_win32.* \ */*_ipv6.cpp \ */old/* \ diff --git a/src/main/doxygen.h b/src/main/doxygen.h index 4380fec..0111cd6 100644 --- a/src/main/doxygen.h +++ b/src/main/doxygen.h @@ -1,23 +1,23 @@ /* + Copyright (C) 2001-2003 Graeme Walker -Copyright (C) 2001-2003 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 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. -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. + 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. */ + /* \htmlonly */ /*! \mainpage E-MailRelay Source code @@ -56,11 +56,12 @@ The GSmtp namespace contains classes relating to the SMTP protocol and to e-mail storage. Key classes are: -- MessageStore -- ClientProtocol - Client -- ServerProtocol +- ClientProtocol +- ProtocolMessage +- MessageStore - Server +- ServerProtocol */ @@ -72,12 +73,13 @@ The GNet namespace contains network interface classes based on the Berkley socket and WinSock system APIs. Key classes are: +- Address - EventHandler - EventLoop -- Socket -- Address - Resolver - Server +- Socket +- Timer */ @@ -90,13 +92,14 @@ date and time representation, string utility functions, logging, command line parsing etc. Key classes are: -- Str -- GetOpt -- Path +- Directory - File -- LogOutput +- GetOpt - Log +- LogOutput +- Path - Process +- Str */ diff --git a/src/main/emailrelay.dsp b/src/main/emailrelay.dsp index a6d2616..02558f3 100644 --- a/src/main/emailrelay.dsp +++ b/src/main/emailrelay.dsp @@ -103,11 +103,23 @@ SOURCE=.\configuration.cpp # End Source File # Begin Source File -SOURCE=.\main_win32.cpp +SOURCE=.\run.cpp # End Source File # Begin Source File -SOURCE=.\run.cpp +SOURCE=.\winapp.cpp +# End Source File +# Begin Source File + +SOURCE=.\winform.cpp +# End Source File +# Begin Source File + +SOURCE=.\winmain.cpp +# End Source File +# Begin Source File + +SOURCE=.\winmenu.cpp # End Source File # End Group # Begin Group "Header Files" diff --git a/src/main/emailrelay.rc b/src/main/emailrelay.rc index 18dba89..3e79265 100644 --- a/src/main/emailrelay.rc +++ b/src/main/emailrelay.rc @@ -51,6 +51,8 @@ END 3 TEXTINCLUDE DISCARDABLE BEGIN "#include \r\n" + "/// 1 TYPELIB ""emailrelay_idl.tlb""\r\n" + "\r\n" "\r\n" "\r\n" "\0" @@ -137,7 +139,7 @@ BEGIN VALUE "FileDescription", "E-MailRelay Application\0" VALUE "FileVersion", "1, 0, 0, 0\0" VALUE "InternalName", "emailrelay\0" - VALUE "LegalCopyright", "Copyright © Graeme Walker, 2003\0" + VALUE "LegalCopyright", "Copyright © Graeme Walker, 2002\0" VALUE "LegalTrademarks", "\0" VALUE "OriginalFilename", "emailrelay.rc\0" VALUE "PrivateBuild", "\0" @@ -165,6 +167,8 @@ END // Generated from the TEXTINCLUDE 3 resource. // #include +/// 1 TYPELIB "emailrelay_idl.tlb" + diff --git a/src/main/main_unix.cpp b/src/main/main.cpp similarity index 100% rename from src/main/main_unix.cpp rename to src/main/main.cpp diff --git a/src/main/main_win32.cpp b/src/main/main_win32.cpp deleted file mode 100644 index 1cdd50b..0000000 --- a/src/main/main_win32.cpp +++ /dev/null @@ -1,463 +0,0 @@ -// -// Copyright (C) 2001-2003 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. -// -// === -// -// main_win32.cpp -// -// This file contains all the GUI code -// for the Windows executable. (There's too much -// in here, but at least it keeps it out of sight -// when in a unix mindset.) -// - -#include "gdef.h" -#include "gsmtp.h" -#include "commandline.h" -#include "configuration.h" -#include "legal.h" -#include "resource.h" -#include "run.h" -#include "gappbase.h" -#include "gassert.h" -#include "gcontrol.h" -#include "gdialog.h" -#include "gexception.h" -#include "glog.h" -#include "gmd5.h" -#include "gmemory.h" -#include "gmessagestore.h" -#include "gmonitor.h" -#include "gnoncopyable.h" -#include "gpump.h" -#include "gregistry.h" -#include "gstoredmessage.h" -#include "gstr.h" -#include "gtray.h" -#include -#include - -namespace -{ - class App ; - - class Form : public GGui::Dialog - { - public: - Form( App & , const Main::Configuration & cfg , bool confirm ) ; - void close() ; - private: - virtual bool onInit() ; - virtual void onNcDestroy() ; - virtual void onCommand( unsigned int id ) ; - std::string text() const ; - private: - App & m_app ; - GGui::EditBox m_edit_box ; - Main::Configuration m_cfg ; - bool m_confirm ; - } ; - - class App : public GGui::ApplicationBase - { - public: - G_EXCEPTION( Error , "application error" ) ; - App( HINSTANCE h , HINSTANCE p , const char * name ) ; - void init( const Main::Configuration & cfg ) ; - void setStatus( const std::string & , const std::string & ) ; - bool confirm() ; - void formOk() ; - void formDone() ; - private: - void doOpen() ; - void doClose() ; - void doQuit() ; - void hide() ; - virtual UINT resource() const ; - virtual DWORD windowStyle() const ; - virtual bool onCreate() ; - virtual bool onClose() ; - virtual void onTrayDoubleClick() ; - virtual void onTrayRightMouseButtonDown() ; - virtual void onDimension( int & , int & ) ; - virtual bool onSysCommand( SysCommand ) ; - virtual LRESULT onUser( WPARAM , LPARAM ) ; - private: - std::auto_ptr m_tray ; - std::auto_ptr

    m_form ; - std::auto_ptr m_cfg ; - bool m_quit ; - bool m_use_tray ; - unsigned int m_icon ; - bool m_external_gui ; - } ; - - class Menu - { - public: - G_EXCEPTION( Error , "menu error" ) ; - explicit Menu( unsigned int resource_id ) ; - ~Menu() ; - int popup( const GGui::WindowBase & w , bool with_open , bool with_close ) ; - private: - HMENU m_hmenu ; - HMENU m_hmenu_popup ; - Menu( const Menu & ) ; - void operator=( const Menu & ) ; - } ; - - class Run : public Main::Run - { - public: - Run( App & app , const G::Arg & ) ; - protected: - virtual void onEvent( const std::string & , const std::string & , const std::string & ) ; - virtual bool runnable() const ; - private: - App & m_app ; - bool m_runnable ; - } ; -} ; - -// === - -Form::Form( App & app , const Main::Configuration & cfg , bool confirm ) : - GGui::Dialog(app) , - m_app(app) , - m_cfg(cfg) , - m_edit_box(*this,IDC_EDIT1) , - m_confirm(confirm) -{ -} - -bool Form::onInit() -{ - m_edit_box.set( text() ) ; - return true ; -} - -std::string Form::text() const -{ - const std::string crlf( "\r\n" ) ; - - std::ostringstream ss ; - ss - << "E-MailRelay V" << Main::Run::versionNumber() << crlf << crlf - << "Configuration..." << crlf - << m_cfg.str("* ",crlf) - ; - - if( GNet::Monitor::instance() ) - { - ss << crlf << "Network connections..." << crlf ; - GNet::Monitor::instance()->report( ss , "* " , crlf ) ; - } - - ss - << crlf << Main::Legal::warranty("",crlf) - << crlf << Main::Legal::copyright() ; - - return ss.str() ; -} - -void Form::close() -{ - end() ; -} - -void Form::onNcDestroy() -{ - m_app.formDone() ; -} - -void Form::onCommand( unsigned int id ) -{ - if( id == IDOK && ( !m_confirm || m_app.confirm() ) ) - { - m_app.formOk() ; - end() ; - } -} - -// === - -App::App( HINSTANCE h , HINSTANCE p , const char * name ) : - GGui::ApplicationBase( h , p , name ) , - m_use_tray(false) , - m_quit(false) , - m_icon(0U) , - m_external_gui(false) -{ -} - -void App::init( const Main::Configuration & cfg ) -{ - m_use_tray = cfg.daemon() ; - m_cfg <<= new Main::Configuration(cfg) ; - m_icon = m_cfg->icon() % 4U ; -} - -void App::onDimension( int & dx , int & dy ) -{ - G_ASSERT( m_form.get() != NULL ) ; - if( m_form.get() ) - { - // (force main window's internal size to be - // the same size as the form, but x and y - // are the window's external size) - - const bool has_menu = false ; - GGui::Size size = m_form->externalSize() ; - GGui::Size border = GGui::Window::borderSize(has_menu) ; - dx = size.dx + border.dx ; - dy = size.dy + border.dy ; - } -} - -void App::hide() -{ - show( SW_HIDE ) ; -} - -DWORD App::windowStyle() const -{ - return GGui::Window::windowStyleMain() ; -} - -UINT App::resource() const -{ - // (resource() provides the combined menu and icon id, but we have no menus) - if( m_icon == 0U ) return IDI_ICON1 ; - if( m_icon == 1U ) return IDI_ICON2 ; - if( m_icon == 2U ) return IDI_ICON3 ; - G_ASSERT( m_icon == 3U ) ; return IDI_ICON4 ; -} - -bool App::onCreate() -{ - if( m_use_tray ) - m_tray <<= new GGui::Tray(resource(),*this,"E-MailRelay") ; - else - doOpen() ; - return true ; -} - -void App::onTrayRightMouseButtonDown() -{ - Menu menu( IDR_MENU1 ) ; - bool form_is_open = m_form.get() != NULL ; - bool with_open = m_external_gui || !form_is_open ; - bool with_close = m_external_gui || form_is_open ; - int id = menu.popup( *this , with_open , with_close ) ; - - // make it asychronous to prevent "RPC_E_CANTCALLOUT_ININPUTSYNCCALL" -- - // see App::onUser() - ::PostMessage( handle() , wm_user() , 0 , static_cast(id) ) ; -} - -void App::onTrayDoubleClick() -{ - // make it asychronous to prevent "RPC_E_CANTCALLOUT_ININPUTSYNCCALL" -- - // see App::onUser() - ::PostMessage( handle() , wm_user() , 0 , static_cast(IDM_OPEN) ) ; -} - -LRESULT App::onUser( WPARAM , LPARAM lparam ) -{ - int id = static_cast(lparam) ; - if( id == IDM_OPEN ) doOpen() ; - if( id == IDM_CLOSE ) doClose() ; - if( id == IDM_QUIT ) doQuit() ; - return 0L ; -} - -void App::doOpen() -{ - if( !m_external_gui ) - { - if( m_form.get() == NULL ) - { - m_form <<= new Form( *this , *m_cfg.get() , !m_use_tray ) ; - if( ! m_form->runModeless(IDD_DIALOG1) ) - throw Error( "cannot run dialog box" ) ; - } - - resize( externalSize() ) ; // no-op in itself, but uses onDimension() - show() ; - } -} - -void App::doQuit() -{ - m_quit = true ; - close() ; // triggers onClose(), but without doClose() -} - -bool App::onClose() -{ - // (this is triggered by close() or using the system close menu item) - - bool really_quit = m_quit || ( !m_use_tray && confirm() ) ; - if( !really_quit ) doClose() ; - return really_quit ; -} - -bool App::confirm() -{ - return messageBoxQuery("Really quit?") ; -} - -void App::doClose() -{ - hide() ; - - // (close the form so that it gets recreated each time with current data) - if( m_form.get() != NULL ) - m_form->close() ; -} - -void App::formOk() -{ - // (this is triggered by clicking the OK button) - m_use_tray ? doClose() : doQuit() ; -} - -void App::formDone() -{ - // (this is called from Form::onNcDestroy) - m_form <<= 0 ; -} - -bool App::onSysCommand( SysCommand sc ) -{ - // true <= processed as no-op => dont change size - return sc == scMaximise || sc == scSize ; -} - -void App::setStatus( const std::string & s1 , const std::string & s2 ) -{ - std::string message( title() ) ; - if( !s1.empty() ) message.append( std::string(": ")+s1 ) ; - if( !s2.empty() ) message.append( std::string(": ")+s2 ) ; - ::SetWindowText( handle() , message.c_str() ) ; -} - -// === - -Menu::Menu( unsigned int id ) -{ - HINSTANCE hinstance = GGui::ApplicationInstance::hinstance() ; - m_hmenu = ::LoadMenu( hinstance , MAKEINTRESOURCE(id) ) ; - if( m_hmenu == NULL ) - throw Error() ; -} - -int Menu::popup( const GGui::WindowBase & w , bool with_open , bool with_close ) -{ - const int open_pos = 0 ; - const int close_pos = 1 ; - - POINT p ; - ::GetCursorPos( &p ) ; - ::SetForegroundWindow( w.handle() ) ; - - // TrackPopup() only works with a sub-menu, although - // you would never guess from the documentation - // - m_hmenu_popup = ::GetSubMenu( m_hmenu , 0 ) ; - - // make the "open" menu item bold - // - ::SetMenuDefaultItem( m_hmenu_popup , open_pos , TRUE ) ; - - // optionally grey-out menu items - // - if( !with_open ) - ::EnableMenuItem( m_hmenu_popup , open_pos , MF_BYPOSITION | MF_GRAYED ) ; - if( !with_close ) - ::EnableMenuItem( m_hmenu_popup , close_pos , MF_BYPOSITION | MF_GRAYED ) ; - - // display the menu - // - BOOL rc = ::TrackPopupMenuEx( m_hmenu_popup , - TPM_RETURNCMD , p.x , p.y , w.handle() , NULL ) ; - return static_cast(rc) ; // BOOL->int!, only in Microsoft wonderland -} - -Menu::~Menu() -{ - if( m_hmenu != NULL ) - ::DestroyMenu( m_hmenu ) ; -} - -// === - -Run::Run( App & app , const G::Arg & arg ) : - Main::Run(arg) , - m_app(app) , - m_runnable(true) -{ -} - -void Run::onEvent( const std::string & category , const std::string & s1 , const std::string & s2 ) -{ - if( category == "client" ) - m_app.setStatus( s1 , s2 ) ; -} - -bool Run::runnable() const -{ - return m_runnable ; -} - -// === - -int WINAPI WinMain( HINSTANCE hinstance , HINSTANCE previous , - LPSTR command_line , int show ) -{ - try - { - G::Arg arg ; - arg.parse( hinstance , command_line ) ; - App app( hinstance , previous , "E-MailRelay" ) ; - - try - { - Run run( app , arg ) ; - if( run.prepare() ) - { - const bool visible = ! run.cfg().daemon() ; - app.init( run.cfg() ) ; - app.createWindow( show , visible ) ; - run.run() ; - } - } - catch( std::exception & e ) - { - app.messageBox( e.what() ) ; - } - - return 0 ; - } - catch(...) - { - ::MessageBeep( MB_ICONHAND ) ; - } - return 1 ; -} - diff --git a/src/main/passwd.cpp b/src/main/passwd.cpp index 4e213a8..f2450cb 100644 --- a/src/main/passwd.cpp +++ b/src/main/passwd.cpp @@ -40,7 +40,9 @@ int main( int argc , char * argv [] ) if( argc != 1 ) { std::cerr + << arg.prefix() << ": too many command-line arguments" << std::endl << "usage: " << arg.prefix() << std::endl + << std::endl << Main::Legal::warranty(" ","\n") << " " << Main::Legal::copyright() << std::endl ; return EXIT_FAILURE ; diff --git a/src/main/poke.c b/src/main/poke.c index 3f64716..9ebe6a5 100644 --- a/src/main/poke.c +++ b/src/main/poke.c @@ -1,58 +1,116 @@ -// -// Copyright (C) 2001-2003 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. -// -// === -// -// poke.c -// +/* + Copyright (C) 2001-2003 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. + +*/ -// This is a small program that connects to the -// specified port on the local machine, sends -// a fixed string, and prints out the first -// bit of what it gets sent back. -// -// Its purpose is to provide a low-overhead -// mechanism for stimulating the mail-relay -// daemon to send its queued-up messages to -// the remote smtp server. -// -// usage: poke [ []] -// +/* + poke.c + + This is a small program that connects to the + specified port on the local machine, sends + a fixed string, and prints out the first + bit of what it gets sent back. + + In daemon mode it detaches from the terminal, + writes a pid-file, and then sends the fixed string + periodically, discarding any responses. + + Its purpose is to provide a low-overhead + mechanism for stimulating the E-MailRelay + daemon to send its queued-up messages to + the remote smtp server. + + If there is an error no output is generated, + but the exit code is non-zero. + + usage: poke [-d] [ []] + +*/ #if defined(G_WINDOWS) || defined(G_WIN32) || defined(_WIN32) || defined(WIN32) -#include -#include -#define write _write -#define STDOUT_FILENO 1 + #ifndef G_WIN32 + #define G_WIN32 + #endif + #include + #include + #include + #include + #define write _write + #define STDOUT_FILENO 1 + void sleep( unsigned int s ) { Sleep( s * 1000UL ) ; } #else -#include -#include -#include -#include -#include + #include + #include + #include + #include + #include + #include + #include + #include + #include + #include #endif -#include -#include -int main( int argc , char * argv [] ) +#ifndef TRUE + #define TRUE 1 +#endif +#ifndef FALSE + #define FALSE 0 +#endif +#ifndef BOOL + #define BOOL int +#endif + +static void detach( void ) +{ + #ifndef G_WIN32 + if( fork() ) exit( EXIT_SUCCESS ) ; + chdir( "/" ) ; + setsid() ; + if( fork() ) exit( EXIT_SUCCESS ) ; + close( STDIN_FILENO ) ; + close( STDOUT_FILENO ) ; + close( STDERR_FILENO ) ; + #endif +} + +static void pidfile( void ) +{ + #ifndef G_WIN32 + int fd = open( "/var/run/emailrelay-poke.pid" , O_CREAT | O_WRONLY | O_TRUNC , 0666 ) ; + if( fd >= 0 ) + { + char buffer[30] ; + char * p = buffer + sizeof(buffer) - 1 ; + pid_t pid = getpid() ; + for( *p = '\0' ; pid != 0 ; pid /= 10 ) + *--p = '0' + (pid%10) ; + write( fd , p , strlen(p) ) ; + write( fd , "\n" , 1 ) ; + close( fd ) ; + } + #endif +} + +static BOOL poke( int argc , char * argv [] ) { const char * const host = "127.0.0.1" ; - unsigned short port = 10025U ; + unsigned short port = 10025U ; /* --admin port */ char buffer[160U] = "FLUSH" ; struct sockaddr_in address ; int fd , rc ; @@ -74,7 +132,7 @@ int main( int argc , char * argv [] ) /* open the socket */ fd = socket( AF_INET , SOCK_STREAM , 0 ) ; if( fd < 0 ) - return EXIT_FAILURE ; + return FALSE ; /* prepare the address */ memset( &address , 0 , sizeof(address) ) ; @@ -85,17 +143,27 @@ int main( int argc , char * argv [] ) /* connect */ rc = connect( fd , (const struct sockaddr*)&address , sizeof(address) ) ; if( rc < 0 ) - return EXIT_FAILURE ; + { + close( fd ) ; + return FALSE ; + } /* send the string */ rc = send( fd , buffer , strlen(buffer) , 0 ) ; if( rc != (int)strlen(buffer) ) - return EXIT_FAILURE ; + { + close( fd ) ; + return FALSE ; + } /* read the reply */ rc = recv( fd , buffer , sizeof(buffer)-1U , 0 ) ; if( rc <= 0 ) - return EXIT_FAILURE ; + { + close( fd ) ; + return FALSE ; + } + close( fd ) ; /* print the reply */ write( STDOUT_FILENO , buffer , rc ) ; @@ -103,6 +171,35 @@ int main( int argc , char * argv [] ) buffer[1U] = '\0' ; write( STDOUT_FILENO , buffer , strlen(buffer) ) ; - return EXIT_SUCCESS ; + return TRUE ; +} + +int main( int argc , char * argv [] ) +{ + /* parse the command line -- daemon switch */ + BOOL daemon = FALSE ; + if( argc > 1 && strcmp(argv[1],"-d") == 0 ) + { + daemon = TRUE ; + argc-- ; + argv++ ; + } + + /* run once, or in a loop */ + if( daemon ) + { + detach() ; + pidfile() ; + for(;;) + { + poke( argc , argv ) ; + sleep( 60 ) ; + } + return EXIT_FAILURE ; + } + else + { + return poke( argc , argv ) ? EXIT_SUCCESS : EXIT_FAILURE ; + } } diff --git a/src/main/run.cpp b/src/main/run.cpp old mode 100644 new mode 100755 index e1b892a..5e4df87 --- a/src/main/run.cpp +++ b/src/main/run.cpp @@ -35,6 +35,7 @@ #include "gfilestore.h" #include "gnewfile.h" #include "gadminserver.h" +#include "gslot.h" #include "gmonitor.h" #include "glocal.h" #include "groot.h" @@ -46,54 +47,19 @@ #include #include -namespace Main -{ - class FileStore ; - class Monitor ; -} - -// Class: Main::FileStore -// Description: A derivation of GSmtp::FileStore which is used to -// do event plumbing into Main::Run. -// -class Main::FileStore : public GSmtp::FileStore -{ - private: Run & m_run ; - public: FileStore( Run & run , const G::Path & path ) : GSmtp::FileStore(path) , m_run(run) {} - private: virtual void onEvent() { m_run.raiseStoreEvent() ; } -} ; - -// Class: Main::Monitor -// Description: A derivation of GNet::Monitor which is used to do -// event plumbing into Main::Run. -// -class Main::Monitor : public GNet::Monitor -{ - private: Run & m_run ; - public: Monitor( Run & run ) : m_run(run) {} - private: virtual void onEvent( const std::string & s1 , const std::string & s2 ) - { m_run.raiseNetworkEvent( s1 , s2 ) ; } -} ; - -Main::Run * Main::Run::m_this = NULL ; - //static std::string Main::Run::versionNumber() { - return "1.0.2" ; + return "1.1" ; } Main::Run::Run( const G::Arg & arg ) : m_arg(arg) { - if( m_this == NULL ) - m_this = this ; } Main::Run::~Run() { - if( m_this == this ) - m_this = NULL ; } Main::Configuration Main::Run::cfg() const @@ -124,11 +90,7 @@ void Main::Run::closeMoreFiles() bool Main::Run::prepare() { bool do_run = false ; - - if( !runnable() ) - { - } - else if( cl().contains("help") ) + if( cl().contains("help") ) { cl().showHelp( false ) ; } @@ -155,10 +117,11 @@ bool Main::Run::prepare() // early singletons... // - // (prefix,output,log,verbose-log,debug,level,timestamp,strip-context) + // (prefix,output,log,verbose-log,debug,level,timestamp,strip-context,syslog) m_log_output <<= new G::LogOutput( m_arg.prefix() , cfg().log() , cfg().log() , cfg().verbose() , cfg().debug() , true , - cfg().logTimestamp() , !cfg().debug() ) ; + cfg().logTimestamp() , !cfg().debug() , + cfg().syslog() , G::LogOutput::Mail ) ; return do_run ; } @@ -184,11 +147,6 @@ void Main::Run::run() void Main::Run::runCore() { - // syslog initialisation - // - if( cfg().syslog() ) - G::LogOutput::instance()->syslog(G::LogOutput::Mail) ; - // fqdn override option // GNet::Local::fqdn( cfg().fqdn() ) ; @@ -205,16 +163,6 @@ void Main::Run::runCore() // G::Root::init( cfg().nobody() ) ; - // message store singleton - // - Main::FileStore store( *this , cfg().spoolDir() ) ; - if( cfg().useFilter() ) - GSmtp::NewFile::setPreprocessor( G::Path(cfg().filter()) ) ; - - // authentication singleton - // - GSmtp::Sasl sasl_library( "emailrelay" , cfg().clientSecretsFile() , cfg().serverSecretsFile() ) ; - // event loop singletons // GNet::TimerList timer_list ; @@ -224,37 +172,41 @@ void Main::Run::runCore() // network monitor singleton // - Main::Monitor monitor( *this ) ; + GNet::Monitor monitor ; + monitor.signal().connect( G::slot(*this,&Run::raiseNetworkEvent) ) ; - // timeout configuration + // message store singleton // - GSmtp::Client::responseTimeout( cfg().responseTimeout() ) ; - GSmtp::Client::connectionTimeout( cfg().connectionTimeout() ) ; + m_store <<= new GSmtp::FileStore( cfg().spoolDir() ) ; + m_store->signal().connect( G::slot(*this,&Run::raiseStoreEvent) ) ; + if( cfg().useFilter() ) + GSmtp::NewFile::setPreprocessor( G::Path(cfg().filter()) ) ; + + // authentication secrets + // + m_client_secrets <<= new GSmtp::Secrets( cfg().clientSecretsFile() , "client" ) ; + GSmtp::Secrets server_secrets( cfg().serverSecretsFile() , "server" ) ; // run as forwarding agent // if( cfg().doForwarding() ) { - if( store.empty() ) + if( m_store->empty() ) cl().showNoop( true ) ; else - doForwarding( store , *event_loop.get() ) ; + doForwarding( *m_store.get() , *m_client_secrets.get() , *event_loop.get() ) ; } // run as storage daemon // if( cfg().doServing() ) { - doServing( pid_file , *event_loop.get() ) ; + doServing( *m_store.get() , server_secrets , *m_client_secrets.get() , pid_file , *event_loop.get() ) ; } - - // clean up - // - m_client <<= 0 ; } -void Main::Run::doServing( G::PidFile & pid_file , - GNet::EventLoop & event_loop ) +void Main::Run::doServing( GSmtp::MessageStore & store , const GSmtp::Secrets & server_secrets , + const GSmtp::Secrets & client_secrets , G::PidFile & pid_file , GNet::EventLoop & event_loop ) { std::auto_ptr smtp_server ; if( cfg().doSmtp() ) @@ -263,17 +215,42 @@ void Main::Run::doServing( G::PidFile & pid_file , if( cfg().interface_().length() ) interfaces.push_back( GNet::Address(cfg().interface_(),cfg().port()) ) ; - smtp_server <<= new GSmtp::Server( cfg().port() , interfaces , - cfg().allowRemoteClients() , smtpIdent() , + smtp_server <<= new GSmtp::Server( + store , + server_secrets , + GSmtp::Verifier(cfg().verifier(),cfg().deliverToPostmaster(),cfg().rejectLocalMailboxes()) , + smtpIdent() , + cfg().allowRemoteClients() , + cfg().port() , + interfaces , cfg().immediate() ? cfg().serverAddress() : std::string() , - GSmtp::Verifier(cfg().verifier()) ) ; + cfg().responseTimeout() , + cfg().connectionTimeout() , + client_secrets ) ; } - std::auto_ptr admin_server ; if( cfg().doAdmin() ) { - admin_server <<= new GSmtp::AdminServer( cfg().adminPort() , - cfg().allowRemoteClients() , cfg().serverAddress() ) ; + GNet::Address address = + cfg().interface_().length() ? + GNet::Address(cfg().interface_(),cfg().adminPort()) : + GNet::Address(cfg().adminPort()) ; + + m_admin_server <<= new GSmtp::AdminServer( + store , + client_secrets , + address , + cfg().allowRemoteClients() , + cfg().serverAddress() , + cfg().responseTimeout() , + cfg().connectionTimeout() , + cfg().withTerminate() ) ; + } + + if( cfg().doPolling() ) + { + m_poll_timer <<= new GNet::Timer( *this ) ; + m_poll_timer->startTimer( cfg().pollingTimeout() ) ; } { @@ -283,15 +260,21 @@ void Main::Run::doServing( G::PidFile & pid_file , closeMoreFiles() ; if( smtp_server.get() ) smtp_server->report() ; - if( admin_server.get() ) admin_server->report() ; + if( m_admin_server.get() ) m_admin_server->report() ; event_loop.run() ; + m_admin_server <<= 0 ; } -void Main::Run::doForwarding( GSmtp::MessageStore & store , GNet::EventLoop & event_loop ) +void Main::Run::doForwarding( GSmtp::MessageStore & store , const GSmtp::Secrets & secrets , + GNet::EventLoop & event_loop ) { const bool quit_on_disconnect = true ; - GSmtp::Client client( store , *this , quit_on_disconnect ) ; - std::string error = client.init( cfg().serverAddress() ) ; + GSmtp::Client client( store , secrets , quit_on_disconnect , + cfg().responseTimeout() ) ; + + client.doneSignal().connect( G::slot(*this,&Run::clientDone) ) ; + client.eventSignal().connect( G::slot(*this,&Run::clientEvent) ) ; + std::string error = client.startSending( cfg().serverAddress() , cfg().connectionTimeout() ) ; if( error.length() ) throw G::Exception( error + ": " + cfg().serverAddress() ) ; @@ -299,6 +282,50 @@ void Main::Run::doForwarding( GSmtp::MessageStore & store , GNet::EventLoop & ev event_loop.run() ; } +void Main::Run::onTimeout( GNet::Timer & timer ) +{ + G_ASSERT( &timer == m_poll_timer.get() ) ; + G_DEBUG( "Main::Run::onTimeout" ) ; + + timer.startTimer( cfg().pollingTimeout() ) ; + + if( m_client.get() && m_client->busy() ) + { + G_LOG( "Main::Run::onTimeout: polling: still busy from last time" ) ; + emit( "poll" , "busy" , "" ) ; + } + else + { + emit( "poll" , "start" , "" ) ; + std::string error = doPoll() ; + emit( "poll" , "end" , error ) ; + } +} + +std::string Main::Run::doPoll() +{ + try + { + G_LOG( "Main::Run::doPoll: polling" ) ; + + const bool quit_on_disconnect = false ; + m_client <<= new GSmtp::Client( *m_store.get() , *m_client_secrets.get() , quit_on_disconnect , + cfg().responseTimeout() ) ; + + m_client->doneSignal().connect( G::slot(*this,&Run::clientDone) ) ; + m_client->eventSignal().connect( G::slot(*this,&Run::clientEvent) ) ; + std::string error = m_client->startSending( cfg().serverAddress() , cfg().connectionTimeout() ) ; + if( error.length() && ! GSmtp::Client::nothingToSend(error) ) + G_WARNING( "Main::Run::doPoll: polling: " + error ) ; + return error ; + } + catch( G::Exception & e ) + { + G_ERROR( "Main::Run::doPoll: polling: exception: " << e.what() ) ; + return e.what() ; + } +} + const Main::CommandLine & Main::Run::cl() const { // lazy evaluation so that the constructor doesnt throw @@ -312,70 +339,49 @@ const Main::CommandLine & Main::Run::cl() const void Main::Run::clientDone( std::string reason ) { G_DEBUG( "Main::Run::clientDone: \"" << reason << "\"" ) ; - if( ! reason.empty() ) + if( ! reason.empty() && m_client.get() == NULL ) throw G::Exception( reason ) ; } -void Main::Run::clientEvent( const std::string & s1 , const std::string & s2 ) +void Main::Run::clientEvent( std::string s1 , std::string s2 ) { - onEvent( "client" , s1 , s2 ) ; + emit( "client" , s1 , s2 ) ; } -void Main::Run::raiseStoreEvent() +void Main::Run::raiseStoreEvent( bool repoll ) { - onEvent( "store" , "update" , std::string() ) ; -} - -void Main::Run::raiseNetworkEvent( const std::string & s1 , const std::string & s2 ) -{ - onEvent( "network" , s1 , s2 ) ; -} - -void Main::Run::onEvent( const std::string & , const std::string & , const std::string & ) -{ - ; // default implementation does nothing -} - -bool Main::Run::runnable() const -{ - return true ; // default implementation -} - -//static -bool Main::Run::startForwarding( GSmtp::Client::ClientCallback & callback , const std::string & to ) -{ - const char * reason = - m_this == NULL ? - "no instance" : - m_this->startForwarding( &callback , to ) ; - - if( reason != NULL ) + emit( "store" , "update" , repoll ? std::string("poll") : std::string() ) ; + if( repoll && cfg().doPolling() && m_poll_timer.get() != NULL ) { - G_DEBUG( "Main::Run::startForwarding: doing nothing: " << reason ) ; - return false ; - } - else - { - return true ; + G_LOG( "Main::Run::raiseStoreEvent: polling timeout forced" ) ; + m_poll_timer->cancelTimer() ; + m_poll_timer->startTimer( 1U ) ; // (could use zero) } } -const char * Main::Run::startForwarding( GSmtp::Client::ClientCallback * callback , const std::string & to ) +void Main::Run::raiseNetworkEvent( std::string s1 , std::string s2 ) { - if( !GSmtp::MessageStore::exists() ) return "no message store instance" ; - if( !GNet::EventLoop::exists() ) return "no event loop instance" ; - if( !GNet::EventLoop::instance().running() ) return "not running the event loop" ; - if( GSmtp::MessageStore::instance().empty() ) return "nothing to do" ; - if( m_client.get() != NULL && m_client->busy() ) return "busy" ; - - std::string address( to ) ; - if( address.empty() ) - address = cfg().serverAddress() ; - - m_client <<= new GSmtp::Client( GSmtp::MessageStore::instance() , *callback , false ) ; - std::string error = m_client->init( address ) ; - if( error.length() ) - throw G::Exception( error + ": " + address ) ; - return NULL ; + emit( "network" , s1 , s2 ) ; +} + +void Main::Run::emit( const std::string & s0 , const std::string & s1 , const std::string & s2 ) +{ + try + { + m_signal.emit( s0 , s1 , s2 ) ; + if( m_admin_server.get() != NULL ) + { + m_admin_server->notify( s0 , s1 , s2 ) ; + } + } + catch( std::exception & e ) + { + G_WARNING( "Main::Run::emit: exception: " << e.what() ) ; + } +} + +G::Signal3 & Main::Run::signal() +{ + return m_signal ; } diff --git a/src/main/run.h b/src/main/run.h index eaa1a6b..c12564a 100644 --- a/src/main/run.h +++ b/src/main/run.h @@ -33,9 +33,13 @@ #include "glogoutput.h" #include "gdaemon.h" #include "gpidfile.h" +#include "gslot.h" #include "garg.h" +#include "gsecrets.h" #include "gmessagestore.h" +#include "gfilestore.h" #include "gsmtpclient.h" +#include "gadminserver.h" #include #include #include @@ -57,7 +61,7 @@ namespace Main /// return 0 ; /// } // -class Main::Run : private GSmtp::Client::ClientCallback +class Main::Run : private GNet::TimeoutHandler { public: explicit Run( const G::Arg & arg ) ; @@ -80,54 +84,39 @@ public: static std::string versionNumber() ; // Returns the application version number string. - static bool startForwarding( GSmtp::Client::ClientCallback & , - const std::string & to ) ; - // Starts forwarding spooled email. - // Should be called from within run(). - // Returns false if there is nothing to - // do or if nothing can be done. Throws - // on error. If true is returned then the - // callback object must remain valid - // until its clientDone() method is - // called. - - void raiseStoreEvent() ; - // A pseudo-private method. - - void raiseNetworkEvent( const std::string & , const std::string & ) ; - // A pseudo-private method. - -protected: - virtual void onEvent( const std::string & category , - const std::string & s1 , const std::string & s2 ) ; - // Overridable. Called when something changes. - - virtual bool runnable() const ; - // Overridable. Allows derived classes to have prepare() - // return false. The default implementation - // returns true. + G::Signal3 & signal() ; + // Provides a signal which is activated when something changes. private: Run( const Run & ) ; // not implemented void operator=( const Run & ) ; // not implemented void runCore() ; - void doForwarding( GSmtp::MessageStore & , GNet::EventLoop & ) ; - void doServing( G::PidFile & , GNet::EventLoop & ) ; + void doForwarding( GSmtp::MessageStore & , const GSmtp::Secrets & , GNet::EventLoop & ) ; + void doServing( GSmtp::MessageStore & , const GSmtp::Secrets & , const GSmtp::Secrets & , + G::PidFile & , GNet::EventLoop & ) ; void closeFiles() ; void closeMoreFiles() ; std::string smtpIdent() const ; void recordPid() ; const CommandLine & cl() const ; - virtual void clientDone( std::string ) ; // from ClientCallback - virtual void clientEvent( const std::string & , const std::string & ) ; // from ClientCallback - const char * startForwarding( GSmtp::Client::ClientCallback * , const std::string & ) ; + virtual void clientDone( std::string ) ; // Client::doneSignal() + virtual void clientEvent( std::string , std::string ) ; // Client::eventSignal() + virtual void onTimeout( GNet::Timer & ) ; // from TimeoutHandler + void raiseStoreEvent( bool ) ; + void raiseNetworkEvent( std::string , std::string ) ; + void emit( const std::string & , const std::string & , const std::string & ) ; + std::string doPoll() ; private: - static Run * m_this ; std::auto_ptr m_cl ; std::auto_ptr m_log_output ; std::auto_ptr m_client ; G::Arg m_arg ; + G::Signal3 m_signal ; + std::auto_ptr m_store ; + std::auto_ptr m_client_secrets ; + std::auto_ptr m_admin_server ; + std::auto_ptr m_poll_timer ; } ; #endif diff --git a/src/main/submit.cpp b/src/main/submit.cpp index b56ff5a..b0b1b6a 100644 --- a/src/main/submit.cpp +++ b/src/main/submit.cpp @@ -29,6 +29,9 @@ // * the envelope "From" field can be specified on the command-line // * the envelope "From" field is defaulted from the header "From:" line // * the header "From:" line is defaulted from the envelope "From" field +// +// usage: submit [--spool-dir ] [--from ] [--help] [ ...] +// #include "gdef.h" #include "gnet.h" @@ -84,7 +87,7 @@ static void process( const G::Path & path , std::istream & stream , // add "To:" lines to the envelope // G::Path verifier_exe ; - GSmtp::Verifier verifier( verifier_exe ) ; + GSmtp::Verifier verifier( verifier_exe , false , false ) ; for( G::Strings::const_iterator to_p = to_list.begin() ; to_p != to_list.end() ; ++to_p ) { std::string to = *to_p ; diff --git a/src/main/winapp.cpp b/src/main/winapp.cpp new file mode 100644 index 0000000..1a98236 --- /dev/null +++ b/src/main/winapp.cpp @@ -0,0 +1,207 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// winapp.cpp +// + +#include "gdef.h" +#include "winapp.h" +#include "winmenu.h" +#include "gwindow.h" +#include "glog.h" +#include "gmemory.h" +#include "gassert.h" +#include "resource.h" + +Main::WinApp::WinApp( HINSTANCE h , HINSTANCE p , const char * name ) : + GGui::ApplicationBase( h , p , name ) , + m_use_tray(false) , + m_quit(false) , + m_icon(0U) , + m_hidden(false) +{ +} + +void Main::WinApp::init( const Configuration & cfg ) +{ + m_use_tray = cfg.daemon() ; + m_cfg <<= new Configuration(cfg) ; + m_icon = m_cfg->icon() % 4U ; + m_hidden = m_cfg->hidden() ; +} + +void Main::WinApp::onDimension( int & dx , int & dy ) +{ + G_ASSERT( m_form.get() != NULL ) ; + if( m_form.get() ) + { + // (force main window's internal size to be + // the same size as the form, but x and y + // are the window's external size) + + const bool has_menu = false ; + GGui::Size size = m_form->externalSize() ; + GGui::Size border = GGui::Window::borderSize(has_menu) ; + dx = size.dx + border.dx ; + dy = size.dy + border.dy ; + } +} + +void Main::WinApp::hide() +{ + show( SW_HIDE ) ; +} + +DWORD Main::WinApp::windowStyle() const +{ + return m_hidden ? 0 : GGui::Window::windowStyleMain() ; +} + +UINT Main::WinApp::resource() const +{ + // (resource() provides the combined menu and icon id, but we have no menus) + if( m_icon == 0U ) return IDI_ICON1 ; + if( m_icon == 1U ) return IDI_ICON2 ; + if( m_icon == 2U ) return IDI_ICON3 ; + G_ASSERT( m_icon == 3U ) ; return IDI_ICON4 ; +} + +bool Main::WinApp::onCreate() +{ + if( m_use_tray ) + m_tray <<= new GGui::Tray(resource(),*this,"E-MailRelay") ; + else + doOpen() ; + return true ; +} + +void Main::WinApp::onTrayRightMouseButtonDown() +{ + WinMenu menu( IDR_MENU1 ) ; + bool form_is_open = m_form.get() != NULL ; + bool with_open = !form_is_open ; + bool with_close = form_is_open ; + int id = menu.popup( *this , with_open , with_close ) ; + + // make it asychronous to prevent "RPC_E_CANTCALLOUT_ININPUTSYNCCALL" -- + // see App::onUser() + ::PostMessage( handle() , wm_user() , 0 , static_cast(id) ) ; +} + +void Main::WinApp::onTrayDoubleClick() +{ + // make it asychronous to prevent "RPC_E_CANTCALLOUT_ININPUTSYNCCALL" -- + // see App::onUser() + ::PostMessage( handle() , wm_user() , 0 , static_cast(IDM_OPEN) ) ; +} + +LRESULT Main::WinApp::onUser( WPARAM , LPARAM lparam ) +{ + int id = static_cast(lparam) ; + if( id == IDM_OPEN ) doOpen() ; + if( id == IDM_CLOSE ) doClose() ; + if( id == IDM_QUIT ) doQuit() ; + return 0L ; +} + +void Main::WinApp::doOpen() +{ + if( m_form.get() == NULL ) + { + m_form <<= new WinForm( *this , *m_cfg.get() , !m_use_tray ) ; + if( ! m_form->runModeless(IDD_DIALOG1) ) + throw Error( "cannot run dialog box" ) ; + } + + resize( externalSize() ) ; // no-op in itself, but uses onDimension() + show() ; +} + +void Main::WinApp::doQuit() +{ + m_quit = true ; + close() ; // AppBase::close() -- triggers onClose(), but without doClose() +} + +bool Main::WinApp::onClose() +{ + // (this is triggered by AppBase::close() or using the system close menu item) + + if( m_quit || m_hidden ) + { + return true ; + } + else if( m_use_tray ) + { + doClose() ; + return false ; + } + else + { + return confirm() ; + } +} + +bool Main::WinApp::confirm() +{ + return messageBoxQuery("Really quit?") ; +} + +void Main::WinApp::doClose() +{ + hide() ; + + // (close the form so that it gets recreated each time with current data) + if( m_form.get() != NULL ) + m_form->close() ; +} + +void Main::WinApp::formOk() +{ + // (this is triggered by clicking the OK button) + m_use_tray ? doClose() : doQuit() ; +} + +void Main::WinApp::formDone() +{ + // (this is called from WinForm::onNcDestroy) + m_form <<= 0 ; +} + +bool Main::WinApp::onSysCommand( SysCommand sc ) +{ + // true <= processed as no-op => dont change size + return sc == scMaximise || sc == scSize ; +} + +void Main::WinApp::onRunEvent( std::string category , std::string s1 , std::string s2 ) +{ + if( category == "client" ) + setStatus( s1 , s2 ) ; +} + +void Main::WinApp::setStatus( const std::string & s1 , const std::string & s2 ) +{ + std::string message( title() ) ; + if( !s1.empty() ) message.append( std::string(": ")+s1 ) ; + if( !s2.empty() ) message.append( std::string(": ")+s2 ) ; + ::SetWindowText( handle() , message.c_str() ) ; +} + diff --git a/src/main/winapp.h b/src/main/winapp.h new file mode 100644 index 0000000..97bddd2 --- /dev/null +++ b/src/main/winapp.h @@ -0,0 +1,78 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// winapp.h +// + +#ifndef WIN_APP_H +#define WIN_APP_H + +#include "gdef.h" +#include "gappbase.h" +#include "gexception.h" +#include "gtray.h" +#include "winform.h" +#include "configuration.h" +#include + +namespace Main +{ + class WinApp ; +} + +class Main::WinApp : public GGui::ApplicationBase +{ +public: + G_EXCEPTION( Error , "application error" ) ; + WinApp( HINSTANCE h , HINSTANCE p , const char * name ) ; + void init( const Main::Configuration & cfg ) ; + bool confirm() ; + void formOk() ; + void formDone() ; + void onRunEvent( std::string , std::string , std::string ) ; + +private: + void doOpen() ; + void doClose() ; + void doQuit() ; + void hide() ; + virtual UINT resource() const ; + virtual DWORD windowStyle() const ; + virtual bool onCreate() ; + virtual bool onClose() ; + virtual void onTrayDoubleClick() ; + virtual void onTrayRightMouseButtonDown() ; + virtual void onDimension( int & , int & ) ; + virtual bool onSysCommand( SysCommand ) ; + virtual LRESULT onUser( WPARAM , LPARAM ) ; + void setStatus( const std::string & , const std::string & ) ; + +private: + std::auto_ptr m_tray ; + std::auto_ptr m_form ; + std::auto_ptr m_cfg ; + bool m_quit ; + bool m_use_tray ; + unsigned int m_icon ; + bool m_hidden ; +} ; + +#endif + diff --git a/src/main/winform.cpp b/src/main/winform.cpp new file mode 100644 index 0000000..00e42bd --- /dev/null +++ b/src/main/winform.cpp @@ -0,0 +1,91 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// winform.cpp +// +// + +#include "gdef.h" +#include "gmonitor.h" +#include "run.h" +#include "winform.h" +#include "winapp.h" +#include "legal.h" +#include "resource.h" +#include + +Main::WinForm::WinForm( WinApp & app , const Main::Configuration & cfg , bool confirm ) : + GGui::Dialog(app) , + m_app(app) , + m_cfg(cfg) , + m_edit_box(*this,IDC_EDIT1) , + m_confirm(confirm) +{ +} + +bool Main::WinForm::onInit() +{ + m_edit_box.set( text() ) ; + return true ; +} + +std::string Main::WinForm::text() const +{ + const std::string crlf( "\r\n" ) ; + + std::ostringstream ss ; + ss + << "E-MailRelay V" << Main::Run::versionNumber() << crlf << crlf + << "Configuration..." << crlf + << m_cfg.str("* ",crlf) + ; + + if( GNet::Monitor::instance() ) + { + ss << crlf << "Network connections..." << crlf ; + GNet::Monitor::instance()->report( ss , "* " , crlf ) ; + } + + ss + << crlf << Main::Legal::warranty("",crlf) + << crlf << Main::Legal::copyright() ; + + return ss.str() ; +} + +void Main::WinForm::close() +{ + end() ; +} + +void Main::WinForm::onNcDestroy() +{ + m_app.formDone() ; +} + +void Main::WinForm::onCommand( unsigned int id ) +{ + if( id == IDOK && ( !m_confirm || m_app.confirm() ) ) + { + m_app.formOk() ; + end() ; + } +} + diff --git a/src/main/winform.h b/src/main/winform.h new file mode 100644 index 0000000..63d90fe --- /dev/null +++ b/src/main/winform.h @@ -0,0 +1,61 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// winform.h +// + +#ifndef WIN_FORM_H +#define WIN_FORM_H + +#include "gdef.h" +#include "gdialog.h" +#include "gcontrol.h" +#include "configuration.h" +#include + +namespace Main +{ + class WinForm ; + class WinApp ; +} + +class Main::WinForm : public GGui::Dialog +{ +public: + WinForm( WinApp & , const Configuration & cfg , bool confirm ) ; + // Constructor. + + void close() ; + // Closes the form. + +private: + virtual bool onInit() ; + virtual void onNcDestroy() ; + virtual void onCommand( unsigned int id ) ; + std::string text() const ; + +private: + WinApp & m_app ; + GGui::EditBox m_edit_box ; + Configuration m_cfg ; + bool m_confirm ; +} ; + +#endif diff --git a/src/main/winmain.cpp b/src/main/winmain.cpp new file mode 100644 index 0000000..b916073 --- /dev/null +++ b/src/main/winmain.cpp @@ -0,0 +1,67 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// main_win32.cpp +// + +#include "gdef.h" +#include "gsmtp.h" +#include "garg.h" +#include "gslot.h" +#include "gexception.h" +#include "winapp.h" +#include "run.h" + +int WINAPI WinMain( HINSTANCE hinstance , HINSTANCE previous , + LPSTR command_line , int show ) +{ + try + { + G::Arg arg ; + arg.parse( hinstance , command_line ) ; + Main::WinApp app( hinstance , previous , "E-MailRelay" ) ; + + try + { + Main::Run run( arg ) ; + if( run.prepare() ) + { + const bool visible = ! run.cfg().daemon() ; + app.init( run.cfg() ) ; + app.createWindow( show , visible ) ; + run.signal().connect( G::slot(app,&Main::WinApp::onRunEvent) ) ; + run.run() ; + } + } + catch( std::exception & e ) + { + app.messageBox( e.what() ) ; + } + + return 0 ; + } + catch(...) + { + ::MessageBeep( MB_ICONHAND ) ; + } + return 1 ; +} + + diff --git a/src/main/winmenu.cpp b/src/main/winmenu.cpp new file mode 100644 index 0000000..853dd6f --- /dev/null +++ b/src/main/winmenu.cpp @@ -0,0 +1,73 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// winmenu.cpp +// + +#include "gdef.h" +#include "gappinst.h" +#include "winmenu.h" + +Main::WinMenu::WinMenu( unsigned int id ) +{ + HINSTANCE hinstance = GGui::ApplicationInstance::hinstance() ; + m_hmenu = ::LoadMenu( hinstance , MAKEINTRESOURCE(id) ) ; + if( m_hmenu == NULL ) + throw Error() ; +} + +int Main::WinMenu::popup( const GGui::WindowBase & w , bool with_open , bool with_close ) +{ + const int open_pos = 0 ; + const int close_pos = 1 ; + + POINT p ; + ::GetCursorPos( &p ) ; + ::SetForegroundWindow( w.handle() ) ; + + // TrackPopup() only works with a sub-menu, although + // you would never guess from the documentation + // + m_hmenu_popup = ::GetSubMenu( m_hmenu , 0 ) ; + + // make the "open" menu item bold + // + ::SetMenuDefaultItem( m_hmenu_popup , open_pos , TRUE ) ; + + // optionally grey-out menu items + // + if( !with_open ) + ::EnableMenuItem( m_hmenu_popup , open_pos , MF_BYPOSITION | MF_GRAYED ) ; + if( !with_close ) + ::EnableMenuItem( m_hmenu_popup , close_pos , MF_BYPOSITION | MF_GRAYED ) ; + + // display the menu + // + BOOL rc = ::TrackPopupMenuEx( m_hmenu_popup , + TPM_RETURNCMD , p.x , p.y , w.handle() , NULL ) ; + return static_cast(rc) ; // BOOL->int!, only in Microsoft wonderland +} + +Main::WinMenu::~WinMenu() +{ + if( m_hmenu != NULL ) + ::DestroyMenu( m_hmenu ) ; +} + diff --git a/src/main/winmenu.h b/src/main/winmenu.h new file mode 100644 index 0000000..86b50a0 --- /dev/null +++ b/src/main/winmenu.h @@ -0,0 +1,59 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// winmenu.h +// + +#ifndef WIN_MENU_H +#define WIN_MENU_H + +#include "gdef.h" +#include "gexception.h" +#include "gwinbase.h" + +namespace Main +{ + class WinMenu ; +} + +class Main::WinMenu +{ +public: + G_EXCEPTION( Error , "menu error" ) ; + + explicit WinMenu( unsigned int resource_id ) ; + // Constructor. + + ~WinMenu() ; + // Destructor. + + int popup( const GGui::WindowBase & w , bool with_open , bool with_close ) ; + // Opens the menu as a popup. + // See also: TrackPopupMenuEx() + +private: + HMENU m_hmenu ; + HMENU m_hmenu_popup ; + WinMenu( const WinMenu & ) ; // not implemented + void operator=( const WinMenu & ) ; // not implemented +} ; + +#endif + diff --git a/src/win32/Makefile.am b/src/win32/Makefile.am index d9b571d..d3e2677 100644 --- a/src/win32/Makefile.am +++ b/src/win32/Makefile.am @@ -1,21 +1,22 @@ -# -# Copyright (C) 2001-2003 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. -# +# +## Copyright (C) 2001-2003 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. +## +# EXTRA_DIST = \ gappinst.cpp \ @@ -24,6 +25,8 @@ EXTRA_DIST = \ gappbase.h \ gcracker.cpp \ gcracker.h \ + gdc.h \ + gdc.cpp \ gdialog.cpp \ gdialog.h \ gcontrol.cpp \ diff --git a/src/win32/Makefile.in b/src/win32/Makefile.in index ec92f18..0b34f73 100644 --- a/src/win32/Makefile.in +++ b/src/win32/Makefile.in @@ -14,24 +14,8 @@ @SET_MAKE@ -# -# Copyright (C) 2001-2003 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. -# +# +# SHELL = @SHELL@ srcdir = @srcdir@ @@ -116,6 +100,8 @@ EXTRA_DIST = \ gappbase.h \ gcracker.cpp \ gcracker.h \ + gdc.h \ + gdc.cpp \ gdialog.cpp \ gdialog.h \ gcontrol.cpp \ diff --git a/src/win32/gappbase.cpp b/src/win32/gappbase.cpp index 9a5e1f0..a252587 100644 --- a/src/win32/gappbase.cpp +++ b/src/win32/gappbase.cpp @@ -23,13 +23,14 @@ #include "gdef.h" #include "gappbase.h" +#include "gappinst.h" #include "gwindow.h" #include "gpump.h" #include "gdebug.h" #include "glog.h" GGui::ApplicationBase::ApplicationBase( HINSTANCE current , HINSTANCE previous , - const char *name ) : + const std::string & name ) : ApplicationInstance(current) , m_previous(previous) , m_name(name) @@ -55,7 +56,7 @@ void GGui::ApplicationBase::createWindow( int show_style , bool do_show ) CW_USEDEFAULT , CW_USEDEFAULT , // position (x,y) CW_USEDEFAULT , CW_USEDEFAULT , // size NULL , // parent window - NULL , // menu handle: 0 => use class's menu + NULL , // menu handle: NULL => use class's menu hinstance() ) ) { throw CreateError() ; @@ -75,19 +76,22 @@ bool GGui::ApplicationBase::firstInstance() const void GGui::ApplicationBase::initFirst() { - UINT id = resource() ; - HICON icon = id ? ::LoadIcon(hinstance(),MAKEINTRESOURCE(id)) : 0 ; + G_DEBUG( "GGui::ApplicationBase::initFirst" ) ; + + UINT icon_id = resource() ; + HICON icon = icon_id ? ::LoadIcon(hinstance(),MAKEINTRESOURCE(icon_id)) : 0 ; if( icon == 0 ) icon = classIcon() ; - const char * menu = MAKEINTRESOURCE( id ) ; + UINT menu_id = resource() ; + bool ok = registerWindowClass( className() , hinstance() , classStyle() , icon , classCursor() , backgroundBrush() , - menu ) ; + menu_id ) ; if( !ok ) throw RegisterError( className() ) ; @@ -111,14 +115,14 @@ void GGui::ApplicationBase::onDestroy() GGui::Pump::quit() ; } -const char * GGui::ApplicationBase::title() const +std::string GGui::ApplicationBase::title() const { - return m_name.c_str() ; + return m_name ; } -const char * GGui::ApplicationBase::className() const +std::string GGui::ApplicationBase::className() const { - return m_name.c_str() ; + return m_name ; } HBRUSH GGui::ApplicationBase::backgroundBrush() diff --git a/src/win32/gappbase.h b/src/win32/gappbase.h index 0633f10..4cb6514 100644 --- a/src/win32/gappbase.h +++ b/src/win32/gappbase.h @@ -25,14 +25,14 @@ #define G_APPBASE_H #include "gdef.h" -#include "gappinst.h" #include "gwindow.h" +#include "gappinst.h" #include "gexception.h" namespace GGui { class ApplicationBase ; -} ; +} // Class: GGui::ApplicationBase // @@ -52,13 +52,13 @@ namespace GGui // // See also: Application, ApplicationInstance, Pump // -class GGui::ApplicationBase : public Window , public ApplicationInstance +class GGui::ApplicationBase : public GGui::ApplicationInstance , public GGui::Window { public: G_EXCEPTION( RegisterError, "cannot register application's window class" ) ; G_EXCEPTION( CreateError , "cannot create application window" ) ; - ApplicationBase( HINSTANCE current, HINSTANCE previous, const char *name ); + ApplicationBase( HINSTANCE current, HINSTANCE previous, const std::string & name ); // Constructor. Applications should declare // a ApplicationBase object on the stack within // WinMain(), and then call its createWindow() and @@ -83,7 +83,7 @@ public: // main window, resulting in onClose() being // called. - virtual const char *title() const ; + virtual std::string title() const ; // Overridable. Defines the main window's title. bool messageBoxQuery( const std::string & message ) ; // not const @@ -112,7 +112,7 @@ protected: // application silent or change the type of // beep. - virtual const char *className() const ; + virtual std::string className() const ; // Overridable. Defines the main window's class // name. @@ -123,7 +123,6 @@ protected: virtual DWORD windowStyle() const ; // Overridable. Defines the main window's style. - // (Was called style().) virtual DWORD classStyle() const ; // Overridable. Defines the main window class style. @@ -143,8 +142,8 @@ protected: // implementation is called first. private: - ApplicationBase( const ApplicationBase &other ) ; // not implemented - void operator=( const ApplicationBase &other ) ; // not implemented + ApplicationBase( const ApplicationBase & other ) ; // not implemented + void operator=( const ApplicationBase & other ) ; // not implemented static bool messageBoxCore( HWND , unsigned int , const std::string & , const std::string & ) ; HWND messageBoxHandle() const ; @@ -157,4 +156,3 @@ private: #endif - diff --git a/src/win32/gappinst.cpp b/src/win32/gappinst.cpp index 26443a7..a5f7247 100644 --- a/src/win32/gappinst.cpp +++ b/src/win32/gappinst.cpp @@ -26,9 +26,14 @@ HINSTANCE GGui::ApplicationInstance::m_hinstance = 0 ; -GGui::ApplicationInstance::ApplicationInstance( HINSTANCE hinstance ) +GGui::ApplicationInstance::ApplicationInstance( HINSTANCE h ) { - m_hinstance = hinstance ; + hinstance( h ) ; +} + +void GGui::ApplicationInstance::hinstance( HINSTANCE h ) +{ + m_hinstance = h ; } HINSTANCE GGui::ApplicationInstance::hinstance() diff --git a/src/win32/gappinst.h b/src/win32/gappinst.h index c79ffdb..97c357d 100644 --- a/src/win32/gappinst.h +++ b/src/win32/gappinst.h @@ -29,7 +29,7 @@ namespace GGui { class ApplicationInstance ; -} ; +} // Class: GGui::ApplicationInstance // @@ -37,33 +37,36 @@ namespace GGui // instance handle, as obtained from WinMain(). // // Other low-level classes in this library use this -// class to obtain the application instance handle, -// rather than calling GApplication::instance(). +// interface to obtain the application instance handle, +// rather than some higher-level mechanism. // // Programs which need a message pump, but want to // avoid the overhead of the full GUI application -// must use this class as an absolute minimum. -// However, they should probably use the GApplicationBase -// class, which also minimises the dependencies on -// the framework. +// framework must, as an absolute minimum, use this +// class to set the application instance handle. // -// See also: ApplicationBase +// See also: GGui::ApplicationBase // class GGui::ApplicationInstance { +protected: + explicit ApplicationInstance( HINSTANCE h ) ; + // Protected constructor which calls + // hinstance(h). + // + // (Providing a constructor can simplify + // early initialisation.) + public: - explicit ApplicationInstance( HINSTANCE hinstance ) ; - // Constructor. (Setting the static value - // through a constructor is a bit klunky - // but it makes it easy to retrofit this - // class to the original version of - // GApplication.) + static void hinstance( HINSTANCE h ) ; + // Sets the instance handle which is + // subsequently returned by hinstance(). static HINSTANCE hinstance() ; // Returns the instance handle that was // passed to the constructor. Returns - // zero if no GApplicationInstance - // object has been created. + // zero hinstance(h) has never been + // called. private: static HINSTANCE m_hinstance ; diff --git a/src/win32/gcontrol.cpp b/src/win32/gcontrol.cpp index a8c99a4..e468638 100644 --- a/src/win32/gcontrol.cpp +++ b/src/win32/gcontrol.cpp @@ -27,11 +27,7 @@ #include "glog.h" #include "gassert.h" #include "gdebug.h" - -#define G_DC 0 // 0 <= reduce dependencies for now -#if G_DC #include "gdc.h" -#endif LRESULT CALLBACK gcontrol_wndproc_export( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) ; @@ -95,12 +91,31 @@ bool GGui::Control::subClass() SubClassMap::Proc old = reinterpret_cast( ::GetWindowLong( handle() , GWL_WNDPROC ) ) ; - m_dialog.map().add( handle() , old , (void*)this ) ; + m_dialog.map().add( handle() , old , static_cast(this) ) ; ::SetWindowLong( handle() , GWL_WNDPROC, reinterpret_cast(gcontrol_wndproc_export) ) ; return true ; } +LRESULT GGui::Control::wndProc( unsigned message , WPARAM wparam , LPARAM lparam , WNDPROC super_class ) +{ + bool forward = true ; + LRESULT result = onMessage( message , wparam , lparam , super_class , forward ) ; + + if( forward ) + return (*super_class)( handle() , message , wparam , lparam ) ; + else + return result ; +} + +LRESULT GGui::Control::onMessage( unsigned , WPARAM , LPARAM , WNDPROC , bool &forward ) +{ + forward = true ; + return 0 ; +} + +// === + LRESULT CALLBACK gcontrol_wndproc_export( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) { // get the dialog box window handle @@ -121,9 +136,9 @@ LRESULT CALLBACK gcontrol_wndproc_export( HWND hwnd , UINT message , WPARAM wpar G_ASSERT( dialog->isValid() ) ; // find the control object and the super-class window procedure - void *context = NULL ; + void * context = NULL ; GGui::SubClassMap::Proc super_class = reinterpret_cast(dialog->map().find(hwnd,&context)) ; - GGui::Control *control = reinterpret_cast(context) ; + GGui::Control * control = reinterpret_cast(context) ; G_ASSERT( control != NULL ) ; G_ASSERT( control->handle() == hwnd ) ; G_ASSERT( control->id() == ::GetDlgCtrlID(hwnd) ) ; @@ -135,26 +150,24 @@ LRESULT CALLBACK gcontrol_wndproc_export( HWND hwnd , UINT message , WPARAM wpar return control->wndProc( message , wparam , lparam , super_class ) ; } -LRESULT GGui::Control::wndProc( unsigned message , WPARAM wparam , LPARAM lparam , WNDPROC super_class ) -{ - bool forward = true ; - LRESULT result = onMessage( message , wparam , lparam , super_class , forward ) ; +// === - if( forward ) - return (*super_class)( handle() , message , wparam , lparam ) ; - else - return result ; +GGui::Control::NoRedraw::NoRedraw( Control & control ) : + m_control(control) +{ + m_control.m_no_redraw_count++ ; + if( m_control.m_no_redraw_count == 1 ) + m_control.sendMessage( WM_SETREDRAW , false ) ; } -LRESULT GGui::Control::onMessage( unsigned , WPARAM , LPARAM , WNDPROC , bool &forward ) +GGui::Control::NoRedraw::~NoRedraw() { - forward = true ; - return 0 ; + m_control.m_no_redraw_count-- ; + if( m_control.m_no_redraw_count == 0 ) + m_control.sendMessage( WM_SETREDRAW , true ) ; } -// ===================================== -// GGui::ListBox -// ------------------------------------- +// === GGui::ListBox::ListBox( Dialog &dialog , int id ) : Control(dialog,id) @@ -165,7 +178,7 @@ GGui::ListBox::~ListBox() { } -void GGui::ListBox::set( const G::Strings &list ) // was putList() +void GGui::ListBox::set( const G::Strings &list ) { if( list.size() == 0U ) { @@ -183,14 +196,15 @@ void GGui::ListBox::set( const G::Strings &list ) // was putList() for( G::Strings::const_iterator string_p = list.begin() ; string_p != list.end() ; ++string_p ) { - sendMessage( LB_ADDSTRING , 0 , (LPARAM)(*string_p).c_str() ) ; + sendMessage( LB_ADDSTRING , 0 , + reinterpret_cast((*string_p).c_str()) ) ; } } int GGui::ListBox::getSelection() { LRESULT rc = sendMessage( LB_GETCURSEL ) ; - return rc == LB_ERR ? -1 : (int)rc ; + return rc == LB_ERR ? -1 : static_cast(rc) ; } void GGui::ListBox::setSelection( int index ) @@ -211,7 +225,7 @@ std::string GGui::ListBox::getItem( int index ) const if( buffer == NULL ) return std::string() ; - buffer[0] = '\0' ; + buffer[0] = '\0' ; sendMessage( LB_GETTEXT , (WPARAM)index , (LPARAM)(LPCSTR)buffer ) ; std::string s( buffer ) ; delete [] buffer ; @@ -229,9 +243,7 @@ unsigned GGui::ListBox::entries() const return entries ; } -// ============= -// GGui::EditBox -// ------------- +// === GGui::EditBox::EditBox( Dialog &dialog , int id ) : Control( dialog , id ) , @@ -249,7 +261,7 @@ void GGui::EditBox::set( const std::string & text ) ::SetWindowText( handle() , text.c_str() ) ; } -void GGui::EditBox::set( const G::Strings & list ) // was putList() +void GGui::EditBox::set( const G::Strings & list ) { if( list.size() == 0U ) { @@ -287,7 +299,6 @@ unsigned GGui::EditBox::lines() return lines ; } -#if G_DC unsigned GGui::EditBox::linesInWindow() { unsigned text_height = characterHeight() ; @@ -297,7 +308,6 @@ unsigned GGui::EditBox::linesInWindow() G_DEBUG( "GGui::EditBox::linesInWindow: " << result ) ; return result ; } -#endif void GGui::EditBox::scrollBack( int lines ) { @@ -346,7 +356,6 @@ unsigned GGui::EditBox::scrollRange() return range ; } -#if G_DC unsigned GGui::EditBox::characterHeight() { if( m_character_height == 0 ) @@ -359,9 +368,7 @@ unsigned GGui::EditBox::characterHeight() } return m_character_height ; } -#endif -#if G_DC unsigned GGui::EditBox::windowHeight() { RECT rect ; @@ -369,11 +376,8 @@ unsigned GGui::EditBox::windowHeight() G_ASSERT( rect.bottom >= rect.top ) ; return (unsigned)( rect.bottom - rect.top ) ; } -#endif -// ===================================== -// GCheckBox -// ------------------------------------- +// === GGui::CheckBox::CheckBox( Dialog &dialog , int id ) : Control(dialog,id) @@ -394,9 +398,7 @@ void GGui::CheckBox::set( bool b ) ::CheckDlgButton( dialog().handle() , id() , b ) ; } -// ===================================== -// GButton -// ------------------------------------- +// === GGui::Button::Button( Dialog &dialog , int id ) : Control(dialog,id) diff --git a/src/win32/gcontrol.h b/src/win32/gcontrol.h index 820c294..f1997a6 100644 --- a/src/win32/gcontrol.h +++ b/src/win32/gcontrol.h @@ -37,13 +37,14 @@ namespace GGui class EditBox ; class CheckBox ; class Button ; -} ; +} // Class: GGui::Control // Description: A base class for dialog box control objects. // Normally a dialog box object (derived from Dialog) will // have Control-derived objects embedded within it to -// represent some of the dialog box controls. +// represent some of the dialog box controls. Supports +// sub-classing. // See also: EditBox, ListBox, CheckBox, Button // class GGui::Control @@ -58,17 +59,7 @@ public: private: NoRedraw( const NoRedraw & ) ; } ; -private: - friend class Control::NoRedraw ; - unsigned m_no_redraw_count ; - bool m_valid ; - Dialog & m_dialog ; - int m_id ; - HWND m_hwnd ; - -public: - - Control( Dialog &dialog , int id ) ; + Control( Dialog & dialog , int id ) ; // Constructor. The lifetime of the Control // object should not exceed that of the given // dialog box; normally the control object @@ -107,7 +98,7 @@ public: protected: virtual LRESULT onMessage( unsigned message , WPARAM wparam , - LPARAM lparam , WNDPROC super_class , bool &forward ) ; + LPARAM lparam , WNDPROC super_class , bool & forward ) ; // Overridable. Called on receipt of a window message // sent to a sub-classed control. // @@ -131,32 +122,25 @@ protected: // the super-class behaviour. private: - Control( const Control & ) ; - void operator=( const Control & ) ; + Control( const Control & ) ; // not implemented + void operator=( const Control & ) ; // not implemented + +private: + friend class Control::NoRedraw ; + unsigned m_no_redraw_count ; + bool m_valid ; + Dialog & m_dialog ; + int m_id ; + HWND m_hwnd ; } ; -inline GGui::Control::NoRedraw::NoRedraw( Control &control ) : - m_control(control) -{ - m_control.m_no_redraw_count++ ; - if( m_control.m_no_redraw_count == 1 ) - m_control.sendMessage( WM_SETREDRAW , false ) ; -} - -inline GGui::Control::NoRedraw::~NoRedraw() -{ - m_control.m_no_redraw_count-- ; - if( m_control.m_no_redraw_count == 0 ) - m_control.sendMessage( WM_SETREDRAW , true ) ; -} - // Class: GGui::ListBox // Description: A list box class. // -class GGui::ListBox : public Control +class GGui::ListBox : public GGui::Control { public: - ListBox( Dialog &dialog , int id ) ; + ListBox( Dialog & dialog , int id ) ; // Constructor. virtual ~ListBox() ; @@ -182,20 +166,17 @@ public: // Returns the number of list box entries. private: - void operator=( const ListBox & ) ; - ListBox( const ListBox & ) ; + void operator=( const ListBox & ) ; // not implemented + ListBox( const ListBox & ) ; // not implemented } ; // Class: GGui::EditBox // Description: An edit box class. // -class GGui::EditBox : public Control +class GGui::EditBox : public GGui::Control { -private: - unsigned m_character_height ; - public: - EditBox( Dialog &dialog , int id ) ; + EditBox( Dialog & dialog , int id ) ; // Constructor. virtual ~EditBox() ; @@ -244,19 +225,22 @@ public: // See also SBM_SETRANGE. private: - unsigned windowHeight() /*not const*/ ; - unsigned characterHeight() /*not const*/ ; - EditBox( const EditBox & ) ; - void operator=( const EditBox & ) ; + unsigned windowHeight() ; // not const + unsigned characterHeight() ; // not const + EditBox( const EditBox & ) ; // not implemented + void operator=( const EditBox & ) ; // not implemented + +private: + unsigned m_character_height ; } ; // Class: GGui::CheckBox // Description: A check box class. // -class GGui::CheckBox : public Control +class GGui::CheckBox : public GGui::Control { public: - CheckBox( Dialog &dialog , int id ) ; + CheckBox( Dialog & dialog , int id ) ; // Constructor. virtual ~CheckBox() ; @@ -269,17 +253,17 @@ public: // Sets the state of a boolean check box. private: - void operator=( const CheckBox ) ; - CheckBox( const CheckBox & ) ; + void operator=( const CheckBox ) ; // not implemented + CheckBox( const CheckBox & ) ; // not implemented } ; // Class: GGui::Button // Description: A button class. // -class GGui::Button : public Control +class GGui::Button : public GGui::Control { public: - Button( Dialog &dialog , int id ) ; + Button( Dialog & dialog , int id ) ; // Constructor. virtual ~Button() ; @@ -296,8 +280,8 @@ public: // Disables the button, greying it. private: - void operator=( const Button & ) ; - Button( const Button & ) ; + void operator=( const Button & ) ; // not implemented + Button( const Button & ) ; // not implemented } ; #endif diff --git a/src/win32/gcracker.cpp b/src/win32/gcracker.cpp index 99939de..74acea4 100644 --- a/src/win32/gcracker.cpp +++ b/src/win32/gcracker.cpp @@ -37,6 +37,11 @@ GGui::Cracker::~Cracker() { } +GGui::Cracker::Cracker( const Cracker & other ) : + WindowBase(other) +{ +} + GGui::Cracker & GGui::Cracker::operator=( const Cracker & other ) { WindowBase::operator=( other ) ; @@ -51,7 +56,7 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , { case WM_PAINT: { - G_DEBUG( "GCracker::onPaint" ) ; + G_DEBUG( "Cracker::onPaint" ) ; bool done = onPaintMessage() ; if( ! done ) { @@ -65,7 +70,7 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , case WM_CLOSE: { - G_DEBUG( "GCracker::onClose" ) ; + G_DEBUG( "Cracker::onClose" ) ; if( onClose() ) ::PostMessage( m_hwnd , WM_DESTROY , 0 , 0 ) ; return 0 ; @@ -73,58 +78,58 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , case WM_DESTROY: { - G_DEBUG( "GCracker::onDestroy" ) ; + G_DEBUG( "Cracker::onDestroy" ) ; onDestroy() ; return 0 ; } case WM_NCDESTROY: { - G_DEBUG( "GCracker::onNcDestroy" ) ; + G_DEBUG( "Cracker::onNcDestroy" ) ; onNcDestroy() ; return 0 ; } case WM_CTLCOLORMSGBOX: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_MSGBOX ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_MSGBOX ) ) ; } case WM_CTLCOLORDLG: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_DLG ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_DLG ) ) ; } case WM_CTLCOLOREDIT: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_EDIT ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_EDIT ) ) ; } case WM_CTLCOLORLISTBOX: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_LISTBOX ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_LISTBOX ) ) ; } case WM_CTLCOLORBTN: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_BTN ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_BTN ) ) ; } case WM_CTLCOLORSCROLLBAR: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_SCROLLBAR ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_SCROLLBAR ) ) ; } case WM_CTLCOLORSTATIC: { - return (LRESULT)onControlColour( (HDC)wparam , - (HWND)lparam , CTLCOLOR_STATIC ) ; + return reinterpret_cast( onControlColour( reinterpret_cast(wparam) , + reinterpret_cast(lparam) , CTLCOLOR_STATIC ) ) ; } case WM_SYSCOLORCHANGE: @@ -176,14 +181,14 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , case WM_ERASEBKGND: { - G_DEBUG( "GCracker::onEraseBackground" ) ; + G_DEBUG( "Cracker::onEraseBackground" ) ; HDC hdc = reinterpret_cast(wparam) ; return onEraseBackground( hdc ) ; } case WM_DROPFILES: { - G_DEBUG( "GCracker::onDrop" ) ; + G_DEBUG( "Cracker::onDrop" ) ; HDROP hdrop = reinterpret_cast(wparam) ; int count = ::DragQueryFile( hdrop , -1 , NULL , 0 ) ; G::Strings list ; @@ -192,7 +197,7 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , static char buffer[512] ; if( ::DragQueryFile( hdrop , i , buffer , sizeof(buffer) ) < sizeof(buffer) ) { - G_DEBUG( "GCracker::onDrop: \"" << buffer << "\"" ) ; + G_DEBUG( "Cracker::onDrop: \"" << buffer << "\"" ) ; list.push_back( std::string(buffer) ) ; } } @@ -219,7 +224,7 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , case WM_MOVE: { - onMove( (int)LOWORD(lparam) , (int)HIWORD(lparam) ) ; + onMove( static_cast(LOWORD(lparam)) , static_cast(HIWORD(lparam)) ) ; return 0 ; } @@ -231,7 +236,7 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , if( type == menu || type == accelerator ) { - G_DEBUG( "GCracker::onMenuCommand" ) ; + G_DEBUG( "Cracker::onMenuCommand" ) ; onMenuCommand( wparam ) ; } @@ -240,7 +245,7 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , HWND window = GET_WM_COMMAND_HWND( wparam , lparam ) ; UINT id = GET_WM_COMMAND_ID( wparam , lparam ) ; UINT message = type ; - G_DEBUG( "GCracker::onControlCommand" ) ; + G_DEBUG( "Cracker::onControlCommand" ) ; onControlCommand( window , message , id ) ; } @@ -308,13 +313,13 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , case WM_GETMINMAXINFO: { - MINMAXINFO far *f_p = (MINMAXINFO far *)lparam ; - G_ASSERT( f_p != NULL ) ; - int dx = f_p->ptMaxSize.x ; - int dy = f_p->ptMaxSize.y ; + MINMAXINFO * mmi_p = reinterpret_cast(lparam) ; + G_ASSERT( mmi_p != NULL ) ; + int dx = mmi_p->ptMaxSize.x ; + int dy = mmi_p->ptMaxSize.y ; onDimension( dx , dy ) ; - f_p->ptMaxTrackSize.x = f_p->ptMaxSize.x = dx ; - f_p->ptMaxTrackSize.y = f_p->ptMaxSize.y = dy ; + mmi_p->ptMaxTrackSize.x = mmi_p->ptMaxSize.x = dx ; + mmi_p->ptMaxTrackSize.y = mmi_p->ptMaxSize.y = dy ; return 0 ; } @@ -366,7 +371,8 @@ LRESULT GGui::Cracker::crack( UINT message , WPARAM wparam , case WM_INITMENUPOPUP: { - onInitMenuPopup( (HMENU)wparam , (unsigned)LOWORD(lparam) , + onInitMenuPopup( reinterpret_cast(wparam) , + static_cast(LOWORD(lparam)) , !!HIWORD(lparam) ) ; return 0 ; } @@ -423,7 +429,7 @@ unsigned int GGui::Cracker::wm_winsock() //static unsigned int GGui::Cracker::wm_user_other() { - return WM_USER + 123U ; + return WM_USER+123U ; } // trivial default implementations of virtual functions... diff --git a/src/win32/gcracker.h b/src/win32/gcracker.h index b084ef8..a4bbb32 100644 --- a/src/win32/gcracker.h +++ b/src/win32/gcracker.h @@ -33,14 +33,14 @@ namespace GGui { class Cracker ; -} ; +} // Class: GGui::Cracker // Description: The Cracker class encapsulates a typical // window procedure by 'cracking' Windows messages // into virtual functions. // -class GGui::Cracker : public WindowBase +class GGui::Cracker : public GGui::WindowBase { public: @@ -318,10 +318,4 @@ private: unsigned int , WPARAM , LPARAM ) ; } ; -inline -GGui::Cracker::Cracker( const Cracker & other ) : - WindowBase(other) -{ -} - #endif diff --git a/src/win32/gdc.cpp b/src/win32/gdc.cpp new file mode 100644 index 0000000..a3e037d --- /dev/null +++ b/src/win32/gdc.cpp @@ -0,0 +1,114 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gdc.cpp +// + +#include "gdef.h" +#include "gdc.h" + +GGui::DeviceContext::DeviceContext( HWND hwnd ) : + m_hwnd(hwnd) , + m_do_release(true) +{ + m_hdc = ::GetDC(m_hwnd) ; +} + +GGui::DeviceContext::DeviceContext( HDC hdc ) : + m_hwnd(0) , + m_hdc(hdc) , + m_do_release(false) // ignored +{ +} + +GGui::DeviceContext::~DeviceContext() +{ + if( m_hwnd != 0 && m_do_release ) + ::ReleaseDC( m_hwnd , m_hdc ) ; +} + +HDC GGui::DeviceContext::handle() const +{ + return m_hdc ; +} + +HDC GGui::DeviceContext::extractHandle() +{ + m_do_release = false ; + return m_hdc ; +} + +HDC GGui::DeviceContext::operator()() const +{ + return m_hdc ; +} + +void GGui::DeviceContext::swapBuffers() +{ + BOOL ok = ::SwapBuffers( m_hdc ) ; +} + +// === + +GGui::ScreenDeviceContext::ScreenDeviceContext() +{ + m_dc = ::CreateDC( "DISPLAY" , 0 , 0 , 0 ) ; +} + +GGui::ScreenDeviceContext::~ScreenDeviceContext() +{ + ::DeleteDC( m_dc ) ; +} + +HDC GGui::ScreenDeviceContext::handle() +{ + return m_dc ; +} + +HDC GGui::ScreenDeviceContext::operator()() +{ + return handle() ; +} + +int GGui::ScreenDeviceContext::colours() const +{ + return ::GetDeviceCaps(m_dc,NUMCOLORS) ; +} + +int GGui::ScreenDeviceContext::dx() const +{ + return ::GetDeviceCaps(m_dc,HORZRES) ; +} + +int GGui::ScreenDeviceContext::dy() const +{ + return ::GetDeviceCaps(m_dc,VERTRES) ; +} + +int GGui::ScreenDeviceContext::aspectx() const +{ + return ::GetDeviceCaps(m_dc,ASPECTX) ; +} + +int GGui::ScreenDeviceContext::aspecty() const +{ + return ::GetDeviceCaps(m_dc,ASPECTY) ; +} + diff --git a/src/win32/gdc.h b/src/win32/gdc.h new file mode 100644 index 0000000..b9f0347 --- /dev/null +++ b/src/win32/gdc.h @@ -0,0 +1,130 @@ +// +// Copyright (C) 2001-2003 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. +// +// === +// +// gdc.h +// + +#ifndef G_DC_H +#define G_DC_H + +#include "gdef.h" + +namespace GGui +{ + class DeviceContext ; + class ScreenDeviceContext ; +} + +// Class: GGui::DeviceContext +// Description: A thin wrapper for a GDI device +// context corresponding to a window. +// See also: GGui::ScreenDeviceContext +// +class GGui::DeviceContext +{ +public: + explicit DeviceContext( HWND hwnd ) ; + // Constructor for a window's device context. + // + // The GDI device context is released in + // the destructor. + + explicit DeviceContext( HDC hdc ) ; + // Constructor to wrap the given GDI handle. + // The GDI handle typically comes from ::BeginPaint() + // while processing a WM_PAINT message. + // + // The GDI device context is _not_ released in + // the destructor. + + ~DeviceContext() ; + // Destructor. + + HDC handle() const ; + // Returns the GDI device context handle. + + HDC extractHandle() ; + // Extracts the GDI device context handle. + // The destructor will no longer release it. + + HDC operator()() const ; + // Returns the GDI device context handle. + + void swapBuffers() ; + // If the device context has double buffering + // then the two pixel buffers are swapped. + // This is typically called after the + // "back" buffer has been filled with + // a new image. + +private: + HDC m_hdc ; + HWND m_hwnd ; + bool m_do_release ; + +private: + DeviceContext( const DeviceContext & ) ; + void operator=( const DeviceContext & ) ; +} ; + +// Class: GGui::ScreenDeviceContext +// Description: A thin wrapper for a GDI device +// context corresponding to the whole screen. +// See also: GGui::DeviceContext +// +class GGui::ScreenDeviceContext +{ +public: + ScreenDeviceContext() ; + // Default constructor. + + ~ScreenDeviceContext() ; + // Destructor. + + HDC handle() ; + // Returns the GDI device context handle. + + HDC operator()() ; + // Returns the GDI device context handle. + + int colours() const ; + // Returns the number of colours. + + int dx() const ; + // Returns the screen width. + + int dy() const ; + // Returns the screen height. + + int aspectx() const ; + // Returns one part of the screen's aspect ratio. + + int aspecty() const ; + // Returns the other part of the screen's aspect ratio. + +private: + ScreenDeviceContext( const ScreenDeviceContext & ) ; + void operator=( const ScreenDeviceContext & ) ; + +private: + HDC m_dc ; +} ; + +#endif diff --git a/src/win32/gdialog.cpp b/src/win32/gdialog.cpp index 69239e1..833fe11 100644 --- a/src/win32/gdialog.cpp +++ b/src/win32/gdialog.cpp @@ -27,33 +27,33 @@ #include "glog.h" #include // find -// static data +BOOL CALLBACK gdialog_dlgproc_export( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) +{ + return GGui::Dialog::dlgProc( hwnd , message , wparam , lparam ) ; +} + GGui::DialogList GGui::Dialog::m_list ; -// local prototypes -BOOL CALLBACK gdialog_dlgproc_export( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) ; - -GGui::Dialog::Dialog( HINSTANCE hinstance , HWND hwnd_parent , const char *title ) : +GGui::Dialog::Dialog( HINSTANCE hinstance , HWND hwnd_parent , const std::string & title ) : WindowBase(NULL) , + m_title(title) , m_modal(false) , m_focus_set(false) , m_hinstance(hinstance) , - m_hwnd_parent(hwnd_parent) + m_hwnd_parent(hwnd_parent) , + m_magic(Magic) { - m_magic = Magic ; - if( title != NULL ) - m_title = title ; } GGui::Dialog::Dialog( const ApplicationBase & app , bool top_level ) : WindowBase(NULL) , + m_title(app.title()) , m_modal(false) , - m_focus_set(false) + m_focus_set(false) , + m_hinstance(app.hinstance()) , + m_hwnd_parent(top_level?NULL:app.handle()) , + m_magic(Magic) { - m_magic = Magic ; - m_hinstance = app.hinstance() ; - m_hwnd_parent = top_level ? NULL : app.handle() ; - m_title = app.title() ; } void GGui::Dialog::privateInit( HWND hwnd ) @@ -82,7 +82,7 @@ void GGui::Dialog::cleanup() G_DEBUG( "GGui::Dialog::cleanup" ) ; // reset the object pointer - ::SetWindowLong( handle() , DWL_USER , (LPARAM)NULL ) ; + ::SetWindowLong( handle() , DWL_USER , LPARAM(0) ) ; // remove from the modal list G_ASSERT( (find(handle())!=m_list.end()) == !m_modal ) ; @@ -90,7 +90,7 @@ void GGui::Dialog::cleanup() { G_DEBUG( "GGui::Dialog::dlgProc: removing modeless dialog box window " << handle() ) ; m_list.erase( find(handle()) ) ; - G_ASSERT( find(handle()) == m_list.end() ) ; // assert one + G_ASSERT( find(handle()) == m_list.end() ) ; // assert only one } } setHandle( NULL ) ; @@ -112,12 +112,12 @@ LRESULT GGui::Dialog::sendMessage( int control , unsigned message , WPARAM wpara return ::SendMessage( hwnd_control , message , wparam , lparam ) ; } -bool GGui::Dialog::dlgProc( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) +BOOL GGui::Dialog::dlgProc( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) { if( message == WM_INITDIALOG ) { - Dialog *dialog = (Dialog*)(void*)lparam ; - ::SetWindowLong( hwnd , DWL_USER , (LPARAM)(void *)dialog ) ; + Dialog * dialog = from_lparam( lparam ) ; + ::SetWindowLong( hwnd , DWL_USER , to_lparam(dialog) ) ; dialog->privateInit( hwnd ) ; G_DEBUG( "GGui::Dialog::dlgProc: WM_INITDIALOG" ) ; if( !dialog->onInit() ) @@ -138,7 +138,7 @@ bool GGui::Dialog::dlgProc( HWND hwnd , UINT message , WPARAM wparam , LPARAM lp } else { - GGui::Dialog *dialog = (GGui::Dialog*)::GetWindowLong( hwnd , DWL_USER ) ; + Dialog * dialog = from_long( ::GetWindowLong(hwnd,DWL_USER) ) ; if( dialog != NULL ) return dialog->dlgProc( message , wparam , lparam ) ; else @@ -146,14 +146,14 @@ bool GGui::Dialog::dlgProc( HWND hwnd , UINT message , WPARAM wparam , LPARAM lp } } -bool GGui::Dialog::dlgProc( UINT message , WPARAM wparam , LPARAM lparam ) +BOOL GGui::Dialog::dlgProc( UINT message , WPARAM wparam , LPARAM lparam ) { switch( message ) { case WM_VSCROLL: case WM_HSCROLL: { - HWND hwnd_scrollbar = (HWND)(HIWORD(lparam)) ; // may be zero + HWND hwnd_scrollbar = reinterpret_cast(HIWORD(lparam)) ; // may be zero if( wparam == SB_THUMBPOSITION || wparam == SB_THUMBTRACK ) { unsigned position = LOWORD(lparam) ; @@ -174,34 +174,45 @@ bool GGui::Dialog::dlgProc( UINT message , WPARAM wparam , LPARAM lparam ) return 1 ; } - #ifdef G_WIN16 - case WM_CTLCOLOR: - { - return (bool)onControlColour( wparam , LOWORD(lparam) , HIWORD(lparam) ) ; - } - #endif - - #ifdef G_WIN32 case WM_CTLCOLORDLG: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_DLG ) ; + { + return onControlColour_( wparam , lparam , CTLCOLOR_DLG ) ; + } + case WM_CTLCOLORMSGBOX: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_MSGBOX ) ; + { + return onControlColour_( wparam , lparam , CTLCOLOR_MSGBOX ) ; + } + case WM_CTLCOLOREDIT: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_EDIT ) ; + { + return onControlColour_( wparam , lparam , CTLCOLOR_EDIT ) ; + } + case WM_CTLCOLORBTN: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_BTN ) ; + { + return onControlColour_( wparam , lparam , CTLCOLOR_BTN ) ; + } + case WM_CTLCOLORLISTBOX: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_LISTBOX ) ; + { + return onControlColour_( wparam , lparam , CTLCOLOR_LISTBOX ) ; + } + case WM_CTLCOLORSCROLLBAR: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_SCROLLBAR ) ; + { + return onControlColour_( wparam , lparam , CTLCOLOR_SCROLLBAR ) ; + } + case WM_CTLCOLORSTATIC: - return !!onControlColour( (HDC)wparam , (HWND)lparam , CTLCOLOR_STATIC ) ; - #endif + { + return onControlColour_( wparam , lparam , CTLCOLOR_STATIC ) ; + } #if 0 // Windows bug -- WM_SETCURSOR is useless in a dialog box case WM_SETCURSOR: { - onSetCursor( (HWND)wparam , LOWORD(lparam) , HIWORD(lparam) ) ; + onSetCursor( reinterpret_cast(wparam) , LOWORD(lparam) , HIWORD(lparam) ) ; return 0 ; } #endif @@ -229,7 +240,7 @@ bool GGui::Dialog::dlgProc( UINT message , WPARAM wparam , LPARAM lparam ) return 0 ; } -HBRUSH GGui::Dialog::onControlColour( HDC /*hDC*/ , HWND /*hwnd_control*/ , WORD /*type*/ ) +HBRUSH GGui::Dialog::onControlColour( HDC , HWND , WORD ) { return 0 ; } @@ -273,7 +284,7 @@ bool GGui::Dialog::run( int resource_id ) return run( MAKEINTRESOURCE(resource_id) ) ; } -bool GGui::Dialog::run( const char *f_name ) +bool GGui::Dialog::run( const char * f_name ) { G_DEBUG( "GGui::Dialog::run" ) ; @@ -285,8 +296,7 @@ bool GGui::Dialog::run( const char *f_name ) m_modal = true ; int rc = ::DialogBoxParam( m_hinstance , f_name , - m_hwnd_parent , (DLGPROC)gdialog_dlgproc_export , - (LPARAM)(void *)this ) ; + m_hwnd_parent , dlgproc_export_fn() , to_lparam(this) ) ; if( rc == -1 ) { @@ -308,7 +318,7 @@ bool GGui::Dialog::runModeless( int resource_id , bool visible ) return runModeless( MAKEINTRESOURCE(resource_id) , visible ) ; } -bool GGui::Dialog::runModeless( const char *f_name , bool visible ) +bool GGui::Dialog::runModeless( const char * f_name , bool visible ) { G_DEBUG( "GGui::Dialog::runModeless" ) ; @@ -320,8 +330,7 @@ bool GGui::Dialog::runModeless( const char *f_name , bool visible ) m_modal = false ; HWND hwnd = ::CreateDialogParam( m_hinstance , f_name , - m_hwnd_parent , (DLGPROC)gdialog_dlgproc_export , - (LPARAM)(void *)this ) ; + m_hwnd_parent , dlgproc_export_fn() , to_lparam(this) ) ; if( hwnd == NULL ) { @@ -347,11 +356,6 @@ bool GGui::Dialog::dialogMessage( MSG &msg ) return false ; } -BOOL CALLBACK gdialog_dlgproc_export( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) -{ - return GGui::Dialog::dlgProc( hwnd , message , wparam , lparam ) ; -} - GGui::SubClassMap & GGui::Dialog::map() { return m_map ; @@ -376,3 +380,60 @@ bool GGui::Dialog::registerNewClass( HICON hicon , const std::string & new_class return rc != 0 ; } +bool GGui::Dialog::privateFocusSet() const +{ + return m_focus_set ; +} + +bool GGui::Dialog::onInit() +{ + return true ; +} + +void GGui::Dialog::onScrollPosition( HWND , unsigned ) +{ +} + +void GGui::Dialog::onScroll( HWND , bool ) +{ +} + +void GGui::Dialog::onScrollMessage( unsigned , WPARAM , LPARAM ) +{ +} + +bool GGui::Dialog::isValid() +{ + return m_magic == Magic ; +} + +BOOL GGui::Dialog::onControlColour_( WPARAM wparam , LPARAM lparam , WORD type ) +{ + return reinterpret_cast( + onControlColour( reinterpret_cast(wparam) , reinterpret_cast(lparam) , type ) ) ; +} + +//static +GGui::Dialog * GGui::Dialog::from_lparam( LPARAM lparam ) +{ + return reinterpret_cast( reinterpret_cast(lparam) ) ; +} + +//static +GGui::Dialog * GGui::Dialog::from_long( LONG l ) +{ + return reinterpret_cast( reinterpret_cast(l) ) ; +} + +//static +LPARAM GGui::Dialog::to_lparam( Dialog * p ) +{ + return reinterpret_cast( reinterpret_cast(p) ) ; +} + +//static +DLGPROC GGui::Dialog::dlgproc_export_fn() +{ + return reinterpret_cast(gdialog_dlgproc_export) ; +} + diff --git a/src/win32/gdialog.h b/src/win32/gdialog.h index ed902c2..65dbdd9 100644 --- a/src/win32/gdialog.h +++ b/src/win32/gdialog.h @@ -28,12 +28,13 @@ #include "gwinbase.h" #include "gappbase.h" #include "gscmap.h" +#include namespace GGui { class DialogHandle ; class Dialog ; -} ; +} // Class: GGui::DialogHandle // Description: A private implementation class used by GGui::Dialog. @@ -49,22 +50,22 @@ public: namespace GGui { - typedef std::list< DialogHandle GAllocator(DialogHandle) > DialogList ; -} ; + typedef std::list DialogList ; +} // Class: GGui::Dialog // Description: A dialog box class for both modal and // modeless operation. // See also: GGui::Control // -class GGui::Dialog : public WindowBase +class GGui::Dialog : public GGui::WindowBase { public: Dialog( HINSTANCE hinstance , HWND hwnd_parent , - const char *title = NULL ) ; - // Constructor. After contruction just call - // run() or runModeless() with the appropriate - // dialog resource id or name. + const std::string & title = std::string() ) ; + // Constructor. After contruction just call + // run() or runModeless() with the appropriate + // dialog resource id or name. explicit Dialog( const GGui::ApplicationBase & app , bool top_level = false ) ; // Contructor for a dialog box which takes some @@ -84,7 +85,7 @@ public: static bool dialogMessage( MSG &msg ) ; // Processes messages for all modeless dialog boxes. // This should be put in the application's main message - // loop (as the GPump class does). + // loop (as the GGui::Pump class does). // Returns true if the message was used up. bool run( const char * resource_name ) ; @@ -107,7 +108,7 @@ public: // on the heap and deleted with "delete this" within // onNcDestroy(). - static bool dlgProc( HWND hwnd , UINT message , + static BOOL dlgProc( HWND hwnd , UINT message , WPARAM wparam , LPARAM lparam ) ; // Called directly from the exported dialog procedure. @@ -181,59 +182,31 @@ protected: // necessary. private: - bool dlgProc( UINT message , WPARAM wparam , LPARAM lparam ) ; + BOOL dlgProc( UINT message , WPARAM wparam , LPARAM lparam ) ; void privateInit( HWND hwnd ) ; void privateEnd( int n ) ; bool privateFocusSet() const ; void cleanup() ; DialogList::iterator find( HWND h ) ; - Dialog( const Dialog &other ) ; - void operator=( const Dialog &other ) ; + BOOL onControlColour_( WPARAM wparam , LPARAM lparam , WORD type ) ; + static Dialog * from_lparam( LPARAM lparam ) ; + static Dialog * from_long( LONG l ) ; + static LPARAM to_lparam( Dialog * p ) ; + static DLGPROC dlgproc_export_fn() ; + Dialog( const Dialog &other ) ; // not implemented + void operator=( const Dialog &other ) ; // not implemented private: enum { Magic = 4567 } ; std::string m_name ; std::string m_title ; + bool m_modal ; + bool m_focus_set ; HINSTANCE m_hinstance ; HWND m_hwnd_parent ; - bool m_focus_set ; - bool m_modal ; int m_magic ; SubClassMap m_map ; static DialogList m_list ; } ; -inline -bool GGui::Dialog::privateFocusSet() const -{ - return m_focus_set ; -} - -inline -bool GGui::Dialog::onInit() -{ - return true ; -} - -inline -void GGui::Dialog::onScrollPosition( HWND , unsigned ) -{ -} - -inline -void GGui::Dialog::onScroll( HWND , bool ) -{ -} - -inline -void GGui::Dialog::onScrollMessage( unsigned , WPARAM , LPARAM ) -{ -} - -inline -bool GGui::Dialog::isValid() -{ - return m_magic == Magic ; -} - #endif diff --git a/src/win32/gpump.h b/src/win32/gpump.h index 7a918e0..d5be4e8 100644 --- a/src/win32/gpump.h +++ b/src/win32/gpump.h @@ -29,15 +29,17 @@ namespace GGui { class Pump ; -} ; +} // Class: GGui::Pump // // Description: A static class which implements a -// Windows message pump. Uses GDialog::dialogMessage() +// Windows message pump. Uses GGui::Dialog::dialogMessage() // in its implementation in order to support modeless // dialog boxes. // +// See also: GGui::Cracker, GGui::Dialog, GGui::ApplicationInstance +// class GGui::Pump { public: @@ -52,7 +54,8 @@ public: static void quit() ; // Causes run() to return (once the call stack - // has unwound). + // has unwound). Use this in preference to + // ::PostQuitMessage(). private: static bool dialogMessage( MSG & ) ; // links gpump.cpp to gdialog.cpp (or not) diff --git a/src/win32/gscmap.cpp b/src/win32/gscmap.cpp index 9afa431..a9c0cfd 100644 --- a/src/win32/gscmap.cpp +++ b/src/win32/gscmap.cpp @@ -26,6 +26,11 @@ #include "gdebug.h" #include "glog.h" +GGui::SubClassMap::SubClassMap() : + m_high_water(0U) +{ +} + GGui::SubClassMap::~SubClassMap() { } diff --git a/src/win32/gscmap.h b/src/win32/gscmap.h index 5bfae89..e6a60b3 100644 --- a/src/win32/gscmap.h +++ b/src/win32/gscmap.h @@ -29,7 +29,7 @@ namespace GGui { class SubClassMap ; -} ; +} // Class: GGui::SubClassMap // Description: A class for mapping sub-classed window handles @@ -79,10 +79,4 @@ private: unsigned int m_high_water ; } ; -inline -GGui::SubClassMap::SubClassMap() : - m_high_water(0U) -{ -} - #endif diff --git a/src/win32/gsize.h b/src/win32/gsize.h index b431a01..cfb5844 100644 --- a/src/win32/gsize.h +++ b/src/win32/gsize.h @@ -30,7 +30,7 @@ namespace GGui { class Size ; -} ; +} // Class: GGui::Size // Description: A structure representing the size of a rectangle (typically @@ -74,6 +74,6 @@ namespace GGui size.streamOut( stream ) ; return stream ; } -} ; +} #endif diff --git a/src/win32/gwinbase.h b/src/win32/gwinbase.h index 8e90049..6cf7742 100644 --- a/src/win32/gwinbase.h +++ b/src/win32/gwinbase.h @@ -30,7 +30,7 @@ namespace GGui { class WindowBase ; -} ; +} // Class: GGui::WindowBase // Description: A low-level window class which diff --git a/src/win32/gwindow.cpp b/src/win32/gwindow.cpp index 6ce9dbc..97d8c9f 100644 --- a/src/win32/gwindow.cpp +++ b/src/win32/gwindow.cpp @@ -46,13 +46,16 @@ WNDPROC GGui::Window::windowProcedure() return gwindow_wndproc_export ; } -bool GGui::Window::registerWindowClass( const char *class_name , +bool GGui::Window::registerWindowClass( const std::string & class_name , HINSTANCE hinstance , UINT style , HICON icon , HCURSOR cursor , - HBRUSH background , const char *menu_name ) + HBRUSH background , UINT menu_resource_id ) { - WNDCLASS c ; + G_DEBUG( "GGui::Window::registerWindowClass: \"" << class_name << "\"" ) ; + const char * menu_name = menu_resource_id ? MAKEINTRESOURCE(menu_resource_id) : NULL ; + + WNDCLASS c ; c.style = style ; c.lpfnWndProc = gwindow_wndproc_export ; c.cbClsExtra = 4 ; // reserved @@ -62,25 +65,29 @@ bool GGui::Window::registerWindowClass( const char *class_name , c.hCursor = cursor ; c.hbrBackground = background ; c.lpszMenuName = menu_name ; - c.lpszClassName = class_name ; + c.lpszClassName = class_name.c_str() ; return ::RegisterClass( &c ) != 0 ; } -bool GGui::Window::create( const char *class_name , - const char *title , DWORD style , +bool GGui::Window::create( const std::string & class_name , + const std::string & title , DWORD style , int x , int y , int dx , int dy , HWND parent , HMENU menu , HINSTANCE hinstance ) { G_ASSERT( m_hwnd == NULL ) ; + G_DEBUG( "GGui::Window::create: \"" << class_name << "\", \"" << title << "\"" ) ; - if( title == NULL ) - title = "" ; + DWORD extended_style = 0 ; + if( style == 0 ) + { + style = windowStyleHidden() ; + extended_style = WS_EX_TOOLWINDOW ; + } void *vp = reinterpret_cast(this) ; - m_hwnd = ::CreateWindow( class_name , title , - style , x , y , dx , dy , - parent , menu , hinstance , vp ) ; + m_hwnd = ::CreateWindowEx( extended_style , class_name.c_str() , title.c_str() , + style , x , y , dx , dy , parent , menu , hinstance , vp ) ; G_DEBUG( "GGui::Window::create: handle " << m_hwnd ) ; return m_hwnd != NULL ; @@ -123,7 +130,7 @@ GGui::Window * GGui::Window::instance( HWND hwnd ) { G_ASSERT( hwnd != NULL ) ; LONG wl = ::GetWindowLong( hwnd , 0 ) ; - void far * vp = reinterpret_cast(wl) ; + void * vp = reinterpret_cast(wl) ; return reinterpret_cast(vp) ; } @@ -137,7 +144,7 @@ LRESULT GGui::Window::wndProc( HWND hwnd , UINT msg , WPARAM wparam , LPARAM lpa Window *window = reinterpret_cast(cs->lpCreateParams) ; G_ASSERT( window != NULL ) ; G_DEBUG( "GGui::Window::wndProc: WM_CREATE: this = " << window ) ; - void far * vp = reinterpret_cast(window) ; + void * vp = reinterpret_cast(window) ; LONG wl = reinterpret_cast(vp) ; ::SetWindowLong( hwnd , 0 , wl ) ; window->setHandle( hwnd ) ; @@ -155,10 +162,11 @@ LRESULT GGui::Window::wndProc( HWND hwnd , UINT msg , WPARAM wparam , LPARAM lpa } } -LRESULT GGui::Window::sendUserString( HWND hwnd , const char *string ) +LRESULT GGui::Window::sendUserString( HWND hwnd , const char * string ) { G_ASSERT( string != NULL ) ; - return ::SendMessage( hwnd , Cracker::wm_user_other() , 0 , (LPARAM)(const char far *)string ) ; + return ::SendMessage( hwnd , Cracker::wm_user_other() , 0 , + reinterpret_cast(string) ) ; } LRESULT GGui::Window::onUserOther( WPARAM , LPARAM lparam ) @@ -233,6 +241,11 @@ DWORD GGui::Window::windowStyleChild() return WS_CHILDWINDOW ; } +DWORD GGui::Window::windowStyleHidden() +{ + return WS_POPUP ; // no WS_VISIBLE +} + UINT GGui::Window::classStyle( bool redraw ) { return diff --git a/src/win32/gwindow.h b/src/win32/gwindow.h index b6247f5..a55cdce 100644 --- a/src/win32/gwindow.h +++ b/src/win32/gwindow.h @@ -27,40 +27,32 @@ #include "gdef.h" #include "gcracker.h" #include "gsize.h" - -#define WM_USER_STRING (WM_USER + 123) +#include namespace GGui { class Window ; -} ; +} // Class: GGui::Window -// Description: A window class. Window messages -// should be processed by overriding the on*() -// virtual functions inherited from GGui::Cracker. +// Description: A window class. Window messages should be processed by +// overriding the on*() virtual functions inherited from GGui::Cracker. // See also: WindowBase // -class GGui::Window : public Cracker +class GGui::Window : public GGui::Cracker { public: explicit Window( HWND hwnd = 0 ) ; - // Constructor. Normally the default constructor - // is used, followed by create(). Use - // registerWindowClass() before calling - // any create() function. + // Constructor. Normally the default constructor is used, followed + // by create(). Use registerWindowClass() before calling any + // create() function. virtual ~Window() ; - // Virtual destructor. The Windows window - // is _not_ destroyed. + // Virtual destructor. The Windows window is _not_ destroyed. - static bool registerWindowClass( const char *class_name , - HINSTANCE hinstance , - UINT class_style , - HICON icon , - HCURSOR cursor , - HBRUSH background , - const char *menu_name ) ; + static bool registerWindowClass( const std::string & class_name , + HINSTANCE hinstance , UINT class_style , HICON icon , + HCURSOR cursor , HBRUSH background , UINT menu_resource_id = 0 ) ; // Registers a window class specifically for Window objects. // All Window windows must have their window class registered // in this way before any window is created. @@ -68,27 +60,26 @@ public: // Returns true on success. Fails beningly if the class is already // registered. // - // Default values are provided by the methods classStyle(), - // classIcon() , classCursor() and classBrush(). The 'menu_name' - // parameter may be null. + // Typical values for the 'class_style', 'icon', 'cursor' and + // 'background' parameters can be obtained from the static methods + // classStyle(), classIcon() , classCursor() and classBrush(). // // See also ::RegisterClass() and struct WNDCLASS. - bool create( const char *class_name , - const char *title , DWORD window_style , + bool create( const std::string & class_name , + const std::string & title , DWORD window_style , int x , int y , int dx , int dy , HWND parent , HMENU menu_or_child_id , HINSTANCE hinstance ) ; // Creates the window. Returns true on success. // - // The given window class name must be the - // name of a window class previously registered - // through registerWindowClass(). + // The given window class name must be the name of a window + // class previously registered through registerWindowClass(). // - // The 'title' parameter may be null. - // - // Default values for the 'window_style' parameter - // are provided by windowStyleMain(), windowStylePopup() - // and windowStyleChild(). + // Typical values for the 'window_style' parameter can + // be obtained from the static methods windowStyleMain(), + // windowStylePopup() and windowStyleChild(). A value + // of zero defaults to windowStyleHidden(), with the + // 'exclude-from-toolbar' extended style. // // The window size and location parameters may be specified // using CW_USEDEFAULT. @@ -116,76 +107,70 @@ public: // Invalidates the window so that it redraws. static Size borderSize( bool has_menu ) ; - // Returns the size of the border of a _typical_ - // main window. The actual border size will - // depend on the window style and its size - // (since the menu bar changes height at - // run-time). + // Returns the size of the border of a _typical_ main window. + // The actual border size will depend on the window style and + // its size (since the menu bar changes height at run-time). void resize( Size new_size , bool repaint = true ) ; // Resizes the window. The top-left corner stays put. static Window * instance( HWND hwnd ) ; - // Maps from a window handle to a Window - // object. The handle must be that of - // a Window window. + // Maps from a window handle to a Window object. The handle + // must be that of a Window window. static LRESULT sendUserString( HWND hwnd , const char *string ) ; - // Sends a string to a specified window. - // The other window will receive a - // onUserString() message. + // Sends a string to a specified window. The other window + // will receive a onUserString() message. static UINT classStyle( bool redraw = false ) ; // Returns a general-purpose value for - // resisterWindowClass(..class_style..). + // resisterWindowClass(class_style). static DWORD windowStyleMain() ; - // Returns a value for create(..window_style..) - // for a typical 'main' window. + // Returns a value for create(window_style) for a typical + // 'main' window. // - // The parent window parameter should be NULL. - // The x,y,dx,dy parameters will normally - // be CW_USEDEFAULT. + // The create() parent window parameter should be NULL, and + // the x,y,dx,dy parameters will normally be CW_USEDEFAULT. static DWORD windowStylePopup() ; - // Returns a value for create(..window_style..) - // for a typical 'popup' window ie. (in this - // case) a window which typically acts like a - // modeless dialog box -- it can be independetly - // activated, has a title bar but no minimise/ - // maximise buttons, and stays on top of its - // parent (if any). + // Returns a value for create(window_style) for a typical + // 'popup' window ie. (in this case) a window which typically + // acts like a modeless dialog box -- it can be independetly + // activated, has a title bar but no minimise/maximise buttons, + // and stays on top of its parent (if any). // - // The parent window parameter may be NULL -- if - // NULL then this window will be independently - // iconised with a separate button on the toolbar. + // The create() parent window parameter may be NULL -- if + // NULL then this window will be independently iconised with + // a separate button on the toolbar. static DWORD windowStyleChild() ; - // Returns a value for create(..window_style..) - // for a typical 'child' window. + // Returns a value for create(window_style) for a typical + // 'child' window. // - // The parent window parameter cannot be NULL. + // The create() parent window parameter cannot be NULL. + + static DWORD windowStyleHidden() ; + // Returns a value for create(window_style) for a hidden + // window. static HBRUSH classBrush() ; - // Returns a default value for - // registerWindowClass(..background..). + // Returns a default value for registerWindowClass(background). static HICON classIcon() ; - // Returns a default for registerWindowClass(..hicon..). - // Only called if LoadIcon(resource()) fails. + // Returns a default for registerWindowClass(hicon). static HCURSOR classCursor() ; - // Returns a default for registerWindowClass(..hcursor..). + // Returns a default for registerWindowClass(hcursor). protected: virtual LRESULT onUserString( const char *string ) ; - // Overridable. Called when the window - // receives a message from sendUserString(). + // Overridable. Called when the window receives a message + // from sendUserString(). static WNDPROC windowProcedure() ; - // Returns the address of the exported 'C' window - // procedure. This is not for general use -- see - // WindowHidden. + // Returns the address of the exported 'C' window procedure. + // This is not for general use -- see WindowHidden. virtual void onException( std::exception & e ) ; // Called if an exception is being thrown out of the @@ -204,8 +189,8 @@ private: LRESULT wndProcCore( UINT , WPARAM , LPARAM , bool & ) ; bool onCreateCore() ; virtual LRESULT onUserOther( WPARAM , LPARAM ) ; - Window( const Window &other ) ; // not implemented - Window &operator=( const Window &other ) ; // not implemented + Window( const Window & other ) ; // not implemented + Window & operator=( const Window & other ) ; // not implemented } ; #endif diff --git a/src/win32/gwinhid.cpp b/src/win32/gwinhid.cpp index 6749cd9..f17ae38 100644 --- a/src/win32/gwinhid.cpp +++ b/src/win32/gwinhid.cpp @@ -35,9 +35,9 @@ GGui::WindowHidden::WindowHidden( HINSTANCE hinstance ) : if( !m_registered ) { - bool success = registerWindowClass( window_class_name.c_str() , + bool success = registerWindowClass( window_class_name , hinstance , classStyle() , classIcon() , classCursor() , - classBrush() , /*menu-name*/ NULL ) ; + classBrush() ) ; G_ASSERT( success || !"GGui::WindowHidden: window class registration error" ) ; @@ -45,9 +45,9 @@ GGui::WindowHidden::WindowHidden( HINSTANCE hinstance ) : } { - bool success = create( window_class_name.c_str() , - "" , // title - WS_POPUP , // window style + bool success = create( window_class_name , + std::string() , // title + windowStyleHidden() , // window style 0 , 0 , 10 , 10 , // x,y,dx,dy 0 , // parent 0 , // menu @@ -80,7 +80,7 @@ std::string GGui::WindowHidden::windowClassName() WNDPROC wndproc = windowProcedure() ; std::ostringstream ss ; - ss << "GGui::WindowHidden." << (unsigned long)wndproc ; + ss << "GGui::WindowHidden." << reinterpret_cast(wndproc) ; return ss.str() ; } diff --git a/src/win32/gwinhid.h b/src/win32/gwinhid.h index febeebd..df97318 100644 --- a/src/win32/gwinhid.h +++ b/src/win32/gwinhid.h @@ -31,13 +31,13 @@ namespace GGui { class WindowHidden ; -} ; +} // Class: GGui::WindowHidden -// Description: A derivation of GWindow for +// Description: A derivation of GGui::Window for // a hidden window (without a parent). // -class GGui::WindowHidden : public Window +class GGui::WindowHidden : public GGui::Window { public: explicit WindowHidden( HINSTANCE hinstance ) ; @@ -45,14 +45,14 @@ public: // class if necessary and creates the window. virtual ~WindowHidden() ; - // Virtual destructor. - + // Virtual destructor. The Windows window + // is destroyed (unlike for the base class). private: virtual void onNcDestroy() ; - WindowHidden( const WindowHidden & ) ; - void operator=( const WindowHidden & ) ; std::string windowClassName() ; + WindowHidden( const WindowHidden & ) ; // not implemented + void operator=( const WindowHidden & ) ; // not implemented private: bool m_destroyed ;