dovecot-2.0-pigeonhole: Renamed sieved tool to sieve-dump.

pigeonhole at rename-it.nl pigeonhole at rename-it.nl
Sat Aug 21 22:51:20 EEST 2010


details:   http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/668aa8a99d4d
changeset: 1382:668aa8a99d4d
user:      Stephan Bosch <stephan at rename-it.nl>
date:      Sat Aug 21 21:51:00 2010 +0200
description:
Renamed sieved tool to sieve-dump.

diffstat:

 .hgignore                    |   2 +-
 NEWS                         |   2 +
 README                       |   2 +-
 doc/man/Makefile.am          |   2 +-
 doc/man/sieve-dump.1         |  61 ++++++++++++++++++++++++++++++
 doc/man/sieve-filter.1       |   2 +-
 doc/man/sieve-test.1         |   8 ++--
 doc/man/sievec.1             |   6 +-
 doc/man/sieved.1             |  61 ------------------------------
 src/sieve-tools/Makefile.am  |  12 +++---
 src/sieve-tools/sieve-dump.c |  91 +++++++++++++++++++++++++++++++++++++++++++++
 src/sieve-tools/sieved.c     |  91 ---------------------------------------------
 12 files changed, 171 insertions(+), 169 deletions(-)

diffs (truncated from 478 to 300 lines):

diff -r 9ea3bdda8e15 -r 668aa8a99d4d .hgignore
--- a/.hgignore	Thu Aug 19 18:04:22 2010 +0200
+++ b/.hgignore	Sat Aug 21 21:51:00 2010 +0200
@@ -56,7 +56,7 @@
 **/.deps
 
 src/sieve-tools/sievec
-src/sieve-tools/sieved
+src/sieve-tools/sieve-dump
 src/sieve-tools/sieve-test
 src/sieve-tools/sieve-filter
 
diff -r 9ea3bdda8e15 -r 668aa8a99d4d NEWS
--- a/NEWS	Thu Aug 19 18:04:22 2010 +0200
+++ b/NEWS	Sat Aug 21 21:51:00 2010 +0200
@@ -34,6 +34,8 @@
 	  most notable example is that when the LDA Sieve plugin is trying to store a
 	  binary for a global script, the resulting failure message also points the
 	  administrator towards pre-compiling the script with sievec.
+	* Renamed the sieved tool to sieve-dump. The original name was somewhat
+	  confusing.
 	- Multiscript: fixed duplicate implicit keep caused by erroneous execution
 	  state update.
 	- Prevented assertion failure due to currupt binary string representation. 
diff -r 9ea3bdda8e15 -r 668aa8a99d4d README
--- a/README	Thu Aug 19 18:04:22 2010 +0200
+++ b/README	Sat Aug 21 21:51:00 2010 +0200
@@ -173,7 +173,7 @@
              can be used to test the actual delivery of the message and show the
              messages that would normally be sent through SMTP.
 
-sieved     - Dumps the content of a Sieve binary file for (development) 
+sieve-dump - Dumps the content of a Sieve binary file for (development) 
              debugging purposes.
 
 When installed, man pages are also available for these commands. In this package
diff -r 9ea3bdda8e15 -r 668aa8a99d4d doc/man/Makefile.am
--- a/doc/man/Makefile.am	Thu Aug 19 18:04:22 2010 +0200
+++ b/doc/man/Makefile.am	Sat Aug 21 21:51:00 2010 +0200
@@ -11,7 +11,7 @@
 
 dist_man_MANS = \
 	sievec.1 \
-	sieved.1 \
+	sieve-dump.1 \
 	sieve-test.1 \
 	$(unfinished_mans)
 
diff -r 9ea3bdda8e15 -r 668aa8a99d4d doc/man/sieve-dump.1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/sieve-dump.1	Sat Aug 21 21:51:00 2010 +0200
@@ -0,0 +1,61 @@
+.TH "SIEVE-DUMP" "1" "11 July 2010"
+.SH NAME
+sieve\-dump \- Sieve script binary dump tool for the Dovecot secure IMAP server
+.SH SYNOPSIS
+sieve\-dump [\fB\-c\fR \fIconfig\-file\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR]
+.br
+.SH DESCRIPTION
+.PP
+The \fBsieve\-dump\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure 
+IMAP server. Sieve (RFC 5228) is a simple and highly extensible language for filtering 
+e\-mail messages. It can be implemented for any type of mail access protocol, mail 
+architecture and operating system. The language cannot execute external programs and in 
+its basic form it does not provide the means to cause infinite loops, making it suitable 
+for running securely on mail servers where mail users have no permission run arbitrary programs.
+.PP
+Using the \fBsieve\-dump\fP command, Sieve binaries, which are produced for instance by
+\fBsievec\fP(1), can be transformed into a human\-readable textual representation. This can 
+provide valuable insight in how the Sieve script is executed. This is also particularly useful 
+to view corrupt binaries that can result from bugs in the Sieve implementation. This tool is 
+intended mainly for development purposes, so normally system administrators and users will not 
+need to use this tool.
+.PP
+The \fIsieve\-binary\fR argument specifies the Sieve binary file that needs to be dumped. The
+optional \fIout\-file\fR argument specifies where the output must be written. If omitted, the
+output is written to \fBstdout\fR.
+.PP
+The format of the output is not explained here in detail, but it should be relatively easy
+to understand. The Sieve binaries comprise a set of data blocks, each of which can contain
+arbitrary data. For the base language implementation two blocks are used: the first containing
+a specification of all required language extensions and the second containing the main Sieve
+program. Compiled Sieve programs are represented as flat byte code and therefore the dump of
+the main program is a disassembly listing of the interpreter operations. Extensions can define 
+new operations and use additional blocks. Therefore, the output of \fBsieve\-dump\fP depends greatly
+on the language extensions used when compiling the binary. 
+.SH OPTIONS
+.TP
+\fB\-c\fP \fIconfig\-file\fP
+Alternative Dovecot configuration file path.
+.TP
+\fB\-x\fP "\fIextension extension ...\fP"
+Set the available extensions. The parameter is a space\-separated list of the active extensions. By
+prepending the extension identifiers with \fB+\fP or \fB\-\fP, extensions can be included or excluded
+relative to the default set of extensions. If no extensions have a \fB+\fP or \fB\-\fP prefix, only 
+those extensions that are explicitly listed will be enabled. Unknown extensions are ignored and a 
+warning is produced. By default, all supported extensions are available, except for deprecated
+extensions or those that are still under development.
+
+For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated imapflags extension along with all
+extensions that are available by default, except for the enotify extension.
+.SH AUTHOR
+.PP
+Pigeonhole for Dovecot was written by Stephan Bosch <stephan at rename\-it.nl>.
+.PP
+Dovecot was written by Timo Sirainen <tss at iki.fi>.
+.SH "SEE ALSO"
+.BR sievec (1),
+.BR sieve\-test (1)
+.PP
+Dovecot website: http://www.dovecot.org
+.PP
+Pigeonhole website: http://pigeonhole.dovecot.org
diff -r 9ea3bdda8e15 -r 668aa8a99d4d doc/man/sieve-filter.1
--- a/doc/man/sieve-filter.1	Thu Aug 19 18:04:22 2010 +0200
+++ b/doc/man/sieve-filter.1	Sat Aug 21 21:51:00 2010 +0200
@@ -149,7 +149,7 @@
 
 .SH "SEE ALSO"
 .BR sievec (1),
-.BR sieved (1),
+.BR sieve\-dump (1),
 .BR sieve\-test (1)
 .PP
 Dovecot website: http://www.dovecot.org
diff -r 9ea3bdda8e15 -r 668aa8a99d4d doc/man/sieve-test.1
--- a/doc/man/sieve-test.1	Thu Aug 19 18:04:22 2010 +0200
+++ b/doc/man/sieve-test.1	Sat Aug 21 21:51:00 2010 +0200
@@ -60,7 +60,7 @@
 .TP
 \fB\-d\fP \fIdump\-file\fP
 Causes a dump of the generated code to be written to the specified file. This is identical to the
-dump produced by \fBsieved\fR(1). Using '\-' as filename causes the dump to be written to \fBstdout\fP.
+dump produced by \fBsieve\-dump\fR(1). Using '\-' as filename causes the dump to be written to \fBstdout\fP.
 .TP
 \fB\-e\fP
 Turns on true execution of the set of actions that results from running the script. In combination
@@ -144,7 +144,7 @@
 \fB\-Taddresses\fP
 Print byte code addresses for the current trace output. Normally, only the current Sieve source code 
 position is printed. The byte code addresses are equal to those listed in a binary dump produced
-using the \fB\-d\fP option or by the \fBsieved(1)\fP command.
+using the \fB\-d\fP option or by the \fBsieve\-dump(1)\fP command.
 
 .SH DEBUG SIEVE EXTENSION
 .PP
@@ -162,7 +162,7 @@
 .PP
 }
 .PP
-Other tools like \fBsievec\fP and \fBsieved\fP also recognize the vnd.dovecot.debug extension. In contrast,
+Other tools like \fBsievec\fP and \fBsieve\-dump\fP also recognize the vnd.dovecot.debug extension. In contrast,
 the actual Sieve plugin for the Dovecot LDA does not allow the use of the debug extension. So, keep in mind that 
 scripts and compiled binaries that refer to de debug extension will fail to be run by the Sieve plugin itself.
 .PP
@@ -175,7 +175,7 @@
 Dovecot was written by Timo Sirainen <tss at iki.fi>.
 .SH "SEE ALSO"
 .BR sievec (1),
-.BR sieved (1)
+.BR sieve\-dump (1)
 .PP
 Dovecot website: http://www.dovecot.org
 .PP
diff -r 9ea3bdda8e15 -r 668aa8a99d4d doc/man/sievec.1
--- a/doc/man/sievec.1	Thu Aug 19 18:04:22 2010 +0200
+++ b/doc/man/sievec.1	Sat Aug 21 21:51:00 2010 +0200
@@ -38,7 +38,7 @@
 .PP
 The \fBsievec\fP command is also useful to verify Sieve scripts before using. Additionally, with 
 the \fB\-d\fP option it can output a textual (and thus human\-readable) dump of the generated Sieve
-code to the specified file. The output is then identical to what the \fBsieved\fP(1) command produces
+code to the specified file. The output is then identical to what the \fBsieve\-dump\fP(1) command produces
 for a stored binary file. This output is mainly useful to find bugs in the compiler that yield corrupt 
 binaries.
 .SH OPTIONS
@@ -50,7 +50,7 @@
 Don't write the binary to \fIout\-file\fP, but write a textual dump of the binary in 
 stead. In this context, the \fIout\-file\fP value '\-' has special meaning: it causes the the textual 
 dump to be written to \fBstdout\fP. The \fIout\-file\fP argument may also be omitted, which has 
-the same effect as '\-'. The output is identical to what the \fBsieved\fP(1) command produces for 
+the same effect as '\-'. The output is identical to what the \fBsieve\-dump\fP(1) command produces for 
 a compiled Sieve binary file. Note that this option is not allowed when the \fIout\-file\fP argument
 is a directory.
 .TP
@@ -70,7 +70,7 @@
 .PP
 Dovecot was written by Timo Sirainen <tss at iki.fi>.
 .SH "SEE ALSO"
-.BR sieved (1),
+.BR sieve\-dump (1),
 .BR sieve\-test (1)
 .PP
 Dovecot website: http://www.dovecot.org
diff -r 9ea3bdda8e15 -r 668aa8a99d4d doc/man/sieved.1
--- a/doc/man/sieved.1	Thu Aug 19 18:04:22 2010 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,61 +0,0 @@
-.TH "SIEVED" "1" "11 July 2010"
-.SH NAME
-sieved \- Sieve script binary dump tool for the Dovecot secure IMAP server
-.SH SYNOPSIS
-sieved [\fB\-c\fR \fIconfig\-file\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR]
-.br
-.SH DESCRIPTION
-.PP
-The \fBsieved\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure 
-IMAP server. Sieve (RFC 5228) is a simple and highly extensible language for filtering 
-e\-mail messages. It can be implemented for any type of mail access protocol, mail 
-architecture and operating system. The language cannot execute external programs and in 
-its basic form it does not provide the means to cause infinite loops, making it suitable 
-for running securely on mail servers where mail users have no permission run arbitrary programs.
-.PP
-Using the \fBsieved\fP command, Sieve binaries, which are produced for instance by
-\fBsievec\fP(1), can be transformed into a human\-readable textual representation. This can 
-provide valuable insight in how the Sieve script is executed. This is also particularly useful 
-to view corrupt binaries that can result from bugs in the Sieve implementation. This tool is 
-intended mainly for development purposes, so normally system administrators and users will not 
-need to use this tool.
-.PP
-The \fIsieve\-binary\fR argument specifies the Sieve binary file that needs to be dumped. The
-optional \fIout\-file\fR argument specifies where the output must be written. If omitted, the
-output is written to \fBstdout\fR.
-.PP
-The format of the output is not explained here in detail, but it should be relatively easy
-to understand. The Sieve binaries comprise a set of data blocks, each of which can contain
-arbitrary data. For the base language implementation two blocks are used: the first containing
-a specification of all required language extensions and the second containing the main Sieve
-program. Compiled Sieve programs are represented as flat byte code and therefore the dump of
-the main program is a disassembly listing of the interpreter operations. Extensions can define 
-new operations and use additional blocks. Therefore, the output of \fBsieved\fP depends greatly
-on the language extensions used when compiling the binary. 
-.SH OPTIONS
-.TP
-\fB\-c\fP \fIconfig\-file\fP
-Alternative Dovecot configuration file path.
-.TP
-\fB\-x\fP "\fIextension extension ...\fP"
-Set the available extensions. The parameter is a space\-separated list of the active extensions. By
-prepending the extension identifiers with \fB+\fP or \fB\-\fP, extensions can be included or excluded
-relative to the default set of extensions. If no extensions have a \fB+\fP or \fB\-\fP prefix, only 
-those extensions that are explicitly listed will be enabled. Unknown extensions are ignored and a 
-warning is produced. By default, all supported extensions are available, except for deprecated
-extensions or those that are still under development.
-
-For example \fB\-x\fP "+imapflags \-enotify" will enable the deprecated imapflags extension along with all
-extensions that are available by default, except for the enotify extension.
-.SH AUTHOR
-.PP
-Pigeonhole for Dovecot was written by Stephan Bosch <stephan at rename\-it.nl>.
-.PP
-Dovecot was written by Timo Sirainen <tss at iki.fi>.
-.SH "SEE ALSO"
-.BR sievec (1),
-.BR sieve\-test (1)
-.PP
-Dovecot website: http://www.dovecot.org
-.PP
-Pigeonhole website: http://pigeonhole.dovecot.org
diff -r 9ea3bdda8e15 -r 668aa8a99d4d src/sieve-tools/Makefile.am
--- a/src/sieve-tools/Makefile.am	Thu Aug 19 18:04:22 2010 +0200
+++ b/src/sieve-tools/Makefile.am	Sat Aug 21 21:51:00 2010 +0200
@@ -1,6 +1,6 @@
 SUBDIRS = debug
 
-bin_PROGRAMS = sievec sieved sieve-test
+bin_PROGRAMS = sievec sieve-dump sieve-test
 
 if BUILD_UNFINISHED
 bin_PROGRAMS += sieve-filter
@@ -32,12 +32,12 @@
 
 # Sieve Dump Tool
 
-sieved_LDFLAGS = -export-dynamic
-sieved_LDADD = $(libs_ldadd)
-sieved_DEPENDENCIES = $(libs_deps)
+sieve_dump_LDFLAGS = -export-dynamic
+sieve_dump_LDADD = $(libs_ldadd)
+sieve_dump_DEPENDENCIES = $(libs_deps)
 
-sieved_SOURCES = \
-	sieved.c 
+sieve_dump_SOURCES = \
+	sieve-dump.c 
 
 # Sieve Test Tool
 
diff -r 9ea3bdda8e15 -r 668aa8a99d4d src/sieve-tools/sieve-dump.c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/sieve-tools/sieve-dump.c	Sat Aug 21 21:51:00 2010 +0200
@@ -0,0 +1,91 @@
+/* Copyright (c) 2002-2010 Pigeonhole authors, see the included COPYING file
+ */
+
+#include "lib.h"
+#include "array.h"
+#include "master-service.h"
+#include "master-service-settings.h"
+#include "mail-storage-service.h"


More information about the dovecot-cvs mailing list