ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.139 by root, Fri Jan 5 19:12:03 2007 UTC vs.
Revision 1.278 by root, Mon Jun 11 21:38:14 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.3 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
		25	use BDB ();
		26	use Data::Dumper;
20	use Digest::MD5;	27	use Digest::MD5;
21	use Fcntl;	28	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	29	use YAML::Syck ();
		30	use IO::AIO 2.32 ();
24	use Time::HiRes;	31	use Time::HiRes;
		32	use Compress::LZF;
25		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		39
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
27		41
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
30		44
31	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		46
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		48
35	our %COMMAND = ();	49	our %COMMAND = ();
36	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
		51
		52	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	53	our %EXTCMD = ();
		54	our %EXT_CORO = (); # coroutines bound to extensions
		55	our %EXT_MAP = (); # pluggable maps
38		56
		57	our $RELOAD; # number of reloads so far
39	our @EVENT;	58	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		59
42	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43	our $TICK_WATCHER;	73	our $TICK_WATCHER;
		74	our $AIO_POLL_WATCHER;
		75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	76	our $NEXT_TICK;
45	our $NOW;	77	our $NOW;
		78	our $USE_FSYNC = 1; # use fsync to write maps - default off
		79
		80	our $BDB_POLL_WATCHER;
		81	our $DB_ENV;
46		82
47	our %CFG;	83	our %CFG;
48		84
49	our $UPTIME; $UPTIME ||= time;	85	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	86	our $RUNTIME;
51		87
		88	our %PLAYER; # all users
52	our %MAP; # all maps	89	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	90	our $LINK_MAP; # the special {link} map, which is always available
54	our $RANDOM_MAPS = cf::localdir . "/random";	91
55	our %EXT_CORO;	92	# used to convert map paths into valid unix filenames by replacing / by ∕
		93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
56		98
57	binmode STDOUT;	99	binmode STDOUT;
58	binmode STDERR;	100	binmode STDERR;
59		101
60	# read virtual server time, if available	102	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
63	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
64	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
65	}	107	}
66		108
67	mkdir cf::localdir;	109	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		111
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
		113
		114	sub cf::map::normalise;
76		115
77	#############################################################################	116	#############################################################################
78		117
79	=head2 GLOBAL VARIABLES	118	=head2 GLOBAL VARIABLES
80		119
…		…
87	=item $cf::RUNTIME	126	=item $cf::RUNTIME
88		127
89	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
90	every server tick.	129	every server tick.
91		130
92	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
93		134
94	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
95	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
96		139
97	=item $cf::NOW	140	=item $cf::NOW
98		141
99	The time of the last (current) server tick.	142	The time of the last (current) server tick.
100		143
101	=item $cf::TICK	144	=item $cf::TICK
102		145
103	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
104		157
105	=item %cf::CFG	158	=item %cf::CFG
106		159
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
108	from wherever your confdir points to.	161	from wherever your confdir points to.
		162
		163	=item cf::wait_for_tick, cf::wait_for_tick_begin
		164
		165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		166	returns directly I<after> the tick processing (and consequently, can only wake one process
		167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
109		168
110	=back	169	=back
111		170
112	=cut	171	=cut
113		172
114	BEGIN {	173	BEGIN {
115	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	175	my $msg = join "", @_;
117	utf8::encode $msg;
118		176
119	$msg .= "\n"	177	$msg .= "\n"
120	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
121		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
122	LOG llevError, "cfperl: $msg";	183	LOG llevError, $msg;
123	};	184	};
124	}	185	}
125		186
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
132		194
133	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
134	# within the Safe compartment.	196	# within the Safe compartment.
135	for my $pkg (qw(	197	for my $pkg (qw(
136	cf::global cf::attachable	198	cf::global cf::attachable
…		…
145		207
146	$Event::DIED = sub {	208	$Event::DIED = sub {
147	warn "error in event callback: @_";	209	warn "error in event callback: @_";
148	};	210	};
149		211
150	my %ext_pkg;
151	my @exts;
152	my @hook;
153
154	=head2 UTILITY FUNCTIONS	212	=head2 UTILITY FUNCTIONS
155		213
156	=over 4	214	=over 4
157		215
158	=cut	216	=item dumpval $ref
159		217
		218	=cut
		219
		220	sub dumpval {
		221	eval {
		222	local $SIG{__DIE__};
		223	my $d;
		224	if (1) {
		225	$d = new Data::Dumper([$_[0]], ["*var"]);
		226	$d->Terse(1);
		227	$d->Indent(2);
		228	$d->Quotekeys(0);
		229	$d->Useqq(1);
		230	#$d->Bless(...);
		231	$d->Seen($_[1]) if @_ > 1;
		232	$d = $d->Dump();
		233	}
		234	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		235	$d
		236	} || "[unable to dump $_[0]: '$@']";
		237	}
		238
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	239	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
161		240
162	=item $ref = cf::from_json $json	241	=item $ref = cf::from_json $json
163		242
164	Converts a JSON string into the corresponding perl data structure.	243	Converts a JSON string into the corresponding perl data structure.
165		244
166	=cut
167
168	sub from_json($) {
169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170	JSON::Syck::Load $_[0]
171	}
172
173	=item $json = cf::to_json $ref	245	=item $json = cf::to_json $ref
174		246
175	Converts a perl data structure into its JSON representation.	247	Converts a perl data structure into its JSON representation.
176
177	=cut
178
179	sub to_json($) {
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
181	JSON::Syck::Dump $_[0]
182	}
183		248
184	=item cf::lock_wait $string	249	=item cf::lock_wait $string
185		250
186	Wait until the given lock is available. See cf::lock_acquire.	251	Wait until the given lock is available. See cf::lock_acquire.
187		252
…		…
193	returned.	258	returned.
194		259
195	Lock names should begin with a unique identifier (for example, cf::map::find	260	Lock names should begin with a unique identifier (for example, cf::map::find
196	uses map_find and cf::map::load uses map_load).	261	uses map_find and cf::map::load uses map_load).
197		262
		263	=item $locked = cf::lock_active $string
		264
		265	Return true if the lock is currently active, i.e. somebody has locked it.
		266
198	=cut	267	=cut
199		268
200	our %LOCK;	269	our %LOCK;
201		270
202	sub lock_wait($) {	271	sub lock_wait($) {
…		…
221	# wake up all waiters, to be on the safe side	290	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };	291	$_->ready for @{ delete $LOCK{$key} };
223	}	292	}
224	}	293	}
225		294
		295	sub lock_active($) {
		296	my ($key) = @_;
		297
		298	! ! $LOCK{$key}
		299	}
		300
226	sub freeze_mainloop {	301	sub freeze_mainloop {
227	return unless $TICK_WATCHER->is_active;	302	return unless $TICK_WATCHER->is_active;
228		303
229	my $guard = Coro::guard { $TICK_WATCHER->start };	304	my $guard = Coro::guard {
		305	$TICK_WATCHER->start;
		306	};
230	$TICK_WATCHER->stop;	307	$TICK_WATCHER->stop;
231	$guard	308	$guard
232	}	309	}
		310
		311	=item cf::async { BLOCK }
		312
		313	Currently the same as Coro::async_pool, meaning you cannot use
		314	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		315	thing you are allowed to do is call C<prio> on it.
		316
		317	=cut
		318
		319	BEGIN { *async = \&Coro::async_pool }
233		320
234	=item cf::sync_job { BLOCK }	321	=item cf::sync_job { BLOCK }
235		322
236	The design of crossfire+ requires that the main coro ($Coro::main) is	323	The design of crossfire+ requires that the main coro ($Coro::main) is
237	always able to handle events or runnable, as crossfire+ is only partly	324	always able to handle events or runnable, as crossfire+ is only partly
…		…
246		333
247	sub sync_job(&) {	334	sub sync_job(&) {
248	my ($job) = @_;	335	my ($job) = @_;
249		336
250	if ($Coro::current == $Coro::main) {	337	if ($Coro::current == $Coro::main) {
		338	my $time = Event::time;
		339
251	# this is the main coro, too bad, we have to block	340	# this is the main coro, too bad, we have to block
252	# till the operation succeeds, freezing the server :/	341	# till the operation succeeds, freezing the server :/
253		342
254	# TODO: use suspend/resume instead	343	# TODO: use suspend/resume instead
255	# (but this is cancel-safe)	344	# (but this is cancel-safe)
256	my $freeze_guard = freeze_mainloop;	345	my $freeze_guard = freeze_mainloop;
257		346
258	my $busy = 1;	347	my $busy = 1;
259	my @res;	348	my @res;
260		349
261	(Coro::async_pool {	350	(async {
262	@res = eval { $job->() };	351	@res = eval { $job->() };
263	warn $@ if $@;	352	warn $@ if $@;
264	undef $busy;	353	undef $busy;
265	})->prio (Coro::PRIO_MAX);	354	})->prio (Coro::PRIO_MAX);
266		355
267	while ($busy) {	356	while ($busy) {
268	unless (Coro::cede) {	357	Coro::cede or Event::one_event;
269	Coro::nready ? Event::one_event 0 : Event::one_event;
270	Coro::cede_notself unless Coro::cede;
271	}	358	}
272	}	359
		360	$time = Event::time - $time;
		361
		362	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		363	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		364
		365	$tick_start += $time; # do not account sync jobs to server load
273		366
274	wantarray ? @res : $res[0]	367	wantarray ? @res : $res[0]
275	} else {	368	} else {
276	# we are in another coroutine, how wonderful, everything just works	369	# we are in another coroutine, how wonderful, everything just works
277		370
278	$job->()	371	$job->()
279	}	372	}
280	}	373	}
281		374
282	=item $coro = cf::coro { BLOCK }	375	=item $coro = cf::async_ext { BLOCK }
283		376
284	Creates (and readies) and returns a new coro. This coro is automcatially	377	Like async, but this coro is automatically being canceled when the
285	being canceled when the extension calling this is being unloaded.	378	extension calling this is being unloaded.
286		379
287	=cut	380	=cut
288		381
289	sub coro(&) {	382	sub async_ext(&) {
290	my $cb = shift;	383	my $cb = shift;
291		384
292	my $coro = &Coro::async_pool ($cb);	385	my $coro = &Coro::async ($cb);
293		386
294	$coro->on_destroy (sub {	387	$coro->on_destroy (sub {
295	delete $EXT_CORO{$coro+0};	388	delete $EXT_CORO{$coro+0};
296	});	389	});
297	$EXT_CORO{$coro+0} = $coro;	390	$EXT_CORO{$coro+0} = $coro;
298		391
299	$coro	392	$coro
300	}	393	}
301		394
302	sub write_runtime {	395	sub write_runtime {
303	my $runtime = cf::localdir . "/runtime";	396	my $runtime = "$LOCALDIR/runtime";
		397
		398	# first touch the runtime file to show we are still running:
		399	# the fsync below can take a very very long time.
		400
		401	IO::AIO::aio_utime $runtime, undef, undef;
		402
		403	my $guard = cf::lock_acquire "write_runtime";
304		404
305	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	405	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
306	or return;	406	or return;
307		407
		408	my $value = $cf::RUNTIME + 90 + 10;
308	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	409	# 10 is the runtime save interval, for a monotonic clock
		410	# 60 allows for the watchdog to kill the server.
		411
309	(aio_write $fh, 0, (length $value), $value, 0) <= 0	412	(aio_write $fh, 0, (length $value), $value, 0) <= 0
310	and return;	413	and return;
311		414
		415	# always fsync - this file is important
312	aio_fsync $fh	416	aio_fsync $fh
313	and return;	417	and return;
314		418
		419	# touch it again to show we are up-to-date
		420	aio_utime $fh, undef, undef;
		421
315	close $fh	422	close $fh
316	or return;	423	or return;
317		424
318	aio_rename "$runtime~", $runtime	425	aio_rename "$runtime~", $runtime
319	and return;	426	and return;
320		427
		428	warn "runtime file written.\n";
		429
321	1	430	1
322	}	431	}
323		432
		433	=item cf::datalog type => key => value, ...
		434
		435	Log a datalog packet of the given type with the given key-value pairs.
		436
		437	=cut
		438
		439	sub datalog($@) {
		440	my ($type, %kv) = @_;
		441	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
		442	}
		443
324	=back	444	=back
325		445
326	=cut	446	=cut
327
328	#############################################################################
329
330	package cf::path;
331
332	sub new {
333	my ($class, $path, $base) = @_;
334
335	$path = $path->as_string if ref $path;
336
337	my $self = bless { }, $class;
338
339	# {... are special paths that are not touched
340	# ?xxx/... are special absolute paths
341	# ?random/... random maps
342	# /! non-realised random map exit
343	# /... normal maps
344	# ~/... per-player maps without a specific player (DO NOT USE)
345	# ~user/... per-player map of a specific user
346
347	if ($path =~ /^{/) {
348	# fine as it is
349	} elsif ($path =~ s{^\?random/}{}) {
350	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
351	$self->{random} = cf::from_json $data;
352	} else {
353	if ($path =~ s{^~([^/]+)?}{}) {
354	$self->{user_rel} = 1;
355
356	if (defined $1) {
357	$self->{user} = $1;
358	} elsif ($base =~ m{^~([^/]+)/}) {
359	$self->{user} = $1;
360	} else {
361	warn "cannot resolve user-relative path without user <$path,$base>\n";
362	}
363	} elsif ($path =~ /^\//) {
364	# already absolute
365	} else {
366	$base =~ s{[^/]+/?$}{};
367	return $class->new ("$base/$path");
368	}
369
370	for ($path) {
371	redo if s{/\.?/}{/};
372	redo if s{/[^/]+/\.\./}{/};
373	}
374	}
375
376	$self->{path} = $path;
377
378	$self
379	}
380
381	# the name / primary key / in-game path
382	sub as_string {
383	my ($self) = @_;
384
385	$self->{user_rel} ? "~$self->{user}$self->{path}"
386	: $self->{random} ? "?random/$self->{path}"
387	: $self->{path}
388	}
389
390	# the displayed name, this is a one way mapping
391	sub visible_name {
392	my ($self) = @_;
393
394	# if (my $rmp = $self->{random}) {
395	# # todo: be more intelligent about this
396	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
397	# } else {
398	$self->as_string
399	# }
400	}
401
402	# escape the /'s in the path
403	sub _escaped_path {
404	# ∕ is U+2215
405	(my $path = $_[0]{path}) =~ s/\//∕/g;
406	$path
407	}
408
409	# the original (read-only) location
410	sub load_path {
411	my ($self) = @_;
412
413	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
414	}
415
416	# the temporary/swap location
417	sub save_path {
418	my ($self) = @_;
419
420	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
421	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
422	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
423	}
424
425	# the unique path, might be eq to save_path
426	sub uniq_path {
427	my ($self) = @_;
428
429	$self->{user_rel} || $self->{random}
430	? undef
431	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
432	}
433
434	# return random map parameters, or undef
435	sub random_map_params {
436	my ($self) = @_;
437
438	$self->{random}
439	}
440
441	# this is somewhat ugly, but style maps do need special treatment
442	sub is_style_map {
443	$_[0]{path} =~ m{^/styles/}
444	}
445
446	package cf;
447		447
448	#############################################################################	448	#############################################################################
449		449
450	=head2 ATTACHABLE OBJECTS	450	=head2 ATTACHABLE OBJECTS
451		451
…		…
577	our @CB_TYPE = (); # registry for type (cf-object class) based events	577	our @CB_TYPE = (); # registry for type (cf-object class) based events
578	our @CB_MAP = ();	578	our @CB_MAP = ();
579		579
580	my %attachment;	580	my %attachment;
581		581
		582	sub cf::attachable::thawer_merge {
		583	# simply override everything except _meta
		584	local $_[0]{_meta};
		585	%{$_[0]} = %{$_[1]};
		586	}
		587
582	sub _attach_cb($$$$) {	588	sub _attach_cb($$$$) {
583	my ($registry, $event, $prio, $cb) = @_;	589	my ($registry, $event, $prio, $cb) = @_;
584		590
585	use sort 'stable';	591	use sort 'stable';
586		592
…		…
620	$registry = $CB_TYPE[$object_type] ||= [];	626	$registry = $CB_TYPE[$object_type] ||= [];
621		627
622	} elsif ($type eq "subtype") {	628	} elsif ($type eq "subtype") {
623	defined $object_type or Carp::croak "subtype specified without type";	629	defined $object_type or Carp::croak "subtype specified without type";
624	my $object_subtype = shift @arg;	630	my $object_subtype = shift @arg;
625	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	631	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
626		632
627	} elsif ($type eq "package") {	633	} elsif ($type eq "package") {
628	my $pkg = shift @arg;	634	my $pkg = shift @arg;
629		635
630	while (my ($name, $id) = each %cb_id) {	636	while (my ($name, $id) = each %cb_id) {
…		…
671	if (ref $_[0]) {	677	if (ref $_[0]) {
672	_object_attach @_;	678	_object_attach @_;
673	} else {	679	} else {
674	_attach shift->_attach_registry, @_;	680	_attach shift->_attach_registry, @_;
675	}	681	}
		682	_recalc_want;
676	};	683	};
677		684
678	# all those should be optimised	685	# all those should be optimised
679	sub cf::attachable::detach {	686	sub cf::attachable::detach {
680	my ($obj, $name) = @_;	687	my ($obj, $name) = @_;
…		…
683	delete $obj->{_attachment}{$name};	690	delete $obj->{_attachment}{$name};
684	reattach ($obj);	691	reattach ($obj);
685	} else {	692	} else {
686	Carp::croak "cannot, currently, detach class attachments";	693	Carp::croak "cannot, currently, detach class attachments";
687	}	694	}
		695	_recalc_want;
688	};	696	};
689		697
690	sub cf::attachable::attached {	698	sub cf::attachable::attached {
691	my ($obj, $name) = @_;	699	my ($obj, $name) = @_;
692		700
…		…
757	# object support	765	# object support
758		766
759	sub reattach {	767	sub reattach {
760	# basically do the same as instantiate, without calling instantiate	768	# basically do the same as instantiate, without calling instantiate
761	my ($obj) = @_;	769	my ($obj) = @_;
		770
		771	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
762		772
763	my $registry = $obj->registry;	773	my $registry = $obj->registry;
764		774
765	@$registry = ();	775	@$registry = ();
766		776
…		…
813	$filename, length $$rdata, scalar @$objs;	823	$filename, length $$rdata, scalar @$objs;
814		824
815	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	825	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
816	chmod SAVE_MODE, $fh;	826	chmod SAVE_MODE, $fh;
817	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	827	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
818	aio_fsync $fh;	828	aio_fsync $fh if $cf::USE_FSYNC;
819	close $fh;	829	close $fh;
820		830
821	if (@$objs) {	831	if (@$objs) {
822	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	832	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
823	chmod SAVE_MODE, $fh;	833	chmod SAVE_MODE, $fh;
824	my $data = Storable::nfreeze { version => 1, objs => $objs };	834	my $data = Storable::nfreeze { version => 1, objs => $objs };
825	aio_write $fh, 0, (length $data), $data, 0;	835	aio_write $fh, 0, (length $data), $data, 0;
826	aio_fsync $fh;	836	aio_fsync $fh if $cf::USE_FSYNC;
827	close $fh;	837	close $fh;
828	aio_rename "$filename.pst~", "$filename.pst";	838	aio_rename "$filename.pst~", "$filename.pst";
829	}	839	}
830	} else {	840	} else {
831	aio_unlink "$filename.pst";	841	aio_unlink "$filename.pst";
…		…
863	or return;	873	or return;
864	$av = eval { (Storable::thaw $av)->{objs} };	874	$av = eval { (Storable::thaw $av)->{objs} };
865	}	875	}
866		876
867	warn sprintf "loading %s (%d)\n",	877	warn sprintf "loading %s (%d)\n",
868	$filename, length $data, scalar @{$av || []};#d#	878	$filename, length $data, scalar @{$av || []};
869	return ($data, $av);	879	return ($data, $av);
870	}	880	}
871		881
872	#############################################################################	882	#############################################################################
873	# command handling &c	883	# command handling &c
…		…
898	=cut	908	=cut
899		909
900	sub register_extcmd {	910	sub register_extcmd {
901	my ($name, $cb) = @_;	911	my ($name, $cb) = @_;
902		912
903	my $caller = caller;
904	#warn "registering extcmd '$name' to '$caller'";
905
906	$EXTCMD{$name} = [$cb, $caller];	913	$EXTCMD{$name} = $cb;
907	}	914	}
908		915
909	cf::player->attach (	916	cf::player->attach (
910	on_command => sub {	917	on_command => sub {
911	my ($pl, $name, $params) = @_;	918	my ($pl, $name, $params) = @_;
…		…
924		931
925	my $msg = eval { from_json $buf };	932	my $msg = eval { from_json $buf };
926		933
927	if (ref $msg) {	934	if (ref $msg) {
928	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	935	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
929	if (my %reply = $cb->[0]->($pl, $msg)) {	936	if (my %reply = $cb->($pl, $msg)) {
930	$pl->ext_reply ($msg->{msgid}, %reply);	937	$pl->ext_reply ($msg->{msgid}, %reply);
931	}	938	}
932	}	939	}
933	} else {	940	} else {
934	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	941	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
936		943
937	cf::override;	944	cf::override;
938	},	945	},
939	);	946	);
940		947
941	sub register {
942	my ($base, $pkg) = @_;
943
944	#TODO
945	}
946
947	sub load_extension {	948	sub load_extensions {
		949	cf::sync_job {
		950	my %todo;
		951
		952	for my $path (<$LIBDIR/*.ext>) {
		953	next unless -r $path;
		954
		955	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		956	my $base = $1;
		957	my $pkg = $1;
		958	$pkg =~ s/[^[:word:]]/_/g;
		959	$pkg = "ext::$pkg";
		960
		961	open my $fh, "<:utf8", $path
		962	or die "$path: $!";
		963
		964	my $source = do { local $/; <$fh> };
		965
		966	my %ext = (
		967	path => $path,
		968	base => $base,
		969	pkg => $pkg,
		970	);
		971
		972	$ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }
		973	if $source =~ /^#!.*?perl.*?#\s*(.*)$/;
		974
		975	$ext{source} =
		976	"package $pkg; use strict; use utf8;\n"
		977	. "#line 1 \"$path\"\n{\n"
		978	. $source
		979	. "\n};\n1";
		980
		981	$todo{$base} = \%ext;
		982	}
		983
		984	my %done;
		985	while (%todo) {
		986	my $progress;
		987
		988	while (my ($k, $v) = each %todo) {
		989	for (split /,\s*/, $ext{meta}{depends}) {
		990	goto skip
		991	unless exists $done{$_};
		992	}
		993
		994	warn "... loading '$k' into '$v->{pkg}'\n";
		995
		996	unless (eval $v->{source}) {
		997	my $msg = $@ ? "$v->{path}: $@\n"
		998	: "extension disabled.\n";
		999
		1000	if (exists $v->{meta}{mandatory}) {
		1001	warn $msg;
		1002	warn "mandatory extension failed to load, exiting.\n";
		1003	exit 1;
		1004	}
		1005
		1006	die $msg;
		1007	}
		1008
		1009	$done{$k} = delete $todo{$k};
		1010	push @EXTS, $v->{pkg};
		1011	}
		1012
		1013	skip:
		1014	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1015	unless $progress;
		1016	}
		1017	};
		1018	}
		1019
		1020	#############################################################################
		1021
		1022	=head2 CORE EXTENSIONS
		1023
		1024	Functions and methods that extend core crossfire objects.
		1025
		1026	=cut
		1027
		1028	package cf::player;
		1029
		1030	use Coro::AIO;
		1031
		1032	=head3 cf::player
		1033
		1034	=over 4
		1035
		1036	=item cf::player::find $login
		1037
		1038	Returns the given player object, loading it if necessary (might block).
		1039
		1040	=cut
		1041
		1042	sub playerdir($) {
		1043	"$PLAYERDIR/"
		1044	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1045	}
		1046
		1047	sub path($) {
		1048	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1049
		1050	(playerdir $login) . "/playerdata"
		1051	}
		1052
		1053	sub find_active($) {
		1054	$cf::PLAYER{$_[0]}
		1055	and $cf::PLAYER{$_[0]}->active
		1056	and $cf::PLAYER{$_[0]}
		1057	}
		1058
		1059	sub exists($) {
		1060	my ($login) = @_;
		1061
		1062	$cf::PLAYER{$login}
		1063	or cf::sync_job { !aio_stat path $login }
		1064	}
		1065
		1066	sub find($) {
		1067	return $cf::PLAYER{$_[0]} || do {
		1068	my $login = $_[0];
		1069
		1070	my $guard = cf::lock_acquire "user_find:$login";
		1071
		1072	$cf::PLAYER{$_[0]} || do {
		1073	# rename old playerfiles to new ones
		1074	#TODO: remove when no longer required
		1075	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1076	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1077	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1078	aio_unlink +(playerdir $login) . "/$login.pl";
		1079
		1080	my $pl = load_pl path $login
		1081	or return;
		1082	$cf::PLAYER{$login} = $pl
		1083	}
		1084	}
		1085	}
		1086
		1087	sub save($) {
		1088	my ($pl) = @_;
		1089
		1090	return if $pl->{deny_save};
		1091
		1092	my $path = path $pl;
		1093	my $guard = cf::lock_acquire "user_save:$path";
		1094
		1095	return if $pl->{deny_save};
		1096
		1097	aio_mkdir playerdir $pl, 0770;
		1098	$pl->{last_save} = $cf::RUNTIME;
		1099
		1100	$pl->save_pl ($path);
		1101	Coro::cede;
		1102	}
		1103
		1104	sub new($) {
		1105	my ($login) = @_;
		1106
		1107	my $self = create;
		1108
		1109	$self->ob->name ($login);
		1110	$self->{deny_save} = 1;
		1111
		1112	$cf::PLAYER{$login} = $self;
		1113
		1114	$self
		1115	}
		1116
		1117	=item $pl->quit_character
		1118
		1119	Nukes the player without looking back. If logged in, the connection will
		1120	be destroyed. May block for a long time.
		1121
		1122	=cut
		1123
		1124	sub quit_character {
		1125	my ($pl) = @_;
		1126
		1127	my $name = $pl->ob->name;
		1128
		1129	$pl->{deny_save} = 1;
		1130	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1131
		1132	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1133	$pl->deactivate;
		1134	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1135	$pl->ns->destroy if $pl->ns;
		1136
		1137	my $path = playerdir $pl;
		1138	my $temp = "$path~$cf::RUNTIME~deleting~";
		1139	aio_rename $path, $temp;
		1140	delete $cf::PLAYER{$pl->ob->name};
		1141	$pl->destroy;
		1142
		1143	my $prefix = qr<^~\Q$name\E/>;
		1144
		1145	# nuke player maps
		1146	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1147
		1148	IO::AIO::aio_rmtree $temp;
		1149	}
		1150
		1151	=item $pl->kick
		1152
		1153	Kicks a player out of the game. This destroys the connection.
		1154
		1155	=cut
		1156
		1157	sub kick {
		1158	my ($pl, $kicker) = @_;
		1159
		1160	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1161	$pl->killer ("kicked");
		1162	$pl->ns->destroy;
		1163	}
		1164
		1165	=item cf::player::list_logins
		1166
		1167	Returns am arrayref of all valid playernames in the system, can take a
		1168	while and may block, so not sync_job-capable, ever.
		1169
		1170	=cut
		1171
		1172	sub list_logins {
		1173	my $dirs = aio_readdir $PLAYERDIR
		1174	or return [];
		1175
		1176	my @logins;
		1177
		1178	for my $login (@$dirs) {
		1179	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1180	aio_read $fh, 0, 512, my $buf, 0 or next;
		1181	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1182
		1183	utf8::decode $login;
		1184	push @logins, $login;
		1185	}
		1186
		1187	\@logins
		1188	}
		1189
		1190	=item $player->maps
		1191
		1192	Returns an arrayref of map paths that are private for this
		1193	player. May block.
		1194
		1195	=cut
		1196
		1197	sub maps($) {
		1198	my ($pl) = @_;
		1199
		1200	$pl = ref $pl ? $pl->ob->name : $pl;
		1201
		1202	my $files = aio_readdir playerdir $pl
		1203	or return;
		1204
		1205	my @paths;
		1206
		1207	for (@$files) {
		1208	utf8::decode $_;
		1209	next if /\.(?:pl|pst)$/;
		1210	next unless /^$PATH_SEP/o;
		1211
		1212	push @paths, cf::map::normalise "~$pl/$_";
		1213	}
		1214
		1215	\@paths
		1216	}
		1217
		1218	=item $player->ext_reply ($msgid, %msg)
		1219
		1220	Sends an ext reply to the player.
		1221
		1222	=cut
		1223
		1224	sub ext_reply($$%) {
		1225	my ($self, $id, %msg) = @_;
		1226
		1227	$msg{msgid} = $id;
		1228
		1229	$self->send ("ext " . cf::to_json \%msg);
		1230	}
		1231
		1232	=item $player->ext_event ($type, %msg)
		1233
		1234	Sends an ext event to the client.
		1235
		1236	=cut
		1237
		1238	sub ext_event($$%) {
		1239	my ($self, $type, %msg) = @_;
		1240
		1241	$self->ns->ext_event ($type, %msg);
		1242	}
		1243
		1244	=head3 cf::region
		1245
		1246	=over 4
		1247
		1248	=cut
		1249
		1250	package cf::region;
		1251
		1252	=item cf::region::find_by_path $path
		1253
		1254	Tries to decuce the probable region for a map knowing only its path.
		1255
		1256	=cut
		1257
		1258	sub find_by_path($) {
948	my ($path) = @_;	1259	my ($path) = @_;
949		1260
950	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1261	my ($match, $specificity);
951	my $base = $1;
952	my $pkg = $1;
953	$pkg =~ s/[^[:word:]]/_/g;
954	$pkg = "ext::$pkg";
955		1262
956	warn "loading '$path' into '$pkg'\n";	1263	for my $region (list) {
957		1264	if ($region->match && $path =~ $region->match) {
958	open my $fh, "<:utf8", $path	1265	($match, $specificity) = ($region, $region->specificity)
959	or die "$path: $!";	1266	if $region->specificity > $specificity;
960		1267	}
961	my $source =
962	"package $pkg; use strict; use utf8;\n"
963	. "#line 1 \"$path\"\n{\n"
964	. (do { local $/; <$fh> })
965	. "\n};\n1";
966
967	eval $source
968	or die $@ ? "$path: $@\n"
969	: "extension disabled.\n";
970
971	push @exts, $pkg;
972	$ext_pkg{$base} = $pkg;
973
974	# no strict 'refs';
975	# @{"$pkg\::ISA"} = ext::;
976
977	register $base, $pkg;
978	}
979
980	sub unload_extension {
981	my ($pkg) = @_;
982
983	warn "removing extension $pkg\n";
984
985	# remove hooks
986	#TODO
987	# for my $idx (0 .. $#PLUGIN_EVENT) {
988	# delete $hook[$idx]{$pkg};
989	# }	1268	}
990		1269
991	# remove commands	1270	$match
992	for my $name (keys %COMMAND) {
993	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
994
995	if (@cb) {
996	$COMMAND{$name} = \@cb;
997	} else {
998	delete $COMMAND{$name};
999	}
1000	}
1001
1002	# remove extcmds
1003	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1004	delete $EXTCMD{$name};
1005	}
1006
1007	if (my $cb = $pkg->can ("unload")) {
1008	eval {
1009	$cb->($pkg);
1010	1
1011	} or warn "$pkg unloaded, but with errors: $@";
1012	}
1013
1014	Symbol::delete_package $pkg;
1015	}
1016
1017	sub load_extensions {
1018	for my $ext (<$LIBDIR/*.ext>) {
1019	next unless -r $ext;
1020	eval {
1021	load_extension $ext;
1022	1
1023	} or warn "$ext not loaded: $@";
1024	}
1025	}
1026
1027	#############################################################################
1028	# load/save/clean perl data associated with a map
1029
1030	*cf::mapsupport::on_clean = sub {
1031	my ($map) = @_;
1032
1033	my $path = $map->tmpname;
1034	defined $path or return;
1035
1036	unlink "$path.pst";
1037	};
1038
1039	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1040
1041	#############################################################################
1042	# load/save perl data associated with player->ob objects
1043
1044	sub all_objects(@) {
1045	@_, map all_objects ($_->inv), @_
1046	}
1047
1048	# TODO: compatibility cruft, remove when no longer needed
1049	cf::player->attach (
1050	on_load => sub {
1051	my ($pl, $path) = @_;
1052
1053	for my $o (all_objects $pl->ob) {
1054	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1055	$o->set_ob_key_value ("_perl_data");
1056
1057	%$o = %{ Storable::thaw pack "H*", $value };
1058	}
1059	}
1060	},
1061	);
1062
1063	#############################################################################
1064
1065	=head2 CORE EXTENSIONS
1066
1067	Functions and methods that extend core crossfire objects.
1068
1069	=head3 cf::player
1070
1071	=over 4
1072
1073	=item cf::player::exists $login
1074
1075	Returns true when the given account exists.
1076
1077	=cut
1078
1079	sub cf::player::exists($) {
1080	cf::player::find $_[0]
1081	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1082	}
1083
1084	=item $player->ext_reply ($msgid, $msgtype, %msg)
1085
1086	Sends an ext reply to the player.
1087
1088	=cut
1089
1090	sub cf::player::ext_reply($$$%) {
1091	my ($self, $id, %msg) = @_;
1092
1093	$msg{msgid} = $id;
1094
1095	$self->send ("ext " . to_json \%msg);
1096	}	1271	}
1097		1272
1098	=back	1273	=back
1099
1100		1274
1101	=head3 cf::map	1275	=head3 cf::map
1102		1276
1103	=over 4	1277	=over 4
1104		1278
…		…
1107	package cf::map;	1281	package cf::map;
1108		1282
1109	use Fcntl;	1283	use Fcntl;
1110	use Coro::AIO;	1284	use Coro::AIO;
1111		1285
		1286	use overload
		1287	'""' => \&as_string,
		1288	fallback => 1;
		1289
1112	our $MAX_RESET = 3600;	1290	our $MAX_RESET = 3600;
1113	our $DEFAULT_RESET = 3000;	1291	our $DEFAULT_RESET = 3000;
1114		1292
1115	sub generate_random_map {	1293	sub generate_random_map {
1116	my ($path, $rmp) = @_;	1294	my ($self, $rmp) = @_;
1117
1118	# mit "rum" bekleckern, nicht	1295	# mit "rum" bekleckern, nicht
1119	cf::map::_create_random_map	1296	$self->_create_random_map (
1120	$path,
1121	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1297	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1122	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1298	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1123	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1299	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1124	$rmp->{exit_on_final_map},	1300	$rmp->{exit_on_final_map},
1125	$rmp->{xsize}, $rmp->{ysize},	1301	$rmp->{xsize}, $rmp->{ysize},
1126	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1302	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1127	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1303	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1128	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1304	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1129	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1305	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1130	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1306	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1131	(cf::region::find $rmp->{region})	1307	(cf::region::find $rmp->{region}), $rmp->{custom}
		1308	)
		1309	}
		1310
		1311	=item cf::map->register ($regex, $prio)
		1312
		1313	Register a handler for the map path matching the given regex at the
		1314	givne priority (higher is better, built-in handlers have priority 0, the
		1315	default).
		1316
		1317	=cut
		1318
		1319	sub register {
		1320	my (undef, $regex, $prio) = @_;
		1321	my $pkg = caller;
		1322
		1323	no strict;
		1324	push @{"$pkg\::ISA"}, __PACKAGE__;
		1325
		1326	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1327	}
		1328
		1329	# also paths starting with '/'
		1330	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1331
		1332	sub thawer_merge {
		1333	my ($self, $merge) = @_;
		1334
		1335	# we have to keep some variables in memory intact
		1336	local $self->{path};
		1337	local $self->{load_path};
		1338
		1339	$self->SUPER::thawer_merge ($merge);
		1340	}
		1341
		1342	sub normalise {
		1343	my ($path, $base) = @_;
		1344
		1345	$path = "$path"; # make sure its a string
		1346
		1347	$path =~ s/\.map$//;
		1348
		1349	# map plan:
		1350	#
		1351	# /! non-realised random map exit (special hack!)
		1352	# {... are special paths that are not being touched
		1353	# ?xxx/... are special absolute paths
		1354	# ?random/... random maps
		1355	# /... normal maps
		1356	# ~user/... per-player map of a specific user
		1357
		1358	$path =~ s/$PATH_SEP/\//go;
		1359
		1360	# treat it as relative path if it starts with
		1361	# something that looks reasonable
		1362	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1363	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1364
		1365	$base =~ s{[^/]+/?$}{};
		1366	$path = "$base/$path";
		1367	}
		1368
		1369	for ($path) {
		1370	redo if s{//}{/};
		1371	redo if s{/\.?/}{/};
		1372	redo if s{/[^/]+/\.\./}{/};
		1373	}
		1374
		1375	$path
		1376	}
		1377
		1378	sub new_from_path {
		1379	my (undef, $path, $base) = @_;
		1380
		1381	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1382
		1383	$path = normalise $path, $base;
		1384
		1385	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1386	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1387	my $self = bless cf::map::new, $pkg;
		1388	$self->{path} = $path; $self->path ($path);
		1389	$self->init; # pass $1 etc.
		1390	return $self;
		1391	}
		1392	}
		1393
		1394	Carp::carp "unable to resolve path '$path' (base '$base').";
		1395	()
		1396	}
		1397
		1398	sub init {
		1399	my ($self) = @_;
		1400
		1401	$self
		1402	}
		1403
		1404	sub as_string {
		1405	my ($self) = @_;
		1406
		1407	"$self->{path}"
		1408	}
		1409
		1410	# the displayed name, this is a one way mapping
		1411	sub visible_name {
		1412	&as_string
		1413	}
		1414
		1415	# the original (read-only) location
		1416	sub load_path {
		1417	my ($self) = @_;
		1418
		1419	"$MAPDIR/$self->{path}.map"
		1420	}
		1421
		1422	# the temporary/swap location
		1423	sub save_path {
		1424	my ($self) = @_;
		1425
		1426	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1427	"$TMPDIR/$path.map"
		1428	}
		1429
		1430	# the unique path, undef == no special unique path
		1431	sub uniq_path {
		1432	my ($self) = @_;
		1433
		1434	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1435	"$UNIQUEDIR/$path"
1132	}	1436	}
1133		1437
1134	# and all this just because we cannot iterate over	1438	# and all this just because we cannot iterate over
1135	# all maps in C++...	1439	# all maps in C++...
1136	sub change_all_map_light {	1440	sub change_all_map_light {
…		…
1138		1442
1139	$_->change_map_light ($change)	1443	$_->change_map_light ($change)
1140	for grep $_->outdoor, values %cf::MAP;	1444	for grep $_->outdoor, values %cf::MAP;
1141	}	1445	}
1142		1446
		1447	sub decay_objects {
		1448	my ($self) = @_;
		1449
		1450	return if $self->{deny_reset};
		1451
		1452	$self->do_decay_objects;
		1453	}
		1454
		1455	sub unlink_save {
		1456	my ($self) = @_;
		1457
		1458	utf8::encode (my $save = $self->save_path);
		1459	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1460	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1461	}
		1462
1143	sub try_load_header($) {	1463	sub load_header_from($) {
1144	my ($path) = @_;	1464	my ($self, $path) = @_;
1145		1465
1146	utf8::encode $path;	1466	utf8::encode $path;
1147	aio_open $path, O_RDONLY, 0	1467	#aio_open $path, O_RDONLY, 0
		1468	# or return;
		1469
		1470	$self->_load_header ($path)
1148	or return;	1471	or return;
1149		1472
1150	my $map = cf::map::new	1473	$self->{load_path} = $path;
		1474
		1475	1
		1476	}
		1477
		1478	sub load_header_orig {
		1479	my ($self) = @_;
		1480
		1481	$self->load_header_from ($self->load_path)
		1482	}
		1483
		1484	sub load_header_temp {
		1485	my ($self) = @_;
		1486
		1487	$self->load_header_from ($self->save_path)
		1488	}
		1489
		1490	sub prepare_temp {
		1491	my ($self) = @_;
		1492
		1493	$self->last_access ((delete $self->{last_access})
		1494	|| $cf::RUNTIME); #d#
		1495	# safety
		1496	$self->{instantiate_time} = $cf::RUNTIME
		1497	if $self->{instantiate_time} > $cf::RUNTIME;
		1498	}
		1499
		1500	sub prepare_orig {
		1501	my ($self) = @_;
		1502
		1503	$self->{load_original} = 1;
		1504	$self->{instantiate_time} = $cf::RUNTIME;
		1505	$self->last_access ($cf::RUNTIME);
		1506	$self->instantiate;
		1507	}
		1508
		1509	sub load_header {
		1510	my ($self) = @_;
		1511
		1512	if ($self->load_header_temp) {
		1513	$self->prepare_temp;
		1514	} else {
		1515	$self->load_header_orig
1151	or return;	1516	or return;
		1517	$self->prepare_orig;
		1518	}
1152		1519
1153	# for better error messages only, will be overwritten	1520	$self->{deny_reset} = 1
1154	$map->path ($path);	1521	if $self->no_reset;
1155		1522
1156	$map->load_header ($path)	1523	$self->default_region (cf::region::find_by_path $self->{path})
1157	or return;	1524	unless $self->default_region;
1158		1525
1159	$map->{load_path} = $path;	1526	1
1160
1161	$map
1162	}	1527	}
1163		1528
1164	sub find;	1529	sub find;
1165	sub find {	1530	sub find {
1166	my ($path, $origin) = @_;	1531	my ($path, $origin) = @_;
1167		1532
1168	#warn "find<$path,$origin>\n";#d#
1169
1170	$path = new cf::path $path, $origin && $origin->path;	1533	$path = normalise $path, $origin && $origin->path;
1171	my $key = $path->as_string;
1172		1534
1173	cf::lock_wait "map_find:$key";	1535	cf::lock_wait "map_find:$path";
1174		1536
1175	$cf::MAP{$key} || do {	1537	$cf::MAP{$path} || do {
1176	my $guard = cf::lock_acquire "map_find:$key";	1538	my $guard = cf::lock_acquire "map_find:$path";
1177		1539	my $map = new_from_path cf::map $path
1178	# do it the slow way
1179	my $map = try_load_header $path->save_path;
1180
1181	Coro::cede;
1182
1183	if ($map) {
1184	$map->last_access ((delete $map->{last_access})
1185	|| $cf::RUNTIME); #d#
1186	# safety
1187	$map->{instantiate_time} = $cf::RUNTIME
1188	if $map->{instantiate_time} > $cf::RUNTIME;
1189	} else {
1190	if (my $rmp = $path->random_map_params) {
1191	$map = generate_random_map $key, $rmp;
1192	} else {
1193	$map = try_load_header $path->load_path;
1194	}
1195
1196	$map or return;	1540	or return;
1197		1541
1198	$map->{load_original} = 1;
1199	$map->{instantiate_time} = $cf::RUNTIME;
1200	$map->last_access ($cf::RUNTIME);
1201	$map->instantiate;
1202
1203	# per-player maps become, after loading, normal maps
1204	$map->per_player (0) if $path->{user_rel};
1205	}
1206
1207	$map->path ($key);
1208	$map->{path} = $path;
1209	$map->{last_save} = $cf::RUNTIME;	1542	$map->{last_save} = $cf::RUNTIME;
1210		1543
1211	Coro::cede;	1544	$map->load_header
		1545	or return;
1212		1546
1213	if ($map->should_reset) {	1547	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1548	# doing this can freeze the server in a sync job, obviously
		1549	#$cf::WAIT_FOR_TICK->wait;
1214	$map->reset;	1550	$map->reset;
1215	undef $guard;	1551	undef $guard;
1216	$map = find $path	1552	return find $path;
1217	or return;
1218	}	1553	}
1219		1554
1220	$cf::MAP{$key} = $map	1555	$cf::MAP{$path} = $map
1221	}	1556	}
1222	}	1557	}
		1558
		1559	sub pre_load { }
		1560	sub post_load { }
1223		1561
1224	sub load {	1562	sub load {
1225	my ($self) = @_;	1563	my ($self) = @_;
1226		1564
		1565	local $self->{deny_reset} = 1; # loading can take a long time
		1566
1227	my $path = $self->{path};	1567	my $path = $self->{path};
		1568
		1569	{
1228	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1570	my $guard = cf::lock_acquire "map_load:$path";
1229		1571
1230	return if $self->in_memory != cf::MAP_SWAPPED;	1572	return if $self->in_memory != cf::MAP_SWAPPED;
1231		1573
1232	$self->in_memory (cf::MAP_LOADING);	1574	$self->in_memory (cf::MAP_LOADING);
1233		1575
1234	$self->alloc;	1576	$self->alloc;
		1577
		1578	$self->pre_load;
		1579	Coro::cede;
		1580
1235	$self->load_objects ($self->{load_path}, 1)	1581	$self->_load_objects ($self->{load_path}, 1)
1236	or return;	1582	or return;
1237		1583
1238	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1584	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1239	if delete $self->{load_original};	1585	if delete $self->{load_original};
1240		1586
1241	if (my $uniq = $path->uniq_path) {	1587	if (my $uniq = $self->uniq_path) {
1242	utf8::encode $uniq;	1588	utf8::encode $uniq;
1243	if (aio_open $uniq, O_RDONLY, 0) {	1589	if (aio_open $uniq, O_RDONLY, 0) {
1244	$self->clear_unique_items;	1590	$self->clear_unique_items;
1245	$self->load_objects ($uniq, 0);	1591	$self->_load_objects ($uniq, 0);
1246	}	1592	}
1247	}	1593	}
1248		1594
1249	Coro::cede;	1595	Coro::cede;
1250
1251	# now do the right thing for maps	1596	# now do the right thing for maps
1252	$self->link_multipart_objects;	1597	$self->link_multipart_objects;
1253
1254	if ($self->{path}->is_style_map) {
1255	$self->{deny_save} = 1;
1256	$self->{deny_reset} = 1;
1257	} else {
1258	$self->fix_auto_apply;
1259	$self->decay_objects;
1260	$self->update_buttons;
1261	$self->set_darkness_map;
1262	$self->difficulty ($self->estimate_difficulty)	1598	$self->difficulty ($self->estimate_difficulty)
1263	unless $self->difficulty;	1599	unless $self->difficulty;
		1600	Coro::cede;
		1601
		1602	unless ($self->{deny_activate}) {
		1603	$self->decay_objects;
		1604	$self->fix_auto_apply;
		1605	$self->update_buttons;
		1606	Coro::cede;
		1607	$self->set_darkness_map;
		1608	Coro::cede;
1264	$self->activate;	1609	$self->activate;
1265	}	1610	}
1266		1611
1267	Coro::cede;
1268
1269	$self->in_memory (cf::MAP_IN_MEMORY);	1612	$self->in_memory (cf::MAP_IN_MEMORY);
		1613	}
		1614
		1615	$self->post_load;
		1616	}
		1617
		1618	sub customise_for {
		1619	my ($self, $ob) = @_;
		1620
		1621	return find "~" . $ob->name . "/" . $self->{path}
		1622	if $self->per_player;
		1623
		1624	# return find "?party/" . $ob->name . "/" . $self->{path}
		1625	# if $self->per_party;
		1626
		1627	$self
		1628	}
		1629
		1630	# find and load all maps in the 3x3 area around a map
		1631	sub load_diag {
		1632	my ($map) = @_;
		1633
		1634	my @diag; # diagonal neighbours
		1635
		1636	for (0 .. 3) {
		1637	my $neigh = $map->tile_path ($_)
		1638	or next;
		1639	$neigh = find $neigh, $map
		1640	or next;
		1641	$neigh->load;
		1642
		1643	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1644	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1645	}
		1646
		1647	for (@diag) {
		1648	my $neigh = find @$_
		1649	or next;
		1650	$neigh->load;
		1651	}
1270	}	1652	}
1271		1653
1272	sub find_sync {	1654	sub find_sync {
1273	my ($path, $origin) = @_;	1655	my ($path, $origin) = @_;
1274		1656
1275	cf::sync_job {	1657	cf::sync_job { find $path, $origin }
1276	my $map = cf::map::find $path, $origin;
1277	$map
1278	}
1279	}	1658	}
1280		1659
1281	sub do_load_sync {	1660	sub do_load_sync {
1282	my ($map) = @_;	1661	my ($map) = @_;
1283		1662
1284	cf::sync_job { $map->load };	1663	cf::sync_job { $map->load };
1285	}	1664	}
1286		1665
		1666	our %MAP_PREFETCH;
		1667	our $MAP_PREFETCHER = undef;
		1668
		1669	sub find_async {
		1670	my ($path, $origin) = @_;
		1671
		1672	$path = normalise $path, $origin && $origin->{path};
		1673
		1674	if (my $map = $cf::MAP{$path}) {
		1675	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1676	}
		1677
		1678	undef $MAP_PREFETCH{$path};
		1679	$MAP_PREFETCHER ||= cf::async {
		1680	while (%MAP_PREFETCH) {
		1681	for my $path (keys %MAP_PREFETCH) {
		1682	my $map = find $path
		1683	or next;
		1684	$map->load;
		1685
		1686	delete $MAP_PREFETCH{$path};
		1687	}
		1688	}
		1689	undef $MAP_PREFETCHER;
		1690	};
		1691	$MAP_PREFETCHER->prio (6);
		1692
		1693	()
		1694	}
		1695
1287	sub save {	1696	sub save {
1288	my ($self) = @_;	1697	my ($self) = @_;
1289		1698
1290	my $lock = cf::lock_acquire "map_data:" . $self->path;	1699	my $lock = cf::lock_acquire "map_data:" . $self->path;
1291		1700
1292	$self->{last_save} = $cf::RUNTIME;	1701	$self->{last_save} = $cf::RUNTIME;
1293		1702
1294	return unless $self->dirty;	1703	return unless $self->dirty;
1295		1704
1296	my $save = $self->{path}->save_path; utf8::encode $save;	1705	my $save = $self->save_path; utf8::encode $save;
1297	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	1706	my $uniq = $self->uniq_path; utf8::encode $uniq;
1298		1707
1299	$self->{load_path} = $save;	1708	$self->{load_path} = $save;
1300		1709
1301	return if $self->{deny_save};	1710	return if $self->{deny_save};
1302		1711
1303	local $self->{last_access} = $self->last_access;#d#	1712	local $self->{last_access} = $self->last_access;#d#
1304		1713
		1714	cf::async {
		1715	$_->contr->save for $self->players;
		1716	};
		1717
1305	if ($uniq) {	1718	if ($uniq) {
1306	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	1719	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1307	$self->save_objects ($uniq, cf::IO_UNIQUES);	1720	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1308	} else {	1721	} else {
1309	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	1722	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1310	}	1723	}
1311	}	1724	}
1312		1725
1313	sub swap_out {	1726	sub swap_out {
1314	my ($self) = @_;	1727	my ($self) = @_;
…		…
1328		1741
1329	sub reset_at {	1742	sub reset_at {
1330	my ($self) = @_;	1743	my ($self) = @_;
1331		1744
1332	# TODO: safety, remove and allow resettable per-player maps	1745	# TODO: safety, remove and allow resettable per-player maps
1333	return 1e99 if $self->{path}{user_rel};
1334	return 1e99 if $self->{deny_reset};	1746	return 1e99 if $self->{deny_reset};
1335		1747
1336	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1748	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1337	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1749	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1338		1750
…		…
1343	my ($self) = @_;	1755	my ($self) = @_;
1344		1756
1345	$self->reset_at <= $cf::RUNTIME	1757	$self->reset_at <= $cf::RUNTIME
1346	}	1758	}
1347		1759
1348	sub unlink_save {
1349	my ($self) = @_;
1350
1351	utf8::encode (my $save = $self->{path}->save_path);
1352	aioreq_pri 3; IO::AIO::aio_unlink $save;
1353	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1354	}
1355
1356	sub rename {
1357	my ($self, $new_path) = @_;
1358
1359	$self->unlink_save;
1360
1361	delete $cf::MAP{$self->path};
1362	$self->{path} = new cf::path $new_path;
1363	$self->path ($self->{path}->as_string);
1364	$cf::MAP{$self->path} = $self;
1365
1366	$self->save;
1367	}
1368
1369	sub reset {	1760	sub reset {
1370	my ($self) = @_;	1761	my ($self) = @_;
1371		1762
1372	my $lock = cf::lock_acquire "map_data:" . $self->path;	1763	my $lock = cf::lock_acquire "map_data:$self->{path}";
1373		1764
1374	return if $self->players;	1765	return if $self->players;
1375	return if $self->{path}{user_rel};#d#
1376		1766
1377	warn "resetting map ", $self->path;#d#	1767	warn "resetting map ", $self->path;
		1768
		1769	$self->in_memory (cf::MAP_SWAPPED);
		1770
		1771	# need to save uniques path
		1772	unless ($self->{deny_save}) {
		1773	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1774
		1775	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1776	if $uniq;
		1777	}
1378		1778
1379	delete $cf::MAP{$self->path};	1779	delete $cf::MAP{$self->path};
		1780
		1781	$self->clear;
1380		1782
1381	$_->clear_links_to ($self) for values %cf::MAP;	1783	$_->clear_links_to ($self) for values %cf::MAP;
1382		1784
1383	$self->unlink_save;	1785	$self->unlink_save;
1384	$self->destroy;	1786	$self->destroy;
…		…
1387	my $nuke_counter = "aaaa";	1789	my $nuke_counter = "aaaa";
1388		1790
1389	sub nuke {	1791	sub nuke {
1390	my ($self) = @_;	1792	my ($self) = @_;
1391		1793
		1794	delete $cf::MAP{$self->path};
		1795
		1796	$self->unlink_save;
		1797
		1798	bless $self, "cf::map";
		1799	delete $self->{deny_reset};
1392	$self->{deny_save} = 1;	1800	$self->{deny_save} = 1;
1393	$self->reset_timeout (1);	1801	$self->reset_timeout (1);
1394	$self->rename ("{nuke}/" . ($nuke_counter++));	1802	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1803
		1804	$cf::MAP{$self->path} = $self;
		1805
1395	$self->reset; # polite request, might not happen	1806	$self->reset; # polite request, might not happen
1396	}	1807	}
1397		1808
1398	sub customise_for {	1809	=item $maps = cf::map::tmp_maps
1399	my ($map, $ob) = @_;
1400		1810
1401	if ($map->per_player) {	1811	Returns an arrayref with all map paths of currently instantiated and saved
1402	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	1812	maps. May block.
		1813
		1814	=cut
		1815
		1816	sub tmp_maps() {
1403	}	1817	[
1404		1818	map {
1405	$map	1819	utf8::decode $_;
		1820	/\.map$/
		1821	? normalise $_
		1822	: ()
		1823	} @{ aio_readdir $TMPDIR or [] }
		1824	]
1406	}	1825	}
1407		1826
1408	sub emergency_save {	1827	=item $maps = cf::map::random_maps
1409	my $freeze_guard = cf::freeze_mainloop;
1410		1828
1411	warn "enter emergency map save\n";	1829	Returns an arrayref with all map paths of currently instantiated and saved
		1830	random maps. May block.
1412		1831
1413	cf::sync_job {	1832	=cut
1414	warn "begin emergency map save\n";
1415	$_->save for values %cf::MAP;
1416	};
1417		1833
1418	warn "end emergency map save\n";	1834	sub random_maps() {
		1835	[
		1836	map {
		1837	utf8::decode $_;
		1838	/\.map$/
		1839	? normalise "?random/$_"
		1840	: ()
		1841	} @{ aio_readdir $RANDOMDIR or [] }
		1842	]
		1843	}
		1844
		1845	=item cf::map::unique_maps
		1846
		1847	Returns an arrayref of paths of all shared maps that have
		1848	instantiated unique items. May block.
		1849
		1850	=cut
		1851
		1852	sub unique_maps() {
		1853	[
		1854	map {
		1855	utf8::decode $_;
		1856	/\.map$/
		1857	? normalise $_
		1858	: ()
		1859	} @{ aio_readdir $UNIQUEDIR or [] }
		1860	]
1419	}	1861	}
1420		1862
1421	package cf;	1863	package cf;
1422		1864
1423	=back	1865	=back
1424		1866
		1867	=head3 cf::object
		1868
		1869	=cut
		1870
		1871	package cf::object;
		1872
		1873	=over 4
		1874
		1875	=item $ob->inv_recursive
		1876
		1877	Returns the inventory of the object _and_ their inventories, recursively.
		1878
		1879	=cut
		1880
		1881	sub inv_recursive_;
		1882	sub inv_recursive_ {
		1883	map { $_, inv_recursive_ $_->inv } @_
		1884	}
		1885
		1886	sub inv_recursive {
		1887	inv_recursive_ inv $_[0]
		1888	}
		1889
		1890	package cf;
		1891
		1892	=back
1425		1893
1426	=head3 cf::object::player	1894	=head3 cf::object::player
1427		1895
1428	=over 4	1896	=over 4
1429		1897
…		…
1469		1937
1470	=item $player_object->enter_link	1938	=item $player_object->enter_link
1471		1939
1472	Freezes the player and moves him/her to a special map (C<{link}>).	1940	Freezes the player and moves him/her to a special map (C<{link}>).
1473		1941
1474	The player should be reaosnably safe there for short amounts of time. You	1942	The player should be reasonably safe there for short amounts of time. You
1475	I<MUST> call C<leave_link> as soon as possible, though.	1943	I<MUST> call C<leave_link> as soon as possible, though.
1476		1944
		1945	Will never block.
		1946
1477	=item $player_object->leave_link ($map, $x, $y)	1947	=item $player_object->leave_link ($map, $x, $y)
1478		1948
1479	Moves the player out of the specila link map onto the given map. If the	1949	Moves the player out of the special C<{link}> map onto the specified
1480	map is not valid (or omitted), the player will be moved back to the	1950	map. If the map is not valid (or omitted), the player will be moved back
1481	location he/she was before the call to C<enter_link>, or, if that fails,	1951	to the location he/she was before the call to C<enter_link>, or, if that
1482	to the emergency map position.	1952	fails, to the emergency map position.
1483		1953
1484	Might block.	1954	Might block.
1485		1955
1486	=cut	1956	=cut
		1957
		1958	sub link_map {
		1959	unless ($LINK_MAP) {
		1960	$LINK_MAP = cf::map::find "{link}"
		1961	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1962	$LINK_MAP->load;
		1963	}
		1964
		1965	$LINK_MAP
		1966	}
1487		1967
1488	sub cf::object::player::enter_link {	1968	sub cf::object::player::enter_link {
1489	my ($self) = @_;	1969	my ($self) = @_;
1490		1970
1491	$self->deactivate_recursive;	1971	$self->deactivate_recursive;
1492		1972
1493	return if $self->map == $LINK_MAP;	1973	return if UNIVERSAL::isa $self->map, "ext::map_link";
1494		1974
1495	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	1975	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1496	if $self->map;	1976	if $self->map && $self->map->{path} ne "{link}";
1497		1977
1498	$self->enter_map ($LINK_MAP, 20, 20);	1978	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1499	}	1979	}
1500		1980
1501	sub cf::object::player::leave_link {	1981	sub cf::object::player::leave_link {
1502	my ($self, $map, $x, $y) = @_;	1982	my ($self, $map, $x, $y) = @_;
		1983
		1984	return unless $self->contr->active;
1503		1985
1504	my $link_pos = delete $self->{_link_pos};	1986	my $link_pos = delete $self->{_link_pos};
1505		1987
1506	unless ($map) {	1988	unless ($map) {
1507	# restore original map position	1989	# restore original map position
…		…
1521	# use -1 or undef as default coordinates, not 0, 0	2003	# use -1 or undef as default coordinates, not 0, 0
1522	($x, $y) = ($map->enter_x, $map->enter_y)	2004	($x, $y) = ($map->enter_x, $map->enter_y)
1523	if $x <=0 && $y <= 0;	2005	if $x <=0 && $y <= 0;
1524		2006
1525	$map->load;	2007	$map->load;
		2008	$map->load_diag;
1526		2009
		2010	return unless $self->contr->active;
1527	$self->activate_recursive;	2011	$self->activate_recursive;
		2012
		2013	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1528	$self->enter_map ($map, $x, $y);	2014	$self->enter_map ($map, $x, $y);
1529	}	2015	}
1530		2016
1531	cf::player->attach (
1532	on_logout => sub {
1533	my ($pl) = @_;
1534
1535	# abort map switching before logout
1536	if ($pl->ob->{_link_pos}) {
1537	cf::sync_job {
1538	$pl->ob->leave_link
1539	};
1540	}
1541	},
1542	on_login => sub {
1543	my ($pl) = @_;
1544
1545	# try to abort aborted map switching on player login :)
1546	# should happen only on crashes
1547	if ($pl->ob->{_link_pos}) {
1548
1549	$pl->ob->enter_link;
1550	(Coro::async_pool {
1551	# we need this sleep as the login has a concurrent enter_exit running
1552	# and this sleep increases chances of the player not ending up in scorn
1553	Coro::Timer::sleep 1;
1554	$pl->ob->leave_link;
1555	})->prio (2);
1556	}
1557	},
1558	);
1559
1560	=item $player_object->goto ($path, $x, $y)	2017	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1561		2018
		2019	Moves the player to the given map-path and coordinates by first freezing
		2020	her, loading and preparing them map, calling the provided $check callback
		2021	that has to return the map if sucecssful, and then unfreezes the player on
		2022	the new (success) or old (failed) map position.
		2023
1562	=cut	2024	=cut
		2025
		2026	our $GOTOGEN;
1563		2027
1564	sub cf::object::player::goto {	2028	sub cf::object::player::goto {
1565	my ($self, $path, $x, $y) = @_;	2029	my ($self, $path, $x, $y, $check) = @_;
		2030
		2031	# do generation counting so two concurrent goto's will be executed in-order
		2032	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1566		2033
1567	$self->enter_link;	2034	$self->enter_link;
1568		2035
1569	(Coro::async_pool {	2036	(async {
1570	$path = new cf::path $path;	2037	my $map = eval {
1571
1572	my $map = cf::map::find $path->as_string;	2038	my $map = cf::map::find $path;
		2039
		2040	if ($map) {
1573	$map = $map->customise_for ($self) if $map;	2041	$map = $map->customise_for ($self);
1574		2042	$map = $check->($map) if $check && $map;
1575	# warn "entering ", $map->path, " at ($x, $y)\n"	2043	} else {
1576	# if $map;
1577
1578	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2044	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2045	}
1579		2046
		2047	$map
		2048	};
		2049
		2050	if ($@) {
		2051	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2052	LOG llevError | logBacktrace, Carp::longmess $@;
		2053	}
		2054
		2055	if ($gen == $self->{_goto_generation}) {
		2056	delete $self->{_goto_generation};
1580	$self->leave_link ($map, $x, $y);	2057	$self->leave_link ($map, $x, $y);
		2058	}
1581	})->prio (1);	2059	})->prio (1);
1582	}	2060	}
1583		2061
1584	=item $player_object->enter_exit ($exit_object)	2062	=item $player_object->enter_exit ($exit_object)
1585		2063
…		…
1587		2065
1588	sub parse_random_map_params {	2066	sub parse_random_map_params {
1589	my ($spec) = @_;	2067	my ($spec) = @_;
1590		2068
1591	my $rmp = { # defaults	2069	my $rmp = { # defaults
1592	xsize => 10,	2070	xsize => (cf::rndm 15, 40),
1593	ysize => 10,	2071	ysize => (cf::rndm 15, 40),
		2072	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2073	#layout => string,
1594	};	2074	};
1595		2075
1596	for (split /\n/, $spec) {	2076	for (split /\n/, $spec) {
1597	my ($k, $v) = split /\s+/, $_, 2;	2077	my ($k, $v) = split /\s+/, $_, 2;
1598		2078
…		…
1602	$rmp	2082	$rmp
1603	}	2083	}
1604		2084
1605	sub prepare_random_map {	2085	sub prepare_random_map {
1606	my ($exit) = @_;	2086	my ($exit) = @_;
		2087
		2088	my $guard = cf::lock_acquire "exit_prepare:$exit";
1607		2089
1608	# all this does is basically replace the /! path by	2090	# all this does is basically replace the /! path by
1609	# a new random map path (?random/...) with a seed	2091	# a new random map path (?random/...) with a seed
1610	# that depends on the exit object	2092	# that depends on the exit object
1611		2093
1612	my $rmp = parse_random_map_params $exit->msg;	2094	my $rmp = parse_random_map_params $exit->msg;
1613		2095
1614	if ($exit->map) {	2096	if ($exit->map) {
1615	$rmp->{region} = $exit->map->region_name;	2097	$rmp->{region} = $exit->region->name;
1616	$rmp->{origin_map} = $exit->map->path;	2098	$rmp->{origin_map} = $exit->map->path;
1617	$rmp->{origin_x} = $exit->x;	2099	$rmp->{origin_x} = $exit->x;
1618	$rmp->{origin_y} = $exit->y;	2100	$rmp->{origin_y} = $exit->y;
1619	}	2101	}
1620		2102
1621	$rmp->{random_seed} ||= $exit->random_seed;	2103	$rmp->{random_seed} ||= $exit->random_seed;
1622		2104
1623	my $data = cf::to_json $rmp;	2105	my $data = cf::to_json $rmp;
1624	my $md5 = Digest::MD5::md5_hex $data;	2106	my $md5 = Digest::MD5::md5_hex $data;
		2107	my $meta = "$RANDOMDIR/$md5.meta";
1625		2108
1626	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2109	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1627	aio_write $fh, 0, (length $data), $data, 0;	2110	aio_write $fh, 0, (length $data), $data, 0;
		2111	undef $fh;
		2112	aio_rename "$meta~", $meta;
1628		2113
1629	$exit->slaying ("?random/$md5");	2114	$exit->slaying ("?random/$md5");
1630	$exit->msg (undef);	2115	$exit->msg (undef);
1631	}	2116	}
1632	}	2117	}
…		…
1634	sub cf::object::player::enter_exit {	2119	sub cf::object::player::enter_exit {
1635	my ($self, $exit) = @_;	2120	my ($self, $exit) = @_;
1636		2121
1637	return unless $self->type == cf::PLAYER;	2122	return unless $self->type == cf::PLAYER;
1638		2123
		2124	if ($exit->slaying eq "/!") {
		2125	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2126	# the problem is that $exit might not survive long enough
		2127	# so it needs to be done right now, right here
		2128	cf::sync_job { prepare_random_map $exit };
		2129	}
		2130
		2131	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2132	my $hp = $exit->stats->hp;
		2133	my $sp = $exit->stats->sp;
		2134
1639	$self->enter_link;	2135	$self->enter_link;
1640		2136
1641	(Coro::async_pool {	2137	(async {
1642	$self->deactivate_recursive; # just to be sure	2138	$self->deactivate_recursive; # just to be sure
1643	unless (eval {	2139	unless (eval {
1644	prepare_random_map $exit	2140	$self->goto ($slaying, $hp, $sp);
1645	if $exit->slaying eq "/!";
1646
1647	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1648	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1649		2141
1650	1;	2142	1;
1651	}) {	2143	}) {
1652	$self->message ("Something went wrong deep within the crossfire server. "	2144	$self->message ("Something went wrong deep within the crossfire server. "
1653	. "I'll try to bring you back to the map you were before. "	2145	. "I'll try to bring you back to the map you were before. "
1654	. "Please report this to the dungeon master",	2146	. "Please report this to the dungeon master!",
1655	cf::NDI_UNIQUE | cf::NDI_RED);	2147	cf::NDI_UNIQUE | cf::NDI_RED);
1656		2148
1657	warn "ERROR in enter_exit: $@";	2149	warn "ERROR in enter_exit: $@";
1658	$self->leave_link;	2150	$self->leave_link;
1659	}	2151	}
1660	})->prio (1);	2152	})->prio (1);
…		…
1673		2165
1674	sub cf::client::send_drawinfo {	2166	sub cf::client::send_drawinfo {
1675	my ($self, $text, $flags) = @_;	2167	my ($self, $text, $flags) = @_;
1676		2168
1677	utf8::encode $text;	2169	utf8::encode $text;
1678	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2170	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1679	}	2171	}
1680		2172
		2173	=item $client->ext_event ($type, %msg)
		2174
		2175	Sends an exti event to the client.
		2176
		2177	=cut
		2178
		2179	sub cf::client::ext_event($$%) {
		2180	my ($self, $type, %msg) = @_;
		2181
		2182	$msg{msgtype} = "event_$type";
		2183	$self->send_packet ("ext " . cf::to_json \%msg);
		2184	}
1681		2185
1682	=item $success = $client->query ($flags, "text", \&cb)	2186	=item $success = $client->query ($flags, "text", \&cb)
1683		2187
1684	Queues a query to the client, calling the given callback with	2188	Queues a query to the client, calling the given callback with
1685	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2189	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
1714	# get handled first	2218	# get handled first
1715	my $queue = delete $ns->{query_queue}	2219	my $queue = delete $ns->{query_queue}
1716	or return; # be conservative, not sure how that can happen, but we saw a crash here	2220	or return; # be conservative, not sure how that can happen, but we saw a crash here
1717		2221
1718	(shift @$queue)->[1]->($msg);	2222	(shift @$queue)->[1]->($msg);
		2223	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1719		2224
1720	push @{ $ns->{query_queue} }, @$queue;	2225	push @{ $ns->{query_queue} }, @$queue;
1721		2226
1722	if (@{ $ns->{query_queue} } == @$queue) {	2227	if (@{ $ns->{query_queue} } == @$queue) {
1723	if (@$queue) {	2228	if (@$queue) {
…		…
1727	}	2232	}
1728	}	2233	}
1729	},	2234	},
1730	);	2235	);
1731		2236
1732	=item $client->coro (\&cb)	2237	=item $client->async (\&cb)
1733		2238
1734	Create a new coroutine, running the specified callback. The coroutine will	2239	Create a new coroutine, running the specified callback. The coroutine will
1735	be automatically cancelled when the client gets destroyed (e.g. on logout,	2240	be automatically cancelled when the client gets destroyed (e.g. on logout,
1736	or loss of connection).	2241	or loss of connection).
1737		2242
1738	=cut	2243	=cut
1739		2244
1740	sub cf::client::coro {	2245	sub cf::client::async {
1741	my ($self, $cb) = @_;	2246	my ($self, $cb) = @_;
1742		2247
1743	my $coro = &Coro::async_pool ($cb);	2248	my $coro = &Coro::async ($cb);
1744		2249
1745	$coro->on_destroy (sub {	2250	$coro->on_destroy (sub {
1746	delete $self->{_coro}{$coro+0};	2251	delete $self->{_coro}{$coro+0};
1747	});	2252	});
1748		2253
…		…
1781		2286
1782	# here we export the classes and methods available to script code	2287	# here we export the classes and methods available to script code
1783		2288
1784	=pod	2289	=pod
1785		2290
1786	The following fucntions and emthods are available within a safe environment:	2291	The following functions and methods are available within a safe environment:
1787		2292
1788	cf::object contr pay_amount pay_player map	2293	cf::object contr pay_amount pay_player map
1789	cf::object::player player	2294	cf::object::player player
1790	cf::player peaceful	2295	cf::player peaceful
1791	cf::map trigger	2296	cf::map trigger
…		…
1876	#############################################################################	2381	#############################################################################
1877		2382
1878	=head2 EXTENSION DATABASE SUPPORT	2383	=head2 EXTENSION DATABASE SUPPORT
1879		2384
1880	Crossfire maintains a very simple database for extension use. It can	2385	Crossfire maintains a very simple database for extension use. It can
1881	currently store anything that can be serialised using Storable, which	2386	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
1882	excludes objects.	2387	convert to/from binary).
1883		2388
1884	The parameter C<$family> should best start with the name of the extension	2389	The parameter C<$family> should best start with the name of the extension
1885	using it, it should be unique.	2390	using it, it should be unique.
1886		2391
1887	=over 4	2392	=over 4
1888		2393
1889	=item $hashref = cf::db_get $family
1890
1891	Return a hashref for use by the extension C<$family>, which can be
1892	modified. After modifications, you have to call C<cf::db_dirty> or
1893	C<cf::db_sync>.
1894
1895	=item $value = cf::db_get $family => $key	2394	=item $value = cf::db_get $family => $key
1896		2395
1897	Returns a single value from the database	2396	Returns a single value from the database.
1898
1899	=item cf::db_put $family => $hashref
1900
1901	Stores the given family hashref into the database. Updates are delayed, if
1902	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1903		2397
1904	=item cf::db_put $family => $key => $value	2398	=item cf::db_put $family => $key => $value
1905		2399
1906	Stores the given C<$value> in the family hash. Updates are delayed, if you	2400	Stores the given C<$value> in the family.
1907	want the data to be synced to disk immediately, use C<cf::db_sync>.
1908
1909	=item cf::db_dirty
1910
1911	Marks the database as dirty, to be updated at a later time.
1912
1913	=item cf::db_sync
1914
1915	Immediately write the database to disk I<if it is dirty>.
1916		2401
1917	=cut	2402	=cut
1918		2403
1919	our $DB;	2404	our $DB;
1920		2405
1921	{	2406	sub db_init {
1922	my $path = cf::localdir . "/database.pst";	2407	unless ($DB) {
		2408	$DB = BDB::db_create $DB_ENV;
1923		2409
1924	sub db_load() {	2410	cf::sync_job {
1925	$DB = stat $path ? Storable::retrieve $path : { };	2411	eval {
1926	}	2412	$DB->set_flags (BDB::CHKSUM);
1927		2413
1928	my $pid;	2414	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1929		2415	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1930	sub db_save() {	2416	cf::cleanup "db_open(db): $!" if $!;
1931	waitpid $pid, 0 if $pid;	2417	};
1932	if (0 == ($pid = fork)) {	2418	cf::cleanup "db_open(db): $@" if $@;
1933	$DB->{_meta}{version} = 1;
1934	Storable::nstore $DB, "$path~";
1935	rename "$path~", $path;
1936	cf::_exit 0 if defined $pid;
1937	}	2419	};
1938	}
1939
1940	my $dirty;
1941
1942	sub db_sync() {
1943	db_save if $dirty;
1944	undef $dirty;
1945	}
1946
1947	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1948	db_sync;
1949	});	2420	}
		2421	}
1950		2422
1951	sub db_dirty() {
1952	$dirty = 1;
1953	$idle->start;
1954	}
1955
1956	sub db_get($;$) {	2423	sub db_get($$) {
1957	@_ >= 2	2424	my $key = "$_[0]/$_[1]";
1958	? $DB->{$_[0]}{$_[1]}
1959	: ($DB->{$_[0]} ||= { })
1960	}
1961		2425
		2426	cf::sync_job {
		2427	BDB::db_get $DB, undef, $key, my $data;
		2428
		2429	$! ? ()
		2430	: $data
		2431	}
		2432	}
		2433
1962	sub db_put($$;$) {	2434	sub db_put($$$) {
1963	if (@_ >= 3) {	2435	BDB::dbreq_pri 4;
1964	$DB->{$_[0]}{$_[1]} = $_[2];	2436	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1965	} else {	2437	}
1966	$DB->{$_[0]} = $_[1];
1967	}
1968	db_dirty;
1969	}
1970		2438
1971	cf::global->attach (	2439	=item cf::cache $id => [$paths...], $processversion => $process
1972	prio => 10000,	2440
1973	on_cleanup => sub {	2441	Generic caching function that returns the value of the resource $id,
1974	db_sync;	2442	caching and regenerating as required.
		2443
		2444	This function can block.
		2445
		2446	=cut
		2447
		2448	sub cache {
		2449	my ($id, $src, $processversion, $process) = @_;
		2450
		2451	my $meta =
		2452	join "\x00",
		2453	$processversion,
		2454	map {
		2455	aio_stat $_
		2456	and Carp::croak "$_: $!";
		2457
		2458	($_, (stat _)[7,9])
		2459	} @$src;
		2460
		2461	my $dbmeta = db_get cache => "$id/meta";
		2462	if ($dbmeta ne $meta) {
		2463	# changed, we may need to process
		2464
		2465	my @data;
		2466	my $md5;
		2467
		2468	for (0 .. $#$src) {
		2469	0 <= aio_load $src->[$_], $data[$_]
		2470	or Carp::croak "$src->[$_]: $!";
1975	},	2471	}
1976	);	2472
		2473	# if processing is expensive, check
		2474	# checksum first
		2475	if (1) {
		2476	$md5 =
		2477	join "\x00",
		2478	$processversion,
		2479	map {
		2480	Coro::cede;
		2481	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2482	} 0.. $#$src;
		2483
		2484
		2485	my $dbmd5 = db_get cache => "$id/md5";
		2486	if ($dbmd5 eq $md5) {
		2487	db_put cache => "$id/meta", $meta;
		2488
		2489	return db_get cache => "$id/data";
		2490	}
		2491	}
		2492
		2493	my $t1 = Time::HiRes::time;
		2494	my $data = $process->(\@data);
		2495	my $t2 = Time::HiRes::time;
		2496
		2497	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2498
		2499	db_put cache => "$id/data", $data;
		2500	db_put cache => "$id/md5" , $md5;
		2501	db_put cache => "$id/meta", $meta;
		2502
		2503	return $data;
		2504	}
		2505
		2506	db_get cache => "$id/data"
		2507	}
		2508
		2509	=item fork_call { }, $args
		2510
		2511	Executes the given code block with the given arguments in a seperate
		2512	process, returning the results. Everything must be serialisable with
		2513	Coro::Storable. May, of course, block. Note that the executed sub may
		2514	never block itself or use any form of Event handling.
		2515
		2516	=cut
		2517
		2518	sub fork_call(&@) {
		2519	my ($cb, @args) = @_;
		2520
		2521	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2522	# or die "socketpair: $!";
		2523	pipe my $fh1, my $fh2
		2524	or die "pipe: $!";
		2525
		2526	if (my $pid = fork) {
		2527	close $fh2;
		2528
		2529	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2530	$res = Coro::Storable::thaw $res;
		2531
		2532	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2533
		2534	die $$res unless "ARRAY" eq ref $res;
		2535
		2536	return wantarray ? @$res : $res->[-1];
		2537	} else {
		2538	reset_signals;
		2539	local $SIG{__WARN__};
		2540	local $SIG{__DIE__};
		2541	eval {
		2542	close $fh1;
		2543
		2544	my @res = eval { $cb->(@args) };
		2545	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2546	};
		2547
		2548	warn $@ if $@;
		2549	_exit 0;
		2550	}
1977	}	2551	}
1978		2552
1979	#############################################################################	2553	#############################################################################
1980	# the server's main()	2554	# the server's init and main functions
		2555
		2556	sub load_facedata($) {
		2557	my ($path) = @_;
		2558
		2559	warn "loading facedata from $path\n";
		2560
		2561	my $facedata;
		2562	0 < aio_load $path, $facedata
		2563	or die "$path: $!";
		2564
		2565	$facedata = Coro::Storable::thaw $facedata;
		2566
		2567	$facedata->{version} == 2
		2568	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2569
		2570	{
		2571	my $faces = $facedata->{faceinfo};
		2572
		2573	while (my ($face, $info) = each %$faces) {
		2574	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2575	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2576	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2577	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2578	Coro::cede;
		2579	}
		2580
		2581	while (my ($face, $info) = each %$faces) {
		2582	next unless $info->{smooth};
		2583	my $idx = cf::face::find $face
		2584	or next;
		2585	if (my $smooth = cf::face::find $info->{smooth}) {
		2586	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2587	} else {
		2588	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2589	}
		2590	Coro::cede;
		2591	}
		2592	}
		2593
		2594	{
		2595	my $anims = $facedata->{animinfo};
		2596
		2597	while (my ($anim, $info) = each %$anims) {
		2598	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2599	Coro::cede;
		2600	}
		2601
		2602	cf::anim::invalidate_all; # d'oh
		2603	}
		2604
		2605	1
		2606	}
		2607
		2608	sub reload_regions {
		2609	load_resource_file "$MAPDIR/regions"
		2610	or die "unable to load regions file\n";
		2611	}
		2612
		2613	sub reload_facedata {
		2614	load_facedata "$DATADIR/facedata"
		2615	or die "unable to load facedata\n";
		2616	}
		2617
		2618	sub reload_archetypes {
		2619	load_resource_file "$DATADIR/archetypes"
		2620	or die "unable to load archetypes\n";
		2621	}
		2622
		2623	sub reload_treasures {
		2624	load_resource_file "$DATADIR/treasures"
		2625	or die "unable to load treasurelists\n";
		2626	}
		2627
		2628	sub reload_resources {
		2629	warn "reloading resource files...\n";
		2630
		2631	reload_regions;
		2632	reload_facedata;
		2633	#reload_archetypes;#d#
		2634	reload_archetypes;
		2635	reload_treasures;
		2636
		2637	warn "finished reloading resource files\n";
		2638	}
		2639
		2640	sub init {
		2641	reload_resources;
		2642	}
1981		2643
1982	sub cfg_load {	2644	sub cfg_load {
1983	open my $fh, "<:utf8", cf::confdir . "/config"	2645	open my $fh, "<:utf8", "$CONFDIR/config"
1984	or return;	2646	or return;
1985		2647
1986	local $/;	2648	local $/;
1987	*CFG = YAML::Syck::Load <$fh>;	2649	*CFG = YAML::Syck::Load <$fh>;
1988		2650
…		…
1991	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};	2653	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
1992	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};	2654	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
1993		2655
1994	if (exists $CFG{mlockall}) {	2656	if (exists $CFG{mlockall}) {
1995	eval {	2657	eval {
1996	$CFG{mlockall} ? &mlockall : &munlockall	2658	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1997	and die "WARNING: m(un)lockall failed: $!\n";	2659	and die "WARNING: m(un)lockall failed: $!\n";
1998	};	2660	};
1999	warn $@ if $@;	2661	warn $@ if $@;
2000	}	2662	}
2001	}	2663	}
2002		2664
2003	sub main {	2665	sub main {
2004	# we must not ever block the main coroutine	2666	# we must not ever block the main coroutine
2005	local $Coro::idle = sub {	2667	local $Coro::idle = sub {
2006	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	2668	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2007	Coro::async_pool { Event::one_event };	2669	(async {
		2670	Event::one_event;
		2671	})->prio (Coro::PRIO_MAX);
2008	};	2672	};
2009		2673
2010	cfg_load;	2674	cfg_load;
2011	db_load;	2675	db_init;
2012	load_extensions;	2676	load_extensions;
		2677
		2678	$TICK_WATCHER->start;
2013	Event::loop;	2679	Event::loop;
2014	}	2680	}
2015		2681
2016	#############################################################################	2682	#############################################################################
2017	# initialisation	2683	# initialisation and cleanup
2018		2684
		2685	# install some emergency cleanup handlers
		2686	BEGIN {
		2687	for my $signal (qw(INT HUP TERM)) {
		2688	Event->signal (
		2689	reentrant => 0,
		2690	data => WF_AUTOCANCEL,
		2691	signal => $signal,
		2692	prio => 0,
		2693	cb => sub {
		2694	cf::cleanup "SIG$signal";
		2695	},
		2696	);
		2697	}
		2698	}
		2699
		2700	sub emergency_save() {
		2701	my $freeze_guard = cf::freeze_mainloop;
		2702
		2703	warn "enter emergency perl save\n";
		2704
		2705	cf::sync_job {
		2706	# use a peculiar iteration method to avoid tripping on perl
		2707	# refcount bugs in for. also avoids problems with players
		2708	# and maps saved/destroyed asynchronously.
		2709	warn "begin emergency player save\n";
		2710	for my $login (keys %cf::PLAYER) {
		2711	my $pl = $cf::PLAYER{$login} or next;
		2712	$pl->valid or next;
		2713	$pl->save;
		2714	}
		2715	warn "end emergency player save\n";
		2716
		2717	warn "begin emergency map save\n";
		2718	for my $path (keys %cf::MAP) {
		2719	my $map = $cf::MAP{$path} or next;
		2720	$map->valid or next;
		2721	$map->save;
		2722	}
		2723	warn "end emergency map save\n";
		2724
		2725	warn "begin emergency database checkpoint\n";
		2726	BDB::db_env_txn_checkpoint $DB_ENV;
		2727	warn "end emergency database checkpoint\n";
		2728	};
		2729
		2730	warn "leave emergency perl save\n";
		2731	}
		2732
		2733	sub post_cleanup {
		2734	my ($make_core) = @_;
		2735
		2736	warn Carp::longmess "post_cleanup backtrace"
		2737	if $make_core;
		2738	}
		2739
2019	sub reload() {	2740	sub do_reload_perl() {
2020	# can/must only be called in main	2741	# can/must only be called in main
2021	if ($Coro::current != $Coro::main) {	2742	if ($Coro::current != $Coro::main) {
2022	warn "can only reload from main coroutine\n";	2743	warn "can only reload from main coroutine";
2023	return;	2744	return;
2024	}	2745	}
2025		2746
2026	warn "reloading...";	2747	warn "reloading...";
2027		2748
2028	my $guard = freeze_mainloop;	2749	warn "entering sync_job";
		2750
		2751	cf::sync_job {
		2752	cf::write_runtime; # external watchdog should not bark
2029	cf::emergency_save;	2753	cf::emergency_save;
		2754	cf::write_runtime; # external watchdog should not bark
2030		2755
2031	eval {	2756	warn "syncing database to disk";
		2757	BDB::db_env_txn_checkpoint $DB_ENV;
		2758
2032	# if anything goes wrong in here, we should simply crash as we already saved	2759	# if anything goes wrong in here, we should simply crash as we already saved
2033		2760
2034	# cancel all watchers	2761	warn "cancelling all WF_AUTOCANCEL watchers";
2035	for (Event::all_watchers) {	2762	for (Event::all_watchers) {
2036	$_->cancel if $_->data & WF_AUTOCANCEL;	2763	$_->cancel if $_->data & WF_AUTOCANCEL;
2037	}	2764	}
2038		2765
		2766	warn "flushing outstanding aio requests";
		2767	for (;;) {
		2768	BDB::flush;
		2769	IO::AIO::flush;
		2770	Coro::cede;
		2771	last unless IO::AIO::nreqs || BDB::nreqs;
		2772	warn "iterate...";
		2773	}
		2774
		2775	++$RELOAD;
		2776
2039	# cancel all extension coros	2777	warn "cancelling all extension coros";
2040	$_->cancel for values %EXT_CORO;	2778	$_->cancel for values %EXT_CORO;
2041	%EXT_CORO = ();	2779	%EXT_CORO = ();
2042		2780
2043	# unload all extensions	2781	warn "removing commands";
2044	for (@exts) {	2782	%COMMAND = ();
		2783
		2784	warn "removing ext commands";
		2785	%EXTCMD = ();
		2786
		2787	warn "unloading/nuking all extensions";
		2788	for my $pkg (@EXTS) {
2045	warn "unloading <$_>";	2789	warn "... unloading $pkg";
2046	unload_extension $_;	2790
		2791	if (my $cb = $pkg->can ("unload")) {
		2792	eval {
		2793	$cb->($pkg);
		2794	1
		2795	} or warn "$pkg unloaded, but with errors: $@";
2047	}	2796	}
2048		2797
		2798	warn "... nuking $pkg";
		2799	Symbol::delete_package $pkg;
		2800	}
		2801
2049	# unload all modules loaded from $LIBDIR	2802	warn "unloading all perl modules loaded from $LIBDIR";
2050	while (my ($k, $v) = each %INC) {	2803	while (my ($k, $v) = each %INC) {
2051	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2804	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2052		2805
2053	warn "removing <$k>";	2806	warn "... unloading $k";
2054	delete $INC{$k};	2807	delete $INC{$k};
2055		2808
2056	$k =~ s/\.pm$//;	2809	$k =~ s/\.pm$//;
2057	$k =~ s/\//::/g;	2810	$k =~ s/\//::/g;
2058		2811
…		…
2061	}	2814	}
2062		2815
2063	Symbol::delete_package $k;	2816	Symbol::delete_package $k;
2064	}	2817	}
2065		2818
2066	# sync database to disk
2067	cf::db_sync;
2068	IO::AIO::flush;
2069
2070	# get rid of safe::, as good as possible	2819	warn "getting rid of safe::, as good as possible";
2071	Symbol::delete_package "safe::$_"	2820	Symbol::delete_package "safe::$_"
2072	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2821	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2073		2822
2074	# remove register_script_function callbacks
2075	# TODO
2076
2077	# unload cf.pm "a bit"	2823	warn "unloading cf.pm \"a bit\"";
2078	delete $INC{"cf.pm"};	2824	delete $INC{"cf.pm"};
		2825	delete $INC{"cf/pod.pm"};
2079		2826
2080	# don't, removes xs symbols, too,	2827	# don't, removes xs symbols, too,
2081	# and global variables created in xs	2828	# and global variables created in xs
2082	#Symbol::delete_package __PACKAGE__;	2829	#Symbol::delete_package __PACKAGE__;
2083		2830
2084	# reload cf.pm	2831	warn "unload completed, starting to reload now";
		2832
2085	warn "reloading cf.pm";	2833	warn "reloading cf.pm";
2086	require cf;	2834	require cf;
2087	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	2835	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2088		2836
2089	# load config and database again	2837	warn "loading config and database again";
2090	cf::cfg_load;	2838	cf::cfg_load;
2091	cf::db_load;
2092		2839
2093	# load extensions
2094	warn "load extensions";	2840	warn "loading extensions";
2095	cf::load_extensions;	2841	cf::load_extensions;
2096		2842
2097	# reattach attachments to objects	2843	warn "reattaching attachments to objects/players";
2098	warn "reattach";	2844	_global_reattach; # objects, sockets
2099	_global_reattach;	2845	warn "reattaching attachments to maps";
2100	};	2846	reattach $_ for values %MAP;
		2847	warn "reattaching attachments to players";
		2848	reattach $_ for values %PLAYER;
2101		2849
2102	if ($@) {	2850	warn "leaving sync_job";
		2851
		2852	1
		2853	} or do {
2103	warn $@;	2854	warn $@;
2104	warn "error while reloading, exiting.";	2855	warn "error while reloading, exiting.";
2105	exit 1;	2856	exit 1;
2106	}	2857	};
2107		2858
2108	warn "reloaded successfully";	2859	warn "reloaded";
2109	};	2860	};
2110		2861
2111	#############################################################################	2862	our $RELOAD_WATCHER; # used only during reload
2112		2863
2113	unless ($LINK_MAP) {	2864	sub reload_perl() {
2114	$LINK_MAP = cf::map::new;	2865	# doing reload synchronously and two reloads happen back-to-back,
		2866	# coro crashes during coro_state_free->destroy here.
2115		2867
2116	$LINK_MAP->width (41);	2868	$RELOAD_WATCHER ||= Event->timer (
2117	$LINK_MAP->height (41);	2869	reentrant => 0,
2118	$LINK_MAP->alloc;
2119	$LINK_MAP->path ("{link}");
2120	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2121	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2122
2123	# dirty hack because... archetypes are not yet loaded
2124	Event->timer (
2125	after => 2,	2870	after => 0,
		2871	data => WF_AUTOCANCEL,
2126	cb => sub {	2872	cb => sub {
2127	$_[0]->w->cancel;	2873	do_reload_perl;
2128		2874	undef $RELOAD_WATCHER;
2129	# provide some exits "home"
2130	my $exit = cf::object::new "exit";
2131
2132	$exit->slaying ($EMERGENCY_POSITION->[0]);
2133	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2134	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2135
2136	$LINK_MAP->insert ($exit->clone, 19, 19);
2137	$LINK_MAP->insert ($exit->clone, 19, 20);
2138	$LINK_MAP->insert ($exit->clone, 19, 21);
2139	$LINK_MAP->insert ($exit->clone, 20, 19);
2140	$LINK_MAP->insert ($exit->clone, 20, 21);
2141	$LINK_MAP->insert ($exit->clone, 21, 19);
2142	$LINK_MAP->insert ($exit->clone, 21, 20);
2143	$LINK_MAP->insert ($exit->clone, 21, 21);
2144
2145	$exit->destroy;
2146	});	2875	},
2147		2876	);
2148	$LINK_MAP->{deny_save} = 1;
2149	$LINK_MAP->{deny_reset} = 1;
2150
2151	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2152	}	2877	}
2153
2154	register "<global>", __PACKAGE__;
2155		2878
2156	register_command "reload" => sub {	2879	register_command "reload" => sub {
2157	my ($who, $arg) = @_;	2880	my ($who, $arg) = @_;
2158		2881
2159	if ($who->flag (FLAG_WIZ)) {	2882	if ($who->flag (FLAG_WIZ)) {
2160	$who->message ("start of reload.");
2161	reload;
2162	$who->message ("end of reload.");	2883	$who->message ("reloading server.");
		2884	async { reload_perl };
2163	}	2885	}
2164	};	2886	};
2165		2887
2166	unshift @INC, $LIBDIR;	2888	unshift @INC, $LIBDIR;
2167		2889
		2890	my $bug_warning = 0;
		2891
		2892	our @WAIT_FOR_TICK;
		2893	our @WAIT_FOR_TICK_BEGIN;
		2894
		2895	sub wait_for_tick {
		2896	return unless $TICK_WATCHER->is_active;
		2897	return if $Coro::current == $Coro::main;
		2898
		2899	my $signal = new Coro::Signal;
		2900	push @WAIT_FOR_TICK, $signal;
		2901	$signal->wait;
		2902	}
		2903
		2904	sub wait_for_tick_begin {
		2905	return unless $TICK_WATCHER->is_active;
		2906	return if $Coro::current == $Coro::main;
		2907
		2908	my $signal = new Coro::Signal;
		2909	push @WAIT_FOR_TICK_BEGIN, $signal;
		2910	$signal->wait;
		2911	}
		2912
		2913	my $min = 1e6;#d#
		2914	my $avg = 10;
2168	$TICK_WATCHER = Event->timer (	2915	$TICK_WATCHER = Event->timer (
2169	reentrant => 0,	2916	reentrant => 0,
		2917	parked => 1,
2170	prio => 0,	2918	prio => 0,
2171	at => $NEXT_TICK || $TICK,	2919	at => $NEXT_TICK || $TICK,
2172	data => WF_AUTOCANCEL,	2920	data => WF_AUTOCANCEL,
2173	cb => sub {	2921	cb => sub {
		2922	if ($Coro::current != $Coro::main) {
		2923	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2924	unless ++$bug_warning > 10;
		2925	return;
		2926	}
		2927
		2928	$NOW = $tick_start = Event::time;
		2929
2174	cf::server_tick; # one server iteration	2930	cf::server_tick; # one server iteration
		2931
		2932	0 && sync_job {#d#
		2933	for(1..10) {
		2934	my $t = Event::time;
		2935	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2936	or die;
		2937
		2938	$map->width (50);
		2939	$map->height (50);
		2940	$map->alloc;
		2941	$map->_load_objects ("/tmp/x.map", 1);
		2942	my $t = Event::time - $t;
		2943
		2944	#next unless $t < 0.0013;#d#
		2945	if ($t < $min) {
		2946	$min = $t;
		2947	}
		2948	$avg = $avg * 0.99 + $t * 0.01;
		2949	}
		2950	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2951	exit 0;
		2952	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		2953	};
		2954
2175	$RUNTIME += $TICK;	2955	$RUNTIME += $TICK;
2176	$NEXT_TICK += $TICK;	2956	$NEXT_TICK += $TICK;
2177		2957
		2958	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2959	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2960	Coro::async_pool {
		2961	write_runtime
		2962	or warn "ERROR: unable to write runtime file: $!";
		2963	};
		2964	}
		2965
		2966	# my $AFTER = Event::time;
		2967	# warn $AFTER - $NOW;#d#
		2968
		2969	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2970	$sig->send;
		2971	}
		2972	while (my $sig = shift @WAIT_FOR_TICK) {
		2973	$sig->send;
		2974	}
		2975
		2976	$NOW = Event::time;
		2977
2178	# if we are delayed by four ticks or more, skip them all	2978	# if we are delayed by four ticks or more, skip them all
2179	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	2979	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2180		2980
2181	$TICK_WATCHER->at ($NEXT_TICK);	2981	$TICK_WATCHER->at ($NEXT_TICK);
2182	$TICK_WATCHER->start;	2982	$TICK_WATCHER->start;
		2983
		2984	$LOAD = ($NOW - $tick_start) / $TICK;
		2985	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2986
		2987	_post_tick;
		2988
		2989
2183	},	2990	},
2184	);	2991	);
2185		2992
		2993	{
2186	IO::AIO::max_poll_time $TICK * 0.2;	2994	BDB::max_poll_time $TICK * 0.1;
2187		2995	$BDB_POLL_WATCHER = Event->io (
2188	Event->io (	2996	reentrant => 0,
2189	fd => IO::AIO::poll_fileno,	2997	fd => BDB::poll_fileno,
2190	poll => 'r',	2998	poll => 'r',
2191	prio => 5,	2999	prio => 0,
2192	data => WF_AUTOCANCEL,
2193	cb => \&IO::AIO::poll_cb,
2194	);
2195
2196	Event->timer (
2197	data => WF_AUTOCANCEL,	3000	data => WF_AUTOCANCEL,
2198	after => 0,	3001	cb => \&BDB::poll_cb,
2199	interval => 10,	3002	);
2200	cb => sub {	3003	BDB::min_parallel 8;
2201	(Coro::unblock_sub {	3004
2202	write_runtime	3005	BDB::set_sync_prepare {
2203	or warn "ERROR: unable to write runtime file: $!";	3006	my $status;
		3007	my $current = $Coro::current;
		3008	(
		3009	sub {
		3010	$status = $!;
		3011	$current->ready; undef $current;
		3012	},
		3013	sub {
		3014	Coro::schedule while defined $current;
		3015	$! = $status;
		3016	},
		3017	)
		3018	};
		3019
		3020	unless ($DB_ENV) {
		3021	$DB_ENV = BDB::db_env_create;
		3022
		3023	cf::sync_job {
		3024	eval {
		3025	BDB::db_env_open
		3026	$DB_ENV,
		3027	$BDBDIR,
		3028	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3029	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3030	0666;
		3031
		3032	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3033
		3034	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3035	$DB_ENV->set_lk_detect;
		3036	};
		3037
		3038	cf::cleanup "db_env_open(db): $@" if $@;
2204	})->();	3039	};
2205	},	3040	}
2206	);	3041	}
		3042
		3043	{
		3044	IO::AIO::min_parallel 8;
		3045
		3046	undef $Coro::AIO::WATCHER;
		3047	IO::AIO::max_poll_time $TICK * 0.1;
		3048	$AIO_POLL_WATCHER = Event->io (
		3049	reentrant => 0,
		3050	data => WF_AUTOCANCEL,
		3051	fd => IO::AIO::poll_fileno,
		3052	poll => 'r',
		3053	prio => 6,
		3054	cb => \&IO::AIO::poll_cb,
		3055	);
		3056	}
		3057
		3058	my $_log_backtrace;
		3059
		3060	sub _log_backtrace {
		3061	my ($msg, @addr) = @_;
		3062
		3063	$msg =~ s/\n//;
		3064
		3065	# limit the # of concurrent backtraces
		3066	if ($_log_backtrace < 2) {
		3067	++$_log_backtrace;
		3068	async {
		3069	my @bt = fork_call {
		3070	@addr = map { sprintf "%x", $_ } @addr;
		3071	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3072	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3073	or die "addr2line: $!";
		3074
		3075	my @funcs;
		3076	my @res = <$fh>;
		3077	chomp for @res;
		3078	while (@res) {
		3079	my ($func, $line) = splice @res, 0, 2, ();
		3080	push @funcs, "[$func] $line";
		3081	}
		3082
		3083	@funcs
		3084	};
		3085
		3086	LOG llevInfo, "[ABT] $msg\n";
		3087	LOG llevInfo, "[ABT] $_\n" for @bt;
		3088	--$_log_backtrace;
		3089	};
		3090	} else {
		3091	LOG llevInfo, "[ABT] $msg\n";
		3092	LOG llevInfo, "[ABT] [suppressed]\n";
		3093	}
		3094	}
		3095
		3096	# load additional modules
		3097	use cf::pod;
2207		3098
2208	END { cf::emergency_save }	3099	END { cf::emergency_save }
2209		3100
2210	1	3101	1
2211		3102

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines