Added some draft templates for Sieve GUI

dev/Sieve/Commands.js

@@ -15,7 +15,6 @@ import {
 } from 'Sieve/Commands/Actions';
 
 import {
-	ConditionalCommand,
 	ElsIfCommand,
 	ElseCommand,
 	IfCommand,
@@ -67,7 +66,6 @@ export const
 		IfCommand,
 		ElsIfCommand,
 		ElseCommand,
-		ConditionalCommand,
 		RequireCommand,
 		StopCommand,
 		// Action commands

dev/Sieve/Commands/Actions.js

@@ -21,6 +21,10 @@ export class FileIntoCommand extends ActionCommand
 		super();
 		// QuotedString / MultiLine
 		this._mailbox = new GrammarQuotedString();
+		// https://datatracker.ietf.org/doc/html/rfc3894
+//		this.copy = false;
+		// https://datatracker.ietf.org/doc/html/rfc5490#section-3.2
+//		this.create = false;
 	}
 
 	get require() { return 'fileinto'; }
@@ -28,9 +32,7 @@ export class FileIntoCommand extends ActionCommand
 	toString()
 	{
 		return 'fileinto'
-			// https://datatracker.ietf.org/doc/html/rfc3894
 			+ ((this.copy && capa.includes('copy')) ? ' :copy' : '')
-			// https://datatracker.ietf.org/doc/html/rfc5490#section-3.2
 			+ ((this.create && capa.includes('mailbox')) ? ' :create' : '')
 			+ ' ' + this._mailbox
 			+ ';';
@@ -64,15 +66,17 @@ export class RedirectCommand extends ActionCommand
 		super();
 		// QuotedString / MultiLine
 		this._address = new GrammarQuotedString();
+		// https://datatracker.ietf.org/doc/html/rfc3894
+//		this.copy = false;
+		// https://datatracker.ietf.org/doc/html/rfc6134#section-2.3
+//		this.list = null;
 	}
 
 	toString()
 	{
 
 		return 'redirect'
-			// https://datatracker.ietf.org/doc/html/rfc6134#section-2.3
 //			+ ((this.list && capa.includes('extlists')) ? ' :list ' + this.list : '')
-			// https://datatracker.ietf.org/doc/html/rfc3894
 			+ ((this.copy && capa.includes('copy')) ? ' :copy' : '')
 			+ ' ' + this._address
 			+ ';';

dev/Sieve/Commands/Controls.js

@@ -5,6 +5,7 @@
 
 import {
 	ControlCommand,
+	GrammarCommands,
 	GrammarStringList,
 	GrammarQuotedString
 } from 'Sieve/Grammar';
@@ -16,37 +17,55 @@ import {
  *    elsif <test2: test> <block2: block>
  *    else <block3: block>
  */
-export class ConditionalCommand extends ControlCommand
+export /*abstract*/ class ConditionalCommand extends ControlCommand
 {
-	constructor(identifier)
+	constructor()
 	{
-		super(identifier);
-		this.test = null;
-	}
-
-	toString()
-	{
-		return this.identifier + ' ' + this.test + ' ' + this.commands;
-	}
 /*
-	public function pushArguments(array $args): void
-	{
-		args.forEach((arg, i) => {
-			if (i && ':' === args[i-1][0]) {
-				this[args[i-1].replace(':','_')].value = arg.value;
-			}
-		});
-		print_r($args);
-		exit;
-	}
+		if (this.constructor == ConditionalCommand) {
+			throw Error("Abstract class can't be instantiated.");
+		}
 */
+		super();
+		this.commands = new GrammarCommands;
+	}
 }
 
 export class IfCommand extends ConditionalCommand
 {
+	constructor()
+	{
+		super();
+		this._test = null; // must be descendent instanceof TestCommand
+	}
+
+	get test()
+	{
+		return this._test;
+	}
+
+	set test(value)
+	{
+/*
+		if (!value instanceof TestCommand) {
+			throw Error("test must be descendent instanceof TestCommand.");
+		}
+*/
+		this._test = value;
+	}
+
+	toString()
+	{
+/*
+		if (!this._test instanceof TestCommand) {
+			throw Error("test must be descendent instanceof TestCommand.");
+		}
+*/
+		return this.identifier + ' ' + this._test + ' ' + this.commands;
+	}
 }
 
-export class ElsIfCommand extends ConditionalCommand
+export class ElsIfCommand extends IfCommand
 {
 }
 

dev/Sieve/Commands/Tests.js

@@ -316,11 +316,6 @@ export class NotTest extends TestCommand
 	{
 		return 'not ' + this.test;
 	}
-
-	pushArguments()
-	{
-		throw 'No arguments';
-	}
 }
 
 /**

dev/Sieve/Extensions/rfc5230.js

@@ -43,7 +43,6 @@ export class VacationCommand extends ActionCommand
 		}
 		if (this._from.length) {
 			result += ' :from ' + this._from;
-//			result += ' :from ' + this.arguments[':from'];
 		}
 		if (this.addresses.length) {
 			result += ' :addresses ' + this.addresses;

dev/Sieve/Extensions/rfc5429.js

@@ -8,11 +8,11 @@ import {
 	GrammarString
 } from 'Sieve/Grammar';
 
-class rfc5429Command extends ActionCommand
+class /*abstract*/ rfc5429Command extends ActionCommand
 {
-	constructor(identifier)
+	constructor()
 	{
-		super(identifier);
+		super();
 		this._reason = new GrammarQuotedString;
 	}
 
@@ -44,7 +44,6 @@ class rfc5429Command extends ActionCommand
  */
 export class ErejectCommand extends rfc5429Command
 {
-	constructor() { super('ereject'); }
 	get require() { return 'ereject'; }
 }
 
@@ -53,6 +52,5 @@ export class ErejectCommand extends rfc5429Command
  */
 export class RejectCommand extends rfc5429Command
 {
-	constructor() { super('reject'); }
 	get require() { return 'reject'; }
 }

dev/Sieve/Extensions/rfc5703.js

@@ -5,6 +5,7 @@
 import {
 	ActionCommand,
 	ControlCommand,
+	GrammarCommands,
 	GrammarNumber,
 	GrammarQuotedString,
 	GrammarString,
@@ -20,6 +21,7 @@ export class ForEveryPartCommand extends ControlCommand
 	{
 		super();
 		this._name = new GrammarString;
+		this.commands = new GrammarCommands;
 	}
 
 	get require() { return 'foreverypart'; }
@@ -27,7 +29,7 @@ export class ForEveryPartCommand extends ControlCommand
 	toString()
 	{
 		let result = 'foreverypart';
-		if (this._subject.length) {
+		if (this._name.length) {
 			result += ' :name ' + this._name;
 		}
 		return result + ' ' + this.commands;
@@ -43,12 +45,15 @@ export class ForEveryPartCommand extends ControlCommand
 	}
 }
 
+/**
+ * Must be inside foreverypart
+ */
 export class BreakCommand extends ForEveryPartCommand
 {
 	toString()
 	{
 		let result = 'break';
-		if (this._subject.length) {
+		if (this._name.length) {
 			result += ' :name ' + this._name;
 		}
 		return result + ';';
@@ -82,7 +87,6 @@ export class ReplaceCommand extends ActionCommand
 		}
 		if (this._from.length) {
 			result += ' :from ' + this._from;
-//			result += ' :from ' + this.arguments[':from'];
 		}
 		return result + this.replacement + ';';
 	}
@@ -140,6 +144,7 @@ export class EncloseCommand extends ActionCommand
 
 /**
  * https://datatracker.ietf.org/doc/html/rfc5703#section-7
+ * Should be inside foreverypart, else empty and flagged as a compilation error
  */
 export class ExtractTextCommand extends ActionCommand
 {

dev/Sieve/Grammar.js

@@ -52,34 +52,26 @@ export class GrammarComment extends GrammarString
 /**
  * https://tools.ietf.org/html/rfc5228#section-2.9
  */
-export class GrammarCommand
+const cmdNameSuffix = /(test|command|action)$/;
+export /*abstract*/ class GrammarCommand
 {
 	constructor(identifier)
 	{
-		this.identifier = identifier || this.constructor.name.toLowerCase().replace(/(test|command|action)$/, '');
-		this.arguments = [];
-		this.commands = new GrammarCommands;
+/*
+		if (this.constructor == GrammarCommand) {
+			throw Error("Abstract class can't be instantiated.");
+		}
+*/
+		this.identifier = identifier || this.constructor.name.toLowerCase().replace(cmdNameSuffix, '');
 	}
 
 	toString()
 	{
 		let result = this.identifier;
-		if (this.arguments.length) {
+		if (this.arguments?.length) {
 			result += ' ' + arrayToString(this.arguments, ' ');
 		}
-		return result + (
-			this.commands.length ? ' ' + this.commands : ';'
-		);
-	}
-
-	getComparators()
-	{
-		return ['i;ascii-casemap'];
-	}
-
-	getMatchTypes()
-	{
-		return [':is', ':contains', ':matches'];
+		return result + ';';
 	}
 
 	pushArguments(args)
@@ -108,63 +100,47 @@ export class GrammarCommands extends Array
 /**
  * https://tools.ietf.org/html/rfc5228#section-3
  */
-export class ControlCommand extends GrammarCommand
+export /*abstract*/ class ControlCommand extends GrammarCommand
 {
+/*
 	constructor(identifier)
 	{
-		super(identifier);
-		this.commands = new GrammarCommands;
-	}
-
-	toString()
-	{
-		let result = this.identifier;
-		if (this.arguments.length) {
-			result += ' ' + arrayToString(this.arguments, ' ');
+		if (this.constructor == ControlCommand) {
+			throw Error("Abstract class can't be instantiated.");
 		}
-		return result + (
-			this.commands.length ? ' ' + this.commands : ';'
-		);
-	}
-
-	getComparators()
-	{
-		return ['i;ascii-casemap'];
-	}
-
-	getMatchTypes()
-	{
-		return [':is', ':contains', ':matches'];
+		super(identifier);
 	}
+*/
 }
 
 /**
  * https://tools.ietf.org/html/rfc5228#section-4
  */
-export class ActionCommand extends GrammarCommand
+export /*abstract*/ class ActionCommand extends GrammarCommand
 {
+/*
 	constructor(identifier)
 	{
+		if (this.constructor == ActionCommand) {
+			throw Error("Abstract class can't be instantiated.");
+		}
 		super(identifier);
 	}
-
-	toString()
-	{
-		let result = this.identifier;
-		if (this.arguments.length) {
-			result += ' ' + arrayToString(this.arguments, ' ');
-		}
-		return result + ';'
-	}
+*/
 }
 
 /**
  * https://tools.ietf.org/html/rfc5228#section-5
  */
-export class TestCommand extends GrammarCommand
+export /*abstract*/ class TestCommand extends GrammarCommand
 {
 	constructor(identifier)
 	{
+/*
+		if (this.constructor == TestCommand) {
+			throw Error("Abstract class can't be instantiated.");
+		}
+*/
 		super(identifier);
 		// Almost every test has a comparator and match_type, so define them here
 		this.comparator = '';
@@ -324,3 +300,23 @@ GrammarMultiLine.fromString = string => {
 	}
 	return new GrammarMultiLine();
 }
+
+export class UnknownCommand extends GrammarCommand
+{
+	constructor(identifier)
+	{
+		super(identifier);
+		this.commands = new GrammarCommands;
+	}
+
+	toString()
+	{
+		let result = this.identifier;
+		if (this.arguments?.length) {
+			result += ' ' + arrayToString(this.arguments, ' ');
+		}
+		return result + (
+			this.commands?.length ? ' ' + this.commands : ';'
+		);
+	}
+}

dev/Sieve/Parser.js

@@ -154,12 +154,10 @@ export const parseScript = (script, name = 'script.sieve') => {
 			pushArgs();
 			value = value.toLowerCase();
 			let new_command;
-			if ('if' === value) {
-				new_command = new ConditionalCommand(value);
-			} else if ('elsif' === value || 'else' === value) {
-//				(prev_command instanceof ConditionalCommand) || error('Not after IF condition');
-				new_command = new ConditionalCommand(value);
-			} else if (Commands[value]) {
+			if (Commands[value]) {
+				if ('elsif' === value || 'else' === value) {
+//					(prev_command instanceof ConditionalCommand) || error('Not after IF condition');
+				}
 				if ('allof' === value || 'anyof' === value) {
 //					(command instanceof ConditionalCommand || command instanceof NotTest) || error('Test-list not in conditional');
 				}

dev/Sieve/README.md

@@ -31,3 +31,259 @@ https://www.iana.org/assignments/sieve-extensions/sieve-extensions.xhtml
 - [ ] RFC     regex                https://tools.ietf.org/html/draft-ietf-sieve-regex-01
 - [ ]         vnd.cyrus.*
 - [ ]         vnd.dovecot.*
+
+# Classes
+
+## abstract GrammarCommand
+	identifier = identifier || constructor.name.toLowerCase().replace(/(test|command|action)$/, '');
+	arguments = []; only initialized at pushArguments()
+
+### abstract ControlCommand extends GrammarCommand
+
+#### IncludeCommand extends ControlCommand
+	global = false; // ':personal' / ':global';
+	once = false;
+	optional = false;
+	value = new GrammarQuotedString;
+
+#### ReturnCommand extends ControlCommand
+	no properties
+
+#### GlobalCommand extends ControlCommand
+	value = new GrammarStringList;
+
+#### ForEveryPartCommand extends ControlCommand
+	_name = new GrammarString;
+	commands = new GrammarCommands;
+
+#### ErrorCommand extends ControlCommand
+	message = new GrammarQuotedString;
+
+#### RequireCommand extends ControlCommand
+	capabilities = new GrammarStringList();
+
+#### StopCommand extends ControlCommand
+	no properties
+
+#### abstract ConditionalCommand extends ControlCommand
+	no properties
+
+#### IfCommand extends ConditionalCommand
+	test = null; // must be descendent instanceof TestCommand
+	commands = new GrammarCommands;
+
+#### ElsIfCommand extends IfCommand
+	test = null; // must be descendent instanceof TestCommand
+	commands = new GrammarCommands;
+
+#### ElseCommand extends ConditionalCommand
+	no properties
+	commands = new GrammarCommands;
+
+### abstract ActionCommand extends GrammarCommand
+
+#### FileIntoCommand extends ActionCommand
+	_mailbox = new GrammarQuotedString();
+	copy = false;
+	create = false;
+
+#### RedirectCommand extends ActionCommand
+	_address = new GrammarQuotedString();
+	copy = false;
+	list = null;
+
+#### KeepCommand extends ActionCommand
+	no properties
+
+#### DiscardCommand extends ActionCommand
+	no properties
+
+#### SetCommand extends ActionCommand
+	modifiers = [];
+	_name    = new GrammarQuotedString;
+	_value   = new GrammarQuotedString;
+
+#### VacationCommand extends ActionCommand
+	_days      = new GrammarNumber;
+	_seconds   = new GrammarNumber;
+	_subject   = new GrammarQuotedString;
+	_from      = new GrammarQuotedString;
+	addresses  = new GrammarStringList;
+	mime       = false;
+	_handle    = new GrammarQuotedString;
+	_reason    = new GrammarQuotedString; // QuotedString / MultiLine
+
+#### SetFlagCommand extends ActionCommand
+	_variablename = new GrammarQuotedString;
+	list_of_flags = new GrammarStringList;
+
+#### AddFlagCommand extends ActionCommand
+	_variablename = new GrammarQuotedString;
+	list_of_flags = new GrammarStringList;
+
+#### RemoveFlagCommand extends ActionCommand
+	_variablename = new GrammarQuotedString;
+	list_of_flags = new GrammarStringList;
+
+#### AddHeaderCommand extends ActionCommand
+	last       = false;
+	field_name = new GrammarQuotedString;
+	value      = new GrammarQuotedString;
+
+#### DeleteHeaderCommand extends ActionCommand
+	index          = new GrammarNumber;
+	last           = false;
+	comparator     = '',
+	match_type     = ':is',
+	field_name     = new GrammarQuotedString;
+	value_patterns = new GrammarStringList;
+
+#### ErejectCommand extends ActionCommand
+	_reason = new GrammarQuotedString;
+
+#### RejectCommand extends ActionCommand
+	_reason = new GrammarQuotedString;
+
+#### NotifyCommand extends ActionCommand
+	_method = new GrammarQuotedString;
+	_from = new GrammarQuotedString;
+	_importance = new GrammarNumber;
+	options = new GrammarStringList;
+	_message = new GrammarQuotedString;
+
+#### ReplaceCommand extends ActionCommand
+	mime        = false;
+	_subject    = new GrammarQuotedString;
+	_from       = new GrammarQuotedString;
+	replacement = new GrammarQuotedString;
+
+#### EncloseCommand extends ActionCommand
+	_subject    = new GrammarQuotedString;
+	headers     = new GrammarStringList;
+
+#### ExtractTextCommand extends ActionCommand
+	modifiers = [];
+	_first    = new GrammarNumber;
+	varname   = new GrammarQuotedString;
+
+### abstract TestCommand extends GrammarCommand
+
+#### AddressTest extends TestCommand
+	address_part = ':all';
+	header_list  = new GrammarStringList;
+	key_list     = new GrammarStringList;
+	index        = new GrammarNumber;
+	last         = false;
+//	mime
+//	anychild
+
+#### AllOfTest extends TestCommand
+	tests = new GrammarTestList;
+
+#### AnyOfTest extends TestCommand
+	tests = new GrammarTestList;
+
+#### EnvelopeTest extends TestCommand
+	address_part = ':all';
+	envelope_part = new GrammarStringList;
+	key_list      = new GrammarStringList;
+
+#### ExistsTest extends TestCommand
+	header_names = new GrammarStringList;
+//	mime
+//	anychild
+
+#### FalseTest extends TestCommand
+
+#### HeaderTest extends TestCommand
+	address_part = ':all';
+	header_names = new GrammarStringList;
+	key_list     = new GrammarStringList;
+	index        = new GrammarNumber;
+	last         = false;
+	mime         = false;
+	anychild     = false;
+	// when ":mime" is used:
+	type         = false;
+	subtype      = false;
+	contenttype  = false;
+	param        = new GrammarStringList;
+
+#### NotTest extends TestCommand
+	test = new TestCommand;
+
+#### SizeTest extends TestCommand
+	mode  = ':over'; // :under
+	limit = 0;
+
+#### TrueTest extends TestCommand
+
+#### BodyTest extends TestCommand
+	body_transform = ''; // :raw, :content <string-list>, :text
+	key_list = new GrammarStringList;
+
+#### EnvironmentTest extends TestCommand
+	name     = new GrammarQuotedString;
+	key_list = new GrammarStringList;
+
+#### StringTest extends TestCommand
+	source   = new GrammarStringList;
+	key_list = new GrammarStringList;
+
+#### HasFlagTest extends TestCommand
+	variable_list = new GrammarStringList;
+	list_of_flags = new GrammarStringList;
+
+#### SpamTestTest extends TestCommand
+	percent = false, // 0 - 100 else 0 - 10
+	value = new GrammarQuotedString;
+
+#### VirusTestTest extends TestCommand
+	value = new GrammarQuotedString; // 1 - 5
+
+#### DateTest extends TestCommand
+	zone         = new GrammarQuotedString;
+	originalzone = false;
+	header_name  = new GrammarQuotedString;
+	date_part    = new GrammarQuotedString;
+	key_list     = new GrammarStringList;
+	index        = new GrammarNumber;
+	last         = false;
+
+#### CurrentDateTest extends TestCommand
+	zone       = new GrammarQuotedString;
+	date_part  = new GrammarQuotedString;
+	key_list   = new GrammarStringList;
+
+#### ValidNotifyMethodTest extends TestCommand
+	notification_uris = new GrammarStringList;
+
+#### NotifyMethodCapabilityTest extends TestCommand
+	notification_uri = new GrammarQuotedString;
+	notification_capability = new GrammarQuotedString;
+	key_list = new GrammarStringList;
+
+#### IHaveTest extends TestCommand
+	capabilities = new GrammarStringList;
+
+#### MailboxExistsTest extends TestCommand
+	mailbox_names = new GrammarStringList;
+
+#### MetadataTest extends TestCommand
+	mailbox = new GrammarQuotedString;
+	annotation_name = new GrammarQuotedString;
+	key_list = new GrammarStringList;
+
+#### MetadataExistsTest extends TestCommand
+	mailbox = new GrammarQuotedString;
+	annotation_names = new GrammarStringList;
+
+#### ServerMetadataTest extends TestCommand
+	annotation_name = new GrammarQuotedString;
+	key_list = new GrammarStringList;
+
+#### ServerMetadataExistsTest extends TestCommand
+	annotation_names = new GrammarStringList;
+
+#### ValidExtListTest extends TestCommand
+	ext_list_names = new GrammarStringList;

dev/Sieve/Utils.js

@@ -22,7 +22,7 @@ export const
 	koComputable = fn => ko.computed(fn, {'pure':true}),
 
 	arrayToString = (arr, separator) =>
-		arr.map(item => item.toString?.() || item).join(separator),
+		(arr || []).map(item => item.toString?.() || item).join(separator),
 /*
 	getNotificationMessage = code => {
 		let key = getKeyByValue(Notifications, code);
@@ -58,6 +58,8 @@ export const
 		serverErrorDesc(text);
 	},
 
+	getComparators = () => ['i;ascii-casemap'],
+
 	getMatchTypes = (validOnly = 1) => {
 		let result = [':is',':contains',':matches'];
 		// https://datatracker.ietf.org/doc/html/rfc6134#section-2.3