Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451

use std::ffi::OsString;
use std::io::Result as IoResult;
use std::path::{
	Path,
	PathBuf
};
// for file_type.is_socket()
//use std::os::unix::fs::FileTypeExt;

use serde::{Serialize, Deserialize};
use strum::EnumString;
use tokio::fs;

use super::{
	EventType,
	DynamicEventFilter,
	PeerEventFilter,
	PeerEventTypeFilter,
	NodeFilter,
	DaemonEvent,
	handle::ParsedHandler,
	handle::HandlerScript
};

//use crate::config::HandlerDirectory;

use crate::peer::NodeID;
use crate::util::*;

#[derive(Clone, Debug, EnumString, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum DirectoryType {
	V1
}

enum ResolvedEntry {
	Directory {
		name: String,
		path: PathBuf
	},
	File {
		name: String,
		path: PathBuf
	},
	SymlinkedFile {
		name: String,
		path: PathBuf
	},
}

pub struct EntryToParse {
	components: Vec<String>,
	file_path: PathBuf
}

struct EntryParser<'a, R: Fn(&str) -> Option<NodeID>> {
	resolver: &'a R,
	path: PathBuf,
	name: String,
	ev_type: Option<EventType>,
	node_filter: Option<ParsedNodeFilter>,
	tag: Option<String>,
	daemon_filter: Option<DaemonEvent>,
	peer_ev_filter: Option<PeerEventTypeFilter>
}

enum ParsedNodeFilter {
	Id(NodeID),
	Name(String)
}

pub async fn get_all_entries(dir: &Path) -> IoResult<Vec<EntryToParse>> {

	let mut entries = Vec::<EntryToParse>::new();
	// stack of directory names
	let mut stack = Vec::<String>::new();

	let mut dir_stack = Vec::<fs::ReadDir>::new();

	//TODO: check if dir is directory
	dir_stack.push(fs::read_dir(dir).await?);

	/*
	stack.push(dir
		.file_name()
		.unwrap()
		.to_owned()
		.into_string()
		.map_err(invalid_file_name)?
	);
	*/
	'dirs: while let Some(mut dir_iter) = dir_stack.pop() {
		while let Some(dir_entry) = dir_iter.next_entry().await? {
			match ResolvedEntry::resolve(dir_entry).await? {
				ResolvedEntry::Directory{name, path} => {
					// name of the folder, put on the entry stack
					stack.push(name);
					// put the current directory iterator back on the stack
					dir_stack.push(dir_iter);
					// put this new directory on the iterator stack
					dir_stack.push(fs::read_dir(&path).await?);
					// poor mans depth-first traversal
					continue 'dirs;
				},
				ResolvedEntry::File{name, path} => entries.push(
					EntryToParse::new(&stack, name, path)
				),
				ResolvedEntry::SymlinkedFile{name, path} => entries.push(
					EntryToParse::new(&stack, name, path)
				)
			}
		}
		// directory iterator finished, pop directory name
		stack.pop();
	}

	Ok(entries)
}

pub fn parse_all<R>(resolver: &R, entries: Vec<EntryToParse>)
	-> Vec<Result<ParsedHandler, String>>
	where R: Fn(&str) -> Option<NodeID>
{
	entries
		.into_iter()
		.map(|e| EntryParser::parse(resolver, e))
		.collect()

}


impl std::fmt::Display for ParsedNodeFilter {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		match self {
			Self::Id(node_id) => write!(f, "@[{node_id}]"),
			Self::Name(name) => write!(f, "@{name}")
		}
	}
}


impl<'a, R: Fn(&str) -> Option<NodeID>> EntryParser<'a, R> {

	pub fn parse(resolver: &'a R, entry: EntryToParse)
		-> Result<ParsedHandler, String>
	{
		let mut parser = Self::new(resolver, entry.file_path);

		parser.build(entry.components)?;

		parser.finish()
	}

	fn new(resolver: &'a R, path: PathBuf) -> Self {
		Self {
			resolver,
			path,
			name: String::new(),
			ev_type: None,
			node_filter: None,
			tag: None,
			daemon_filter: None,
			peer_ev_filter: None
		}
	}

	fn build(&mut self, components: Vec<String>) -> Result<(), String> {
		for comp in components {
			self.push(comp)?
		}
		let dot = self.name.pop();
		assert_eq!(dot, Some('.'));
		Ok(())
	}

	fn finish(mut self) -> Result<ParsedHandler, String> {
		let node_filter = self.resolve_node_filter()?;
		let script = HandlerScript {
			name: self.name,
			path: self.path
		};
		match self.ev_type.expect("ev_type always set in build()") {
			EventType::Daemon => Ok(ParsedHandler::Daemon {
				script,
				filter: self.daemon_filter
			}),
			EventType::Dynamic => {
				Ok(ParsedHandler::Dynamic {
					script,
					filter: DynamicEventFilter::simple(node_filter, self.tag)
				})
			},
			EventType::Peer => {
				let peer_filter = self.peer_ev_filter.unwrap_or(
					PeerEventTypeFilter::Any
				);
				Ok(ParsedHandler::Peer{
					script,
					filter: PeerEventFilter::new(node_filter, peer_filter)
				})
			}
		}
	}

	fn resolve_node_filter(&mut self) -> Result<NodeFilter, String> {
		match self.node_filter.take() {
			Some(ParsedNodeFilter::Id(id)) => Ok(Some(id)),
			Some(ParsedNodeFilter::Name(name)) => (self.resolver)(&name)
				.map(Some)
				.ok_or_else(|| format!("unknown node {:?}", &name)),
			None => Ok(None)
		}
	}

	fn push(&mut self, next: String) -> Result<(), String> {
		if next.is_empty() { self.error("invalid empty component", &next)? }
		self.name.push_str(&next);
		self.name.push('.');

		if next.starts_with('#') { Ok(()) }
		else if let Some(node_filter) = Self::get_node_filter(&next)? {
			if self.node_filter.is_some() {
				self.error("only one node filter allowed", &next)?
			}
			if let Some(EventType::Daemon) = self.ev_type {
				self.error("node filter invalid for daemon events", &next)?
			}
			self.node_filter.replace(node_filter);
			Ok(())
		}
		else { self.inner_parse(next) }
	}

	fn inner_parse(&mut self, next: String) -> Result<(), String> {
		match self.ev_type {
			// EventType is known but filter already set
			Some(EventType::Peer) if self.peer_ev_filter.is_some() => {
				self.error("invalid trailing path component", &next)?;
			}
			Some(EventType::Daemon) if self.daemon_filter.is_some() => {
				self.error("invalid trailing path component", &next)?;
			},

			// EventType is Daemon and filter not set yet
			Some(EventType::Daemon) => match next.parse::<DaemonEvent>() {
				Ok(filter) => self.daemon_filter = Some(filter),
				Err(err) => self.error(&err.to_string(), &next)?,
			},
			// EventType is Dynamic 
			Some(EventType::Dynamic) => {
				match next.as_str() {
					"daemon" |
					"peer" => self.error("invalid event type filter", &next)?,
					tag_chunk => self.push_tag_chunk(tag_chunk)
				}
			},
			// EventType is Peer and filter not set yet
			Some(EventType::Peer) => {
				self.peer_ev_filter.replace(match next.as_str() {
					"seen" => PeerEventTypeFilter::Seen,
					"new_address" => PeerEventTypeFilter::NewAddress,
					"status_changed" => PeerEventTypeFilter::StatusChanged,
					_ => self.error("expected peer event type filter", &next)?
				});
			},
			// node_filter is only valid for dynamic & peer events
			None if self.node_filter.is_some() => {
				self.ev_type = match next.as_str() {
					"daemon" =>
						self.error("daemon event with node filter", &next)?,
					"peer" => Some(EventType::Peer),
					tag_chunk => {
						self.push_tag_chunk(tag_chunk);
						Some(EventType::Dynamic)
					}
				}
			},
			// no (actionable) components in the stack
			None => self.ev_type = Some(match next.as_str() {
				"daemon" => EventType::Daemon,
				"peer" => EventType::Peer,
				tag_chunk => {
					self.push_tag_chunk(tag_chunk);
					EventType::Dynamic
				}
			})
		}
		Ok(())
	}

	fn push_tag_chunk(&mut self, tag_chunk: &str) {
		if let Some(tag) = self.tag.as_mut() {
			tag.push('.');
			tag.push_str(tag_chunk);
		}
		else {
			self.tag = Some(tag_chunk.to_string());
		}
	}


	//TODO: make it work with names that contain '.' ??
	fn get_node_filter(next: &str) -> Result<Option<ParsedNodeFilter>, String> {
		if next.starts_with("@[") {
			// in base64 3 bytes → 4 chars, NodeID is 6 bytes → 8 chars
			// "@[________]" → 11 chars
			if next.ends_with(']') && next.len() == 11 {
				Ok(Some(ParsedNodeFilter::Id(
					next.get(2..10).unwrap().parse()?
				)))
			}
			else {
				Err(format!("invalid node filter spec: {next}"))
			}
		}
		else if next.starts_with('@') {
			if next.len() < 2 {
				Err(format!("invalid node filter spec: {next}"))
			}
			else {
				// will never return Ok(None)
				Ok(next.get(1..)
					.map(ToString::to_string)
					.map(ParsedNodeFilter::Name)
				)
			}
		}
		else {
			Ok(None)
		}
	}

	fn error(&self, err_msg: &str, comp: &str) -> Result<Never, String> {
		let msg = format!(
			"failed to parse handler at {}!\nreceived \"{}\" after \"{}\": {}",
			&self.path.display(),
			comp,
			&self.name,
			err_msg
		);
		Err(msg)
	}
}


impl EntryToParse {
	pub fn new(
		dir_stack: &[String],
		file_name: String,
		path: PathBuf)
		-> Self
	{
		let mut stack = Self::flatten_dir_stack(dir_stack);

		Self::split_file_name_into(&mut stack, file_name);

		Self {
			components: stack,
			file_path: path
		}
	}

	pub fn print(&self) {
		let mut comp_iter = self.components.iter();
		print!("{}", comp_iter.next().unwrap());
		for c in comp_iter { print!(".{c}") }
		println!("\t\t{}", self.file_path.display());
	}

	fn flatten_dir_stack(dir_stack: &[String]) -> Vec<String> {
		let mut res = Vec::new();

		for dir_name in dir_stack {
			for comp in dir_name.split('.') {
				res.push(comp.to_owned())
			}
		}
		res
	}

	fn split_file_name_into(stack: &mut Vec<String>, file_name: String) {
		let split: Vec<&str> = file_name.split('.').collect();
		if split.len() == 1 { stack.push(file_name); }
		else {
			for comp in split { stack.push(comp.to_owned()); }
		}
	}

}


impl ResolvedEntry {
	pub async fn resolve(dir_entry: fs::DirEntry) -> IoResult<Self> {
		let name = dir_entry
			.file_name()
			.into_string()
			.map_err(invalid_file_name)?;

		let mut file_type = dir_entry.file_type().await?;
		let mut symlink_path: Option<PathBuf> = None;

		if file_type.is_symlink() {
			file_type = fs::metadata(&dir_entry.path())
				.await?
				.file_type();
			symlink_path = Some(fs::canonicalize(&dir_entry.path()).await?);
		}

		if file_type.is_dir() {
			Ok(Self::Directory {
				name,
				path: dir_entry.path()
			})
		}
		else if file_type.is_file() {
			if let Some(path) = symlink_path {
				Ok(Self::SymlinkedFile{name, path})
			}
			else {
				Ok(Self::File {
					name,
					path: fs::canonicalize(&dir_entry.path()).await?
				})
			}
		}
		else if file_type.is_symlink() {
			//Err(other_io_error(format!(
			//	"exceeded symlink traversal depth limit following {}",
			//	dir_entry.path().display() 
			//)))
			unreachable!("fs::metadata should traverse symlinks");
		}
		//else if file_type.is_socket() {todo!("sockets not supported yet")}
		else {
			let msg = format!(
				"unsupported file type, please remove {} from handler dir",
				dir_entry.path().to_string_lossy()
			);
			Err(std::io::Error::other(msg))
		}

	}
}

fn invalid_file_name(invalid: OsString) -> std::io::Error {
	let msg = format!("filename {invalid:?} contains invalid unicode");
	use std::io;
	io::Error::new(io::ErrorKind::InvalidData, msg)
}