aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile.am6
-rw-r--r--configure.ac3
-rw-r--r--doc/wydawca.texi133
-rw-r--r--etc/Makefile.am34
4 files changed, 171 insertions, 5 deletions
diff --git a/Makefile.am b/Makefile.am
index 0bc2a31..0fffb5a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,8 @@
ACLOCAL_AMFLAGS = -I m4
AUTOMAKE_OPTIONS = gnu 1.8.5
-SUBDIRS=gnu lib src doc
+SUBDIRS=gnu lib src doc etc
+
+# We never remove the contents of configuration directory
+distuninstallcheck_listfiles = \
+ find $(prefix) -type f -not -path '$(sysconfdir)/*'
diff --git a/configure.ac b/configure.ac
index e92c238..c5ffd1c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -134,6 +134,7 @@ AC_CONFIG_FILES([Makefile
doc/Makefile
gnu/Makefile
lib/Makefile
- src/Makefile])
+ src/Makefile
+ etc/Makefile])
AC_OUTPUT
diff --git a/doc/wydawca.texi b/doc/wydawca.texi
index b313e4f..1f7ad70 100644
--- a/doc/wydawca.texi
+++ b/doc/wydawca.texi
@@ -1121,7 +1121,7 @@ attempts, or any bad signature was uploaded:
mail-admin-stat stat-msg errors access-violations bad-signatures
@end smallexample
-@kwindex
+@kwindex admin-address
The recipient address for these notifications is set using
@code{admin-address} statement. Its argument is either a single
@acronym{RFC} 822 email address, or a comma-separated list of such
@@ -1192,8 +1192,8 @@ end
@subsection User Notification
@UNREVISED{}
@cindex mail notification, project admin
- Project administrators can be notified via email about any of the
-following events:
+ Project administrators (@dfn{owners}) and/or users may recieve email
+notifications about any of the following events:
@table @code
@kwindex success
@@ -1215,6 +1215,133 @@ uploader.
uploader.
@end table
+@kwindex notify-event
+ These notifications are configured using the following statement:
+
+@smallexample
+notify-event @var{event} @var{who} @var{msg-id}
+@end smallexample
+
+@noindent
+where @var{event} is one of the events described above, @var{msg-id}
+is the identifier of a previously defined message template
+(@pxref{templates}), and @var{who} determines who should receive the
+notification. The following values for @var{who} are allowed:
+
+@table @code
+@kwindex admin
+@item admin
+The system administrator.
+
+@kwindex owner
+@item owner
+Administrators of the project for which the files where uploaded.
+
+@kwindex user
+@item user
+A user who uploaded files.
+@end table
+
+ For example, the following two statements instruct @command{wydawca}
+to email notifications about @code{bad-directive-signature} event to
+project administrators and to the user who did the upload, using two
+different templates:
+
+@smallexample
+notify-event bad-directive-signature user user-bad-directive-signature
+notify-event bad-directive-signature owner owner-bad-directive-signature
+@end smallexample
+
+ The following macro-variables may be used in templates for these
+notifications:
+
+@table @code
+@kwindex project
+@item project
+Project system name.
+
+@kwindex url
+@acronym{URL} of the distribution site.
+
+@kwindex dir
+Directory (relative to the project distribution root) to where the
+files where uploaded.
+
+@kwindex dest-dir
+Value of the @code{destination} keyword.
+
+@kwindex source-dir
+Value of the @code{source} keyword.
+
+@kwindex triplet:full
+@item triplet:full
+Full listing of the uploaded triplet. It is equivalent to:
+
+@smallexample
+@group
+%@{triplet:dist@}
+%@{triplet:sig@}
+%@{triplet:dir@}
+@end group
+@end smallexample
+
+For example:
+
+@FIXME{example}
+
+@kwindex triplet:upload
+@item triplet:upload
+Listing of the uploaded files.
+
+@FIXME{example}
+
+@kwindex triplet:dist
+@item triplet:dist
+Listing of the main distribution file.
+
+@kwindex triplet:sig
+@item triplet:sig
+Listing of the detached signature file.
+
+@kwindex triplet:dir
+@item triplet:dir
+Listing of the directive file.
+
+@kwindex user
+@kwindex user:name
+@item user
+@itemx user:name
+System name of the user who uploaded the triplet.
+
+@kwindex user:real-name
+@item user:real-name
+Real name of the user who uploaded the triplet.
+
+@kwindex user:email
+@item user:email
+Email of the user who uploaded the triplet.
+@end table
+
+ The following example shows how to configure success notification
+for the user:
+
+@smallexample
+define-message user-success
+Subject: Upload of %@{project@} successful
+
+Upload of %@{project@} to %@{dir@} finished successfully.
+Files uploaded:
+
+%@{triplet:upload@}
+
+Regards,
+Wydawca
+The Project Submission Robot
+end
+
+notify-event success user user-success
+@end smallexample
+
@node wydawca.rc, invocation, configuring, Top
@chapter @command{Wydawca} configuration file.
@cindex configuration statements, reference
diff --git a/etc/Makefile.am b/etc/Makefile.am
new file mode 100644
index 0000000..7fc8238
--- /dev/null
+++ b/etc/Makefile.am
@@ -0,0 +1,34 @@
+# This file is part of Wydawca
+# Copyright (C) 2007 Sergey Poznyakoff
+#
+# Wydawca 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 3, or (at your option)
+# any later version.
+#
+# Wydawca 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 Wydawca. If not, see <http://www.gnu.org/licenses/>.
+
+EXTRA_DIST=wydawca.rc messages.rc
+
+install-data-local:
+ @test -d $(DESTDIR)$(sysconfdir) || \
+ ${INSTALL} -d $(DESTDIR)$(sysconfdir); \
+ conf=$(DESTDIR)$(sysconfdir)/wydawca.rc; \
+ if [ -r $$conf ]; then \
+ echo $$conf | sed 's,.,=,g'; \
+ echo "Warning: The configuration file $$conf already exists"; \
+ echo "Make sure it is up to date!"; \
+ echo $$conf | sed 's,.,=,g'; \
+ else \
+ for file in $(EXTRA_DIST); do \
+ ${INSTALL} -m 600 $(top_srcdir)/etc/$$file \
+ $(DESTDIR)$(sysconfdir)/$$file; \
+ done; \
+ fi
+

Return to:

Send suggestions and report system problems to the System administrator.