diff options
-rw-r--r-- | Makefile.am | 6 | ||||
-rw-r--r-- | configure.ac | 3 | ||||
-rw-r--r-- | doc/wydawca.texi | 133 | ||||
-rw-r--r-- | etc/Makefile.am | 34 |
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 @@ | |||
1 | ACLOCAL_AMFLAGS = -I m4 | 1 | ACLOCAL_AMFLAGS = -I m4 |
2 | AUTOMAKE_OPTIONS = gnu 1.8.5 | 2 | AUTOMAKE_OPTIONS = gnu 1.8.5 |
3 | 3 | ||
4 | SUBDIRS=gnu lib src doc | 4 | SUBDIRS=gnu lib src doc etc |
5 | |||
6 | # We never remove the contents of configuration directory | ||
7 | distuninstallcheck_listfiles = \ | ||
8 | 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 | |||
134 | doc/Makefile | 134 | doc/Makefile |
135 | gnu/Makefile | 135 | gnu/Makefile |
136 | lib/Makefile | 136 | lib/Makefile |
137 | src/Makefile]) | 137 | src/Makefile |
138 | etc/Makefile]) | ||
138 | 139 | ||
139 | AC_OUTPUT | 140 | 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: | |||
1121 | mail-admin-stat stat-msg errors access-violations bad-signatures | 1121 | mail-admin-stat stat-msg errors access-violations bad-signatures |
1122 | @end smallexample | 1122 | @end smallexample |
1123 | 1123 | ||
1124 | @kwindex | 1124 | @kwindex admin-address |
1125 | The recipient address for these notifications is set using | 1125 | The recipient address for these notifications is set using |
1126 | @code{admin-address} statement. Its argument is either a single | 1126 | @code{admin-address} statement. Its argument is either a single |
1127 | @acronym{RFC} 822 email address, or a comma-separated list of such | 1127 | @acronym{RFC} 822 email address, or a comma-separated list of such |
@@ -1192,8 +1192,8 @@ end | |||
1192 | @subsection User Notification | 1192 | @subsection User Notification |
1193 | @UNREVISED{} | 1193 | @UNREVISED{} |
1194 | @cindex mail notification, project admin | 1194 | @cindex mail notification, project admin |
1195 | Project administrators can be notified via email about any of the | 1195 | Project administrators (@dfn{owners}) and/or users may recieve email |
1196 | following events: | 1196 | notifications about any of the following events: |
1197 | 1197 | ||
1198 | @table @code | 1198 | @table @code |
1199 | @kwindex success | 1199 | @kwindex success |
@@ -1215,6 +1215,133 @@ uploader. | |||
1215 | uploader. | 1215 | uploader. |
1216 | @end table | 1216 | @end table |
1217 | 1217 | ||
1218 | @kwindex notify-event | ||
1219 | These notifications are configured using the following statement: | ||
1220 | |||
1221 | @smallexample | ||
1222 | notify-event @var{event} @var{who} @var{msg-id} | ||
1223 | @end smallexample | ||
1224 | |||
1225 | @noindent | ||
1226 | where @var{event} is one of the events described above, @var{msg-id} | ||
1227 | is the identifier of a previously defined message template | ||
1228 | (@pxref{templates}), and @var{who} determines who should receive the | ||
1229 | notification. The following values for @var{who} are allowed: | ||
1230 | |||
1231 | @table @code | ||
1232 | @kwindex admin | ||
1233 | @item admin | ||
1234 | The system administrator. | ||
1235 | |||
1236 | @kwindex owner | ||
1237 | @item owner | ||
1238 | Administrators of the project for which the files where uploaded. | ||
1239 | |||
1240 | @kwindex user | ||
1241 | @item user | ||
1242 | A user who uploaded files. | ||
1243 | @end table | ||
1244 | |||
1245 | For example, the following two statements instruct @command{wydawca} | ||
1246 | to email notifications about @code{bad-directive-signature} event to | ||
1247 | project administrators and to the user who did the upload, using two | ||
1248 | different templates: | ||
1249 | |||
1250 | @smallexample | ||
1251 | notify-event bad-directive-signature user user-bad-directive-signature | ||
1252 | notify-event bad-directive-signature owner owner-bad-directive-signature | ||
1253 | @end smallexample | ||
1254 | |||
1255 | The following macro-variables may be used in templates for these | ||
1256 | notifications: | ||
1257 | |||
1258 | @table @code | ||
1259 | @kwindex project | ||
1260 | @item project | ||
1261 | Project system name. | ||
1262 | |||
1263 | @kwindex url | ||
1264 | @acronym{URL} of the distribution site. | ||
1265 | |||
1266 | @kwindex dir | ||
1267 | Directory (relative to the project distribution root) to where the | ||
1268 | files where uploaded. | ||
1269 | |||
1270 | @kwindex dest-dir | ||
1271 | Value of the @code{destination} keyword. | ||
1272 | |||
1273 | @kwindex source-dir | ||
1274 | Value of the @code{source} keyword. | ||
1275 | |||
1276 | @kwindex triplet:full | ||
1277 | @item triplet:full | ||
1278 | Full listing of the uploaded triplet. It is equivalent to: | ||
1279 | |||
1280 | @smallexample | ||
1281 | @group | ||
1282 | %@{triplet:dist@} | ||
1283 | %@{triplet:sig@} | ||
1284 | %@{triplet:dir@} | ||
1285 | @end group | ||
1286 | @end smallexample | ||
1287 | |||
1288 | For example: | ||
1289 | |||
1290 | @FIXME{example} | ||
1291 | |||
1292 | @kwindex triplet:upload | ||
1293 | @item triplet:upload | ||
1294 | Listing of the uploaded files. | ||
1295 | |||
1296 | @FIXME{example} | ||
1297 | |||
1298 | @kwindex triplet:dist | ||
1299 | @item triplet:dist | ||
1300 | Listing of the main distribution file. | ||
1301 | |||
1302 | @kwindex triplet:sig | ||
1303 | @item triplet:sig | ||
1304 | Listing of the detached signature file. | ||
1305 | |||
1306 | @kwindex triplet:dir | ||
1307 | @item triplet:dir | ||
1308 | Listing of the directive file. | ||
1309 | |||
1310 | @kwindex user | ||
1311 | @kwindex user:name | ||
1312 | @item user | ||
1313 | @itemx user:name | ||
1314 | System name of the user who uploaded the triplet. | ||
1315 | |||
1316 | @kwindex user:real-name | ||
1317 | @item user:real-name | ||
1318 | Real name of the user who uploaded the triplet. | ||
1319 | |||
1320 | @kwindex user:email | ||
1321 | @item user:email | ||
1322 | Email of the user who uploaded the triplet. | ||
1323 | @end table | ||
1324 | |||
1325 | The following example shows how to configure success notification | ||
1326 | for the user: | ||
1327 | |||
1328 | @smallexample | ||
1329 | define-message user-success | ||
1330 | Subject: Upload of %@{project@} successful | ||
1331 | |||
1332 | Upload of %@{project@} to %@{dir@} finished successfully. | ||
1333 | Files uploaded: | ||
1334 | |||
1335 | %@{triplet:upload@} | ||
1336 | |||
1337 | Regards, | ||
1338 | Wydawca | ||
1339 | The Project Submission Robot | ||
1340 | end | ||
1341 | |||
1342 | notify-event success user user-success | ||
1343 | @end smallexample | ||
1344 | |||
1218 | @node wydawca.rc, invocation, configuring, Top | 1345 | @node wydawca.rc, invocation, configuring, Top |
1219 | @chapter @command{Wydawca} configuration file. | 1346 | @chapter @command{Wydawca} configuration file. |
1220 | @cindex configuration statements, reference | 1347 | @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 @@ | |||
1 | # This file is part of Wydawca | ||
2 | # Copyright (C) 2007 Sergey Poznyakoff | ||
3 | # | ||
4 | # Wydawca is free software; you can redistribute it and/or modify | ||
5 | # it under the terms of the GNU General Public License as published by | ||
6 | # the Free Software Foundation; either version 3, or (at your option) | ||
7 | # any later version. | ||
8 | # | ||
9 | # Wydawca is distributed in the hope that it will be useful, | ||
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | # GNU General Public License for more details. | ||
13 | # | ||
14 | # You should have received a copy of the GNU General Public License | ||
15 | # along with Wydawca. If not, see <http://www.gnu.org/licenses/>. | ||
16 | |||
17 | EXTRA_DIST=wydawca.rc messages.rc | ||
18 | |||
19 | install-data-local: | ||
20 | @test -d $(DESTDIR)$(sysconfdir) || \ | ||
21 | ${INSTALL} -d $(DESTDIR)$(sysconfdir); \ | ||
22 | conf=$(DESTDIR)$(sysconfdir)/wydawca.rc; \ | ||
23 | if [ -r $$conf ]; then \ | ||
24 | echo $$conf | sed 's,.,=,g'; \ | ||
25 | echo "Warning: The configuration file $$conf already exists"; \ | ||
26 | echo "Make sure it is up to date!"; \ | ||
27 | echo $$conf | sed 's,.,=,g'; \ | ||
28 | else \ | ||
29 | for file in $(EXTRA_DIST); do \ | ||
30 | ${INSTALL} -m 600 $(top_srcdir)/etc/$$file \ | ||
31 | $(DESTDIR)$(sysconfdir)/$$file; \ | ||
32 | done; \ | ||
33 | fi | ||
34 | |||