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.138 by root, Fri Jan 5 17:07:17 2007 UTC vs.
Revision 1.349 by root, Fri Aug 31 04:10:43 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.64 ();
		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;
		24	use Coro::Util ();
19		25
		26	use JSON::XS ();
		27	use BDB ();
		28	use Data::Dumper;
20	use Digest::MD5;	29	use Digest::MD5;
21	use Fcntl;	30	use Fcntl;
22	use IO::AIO 2.31 ();
23	use YAML::Syck ();	31	use YAML::Syck ();
		32	use IO::AIO 2.32 ();
24	use Time::HiRes;	33	use Time::HiRes;
		34	use Compress::LZF;
		35	use Digest::MD5 ();
25		36
		37	# configure various modules to our taste
		38	#
		39	$Storable::canonical = 1; # reduce rsync transfers
		40	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
		41	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		42
26	use Event; $Event::Eval = 1; # no idea why this is required, but it is	43	$Event::Eval = 1; # no idea why this is required, but it is
27		44
28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	45	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29	$YAML::Syck::ImplicitUnicode = 1;	46	$YAML::Syck::ImplicitUnicode = 1;
30		47
31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority	48	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32		49
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	50	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		51
35	our %COMMAND = ();	52	our %COMMAND = ();
36	our %COMMAND_TIME = ();	53	our %COMMAND_TIME = ();
		54
		55	our @EXTS = (); # list of extension package names
37	our %EXTCMD = ();	56	our %EXTCMD = ();
		57	our %EXTICMD = ();
		58	our %EXT_CORO = (); # coroutines bound to extensions
		59	our %EXT_MAP = (); # pluggable maps
38		60
		61	our $RELOAD; # number of reloads so far
39	our @EVENT;	62	our @EVENT;
40	our $LIBDIR = datadir . "/ext";
41		63
42	our $TICK = MAX_TIME * 1e-6;	64	our $CONFDIR = confdir;
		65	our $DATADIR = datadir;
		66	our $LIBDIR = "$DATADIR/ext";
		67	our $PODDIR = "$DATADIR/pod";
		68	our $MAPDIR = "$DATADIR/" . mapdir;
		69	our $LOCALDIR = localdir;
		70	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		71	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		72	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		73	our $RANDOMDIR = "$LOCALDIR/random";
		74	our $BDBDIR = "$LOCALDIR/db";
		75
		76	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43	our $TICK_WATCHER;	77	our $TICK_WATCHER;
		78	our $AIO_POLL_WATCHER;
		79	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44	our $NEXT_TICK;	80	our $NEXT_TICK;
45	our $NOW;	81	our $NOW;
		82	our $USE_FSYNC = 1; # use fsync to write maps - default off
		83
		84	our $BDB_POLL_WATCHER;
		85	our $DB_ENV;
46		86
47	our %CFG;	87	our %CFG;
48		88
49	our $UPTIME; $UPTIME ||= time;	89	our $UPTIME; $UPTIME ||= time;
50	our $RUNTIME;	90	our $RUNTIME;
51		91
		92	our %PLAYER; # all users
52	our %MAP; # all maps	93	our %MAP; # all maps
53	our $LINK_MAP; # the special {link} map	94	our $LINK_MAP; # the special {link} map, which is always available
54	our $RANDOM_MAPS = cf::localdir . "/random";	95
55	our %EXT_CORO;	96	# used to convert map paths into valid unix filenames by replacing / by ∕
		97	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		98
		99	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		100	our $LOADAVG; # same thing, but with alpha-smoothing
		101	our $tick_start; # for load detecting purposes
56		102
57	binmode STDOUT;	103	binmode STDOUT;
58	binmode STDERR;	104	binmode STDERR;
59		105
60	# read virtual server time, if available	106	# read virtual server time, if available
61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	107	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62	open my $fh, "<", cf::localdir . "/runtime"	108	open my $fh, "<", "$LOCALDIR/runtime"
63	or die "unable to read runtime file: $!";	109	or die "unable to read runtime file: $!";
64	$RUNTIME = <$fh> + 0.;	110	$RUNTIME = <$fh> + 0.;
65	}	111	}
66		112
67	mkdir cf::localdir;	113	mkdir $_
68	mkdir cf::localdir . "/" . cf::playerdir;	114	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69	mkdir cf::localdir . "/" . cf::tmpdir;
70	mkdir cf::localdir . "/" . cf::uniquedir;
71	mkdir $RANDOM_MAPS;
72		115
73	# a special map that is always available
74	our $LINK_MAP;
75	our $EMERGENCY_POSITION;	116	our $EMERGENCY_POSITION;
		117
		118	sub cf::map::normalise;
76		119
77	#############################################################################	120	#############################################################################
78		121
79	=head2 GLOBAL VARIABLES	122	=head2 GLOBAL VARIABLES
80		123
…		…
87	=item $cf::RUNTIME	130	=item $cf::RUNTIME
88		131
89	The time this server has run, starts at 0 and is increased by $cf::TICK on	132	The time this server has run, starts at 0 and is increased by $cf::TICK on
90	every server tick.	133	every server tick.
91		134
92	=item $cf::LIBDIR	135	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		136	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		137	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
93		138
94	The perl library directory, where extensions and cf-specific modules can	139	Various directories - "/etc", read-only install directory, perl-library
95	be found. It will be added to C<@INC> automatically.	140	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		141	unique-items directory, player file directory, random maps directory and
		142	database environment.
96		143
97	=item $cf::NOW	144	=item $cf::NOW
98		145
99	The time of the last (current) server tick.	146	The time of the last (current) server tick.
100		147
101	=item $cf::TICK	148	=item $cf::TICK
102		149
103	The interval between server ticks, in seconds.	150	The interval between server ticks, in seconds.
		151
		152	=item $cf::LOADAVG
		153
		154	The current CPU load on the server (alpha-smoothed), as a value between 0
		155	(none) and 1 (overloaded), indicating how much time is spent on processing
		156	objects per tick. Healthy values are < 0.5.
		157
		158	=item $cf::LOAD
		159
		160	The raw value load value from the last tick.
104		161
105	=item %cf::CFG	162	=item %cf::CFG
106		163
107	Configuration for the server, loaded from C</etc/crossfire/config>, or	164	Configuration for the server, loaded from C</etc/crossfire/config>, or
108	from wherever your confdir points to.	165	from wherever your confdir points to.
		166
		167	=item cf::wait_for_tick, cf::wait_for_tick_begin
		168
		169	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
		170	returns directly I<after> the tick processing (and consequently, can only wake one process
		171	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
		172
		173	=item @cf::INVOKE_RESULTS
		174
		175	This array contains the results of the last C<invoke ()> call. When
		176	C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
		177	that call.
109		178
110	=back	179	=back
111		180
112	=cut	181	=cut
113		182
114	BEGIN {	183	BEGIN {
115	*CORE::GLOBAL::warn = sub {	184	*CORE::GLOBAL::warn = sub {
116	my $msg = join "", @_;	185	my $msg = join "", @_;
117	utf8::encode $msg;
118		186
119	$msg .= "\n"	187	$msg .= "\n"
120	unless $msg =~ /\n$/;	188	unless $msg =~ /\n$/;
121		189
		190	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		191
		192	utf8::encode $msg;
122	LOG llevError, "cfperl: $msg";	193	LOG llevError, $msg;
123	};	194	};
124	}	195	}
125		196
126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	197	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	198	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	199	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	200	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	201	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		202	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	203	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
132		204
133	# we bless all objects into (empty) derived classes to force a method lookup	205	# we bless all objects into (empty) derived classes to force a method lookup
134	# within the Safe compartment.	206	# within the Safe compartment.
135	for my $pkg (qw(	207	for my $pkg (qw(
136	cf::global cf::attachable	208	cf::global cf::attachable
…		…
145		217
146	$Event::DIED = sub {	218	$Event::DIED = sub {
147	warn "error in event callback: @_";	219	warn "error in event callback: @_";
148	};	220	};
149		221
150	my %ext_pkg;	222	#############################################################################
151	my @exts;
152	my @hook;
153		223
154	=head2 UTILITY FUNCTIONS	224	=head2 UTILITY FUNCTIONS
155		225
156	=over 4	226	=over 4
157		227
158	=cut	228	=item dumpval $ref
159		229
160	use JSON::Syck (); # TODO# replace by JSON::PC once working	230	=cut
		231
		232	sub dumpval {
		233	eval {
		234	local $SIG{__DIE__};
		235	my $d;
		236	if (1) {
		237	$d = new Data::Dumper([$_[0]], ["*var"]);
		238	$d->Terse(1);
		239	$d->Indent(2);
		240	$d->Quotekeys(0);
		241	$d->Useqq(1);
		242	#$d->Bless(...);
		243	$d->Seen($_[1]) if @_ > 1;
		244	$d = $d->Dump();
		245	}
		246	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		247	$d
		248	} || "[unable to dump $_[0]: '$@']";
		249	}
161		250
162	=item $ref = cf::from_json $json	251	=item $ref = cf::from_json $json
163		252
164	Converts a JSON string into the corresponding perl data structure.	253	Converts a JSON string into the corresponding perl data structure.
165		254
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	255	=item $json = cf::to_json $ref
174		256
175	Converts a perl data structure into its JSON representation.	257	Converts a perl data structure into its JSON representation.
176		258
177	=cut	259	=cut
178		260
179	sub to_json($) {	261	our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	262
181	JSON::Syck::Dump $_[0]	263	sub to_json ($) { $json_coder->encode ($_[0]) }
182	}	264	sub from_json ($) { $json_coder->decode ($_[0]) }
183		265
184	=item cf::lock_wait $string	266	=item cf::lock_wait $string
185		267
186	Wait until the given lock is available. See cf::lock_acquire.	268	Wait until the given lock is available. See cf::lock_acquire.
187		269
…		…
190	Wait until the given lock is available and then acquires it and returns	272	Wait until the given lock is available and then acquires it and returns
191	a Coro::guard object. If the guard object gets destroyed (goes out of scope,	273	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
192	for example when the coroutine gets canceled), the lock is automatically	274	for example when the coroutine gets canceled), the lock is automatically
193	returned.	275	returned.
194		276
		277	Locks are *not* recursive, locking from the same coro twice results in a
		278	deadlocked coro.
		279
195	Lock names should begin with a unique identifier (for example, cf::map::find	280	Lock names should begin with a unique identifier (for example, cf::map::find
196	uses map_find and cf::map::load uses map_load).	281	uses map_find and cf::map::load uses map_load).
		282
		283	=item $locked = cf::lock_active $string
		284
		285	Return true if the lock is currently active, i.e. somebody has locked it.
197		286
198	=cut	287	=cut
199		288
200	our %LOCK;	289	our %LOCK;
201		290
…		…
221	# wake up all waiters, to be on the safe side	310	# wake up all waiters, to be on the safe side
222	$_->ready for @{ delete $LOCK{$key} };	311	$_->ready for @{ delete $LOCK{$key} };
223	}	312	}
224	}	313	}
225		314
		315	sub lock_active($) {
		316	my ($key) = @_;
		317
		318	! ! $LOCK{$key}
		319	}
		320
226	sub freeze_mainloop {	321	sub freeze_mainloop {
227	return unless $TICK_WATCHER->is_active;	322	return unless $TICK_WATCHER->is_active;
228		323
229	my $guard = Coro::guard { $TICK_WATCHER->start };	324	my $guard = Coro::guard {
		325	$TICK_WATCHER->start;
		326	};
230	$TICK_WATCHER->stop;	327	$TICK_WATCHER->stop;
231	$guard	328	$guard
232	}	329	}
233		330
		331	=item cf::get_slot $time[, $priority[, $name]]
		332
		333	Allocate $time seconds of blocking CPU time at priority C<$priority>:
		334	This call blocks and returns only when you have at least C<$time> seconds
		335	of cpu time till the next tick. The slot is only valid till the next cede.
		336
		337	The optional C<$name> can be used to identify the job to run. It might be
		338	used for statistical purposes and should identify the same time-class.
		339
		340	Useful for short background jobs.
		341
		342	=cut
		343
		344	our @SLOT_QUEUE;
		345	our $SLOT_QUEUE;
		346
		347	$SLOT_QUEUE->cancel if $SLOT_QUEUE;
		348	$SLOT_QUEUE = Coro::async {
		349	my $signal = new Coro::Signal;
		350
		351	while () {
		352	next_job:
		353	my $avail = cf::till_tick;
		354	if ($avail > 0.01) {
		355	for (0 .. $#SLOT_QUEUE) {
		356	if ($SLOT_QUEUE[$_][0] < $avail) {
		357	my $job = splice @SLOT_QUEUE, $_, 1, ();
		358	$job->[2]->send;
		359	Coro::cede;
		360	goto next_job;
		361	}
		362	}
		363	}
		364
		365	if (@SLOT_QUEUE) {
		366	# we do not use wait_For_tick() as it returns immediately when tick is inactive
		367	push @cf::WAIT_FOR_TICK, $signal;
		368	$signal->wait;
		369	} else {
		370	Coro::schedule;
		371	}
		372	}
		373	};
		374
		375	sub get_slot($;$$) {
		376	my ($time, $pri, $name) = @_;
		377
		378	$time = $TICK * .6 if $time > $TICK * .6;
		379	my $sig = new Coro::Signal;
		380
		381	push @SLOT_QUEUE, [$time, $pri, $sig, $name];
		382	@SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
		383	$SLOT_QUEUE->ready;
		384	$sig->wait;
		385	}
		386
		387	=item cf::async { BLOCK }
		388
		389	Currently the same as Coro::async_pool, meaning you cannot use
		390	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		391	thing you are allowed to do is call C<prio> on it.
		392
		393	=cut
		394
		395	BEGIN { *async = \&Coro::async_pool }
		396
234	=item cf::sync_job { BLOCK }	397	=item cf::sync_job { BLOCK }
235		398
236	The design of crossfire+ requires that the main coro ($Coro::main) is	399	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
237	always able to handle events or runnable, as crossfire+ is only partly	400	is always able to handle events or runnable, as Crossfire TRT is only
238	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	401	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		402	acceptable.
239		403
240	If it must be done, put the blocking parts into C<sync_job>. This will run	404	If it must be done, put the blocking parts into C<sync_job>. This will run
241	the given BLOCK in another coroutine while waiting for the result. The	405	the given BLOCK in another coroutine while waiting for the result. The
242	server will be frozen during this time, so the block should either finish	406	server will be frozen during this time, so the block should either finish
243	fast or be very important.	407	fast or be very important.
…		…
246		410
247	sub sync_job(&) {	411	sub sync_job(&) {
248	my ($job) = @_;	412	my ($job) = @_;
249		413
250	if ($Coro::current == $Coro::main) {	414	if ($Coro::current == $Coro::main) {
		415	my $time = Event::time;
		416
251	# this is the main coro, too bad, we have to block	417	# this is the main coro, too bad, we have to block
252	# till the operation succeeds, freezing the server :/	418	# till the operation succeeds, freezing the server :/
253		419
254	# TODO: use suspend/resume instead	420	# TODO: use suspend/resume instead
255	# (but this is cancel-safe)	421	# (but this is cancel-safe)
256	my $freeze_guard = freeze_mainloop;	422	my $freeze_guard = freeze_mainloop;
257		423
258	my $busy = 1;	424	my $busy = 1;
259	my @res;	425	my @res;
260		426
261	(Coro::async_pool {	427	(async {
262	@res = eval { $job->() };	428	@res = eval { $job->() };
263	warn $@ if $@;	429	warn $@ if $@;
264	undef $busy;	430	undef $busy;
265	})->prio (Coro::PRIO_MAX);	431	})->prio (Coro::PRIO_MAX);
266		432
267	while ($busy) {	433	while ($busy) {
268	Coro::cede_notself;	434	Coro::cede or Event::one_event;
269	Event::one_event unless Coro::nready;
270	}	435	}
		436
		437	$time = Event::time - $time;
		438
		439	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		440	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		441
		442	$tick_start += $time; # do not account sync jobs to server load
271		443
272	wantarray ? @res : $res[0]	444	wantarray ? @res : $res[0]
273	} else {	445	} else {
274	# we are in another coroutine, how wonderful, everything just works	446	# we are in another coroutine, how wonderful, everything just works
275		447
276	$job->()	448	$job->()
277	}	449	}
278	}	450	}
279		451
280	=item $coro = cf::coro { BLOCK }	452	=item $coro = cf::async_ext { BLOCK }
281		453
282	Creates (and readies) and returns a new coro. This coro is automcatially	454	Like async, but this coro is automatically being canceled when the
283	being canceled when the extension calling this is being unloaded.	455	extension calling this is being unloaded.
284		456
285	=cut	457	=cut
286		458
287	sub coro(&) {	459	sub async_ext(&) {
288	my $cb = shift;	460	my $cb = shift;
289		461
290	my $coro = &Coro::async_pool ($cb);	462	my $coro = &Coro::async ($cb);
291		463
292	$coro->on_destroy (sub {	464	$coro->on_destroy (sub {
293	delete $EXT_CORO{$coro+0};	465	delete $EXT_CORO{$coro+0};
294	});	466	});
295	$EXT_CORO{$coro+0} = $coro;	467	$EXT_CORO{$coro+0} = $coro;
296		468
297	$coro	469	$coro
298	}	470	}
299		471
300	sub write_runtime {	472	=item fork_call { }, $args
301	my $runtime = cf::localdir . "/runtime";
302		473
303	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	474	Executes the given code block with the given arguments in a seperate
304	or return;	475	process, returning the results. Everything must be serialisable with
		476	Coro::Storable. May, of course, block. Note that the executed sub may
		477	never block itself or use any form of Event handling.
305		478
306	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock	479	=cut
307	(aio_write $fh, 0, (length $value), $value, 0) <= 0
308	and return;
309		480
310	aio_fsync $fh	481	sub fork_call(&@) {
311	and return;	482	my ($cb, @args) = @_;
312		483
313	close $fh	484	# we seemingly have to make a local copy of the whole thing,
314	or return;	485	# otherwise perl prematurely frees the stuff :/
		486	# TODO: investigate and fix (liekly this will be rather laborious)
315		487
316	aio_rename "$runtime~", $runtime	488	my @res = Coro::Util::fork_eval {
317	and return;	489	reset_signals;
		490	&$cb
		491	}, @args;
318		492
		493	wantarray ? @res : $res[-1]
		494	}
		495
		496	=item $value = cf::db_get $family => $key
		497
		498	Returns a single value from the environment database.
		499
		500	=item cf::db_put $family => $key => $value
		501
		502	Stores the given C<$value> in the family. It can currently store binary
		503	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		504
		505	=cut
		506
		507	our $DB;
		508
		509	sub db_init {
		510	unless ($DB) {
		511	$DB = BDB::db_create $DB_ENV;
		512
		513	cf::sync_job {
		514	eval {
		515	$DB->set_flags (BDB::CHKSUM);
		516
		517	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		518	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		519	cf::cleanup "db_open(db): $!" if $!;
		520	};
		521	cf::cleanup "db_open(db): $@" if $@;
		522	};
319	1	523	}
		524	}
		525
		526	sub db_get($$) {
		527	my $key = "$_[0]/$_[1]";
		528
		529	cf::sync_job {
		530	BDB::db_get $DB, undef, $key, my $data;
		531
		532	$! ? ()
		533	: $data
		534	}
		535	}
		536
		537	sub db_put($$$) {
		538	BDB::dbreq_pri 4;
		539	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		540	}
		541
		542	=item cf::cache $id => [$paths...], $processversion => $process
		543
		544	Generic caching function that returns the value of the resource $id,
		545	caching and regenerating as required.
		546
		547	This function can block.
		548
		549	=cut
		550
		551	sub cache {
		552	my ($id, $src, $processversion, $process) = @_;
		553
		554	my $meta =
		555	join "\x00",
		556	$processversion,
		557	map {
		558	aio_stat $_
		559	and Carp::croak "$_: $!";
		560
		561	($_, (stat _)[7,9])
		562	} @$src;
		563
		564	my $dbmeta = db_get cache => "$id/meta";
		565	if ($dbmeta ne $meta) {
		566	# changed, we may need to process
		567
		568	my @data;
		569	my $md5;
		570
		571	for (0 .. $#$src) {
		572	0 <= aio_load $src->[$_], $data[$_]
		573	or Carp::croak "$src->[$_]: $!";
		574	}
		575
		576	# if processing is expensive, check
		577	# checksum first
		578	if (1) {
		579	$md5 =
		580	join "\x00",
		581	$processversion,
		582	map {
		583	cf::cede_to_tick;
		584	($src->[$_], Digest::MD5::md5_hex $data[$_])
		585	} 0.. $#$src;
		586
		587
		588	my $dbmd5 = db_get cache => "$id/md5";
		589	if ($dbmd5 eq $md5) {
		590	db_put cache => "$id/meta", $meta;
		591
		592	return db_get cache => "$id/data";
		593	}
		594	}
		595
		596	my $t1 = Time::HiRes::time;
		597	my $data = $process->(\@data);
		598	my $t2 = Time::HiRes::time;
		599
		600	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		601
		602	db_put cache => "$id/data", $data;
		603	db_put cache => "$id/md5" , $md5;
		604	db_put cache => "$id/meta", $meta;
		605
		606	return $data;
		607	}
		608
		609	db_get cache => "$id/data"
		610	}
		611
		612	=item cf::datalog type => key => value, ...
		613
		614	Log a datalog packet of the given type with the given key-value pairs.
		615
		616	=cut
		617
		618	sub datalog($@) {
		619	my ($type, %kv) = @_;
		620	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
320	}	621	}
321		622
322	=back	623	=back
323		624
324	=cut	625	=cut
325
326	#############################################################################
327
328	package cf::path;
329
330	sub new {
331	my ($class, $path, $base) = @_;
332
333	$path = $path->as_string if ref $path;
334
335	my $self = bless { }, $class;
336
337	# {... are special paths that are not touched
338	# ?xxx/... are special absolute paths
339	# ?random/... random maps
340	# /! non-realised random map exit
341	# /... normal maps
342	# ~/... per-player maps without a specific player (DO NOT USE)
343	# ~user/... per-player map of a specific user
344
345	if ($path =~ /^{/) {
346	# fine as it is
347	} elsif ($path =~ s{^\?random/}{}) {
348	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
349	$self->{random} = cf::from_json $data;
350	} else {
351	if ($path =~ s{^~([^/]+)?}{}) {
352	$self->{user_rel} = 1;
353
354	if (defined $1) {
355	$self->{user} = $1;
356	} elsif ($base =~ m{^~([^/]+)/}) {
357	$self->{user} = $1;
358	} else {
359	warn "cannot resolve user-relative path without user <$path,$base>\n";
360	}
361	} elsif ($path =~ /^\//) {
362	# already absolute
363	} else {
364	$base =~ s{[^/]+/?$}{};
365	return $class->new ("$base/$path");
366	}
367
368	for ($path) {
369	redo if s{/\.?/}{/};
370	redo if s{/[^/]+/\.\./}{/};
371	}
372	}
373
374	$self->{path} = $path;
375
376	$self
377	}
378
379	# the name / primary key / in-game path
380	sub as_string {
381	my ($self) = @_;
382
383	$self->{user_rel} ? "~$self->{user}$self->{path}"
384	: $self->{random} ? "?random/$self->{path}"
385	: $self->{path}
386	}
387
388	# the displayed name, this is a one way mapping
389	sub visible_name {
390	my ($self) = @_;
391
392	# if (my $rmp = $self->{random}) {
393	# # todo: be more intelligent about this
394	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
395	# } else {
396	$self->as_string
397	# }
398	}
399
400	# escape the /'s in the path
401	sub _escaped_path {
402	# ∕ is U+2215
403	(my $path = $_[0]{path}) =~ s/\//∕/g;
404	$path
405	}
406
407	# the original (read-only) location
408	sub load_path {
409	my ($self) = @_;
410
411	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
412	}
413
414	# the temporary/swap location
415	sub save_path {
416	my ($self) = @_;
417
418	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
419	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
420	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
421	}
422
423	# the unique path, might be eq to save_path
424	sub uniq_path {
425	my ($self) = @_;
426
427	$self->{user_rel} || $self->{random}
428	? undef
429	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
430	}
431
432	# return random map parameters, or undef
433	sub random_map_params {
434	my ($self) = @_;
435
436	$self->{random}
437	}
438
439	# this is somewhat ugly, but style maps do need special treatment
440	sub is_style_map {
441	$_[0]{path} =~ m{^/styles/}
442	}
443
444	package cf;
445		626
446	#############################################################################	627	#############################################################################
447		628
448	=head2 ATTACHABLE OBJECTS	629	=head2 ATTACHABLE OBJECTS
449		630
…		…
451	attach callbacks/event handlers (a collection of which is called an "attachment")	632	attach callbacks/event handlers (a collection of which is called an "attachment")
452	to it. All such attachable objects support the following methods.	633	to it. All such attachable objects support the following methods.
453		634
454	In the following description, CLASS can be any of C<global>, C<object>	635	In the following description, CLASS can be any of C<global>, C<object>
455	C<player>, C<client> or C<map> (i.e. the attachable objects in	636	C<player>, C<client> or C<map> (i.e. the attachable objects in
456	crossfire+).	637	Crossfire TRT).
457		638
458	=over 4	639	=over 4
459		640
460	=item $attachable->attach ($attachment, key => $value...)	641	=item $attachable->attach ($attachment, key => $value...)
461		642
…		…
575	our @CB_TYPE = (); # registry for type (cf-object class) based events	756	our @CB_TYPE = (); # registry for type (cf-object class) based events
576	our @CB_MAP = ();	757	our @CB_MAP = ();
577		758
578	my %attachment;	759	my %attachment;
579		760
		761	sub cf::attachable::thawer_merge {
		762	# simply override everything except _meta
		763	local $_[0]{_meta};
		764	%{$_[0]} = %{$_[1]};
		765	}
		766
580	sub _attach_cb($$$$) {	767	sub _attach_cb($$$$) {
581	my ($registry, $event, $prio, $cb) = @_;	768	my ($registry, $event, $prio, $cb) = @_;
582		769
583	use sort 'stable';	770	use sort 'stable';
584		771
…		…
618	$registry = $CB_TYPE[$object_type] ||= [];	805	$registry = $CB_TYPE[$object_type] ||= [];
619		806
620	} elsif ($type eq "subtype") {	807	} elsif ($type eq "subtype") {
621	defined $object_type or Carp::croak "subtype specified without type";	808	defined $object_type or Carp::croak "subtype specified without type";
622	my $object_subtype = shift @arg;	809	my $object_subtype = shift @arg;
623	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	810	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
624		811
625	} elsif ($type eq "package") {	812	} elsif ($type eq "package") {
626	my $pkg = shift @arg;	813	my $pkg = shift @arg;
627		814
628	while (my ($name, $id) = each %cb_id) {	815	while (my ($name, $id) = each %cb_id) {
…		…
657	_attach $registry, $klass, @attach;	844	_attach $registry, $klass, @attach;
658	}	845	}
659		846
660	$obj->{$name} = \%arg;	847	$obj->{$name} = \%arg;
661	} else {	848	} else {
662	warn "object uses attachment '$name' that is not available, postponing.\n";	849	warn "object uses attachment '$name' which is not available, postponing.\n";
663	}	850	}
664		851
665	$obj->{_attachment}{$name} = undef;	852	$obj->{_attachment}{$name} = undef;
666	}	853	}
667		854
…		…
669	if (ref $_[0]) {	856	if (ref $_[0]) {
670	_object_attach @_;	857	_object_attach @_;
671	} else {	858	} else {
672	_attach shift->_attach_registry, @_;	859	_attach shift->_attach_registry, @_;
673	}	860	}
		861	_recalc_want;
674	};	862	};
675		863
676	# all those should be optimised	864	# all those should be optimised
677	sub cf::attachable::detach {	865	sub cf::attachable::detach {
678	my ($obj, $name) = @_;	866	my ($obj, $name) = @_;
…		…
681	delete $obj->{_attachment}{$name};	869	delete $obj->{_attachment}{$name};
682	reattach ($obj);	870	reattach ($obj);
683	} else {	871	} else {
684	Carp::croak "cannot, currently, detach class attachments";	872	Carp::croak "cannot, currently, detach class attachments";
685	}	873	}
		874	_recalc_want;
686	};	875	};
687		876
688	sub cf::attachable::attached {	877	sub cf::attachable::attached {
689	my ($obj, $name) = @_;	878	my ($obj, $name) = @_;
690		879
…		…
705	";	894	";
706	die if $@;	895	die if $@;
707	}	896	}
708		897
709	our $override;	898	our $override;
710	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?	899	our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
711		900
712	sub override {	901	sub override {
713	$override = 1;	902	$override = 1;
714	@invoke_results = ();	903	@INVOKE_RESULTS = (@_);
715	}	904	}
716		905
717	sub do_invoke {	906	sub do_invoke {
718	my $event = shift;	907	my $event = shift;
719	my $callbacks = shift;	908	my $callbacks = shift;
720		909
721	@invoke_results = ();	910	@INVOKE_RESULTS = ();
722		911
723	local $override;	912	local $override;
724		913
725	for (@$callbacks) {	914	for (@$callbacks) {
726	eval { &{$_->[1]} };	915	eval { &{$_->[1]} };
…		…
743		932
744	Generate an object-specific event with the given arguments.	933	Generate an object-specific event with the given arguments.
745		934
746	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be	935	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
747	removed in future versions), and there is no public API to access override	936	removed in future versions), and there is no public API to access override
748	results (if you must, access C<@cf::invoke_results> directly).	937	results (if you must, access C<@cf::INVOKE_RESULTS> directly).
749		938
750	=back	939	=back
751		940
752	=cut	941	=cut
753		942
754	#############################################################################	943	#############################################################################
755	# object support	944	# object support
		945	#
		946
		947	sub _can_merge {
		948	my ($ob1, $ob2) = @_;
		949
		950	local $Storable::canonical = 1;
		951	my $fob1 = Storable::freeze $ob1;
		952	my $fob2 = Storable::freeze $ob2;
		953
		954	$fob1 eq $fob2
		955	}
756		956
757	sub reattach {	957	sub reattach {
758	# basically do the same as instantiate, without calling instantiate	958	# basically do the same as instantiate, without calling instantiate
759	my ($obj) = @_;	959	my ($obj) = @_;
		960
		961	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
760		962
761	my $registry = $obj->registry;	963	my $registry = $obj->registry;
762		964
763	@$registry = ();	965	@$registry = ();
764		966
…		…
811	$filename, length $$rdata, scalar @$objs;	1013	$filename, length $$rdata, scalar @$objs;
812		1014
813	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {	1015	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
814	chmod SAVE_MODE, $fh;	1016	chmod SAVE_MODE, $fh;
815	aio_write $fh, 0, (length $$rdata), $$rdata, 0;	1017	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
816	aio_fsync $fh;	1018	aio_fsync $fh if $cf::USE_FSYNC;
817	close $fh;	1019	close $fh;
818		1020
819	if (@$objs) {	1021	if (@$objs) {
820	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {	1022	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
821	chmod SAVE_MODE, $fh;	1023	chmod SAVE_MODE, $fh;
822	my $data = Storable::nfreeze { version => 1, objs => $objs };	1024	my $data = Storable::nfreeze { version => 1, objs => $objs };
823	aio_write $fh, 0, (length $data), $data, 0;	1025	aio_write $fh, 0, (length $data), $data, 0;
824	aio_fsync $fh;	1026	aio_fsync $fh if $cf::USE_FSYNC;
825	close $fh;	1027	close $fh;
826	aio_rename "$filename.pst~", "$filename.pst";	1028	aio_rename "$filename.pst~", "$filename.pst";
827	}	1029	}
828	} else {	1030	} else {
829	aio_unlink "$filename.pst";	1031	aio_unlink "$filename.pst";
…		…
861	or return;	1063	or return;
862	$av = eval { (Storable::thaw $av)->{objs} };	1064	$av = eval { (Storable::thaw $av)->{objs} };
863	}	1065	}
864		1066
865	warn sprintf "loading %s (%d)\n",	1067	warn sprintf "loading %s (%d)\n",
866	$filename, length $data, scalar @{$av || []};#d#	1068	$filename, length $data, scalar @{$av || []};
867	return ($data, $av);	1069	return ($data, $av);
868	}	1070	}
		1071
		1072	=head2 COMMAND CALLBACKS
		1073
		1074	=over 4
		1075
		1076	=cut
869		1077
870	#############################################################################	1078	#############################################################################
871	# command handling &c	1079	# command handling &c
872		1080
873	=item cf::register_command $name => \&callback($ob,$args);	1081	=item cf::register_command $name => \&callback($ob,$args);
…		…
886	push @{ $COMMAND{$name} }, [$caller, $cb];	1094	push @{ $COMMAND{$name} }, [$caller, $cb];
887	}	1095	}
888		1096
889	=item cf::register_extcmd $name => \&callback($pl,$packet);	1097	=item cf::register_extcmd $name => \&callback($pl,$packet);
890		1098
891	Register a callbackf ro execution when the client sends an extcmd packet.	1099	Register a callback for execution when the client sends an (synchronous)
		1100	extcmd packet. Ext commands will be processed in the order they are
		1101	received by the server, like other user commands. The first argument is
		1102	the logged-in player. Ext commands can only be processed after a player
		1103	has logged in successfully.
892		1104
893	If the callback returns something, it is sent back as if reply was being	1105	If the callback returns something, it is sent back as if reply was being
894	called.	1106	called.
895		1107
		1108	=item cf::register_exticmd $name => \&callback($ns,$packet);
		1109
		1110	Register a callback for execution when the client sends an (asynchronous)
		1111	exticmd packet. Exti commands are processed by the server as soon as they
		1112	are received, i.e. out of order w.r.t. other commands. The first argument
		1113	is a client socket. Exti commands can be received anytime, even before
		1114	log-in.
		1115
		1116	If the callback returns something, it is sent back as if reply was being
		1117	called.
		1118
896	=cut	1119	=cut
897		1120
898	sub register_extcmd {	1121	sub register_extcmd {
899	my ($name, $cb) = @_;	1122	my ($name, $cb) = @_;
900		1123
901	my $caller = caller;
902	#warn "registering extcmd '$name' to '$caller'";
903
904	$EXTCMD{$name} = [$cb, $caller];	1124	$EXTCMD{$name} = $cb;
		1125	}
		1126
		1127	sub register_exticmd {
		1128	my ($name, $cb) = @_;
		1129
		1130	$EXTICMD{$name} = $cb;
905	}	1131	}
906		1132
907	cf::player->attach (	1133	cf::player->attach (
908	on_command => sub {	1134	on_command => sub {
909	my ($pl, $name, $params) = @_;	1135	my ($pl, $name, $params) = @_;
…		…
918	cf::override;	1144	cf::override;
919	},	1145	},
920	on_extcmd => sub {	1146	on_extcmd => sub {
921	my ($pl, $buf) = @_;	1147	my ($pl, $buf) = @_;
922		1148
923	my $msg = eval { from_json $buf };	1149	my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
924		1150
925	if (ref $msg) {	1151	if (ref $msg) {
		1152	my ($type, $reply, @payload) =
		1153	"ARRAY" eq ref $msg
		1154	? @$msg
		1155	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		1156
		1157	my @reply;
		1158
926	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	1159	if (my $cb = $EXTCMD{$type}) {
927	if (my %reply = $cb->[0]->($pl, $msg)) {	1160	@reply = $cb->($pl, @payload);
928	$pl->ext_reply ($msg->{msgid}, %reply);
929	}
930	}	1161	}
		1162
		1163	$pl->ext_reply ($reply, @reply)
		1164	if $reply;
		1165
931	} else {	1166	} else {
932	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1167	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
933	}	1168	}
934		1169
935	cf::override;	1170	cf::override;
936	},	1171	},
937	);	1172	);
938		1173
939	sub register {
940	my ($base, $pkg) = @_;
941
942	#TODO
943	}
944
945	sub load_extension {	1174	sub load_extensions {
		1175	cf::sync_job {
		1176	my %todo;
		1177
		1178	for my $path (<$LIBDIR/*.ext>) {
		1179	next unless -r $path;
		1180
		1181	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1182	my $base = $1;
		1183	my $pkg = $1;
		1184	$pkg =~ s/[^[:word:]]/_/g;
		1185	$pkg = "ext::$pkg";
		1186
		1187	open my $fh, "<:utf8", $path
		1188	or die "$path: $!";
		1189
		1190	my $source = do { local $/; <$fh> };
		1191
		1192	my %ext = (
		1193	path => $path,
		1194	base => $base,
		1195	pkg => $pkg,
		1196	);
		1197
		1198	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1199	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1200
		1201	$ext{source} =
		1202	"package $pkg; use strict; use utf8;\n"
		1203	. "#line 1 \"$path\"\n{\n"
		1204	. $source
		1205	. "\n};\n1";
		1206
		1207	$todo{$base} = \%ext;
		1208	}
		1209
		1210	my %done;
		1211	while (%todo) {
		1212	my $progress;
		1213
		1214	while (my ($k, $v) = each %todo) {
		1215	for (split /,\s*/, $v->{meta}{depends}) {
		1216	goto skip
		1217	unless exists $done{$_};
		1218	}
		1219
		1220	warn "... loading '$k' into '$v->{pkg}'\n";
		1221
		1222	unless (eval $v->{source}) {
		1223	my $msg = $@ ? "$v->{path}: $@\n"
		1224	: "$v->{base}: extension inactive.\n";
		1225
		1226	if (exists $v->{meta}{mandatory}) {
		1227	warn $msg;
		1228	warn "mandatory extension failed to load, exiting.\n";
		1229	exit 1;
		1230	}
		1231
		1232	warn $msg;
		1233	}
		1234
		1235	$done{$k} = delete $todo{$k};
		1236	push @EXTS, $v->{pkg};
		1237	$progress = 1;
		1238	}
		1239
		1240	skip:
		1241	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1242	unless $progress;
		1243	}
		1244	};
		1245	}
		1246
		1247	#############################################################################
		1248
		1249	=back
		1250
		1251	=head2 CORE EXTENSIONS
		1252
		1253	Functions and methods that extend core crossfire objects.
		1254
		1255	=cut
		1256
		1257	package cf::player;
		1258
		1259	use Coro::AIO;
		1260
		1261	=head3 cf::player
		1262
		1263	=over 4
		1264
		1265	=item cf::player::find $login
		1266
		1267	Returns the given player object, loading it if necessary (might block).
		1268
		1269	=cut
		1270
		1271	sub playerdir($) {
		1272	"$PLAYERDIR/"
		1273	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1274	}
		1275
		1276	sub path($) {
		1277	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1278
		1279	(playerdir $login) . "/playerdata"
		1280	}
		1281
		1282	sub find_active($) {
		1283	$cf::PLAYER{$_[0]}
		1284	and $cf::PLAYER{$_[0]}->active
		1285	and $cf::PLAYER{$_[0]}
		1286	}
		1287
		1288	sub exists($) {
		1289	my ($login) = @_;
		1290
		1291	$cf::PLAYER{$login}
		1292	or cf::sync_job { !aio_stat path $login }
		1293	}
		1294
		1295	sub find($) {
		1296	return $cf::PLAYER{$_[0]} || do {
		1297	my $login = $_[0];
		1298
		1299	my $guard = cf::lock_acquire "user_find:$login";
		1300
		1301	$cf::PLAYER{$_[0]} || do {
		1302	# rename old playerfiles to new ones
		1303	#TODO: remove when no longer required
		1304	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1305	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1306	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1307	aio_unlink +(playerdir $login) . "/$login.pl";
		1308
		1309	my $pl = load_pl path $login
		1310	or return;
		1311	$cf::PLAYER{$login} = $pl
		1312	}
		1313	}
		1314	}
		1315
		1316	sub save($) {
		1317	my ($pl) = @_;
		1318
		1319	return if $pl->{deny_save};
		1320
		1321	my $path = path $pl;
		1322	my $guard = cf::lock_acquire "user_save:$path";
		1323
		1324	return if $pl->{deny_save};
		1325
		1326	aio_mkdir playerdir $pl, 0770;
		1327	$pl->{last_save} = $cf::RUNTIME;
		1328
		1329	$pl->save_pl ($path);
		1330	cf::cede_to_tick;
		1331	}
		1332
		1333	sub new($) {
		1334	my ($login) = @_;
		1335
		1336	my $self = create;
		1337
		1338	$self->ob->name ($login);
		1339	$self->{deny_save} = 1;
		1340
		1341	$cf::PLAYER{$login} = $self;
		1342
		1343	$self
		1344	}
		1345
		1346	=item $player->send_msg ($channel, $msg, $color, [extra...])
		1347
		1348	=cut
		1349
		1350	sub send_msg {
		1351	my $ns = shift->ns
		1352	or return;
		1353	$ns->send_msg (@_);
		1354	}
		1355
		1356	=item $pl->quit_character
		1357
		1358	Nukes the player without looking back. If logged in, the connection will
		1359	be destroyed. May block for a long time.
		1360
		1361	=cut
		1362
		1363	sub quit_character {
		1364	my ($pl) = @_;
		1365
		1366	my $name = $pl->ob->name;
		1367
		1368	$pl->{deny_save} = 1;
		1369	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1370
		1371	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1372	$pl->deactivate;
		1373	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1374	$pl->ns->destroy if $pl->ns;
		1375
		1376	my $path = playerdir $pl;
		1377	my $temp = "$path~$cf::RUNTIME~deleting~";
		1378	aio_rename $path, $temp;
		1379	delete $cf::PLAYER{$pl->ob->name};
		1380	$pl->destroy;
		1381
		1382	my $prefix = qr<^~\Q$name\E/>;
		1383
		1384	# nuke player maps
		1385	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1386
		1387	IO::AIO::aio_rmtree $temp;
		1388	}
		1389
		1390	=item $pl->kick
		1391
		1392	Kicks a player out of the game. This destroys the connection.
		1393
		1394	=cut
		1395
		1396	sub kick {
		1397	my ($pl, $kicker) = @_;
		1398
		1399	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1400	$pl->killer ("kicked");
		1401	$pl->ns->destroy;
		1402	}
		1403
		1404	=item cf::player::list_logins
		1405
		1406	Returns am arrayref of all valid playernames in the system, can take a
		1407	while and may block, so not sync_job-capable, ever.
		1408
		1409	=cut
		1410
		1411	sub list_logins {
		1412	my $dirs = aio_readdir $PLAYERDIR
		1413	or return [];
		1414
		1415	my @logins;
		1416
		1417	for my $login (@$dirs) {
		1418	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1419	aio_read $fh, 0, 512, my $buf, 0 or next;
		1420	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1421
		1422	utf8::decode $login;
		1423	push @logins, $login;
		1424	}
		1425
		1426	\@logins
		1427	}
		1428
		1429	=item $player->maps
		1430
		1431	Returns an arrayref of map paths that are private for this
		1432	player. May block.
		1433
		1434	=cut
		1435
		1436	sub maps($) {
		1437	my ($pl) = @_;
		1438
		1439	$pl = ref $pl ? $pl->ob->name : $pl;
		1440
		1441	my $files = aio_readdir playerdir $pl
		1442	or return;
		1443
		1444	my @paths;
		1445
		1446	for (@$files) {
		1447	utf8::decode $_;
		1448	next if /\.(?:pl|pst)$/;
		1449	next unless /^$PATH_SEP/o;
		1450
		1451	push @paths, cf::map::normalise "~$pl/$_";
		1452	}
		1453
		1454	\@paths
		1455	}
		1456
		1457	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1458
		1459	Expand crossfire pod fragments into protocol xml.
		1460
		1461	=cut
		1462
		1463	sub expand_cfpod {
		1464	((my $self), (local $_)) = @_;
		1465
		1466	# escape & and <
		1467	s/&/&amp;/g;
		1468	s/(?<![BIUGH])</&lt;/g;
		1469
		1470	# this is buggy, it needs to properly take care of nested <'s
		1471
		1472	1 while
		1473	# replace B<>, I<>, U<> etc.
		1474	s/B<([^\>]*)>/<b>$1<\/b>/
		1475	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1476	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1477	# replace G<male|female> tags
		1478	|| s{G<([^>|]*)\|([^>]*)>}{
		1479	$self->gender ? $2 : $1
		1480	}ge
		1481	# replace H<hint text>
		1482	|| s{H<([^\>]*)>}
		1483	{
		1484	("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
		1485	"<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
		1486	"")
		1487	[$self->{hintmode}]
		1488	}ge;
		1489
		1490	# create single paragraphs (very hackish)
		1491	s/(?<=\S)\n(?=\w)/ /g;
		1492
		1493	# compress some whitespace
		1494	s/\s+\n/\n/g; # ws line-ends
		1495	s/\n\n+/\n/g; # double lines
		1496	s/^\n+//; # beginning lines
		1497	s/\n+$//; # ending lines
		1498
		1499	$_
		1500	}
		1501
		1502	sub hintmode {
		1503	$_[0]{hintmode} = $_[1] if @_ > 1;
		1504	$_[0]{hintmode}
		1505	}
		1506
		1507	=item $player->ext_reply ($msgid, @msg)
		1508
		1509	Sends an ext reply to the player.
		1510
		1511	=cut
		1512
		1513	sub ext_reply($$@) {
		1514	my ($self, $id, @msg) = @_;
		1515
		1516	$self->ns->ext_reply ($id, @msg)
		1517	}
		1518
		1519	=item $player->ext_msg ($type, @msg)
		1520
		1521	Sends an ext event to the client.
		1522
		1523	=cut
		1524
		1525	sub ext_msg($$@) {
		1526	my ($self, $type, @msg) = @_;
		1527
		1528	$self->ns->ext_msg ($type, @msg);
		1529	}
		1530
		1531	=head3 cf::region
		1532
		1533	=over 4
		1534
		1535	=cut
		1536
		1537	package cf::region;
		1538
		1539	=item cf::region::find_by_path $path
		1540
		1541	Tries to decuce the likely region for a map knowing only its path.
		1542
		1543	=cut
		1544
		1545	sub find_by_path($) {
946	my ($path) = @_;	1546	my ($path) = @_;
947		1547
948	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	1548	my ($match, $specificity);
949	my $base = $1;
950	my $pkg = $1;
951	$pkg =~ s/[^[:word:]]/_/g;
952	$pkg = "ext::$pkg";
953		1549
954	warn "loading '$path' into '$pkg'\n";	1550	for my $region (list) {
955		1551	if ($region->{match} && $path =~ $region->{match}) {
956	open my $fh, "<:utf8", $path	1552	($match, $specificity) = ($region, $region->specificity)
957	or die "$path: $!";	1553	if $region->specificity > $specificity;
958		1554	}
959	my $source =
960	"package $pkg; use strict; use utf8;\n"
961	. "#line 1 \"$path\"\n{\n"
962	. (do { local $/; <$fh> })
963	. "\n};\n1";
964
965	eval $source
966	or die $@ ? "$path: $@\n"
967	: "extension disabled.\n";
968
969	push @exts, $pkg;
970	$ext_pkg{$base} = $pkg;
971
972	# no strict 'refs';
973	# @{"$pkg\::ISA"} = ext::;
974
975	register $base, $pkg;
976	}
977
978	sub unload_extension {
979	my ($pkg) = @_;
980
981	warn "removing extension $pkg\n";
982
983	# remove hooks
984	#TODO
985	# for my $idx (0 .. $#PLUGIN_EVENT) {
986	# delete $hook[$idx]{$pkg};
987	# }	1555	}
988		1556
989	# remove commands	1557	$match
990	for my $name (keys %COMMAND) {
991	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
992
993	if (@cb) {
994	$COMMAND{$name} = \@cb;
995	} else {
996	delete $COMMAND{$name};
997	}
998	}
999
1000	# remove extcmds
1001	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1002	delete $EXTCMD{$name};
1003	}
1004
1005	if (my $cb = $pkg->can ("unload")) {
1006	eval {
1007	$cb->($pkg);
1008	1
1009	} or warn "$pkg unloaded, but with errors: $@";
1010	}
1011
1012	Symbol::delete_package $pkg;
1013	}
1014
1015	sub load_extensions {
1016	for my $ext (<$LIBDIR/*.ext>) {
1017	next unless -r $ext;
1018	eval {
1019	load_extension $ext;
1020	1
1021	} or warn "$ext not loaded: $@";
1022	}
1023	}
1024
1025	#############################################################################
1026	# load/save/clean perl data associated with a map
1027
1028	*cf::mapsupport::on_clean = sub {
1029	my ($map) = @_;
1030
1031	my $path = $map->tmpname;
1032	defined $path or return;
1033
1034	unlink "$path.pst";
1035	};
1036
1037	cf::map->attach (prio => -10000, package => cf::mapsupport::);
1038
1039	#############################################################################
1040	# load/save perl data associated with player->ob objects
1041
1042	sub all_objects(@) {
1043	@_, map all_objects ($_->inv), @_
1044	}
1045
1046	# TODO: compatibility cruft, remove when no longer needed
1047	cf::player->attach (
1048	on_load => sub {
1049	my ($pl, $path) = @_;
1050
1051	for my $o (all_objects $pl->ob) {
1052	if (my $value = $o->get_ob_key_value ("_perl_data")) {
1053	$o->set_ob_key_value ("_perl_data");
1054
1055	%$o = %{ Storable::thaw pack "H*", $value };
1056	}
1057	}
1058	},
1059	);
1060
1061	#############################################################################
1062
1063	=head2 CORE EXTENSIONS
1064
1065	Functions and methods that extend core crossfire objects.
1066
1067	=head3 cf::player
1068
1069	=over 4
1070
1071	=item cf::player::exists $login
1072
1073	Returns true when the given account exists.
1074
1075	=cut
1076
1077	sub cf::player::exists($) {
1078	cf::player::find $_[0]
1079	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1080	}
1081
1082	=item $player->ext_reply ($msgid, $msgtype, %msg)
1083
1084	Sends an ext reply to the player.
1085
1086	=cut
1087
1088	sub cf::player::ext_reply($$$%) {
1089	my ($self, $id, %msg) = @_;
1090
1091	$msg{msgid} = $id;
1092
1093	$self->send ("ext " . to_json \%msg);
1094	}	1558	}
1095		1559
1096	=back	1560	=back
1097
1098		1561
1099	=head3 cf::map	1562	=head3 cf::map
1100		1563
1101	=over 4	1564	=over 4
1102		1565
…		…
1105	package cf::map;	1568	package cf::map;
1106		1569
1107	use Fcntl;	1570	use Fcntl;
1108	use Coro::AIO;	1571	use Coro::AIO;
1109		1572
		1573	use overload
		1574	'""' => \&as_string,
		1575	fallback => 1;
		1576
1110	our $MAX_RESET = 3600;	1577	our $MAX_RESET = 3600;
1111	our $DEFAULT_RESET = 3000;	1578	our $DEFAULT_RESET = 3000;
1112		1579
1113	sub generate_random_map {	1580	sub generate_random_map {
1114	my ($path, $rmp) = @_;	1581	my ($self, $rmp) = @_;
1115
1116	# mit "rum" bekleckern, nicht	1582	# mit "rum" bekleckern, nicht
1117	cf::map::_create_random_map	1583	$self->_create_random_map (
1118	$path,
1119	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},	1584	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1120	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},	1585	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1121	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},	1586	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1122	$rmp->{exit_on_final_map},	1587	$rmp->{exit_on_final_map},
1123	$rmp->{xsize}, $rmp->{ysize},	1588	$rmp->{xsize}, $rmp->{ysize},
1124	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},	1589	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1125	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},	1590	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1126	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},	1591	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1127	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},	1592	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1128	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},	1593	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1129	(cf::region::find $rmp->{region})	1594	(cf::region::find $rmp->{region}), $rmp->{custom}
		1595	)
		1596	}
		1597
		1598	=item cf::map->register ($regex, $prio)
		1599
		1600	Register a handler for the map path matching the given regex at the
		1601	givne priority (higher is better, built-in handlers have priority 0, the
		1602	default).
		1603
		1604	=cut
		1605
		1606	sub register {
		1607	my (undef, $regex, $prio) = @_;
		1608	my $pkg = caller;
		1609
		1610	no strict;
		1611	push @{"$pkg\::ISA"}, __PACKAGE__;
		1612
		1613	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1614	}
		1615
		1616	# also paths starting with '/'
		1617	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1618
		1619	sub thawer_merge {
		1620	my ($self, $merge) = @_;
		1621
		1622	# we have to keep some variables in memory intact
		1623	local $self->{path};
		1624	local $self->{load_path};
		1625
		1626	$self->SUPER::thawer_merge ($merge);
		1627	}
		1628
		1629	sub normalise {
		1630	my ($path, $base) = @_;
		1631
		1632	$path = "$path"; # make sure its a string
		1633
		1634	$path =~ s/\.map$//;
		1635
		1636	# map plan:
		1637	#
		1638	# /! non-realised random map exit (special hack!)
		1639	# {... are special paths that are not being touched
		1640	# ?xxx/... are special absolute paths
		1641	# ?random/... random maps
		1642	# /... normal maps
		1643	# ~user/... per-player map of a specific user
		1644
		1645	$path =~ s/$PATH_SEP/\//go;
		1646
		1647	# treat it as relative path if it starts with
		1648	# something that looks reasonable
		1649	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1650	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1651
		1652	$base =~ s{[^/]+/?$}{};
		1653	$path = "$base/$path";
		1654	}
		1655
		1656	for ($path) {
		1657	redo if s{//}{/};
		1658	redo if s{/\.?/}{/};
		1659	redo if s{/[^/]+/\.\./}{/};
		1660	}
		1661
		1662	$path
		1663	}
		1664
		1665	sub new_from_path {
		1666	my (undef, $path, $base) = @_;
		1667
		1668	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1669
		1670	$path = normalise $path, $base;
		1671
		1672	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1673	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1674	my $self = bless cf::map::new, $pkg;
		1675	$self->{path} = $path; $self->path ($path);
		1676	$self->init; # pass $1 etc.
		1677	return $self;
		1678	}
		1679	}
		1680
		1681	Carp::cluck "unable to resolve path '$path' (base '$base').";
		1682	()
		1683	}
		1684
		1685	sub init {
		1686	my ($self) = @_;
		1687
		1688	$self
		1689	}
		1690
		1691	sub as_string {
		1692	my ($self) = @_;
		1693
		1694	"$self->{path}"
		1695	}
		1696
		1697	# the displayed name, this is a one way mapping
		1698	sub visible_name {
		1699	&as_string
		1700	}
		1701
		1702	# the original (read-only) location
		1703	sub load_path {
		1704	my ($self) = @_;
		1705
		1706	"$MAPDIR/$self->{path}.map"
		1707	}
		1708
		1709	# the temporary/swap location
		1710	sub save_path {
		1711	my ($self) = @_;
		1712
		1713	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1714	"$TMPDIR/$path.map"
		1715	}
		1716
		1717	# the unique path, undef == no special unique path
		1718	sub uniq_path {
		1719	my ($self) = @_;
		1720
		1721	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1722	"$UNIQUEDIR/$path"
1130	}	1723	}
1131		1724
1132	# and all this just because we cannot iterate over	1725	# and all this just because we cannot iterate over
1133	# all maps in C++...	1726	# all maps in C++...
1134	sub change_all_map_light {	1727	sub change_all_map_light {
…		…
1136		1729
1137	$_->change_map_light ($change)	1730	$_->change_map_light ($change)
1138	for grep $_->outdoor, values %cf::MAP;	1731	for grep $_->outdoor, values %cf::MAP;
1139	}	1732	}
1140		1733
		1734	sub decay_objects {
		1735	my ($self) = @_;
		1736
		1737	return if $self->{deny_reset};
		1738
		1739	$self->do_decay_objects;
		1740	}
		1741
		1742	sub unlink_save {
		1743	my ($self) = @_;
		1744
		1745	utf8::encode (my $save = $self->save_path);
		1746	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1747	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1748	}
		1749
1141	sub try_load_header($) {	1750	sub load_header_from($) {
1142	my ($path) = @_;	1751	my ($self, $path) = @_;
1143		1752
1144	utf8::encode $path;	1753	utf8::encode $path;
1145	aio_open $path, O_RDONLY, 0	1754	#aio_open $path, O_RDONLY, 0
		1755	# or return;
		1756
		1757	$self->_load_header ($path)
1146	or return;	1758	or return;
1147		1759
1148	my $map = cf::map::new	1760	$self->{load_path} = $path;
		1761
		1762	1
		1763	}
		1764
		1765	sub load_header_orig {
		1766	my ($self) = @_;
		1767
		1768	$self->load_header_from ($self->load_path)
		1769	}
		1770
		1771	sub load_header_temp {
		1772	my ($self) = @_;
		1773
		1774	$self->load_header_from ($self->save_path)
		1775	}
		1776
		1777	sub prepare_temp {
		1778	my ($self) = @_;
		1779
		1780	$self->last_access ((delete $self->{last_access})
		1781	|| $cf::RUNTIME); #d#
		1782	# safety
		1783	$self->{instantiate_time} = $cf::RUNTIME
		1784	if $self->{instantiate_time} > $cf::RUNTIME;
		1785	}
		1786
		1787	sub prepare_orig {
		1788	my ($self) = @_;
		1789
		1790	$self->{load_original} = 1;
		1791	$self->{instantiate_time} = $cf::RUNTIME;
		1792	$self->last_access ($cf::RUNTIME);
		1793	$self->instantiate;
		1794	}
		1795
		1796	sub load_header {
		1797	my ($self) = @_;
		1798
		1799	if ($self->load_header_temp) {
		1800	$self->prepare_temp;
		1801	} else {
		1802	$self->load_header_orig
1149	or return;	1803	or return;
		1804	$self->prepare_orig;
		1805	}
1150		1806
1151	# for better error messages only, will be overwritten	1807	$self->{deny_reset} = 1
1152	$map->path ($path);	1808	if $self->no_reset;
1153		1809
1154	$map->load_header ($path)	1810	$self->default_region (cf::region::find_by_path $self->{path})
1155	or return;	1811	unless $self->default_region;
1156		1812
1157	$map->{load_path} = $path;	1813	1
1158
1159	$map
1160	}	1814	}
1161		1815
1162	sub find;	1816	sub find;
1163	sub find {	1817	sub find {
1164	my ($path, $origin) = @_;	1818	my ($path, $origin) = @_;
1165		1819
1166	#warn "find<$path,$origin>\n";#d#
1167
1168	$path = new cf::path $path, $origin && $origin->path;	1820	$path = normalise $path, $origin && $origin->path;
1169	my $key = $path->as_string;
1170		1821
1171	cf::lock_wait "map_find:$key";	1822	cf::lock_wait "map_find:$path";
1172		1823
1173	$cf::MAP{$key} || do {	1824	$cf::MAP{$path} || do {
1174	my $guard = cf::lock_acquire "map_find:$key";	1825	my $guard = cf::lock_acquire "map_find:$path";
1175		1826	my $map = new_from_path cf::map $path
1176	# do it the slow way
1177	my $map = try_load_header $path->save_path;
1178
1179	Coro::cede;
1180
1181	if ($map) {
1182	$map->last_access ((delete $map->{last_access})
1183	|| $cf::RUNTIME); #d#
1184	# safety
1185	$map->{instantiate_time} = $cf::RUNTIME
1186	if $map->{instantiate_time} > $cf::RUNTIME;
1187	} else {
1188	if (my $rmp = $path->random_map_params) {
1189	$map = generate_random_map $key, $rmp;
1190	} else {
1191	$map = try_load_header $path->load_path;
1192	}
1193
1194	$map or return;	1827	or return;
1195		1828
1196	$map->{load_original} = 1;
1197	$map->{instantiate_time} = $cf::RUNTIME;
1198	$map->last_access ($cf::RUNTIME);
1199	$map->instantiate;
1200
1201	# per-player maps become, after loading, normal maps
1202	$map->per_player (0) if $path->{user_rel};
1203	}
1204
1205	$map->path ($key);
1206	$map->{path} = $path;
1207	$map->{last_save} = $cf::RUNTIME;	1829	$map->{last_save} = $cf::RUNTIME;
1208		1830
1209	Coro::cede;	1831	$map->load_header
		1832	or return;
1210		1833
1211	if ($map->should_reset) {	1834	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
		1835	# doing this can freeze the server in a sync job, obviously
		1836	#$cf::WAIT_FOR_TICK->wait;
1212	$map->reset;	1837	$map->reset;
1213	undef $guard;	1838	undef $guard;
1214	$map = find $path	1839	return find $path;
1215	or return;
1216	}	1840	}
1217		1841
1218	$cf::MAP{$key} = $map	1842	$cf::MAP{$path} = $map
1219	}	1843	}
1220	}	1844	}
		1845
		1846	sub pre_load { }
		1847	sub post_load { }
1221		1848
1222	sub load {	1849	sub load {
1223	my ($self) = @_;	1850	my ($self) = @_;
1224		1851
		1852	local $self->{deny_reset} = 1; # loading can take a long time
		1853
1225	my $path = $self->{path};	1854	my $path = $self->{path};
		1855
		1856	{
		1857	my $guard1 = cf::lock_acquire "map_data:$path";
1226	my $guard = cf::lock_acquire "map_load:" . $path->as_string;	1858	my $guard2 = cf::lock_acquire "map_load:$path";
1227		1859
1228	return if $self->in_memory != cf::MAP_SWAPPED;	1860	return if $self->in_memory != cf::MAP_SWAPPED;
1229		1861
1230	$self->in_memory (cf::MAP_LOADING);	1862	$self->in_memory (cf::MAP_LOADING);
1231		1863
1232	$self->alloc;	1864	$self->alloc;
		1865
		1866	$self->pre_load;
		1867	cf::cede_to_tick;
		1868
1233	$self->load_objects ($self->{load_path}, 1)	1869	$self->_load_objects ($self->{load_path}, 1)
1234	or return;	1870	or return;
1235		1871
1236	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)	1872	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1237	if delete $self->{load_original};	1873	if delete $self->{load_original};
1238		1874
1239	if (my $uniq = $path->uniq_path) {	1875	if (my $uniq = $self->uniq_path) {
1240	utf8::encode $uniq;	1876	utf8::encode $uniq;
1241	if (aio_open $uniq, O_RDONLY, 0) {	1877	if (aio_open $uniq, O_RDONLY, 0) {
1242	$self->clear_unique_items;	1878	$self->clear_unique_items;
1243	$self->load_objects ($uniq, 0);	1879	$self->_load_objects ($uniq, 0);
1244	}	1880	}
1245	}	1881	}
1246		1882
1247	Coro::cede;	1883	cf::cede_to_tick;
1248
1249	# now do the right thing for maps	1884	# now do the right thing for maps
1250	$self->link_multipart_objects;	1885	$self->link_multipart_objects;
1251
1252	if ($self->{path}->is_style_map) {
1253	$self->{deny_save} = 1;
1254	$self->{deny_reset} = 1;
1255	} else {
1256	$self->fix_auto_apply;
1257	$self->decay_objects;
1258	$self->update_buttons;
1259	$self->set_darkness_map;
1260	$self->difficulty ($self->estimate_difficulty)	1886	$self->difficulty ($self->estimate_difficulty)
1261	unless $self->difficulty;	1887	unless $self->difficulty;
		1888	cf::cede_to_tick;
		1889
		1890	unless ($self->{deny_activate}) {
		1891	$self->decay_objects;
		1892	$self->fix_auto_apply;
		1893	$self->update_buttons;
		1894	cf::cede_to_tick;
		1895	$self->set_darkness_map;
		1896	cf::cede_to_tick;
1262	$self->activate;	1897	$self->activate;
1263	}	1898	}
1264		1899
1265	Coro::cede;	1900	$self->{last_save} = $cf::RUNTIME;
		1901	$self->last_access ($cf::RUNTIME);
1266		1902
1267	$self->in_memory (cf::MAP_IN_MEMORY);	1903	$self->in_memory (cf::MAP_IN_MEMORY);
		1904	}
		1905
		1906	$self->post_load;
		1907	}
		1908
		1909	sub customise_for {
		1910	my ($self, $ob) = @_;
		1911
		1912	return find "~" . $ob->name . "/" . $self->{path}
		1913	if $self->per_player;
		1914
		1915	# return find "?party/" . $ob->name . "/" . $self->{path}
		1916	# if $self->per_party;
		1917
		1918	$self
		1919	}
		1920
		1921	# find and load all maps in the 3x3 area around a map
		1922	sub load_neighbours {
		1923	my ($map) = @_;
		1924
		1925	my @neigh; # diagonal neighbours
		1926
		1927	for (0 .. 3) {
		1928	my $neigh = $map->tile_path ($_)
		1929	or next;
		1930	$neigh = find $neigh, $map
		1931	or next;
		1932	$neigh->load;
		1933
		1934	push @neigh,
		1935	[$neigh->tile_path (($_ + 3) % 4), $neigh],
		1936	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1937	}
		1938
		1939	for (grep defined $_->[0], @neigh) {
		1940	my ($path, $origin) = @$_;
		1941	my $neigh = find $path, $origin
		1942	or next;
		1943	$neigh->load;
		1944	}
1268	}	1945	}
1269		1946
1270	sub find_sync {	1947	sub find_sync {
1271	my ($path, $origin) = @_;	1948	my ($path, $origin) = @_;
1272		1949
1273	cf::sync_job { cf::map::find $path, $origin }	1950	cf::sync_job { find $path, $origin }
1274	}	1951	}
1275		1952
1276	sub do_load_sync {	1953	sub do_load_sync {
1277	my ($map) = @_;	1954	my ($map) = @_;
1278		1955
		1956	cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
		1957	if $Coro::current == $Coro::main;
		1958
1279	cf::sync_job { $map->load };	1959	cf::sync_job { $map->load };
		1960	}
		1961
		1962	our %MAP_PREFETCH;
		1963	our $MAP_PREFETCHER = undef;
		1964
		1965	sub find_async {
		1966	my ($path, $origin, $load) = @_;
		1967
		1968	$path = normalise $path, $origin && $origin->{path};
		1969
		1970	if (my $map = $cf::MAP{$path}) {
		1971	return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
		1972	}
		1973
		1974	$MAP_PREFETCH{$path} |= $load;
		1975
		1976	$MAP_PREFETCHER ||= cf::async {
		1977	while (%MAP_PREFETCH) {
		1978	while (my ($k, $v) = each %MAP_PREFETCH) {
		1979	if (my $map = find $k) {
		1980	$map->load if $v;
		1981	}
		1982
		1983	delete $MAP_PREFETCH{$k};
		1984	}
		1985	}
		1986	undef $MAP_PREFETCHER;
		1987	};
		1988	$MAP_PREFETCHER->prio (6);
		1989
		1990	()
1280	}	1991	}
1281		1992
1282	sub save {	1993	sub save {
1283	my ($self) = @_;	1994	my ($self) = @_;
1284		1995
1285	my $lock = cf::lock_acquire "map_data:" . $self->path;	1996	my $lock = cf::lock_acquire "map_data:$self->{path}";
1286		1997
1287	$self->{last_save} = $cf::RUNTIME;	1998	$self->{last_save} = $cf::RUNTIME;
1288		1999
1289	return unless $self->dirty;	2000	return unless $self->dirty;
1290		2001
1291	my $save = $self->{path}->save_path; utf8::encode $save;	2002	my $save = $self->save_path; utf8::encode $save;
1292	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;	2003	my $uniq = $self->uniq_path; utf8::encode $uniq;
1293		2004
1294	$self->{load_path} = $save;	2005	$self->{load_path} = $save;
1295		2006
1296	return if $self->{deny_save};	2007	return if $self->{deny_save};
1297		2008
1298	local $self->{last_access} = $self->last_access;#d#	2009	local $self->{last_access} = $self->last_access;#d#
1299		2010
		2011	cf::async {
		2012	$_->contr->save for $self->players;
		2013	};
		2014
1300	if ($uniq) {	2015	if ($uniq) {
1301	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);	2016	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1302	$self->save_objects ($uniq, cf::IO_UNIQUES);	2017	$self->_save_objects ($uniq, cf::IO_UNIQUES);
1303	} else {	2018	} else {
1304	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);	2019	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1305	}	2020	}
1306	}	2021	}
1307		2022
1308	sub swap_out {	2023	sub swap_out {
1309	my ($self) = @_;	2024	my ($self) = @_;
1310		2025
1311	# save first because save cedes	2026	# save first because save cedes
1312	$self->save;	2027	$self->save;
1313		2028
1314	my $lock = cf::lock_acquire "map_data:" . $self->path;	2029	my $lock = cf::lock_acquire "map_data:$self->{path}";
1315		2030
1316	return if $self->players;	2031	return if $self->players;
1317	return if $self->in_memory != cf::MAP_IN_MEMORY;	2032	return if $self->in_memory != cf::MAP_IN_MEMORY;
1318	return if $self->{deny_save};	2033	return if $self->{deny_save};
1319		2034
…		…
1323		2038
1324	sub reset_at {	2039	sub reset_at {
1325	my ($self) = @_;	2040	my ($self) = @_;
1326		2041
1327	# TODO: safety, remove and allow resettable per-player maps	2042	# TODO: safety, remove and allow resettable per-player maps
1328	return 1e99 if $self->{path}{user_rel};
1329	return 1e99 if $self->{deny_reset};	2043	return 1e99 if $self->{deny_reset};
1330		2044
1331	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	2045	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1332	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	2046	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1333		2047
…		…
1338	my ($self) = @_;	2052	my ($self) = @_;
1339		2053
1340	$self->reset_at <= $cf::RUNTIME	2054	$self->reset_at <= $cf::RUNTIME
1341	}	2055	}
1342		2056
1343	sub unlink_save {
1344	my ($self) = @_;
1345
1346	utf8::encode (my $save = $self->{path}->save_path);
1347	aioreq_pri 3; IO::AIO::aio_unlink $save;
1348	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1349	}
1350
1351	sub rename {
1352	my ($self, $new_path) = @_;
1353
1354	$self->unlink_save;
1355
1356	delete $cf::MAP{$self->path};
1357	$self->{path} = new cf::path $new_path;
1358	$self->path ($self->{path}->as_string);
1359	$cf::MAP{$self->path} = $self;
1360
1361	$self->save;
1362	}
1363
1364	sub reset {	2057	sub reset {
1365	my ($self) = @_;	2058	my ($self) = @_;
1366		2059
1367	my $lock = cf::lock_acquire "map_data:" . $self->path;	2060	my $lock = cf::lock_acquire "map_data:$self->{path}";
1368		2061
1369	return if $self->players;	2062	return if $self->players;
1370	return if $self->{path}{user_rel};#d#
1371		2063
1372	warn "resetting map ", $self->path;#d#	2064	warn "resetting map ", $self->path;
		2065
		2066	$self->in_memory (cf::MAP_SWAPPED);
		2067
		2068	# need to save uniques path
		2069	unless ($self->{deny_save}) {
		2070	my $uniq = $self->uniq_path; utf8::encode $uniq;
		2071
		2072	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		2073	if $uniq;
		2074	}
1373		2075
1374	delete $cf::MAP{$self->path};	2076	delete $cf::MAP{$self->path};
		2077
		2078	$self->clear;
1375		2079
1376	$_->clear_links_to ($self) for values %cf::MAP;	2080	$_->clear_links_to ($self) for values %cf::MAP;
1377		2081
1378	$self->unlink_save;	2082	$self->unlink_save;
1379	$self->destroy;	2083	$self->destroy;
…		…
1382	my $nuke_counter = "aaaa";	2086	my $nuke_counter = "aaaa";
1383		2087
1384	sub nuke {	2088	sub nuke {
1385	my ($self) = @_;	2089	my ($self) = @_;
1386		2090
		2091	{
		2092	my $lock = cf::lock_acquire "map_data:$self->{path}";
		2093
		2094	delete $cf::MAP{$self->path};
		2095
		2096	bless $self, "cf::map";
		2097	delete $self->{deny_reset};
1387	$self->{deny_save} = 1;	2098	$self->{deny_save} = 1;
1388	$self->reset_timeout (1);	2099	$self->reset_timeout (1);
1389	$self->rename ("{nuke}/" . ($nuke_counter++));	2100	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		2101
		2102	$self->unlink_save;
		2103
		2104	$cf::MAP{$self->path} = $self;
		2105	}
		2106
1390	$self->reset; # polite request, might not happen	2107	$self->reset; # polite request, might not happen
1391	}	2108	}
1392		2109
1393	sub customise_for {	2110	=item $maps = cf::map::tmp_maps
1394	my ($map, $ob) = @_;
1395		2111
1396	if ($map->per_player) {	2112	Returns an arrayref with all map paths of currently instantiated and saved
1397	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};	2113	maps. May block.
		2114
		2115	=cut
		2116
		2117	sub tmp_maps() {
1398	}	2118	[
1399		2119	map {
1400	$map	2120	utf8::decode $_;
		2121	/\.map$/
		2122	? normalise $_
		2123	: ()
		2124	} @{ aio_readdir $TMPDIR or [] }
		2125	]
1401	}	2126	}
1402		2127
1403	sub emergency_save {	2128	=item $maps = cf::map::random_maps
1404	my $freeze_guard = cf::freeze_mainloop;
1405		2129
1406	warn "enter emergency map save\n";	2130	Returns an arrayref with all map paths of currently instantiated and saved
		2131	random maps. May block.
1407		2132
1408	cf::sync_job {	2133	=cut
1409	warn "begin emergency map save\n";
1410	$_->save for values %cf::MAP;
1411	};
1412		2134
1413	warn "end emergency map save\n";	2135	sub random_maps() {
		2136	[
		2137	map {
		2138	utf8::decode $_;
		2139	/\.map$/
		2140	? normalise "?random/$_"
		2141	: ()
		2142	} @{ aio_readdir $RANDOMDIR or [] }
		2143	]
		2144	}
		2145
		2146	=item cf::map::unique_maps
		2147
		2148	Returns an arrayref of paths of all shared maps that have
		2149	instantiated unique items. May block.
		2150
		2151	=cut
		2152
		2153	sub unique_maps() {
		2154	[
		2155	map {
		2156	utf8::decode $_;
		2157	/\.map$/
		2158	? normalise $_
		2159	: ()
		2160	} @{ aio_readdir $UNIQUEDIR or [] }
		2161	]
1414	}	2162	}
1415		2163
1416	package cf;	2164	package cf;
1417		2165
1418	=back	2166	=back
1419		2167
		2168	=head3 cf::object
		2169
		2170	=cut
		2171
		2172	package cf::object;
		2173
		2174	=over 4
		2175
		2176	=item $ob->inv_recursive
		2177
		2178	Returns the inventory of the object _and_ their inventories, recursively.
		2179
		2180	=cut
		2181
		2182	sub inv_recursive_;
		2183	sub inv_recursive_ {
		2184	map { $_, inv_recursive_ $_->inv } @_
		2185	}
		2186
		2187	sub inv_recursive {
		2188	inv_recursive_ inv $_[0]
		2189	}
		2190
		2191	package cf;
		2192
		2193	=back
1420		2194
1421	=head3 cf::object::player	2195	=head3 cf::object::player
1422		2196
1423	=over 4	2197	=over 4
1424		2198
…		…
1438		2212
1439	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2213	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1440		2214
1441	if ($self->{record_replies}) {	2215	if ($self->{record_replies}) {
1442	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2216	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2217
1443	} else {	2218	} else {
		2219	my $pl = $self->contr;
		2220
		2221	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2222	my $dialog = $pl->{npc_dialog};
		2223	$dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
		2224
		2225	} else {
1444	$msg = $npc->name . " says: $msg" if $npc;	2226	$msg = $npc->name . " says: $msg" if $npc;
1445	$self->message ($msg, $flags);	2227	$self->message ($msg, $flags);
		2228	}
1446	}	2229	}
		2230	}
		2231
		2232	=item $object->send_msg ($channel, $msg, $color, [extra...])
		2233
		2234	=cut
		2235
		2236	sub cf::object::send_msg {
		2237	my $pl = shift->contr
		2238	or return;
		2239	$pl->send_msg (@_);
1447	}	2240	}
1448		2241
1449	=item $player_object->may ("access")	2242	=item $player_object->may ("access")
1450		2243
1451	Returns wether the given player is authorized to access resource "access"	2244	Returns wether the given player is authorized to access resource "access"
…		…
1464		2257
1465	=item $player_object->enter_link	2258	=item $player_object->enter_link
1466		2259
1467	Freezes the player and moves him/her to a special map (C<{link}>).	2260	Freezes the player and moves him/her to a special map (C<{link}>).
1468		2261
1469	The player should be reaosnably safe there for short amounts of time. You	2262	The player should be reasonably safe there for short amounts of time. You
1470	I<MUST> call C<leave_link> as soon as possible, though.	2263	I<MUST> call C<leave_link> as soon as possible, though.
1471		2264
		2265	Will never block.
		2266
1472	=item $player_object->leave_link ($map, $x, $y)	2267	=item $player_object->leave_link ($map, $x, $y)
1473		2268
1474	Moves the player out of the specila link map onto the given map. If the	2269	Moves the player out of the special C<{link}> map onto the specified
1475	map is not valid (or omitted), the player will be moved back to the	2270	map. If the map is not valid (or omitted), the player will be moved back
1476	location he/she was before the call to C<enter_link>, or, if that fails,	2271	to the location he/she was before the call to C<enter_link>, or, if that
1477	to the emergency map position.	2272	fails, to the emergency map position.
1478		2273
1479	Might block.	2274	Might block.
1480		2275
1481	=cut	2276	=cut
		2277
		2278	sub link_map {
		2279	unless ($LINK_MAP) {
		2280	$LINK_MAP = cf::map::find "{link}"
		2281	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		2282	$LINK_MAP->load;
		2283	}
		2284
		2285	$LINK_MAP
		2286	}
1482		2287
1483	sub cf::object::player::enter_link {	2288	sub cf::object::player::enter_link {
1484	my ($self) = @_;	2289	my ($self) = @_;
1485		2290
1486	$self->deactivate_recursive;	2291	$self->deactivate_recursive;
1487		2292
1488	return if $self->map == $LINK_MAP;	2293	return if UNIVERSAL::isa $self->map, "ext::map_link";
1489		2294
1490	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2295	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1491	if $self->map;	2296	if $self->map && $self->map->{path} ne "{link}";
1492		2297
1493	$self->enter_map ($LINK_MAP, 20, 20);	2298	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1494	}	2299	}
1495		2300
1496	sub cf::object::player::leave_link {	2301	sub cf::object::player::leave_link {
1497	my ($self, $map, $x, $y) = @_;	2302	my ($self, $map, $x, $y) = @_;
		2303
		2304	return unless $self->contr->active;
1498		2305
1499	my $link_pos = delete $self->{_link_pos};	2306	my $link_pos = delete $self->{_link_pos};
1500		2307
1501	unless ($map) {	2308	unless ($map) {
1502	# restore original map position	2309	# restore original map position
…		…
1516	# use -1 or undef as default coordinates, not 0, 0	2323	# use -1 or undef as default coordinates, not 0, 0
1517	($x, $y) = ($map->enter_x, $map->enter_y)	2324	($x, $y) = ($map->enter_x, $map->enter_y)
1518	if $x <=0 && $y <= 0;	2325	if $x <=0 && $y <= 0;
1519		2326
1520	$map->load;	2327	$map->load;
		2328	$map->load_neighbours;
1521		2329
		2330	return unless $self->contr->active;
1522	$self->activate_recursive;	2331	$self->activate_recursive;
		2332
		2333	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1523	$self->enter_map ($map, $x, $y);	2334	$self->enter_map ($map, $x, $y);
1524	}	2335	}
1525		2336
1526	cf::player->attach (	2337	=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1527	on_logout => sub {
1528	my ($pl) = @_;
1529		2338
1530	# abort map switching before logout	2339	Moves the player to the given map-path and coordinates by first freezing
1531	if ($pl->ob->{_link_pos}) {	2340	her, loading and preparing them map, calling the provided $check callback
1532	cf::sync_job {	2341	that has to return the map if sucecssful, and then unfreezes the player on
1533	$pl->ob->leave_link	2342	the new (success) or old (failed) map position. In either case, $done will
1534	};	2343	be called at the end of this process.
1535	}
1536	},
1537	on_login => sub {
1538	my ($pl) = @_;
1539		2344
1540	# try to abort aborted map switching on player login :)
1541	# should happen only on crashes
1542	if ($pl->ob->{_link_pos}) {
1543	$pl->ob->enter_link;
1544	Coro::async_pool {
1545	# we need this sleep as the login has a concurrent enter_exit running
1546	# and this sleep increases chances of the player not ending up in scorn
1547	Coro::Timer::sleep 1;
1548	$pl->ob->leave_link;
1549	};
1550	}
1551	},
1552	);
1553
1554	=item $player_object->goto ($path, $x, $y)
1555
1556	=cut	2345	=cut
		2346
		2347	our $GOTOGEN;
1557		2348
1558	sub cf::object::player::goto {	2349	sub cf::object::player::goto {
1559	my ($self, $path, $x, $y) = @_;	2350	my ($self, $path, $x, $y, $check, $done) = @_;
		2351
		2352	# do generation counting so two concurrent goto's will be executed in-order
		2353	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1560		2354
1561	$self->enter_link;	2355	$self->enter_link;
1562		2356
1563	(Coro::async_pool {	2357	(async {
1564	$path = new cf::path $path;	2358	my $map = eval {
1565
1566	my $map = cf::map::find $path->as_string;	2359	my $map = cf::map::find $path;
		2360
		2361	if ($map) {
1567	$map = $map->customise_for ($self) if $map;	2362	$map = $map->customise_for ($self);
1568		2363	$map = $check->($map) if $check && $map;
1569	# warn "entering ", $map->path, " at ($x, $y)\n"	2364	} else {
1570	# if $map;
1571
1572	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);	2365	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2366	}
1573		2367
		2368	$map
		2369	};
		2370
		2371	if ($@) {
		2372	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2373	LOG llevError | logBacktrace, Carp::longmess $@;
		2374	}
		2375
		2376	if ($gen == $self->{_goto_generation}) {
		2377	delete $self->{_goto_generation};
1574	$self->leave_link ($map, $x, $y);	2378	$self->leave_link ($map, $x, $y);
		2379	}
		2380
		2381	$done->() if $done;
1575	})->prio (1);	2382	})->prio (1);
1576	}	2383	}
1577		2384
1578	=item $player_object->enter_exit ($exit_object)	2385	=item $player_object->enter_exit ($exit_object)
1579		2386
…		…
1581		2388
1582	sub parse_random_map_params {	2389	sub parse_random_map_params {
1583	my ($spec) = @_;	2390	my ($spec) = @_;
1584		2391
1585	my $rmp = { # defaults	2392	my $rmp = { # defaults
1586	xsize => 10,	2393	xsize => (cf::rndm 15, 40),
1587	ysize => 10,	2394	ysize => (cf::rndm 15, 40),
		2395	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2396	#layout => string,
1588	};	2397	};
1589		2398
1590	for (split /\n/, $spec) {	2399	for (split /\n/, $spec) {
1591	my ($k, $v) = split /\s+/, $_, 2;	2400	my ($k, $v) = split /\s+/, $_, 2;
1592		2401
…		…
1596	$rmp	2405	$rmp
1597	}	2406	}
1598		2407
1599	sub prepare_random_map {	2408	sub prepare_random_map {
1600	my ($exit) = @_;	2409	my ($exit) = @_;
		2410
		2411	my $guard = cf::lock_acquire "exit_prepare:$exit";
1601		2412
1602	# all this does is basically replace the /! path by	2413	# all this does is basically replace the /! path by
1603	# a new random map path (?random/...) with a seed	2414	# a new random map path (?random/...) with a seed
1604	# that depends on the exit object	2415	# that depends on the exit object
1605		2416
1606	my $rmp = parse_random_map_params $exit->msg;	2417	my $rmp = parse_random_map_params $exit->msg;
1607		2418
1608	if ($exit->map) {	2419	if ($exit->map) {
1609	$rmp->{region} = $exit->map->region_name;	2420	$rmp->{region} = $exit->region->name;
1610	$rmp->{origin_map} = $exit->map->path;	2421	$rmp->{origin_map} = $exit->map->path;
1611	$rmp->{origin_x} = $exit->x;	2422	$rmp->{origin_x} = $exit->x;
1612	$rmp->{origin_y} = $exit->y;	2423	$rmp->{origin_y} = $exit->y;
1613	}	2424	}
1614		2425
1615	$rmp->{random_seed} ||= $exit->random_seed;	2426	$rmp->{random_seed} ||= $exit->random_seed;
1616		2427
1617	my $data = cf::to_json $rmp;	2428	my $data = cf::to_json $rmp;
1618	my $md5 = Digest::MD5::md5_hex $data;	2429	my $md5 = Digest::MD5::md5_hex $data;
		2430	my $meta = "$RANDOMDIR/$md5.meta";
1619		2431
1620	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {	2432	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1621	aio_write $fh, 0, (length $data), $data, 0;	2433	aio_write $fh, 0, (length $data), $data, 0;
		2434	undef $fh;
		2435	aio_rename "$meta~", $meta;
1622		2436
1623	$exit->slaying ("?random/$md5");	2437	$exit->slaying ("?random/$md5");
1624	$exit->msg (undef);	2438	$exit->msg (undef);
1625	}	2439	}
1626	}	2440	}
…		…
1628	sub cf::object::player::enter_exit {	2442	sub cf::object::player::enter_exit {
1629	my ($self, $exit) = @_;	2443	my ($self, $exit) = @_;
1630		2444
1631	return unless $self->type == cf::PLAYER;	2445	return unless $self->type == cf::PLAYER;
1632		2446
		2447	if ($exit->slaying eq "/!") {
		2448	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2449	# the problem is that $exit might not survive long enough
		2450	# so it needs to be done right now, right here
		2451	cf::sync_job { prepare_random_map $exit };
		2452	}
		2453
		2454	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2455	my $hp = $exit->stats->hp;
		2456	my $sp = $exit->stats->sp;
		2457
1633	$self->enter_link;	2458	$self->enter_link;
1634		2459
1635	(Coro::async_pool {	2460	# if exit is damned, update players death & WoR home-position
		2461	$self->contr->savebed ($slaying, $hp, $sp)
		2462	if $exit->flag (FLAG_DAMNED);
		2463
		2464	(async {
1636	$self->deactivate_recursive; # just to be sure	2465	$self->deactivate_recursive; # just to be sure
1637	unless (eval {	2466	unless (eval {
1638	prepare_random_map $exit	2467	$self->goto ($slaying, $hp, $sp);
1639	if $exit->slaying eq "/!";
1640
1641	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1642	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1643		2468
1644	1;	2469	1;
1645	}) {	2470	}) {
1646	$self->message ("Something went wrong deep within the crossfire server. "	2471	$self->message ("Something went wrong deep within the crossfire server. "
1647	. "I'll try to bring you back to the map you were before. "	2472	. "I'll try to bring you back to the map you were before. "
1648	. "Please report this to the dungeon master",	2473	. "Please report this to the dungeon master!",
1649	cf::NDI_UNIQUE | cf::NDI_RED);	2474	cf::NDI_UNIQUE | cf::NDI_RED);
1650		2475
1651	warn "ERROR in enter_exit: $@";	2476	warn "ERROR in enter_exit: $@";
1652	$self->leave_link;	2477	$self->leave_link;
1653	}	2478	}
1654	})->prio (1);	2479	})->prio (1);
…		…
1667		2492
1668	sub cf::client::send_drawinfo {	2493	sub cf::client::send_drawinfo {
1669	my ($self, $text, $flags) = @_;	2494	my ($self, $text, $flags) = @_;
1670		2495
1671	utf8::encode $text;	2496	utf8::encode $text;
1672	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2497	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1673	}	2498	}
1674		2499
		2500	=item $client->send_msg ($channel, $msg, $color, [extra...])
		2501
		2502	Send a drawinfo or msg packet to the client, formatting the msg for the
		2503	client if neccessary. C<$type> should be a string identifying the type of
		2504	the message, with C<log> being the default. If C<$color> is negative, suppress
		2505	the message unless the client supports the msg packet.
		2506
		2507	=cut
		2508
		2509	sub cf::client::send_msg {
		2510	my ($self, $channel, $msg, $color, @extra) = @_;
		2511
		2512	$msg = $self->pl->expand_cfpod ($msg);
		2513
		2514	$color &= cf::NDI_CLIENT_MASK; # just in case...
		2515
		2516	if (ref $channel) {
		2517	# send meta info to client, if not yet sent
		2518	unless (exists $self->{channel}{$channel->{id}}) {
		2519	$self->{channel}{$channel->{id}} = $channel;
		2520	$self->ext_msg (channel_info => $channel);
		2521	}
		2522
		2523	$channel = $channel->{id};
		2524	}
		2525
		2526	return unless @extra || length $msg;
		2527
		2528	if ($self->can_msg) {
		2529	# default colour, mask it out
		2530	$color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
		2531	if $color & cf::NDI_DEF;
		2532
		2533	$self->send_packet ("msg " . $self->{json_coder}->encode (
		2534	[$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
		2535	} else {
		2536	if ($color >= 0) {
		2537	# replace some tags by gcfclient-compatible ones
		2538	for ($msg) {
		2539	1 while
		2540	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2541	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2542	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2543	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2544	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
		2545	}
		2546
		2547	$color &= cf::NDI_COLOR_MASK;
		2548
		2549	utf8::encode $msg;
		2550
		2551	if (0 && $msg =~ /\[/) {
		2552	# COMMAND/INFO
		2553	$self->send_packet ("drawextinfo $color 10 8 $msg")
		2554	} else {
		2555	$msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
		2556	$self->send_packet ("drawinfo $color $msg")
		2557	}
		2558	}
		2559	}
		2560	}
		2561
		2562	=item $client->ext_msg ($type, @msg)
		2563
		2564	Sends an ext event to the client.
		2565
		2566	=cut
		2567
		2568	sub cf::client::ext_msg($$@) {
		2569	my ($self, $type, @msg) = @_;
		2570
		2571	if ($self->extcmd == 2) {
		2572	$self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
		2573	} elsif ($self->extcmd == 1) { # TODO: remove
		2574	push @msg, msgtype => "event_$type";
		2575	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2576	}
		2577	}
		2578
		2579	=item $client->ext_reply ($msgid, @msg)
		2580
		2581	Sends an ext reply to the client.
		2582
		2583	=cut
		2584
		2585	sub cf::client::ext_reply($$@) {
		2586	my ($self, $id, @msg) = @_;
		2587
		2588	if ($self->extcmd == 2) {
		2589	$self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
		2590	} elsif ($self->extcmd == 1) {
		2591	#TODO: version 1, remove
		2592	unshift @msg, msgtype => "reply", msgid => $id;
		2593	$self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
		2594	}
		2595	}
1675		2596
1676	=item $success = $client->query ($flags, "text", \&cb)	2597	=item $success = $client->query ($flags, "text", \&cb)
1677		2598
1678	Queues a query to the client, calling the given callback with	2599	Queues a query to the client, calling the given callback with
1679	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2600	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1680	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.	2601	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1681		2602
1682	Queries can fail, so check the return code. Or don't, as queries will become	2603	Queries can fail, so check the return code. Or don't, as queries will
1683	reliable at some point in the future.	2604	become reliable at some point in the future.
1684		2605
1685	=cut	2606	=cut
1686		2607
1687	sub cf::client::query {	2608	sub cf::client::query {
1688	my ($self, $flags, $text, $cb) = @_;	2609	my ($self, $flags, $text, $cb) = @_;
…		…
1696	utf8::encode $text;	2617	utf8::encode $text;
1697	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];	2618	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1698		2619
1699	$self->send_packet ($self->{query_queue}[0][0])	2620	$self->send_packet ($self->{query_queue}[0][0])
1700	if @{ $self->{query_queue} } == 1;	2621	if @{ $self->{query_queue} } == 1;
		2622
		2623	1
1701	}	2624	}
1702		2625
1703	cf::client->attach (	2626	cf::client->attach (
		2627	on_connect => sub {
		2628	my ($ns) = @_;
		2629
		2630	$ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
		2631	},
1704	on_reply => sub {	2632	on_reply => sub {
1705	my ($ns, $msg) = @_;	2633	my ($ns, $msg) = @_;
1706		2634
1707	# this weird shuffling is so that direct followup queries	2635	# this weird shuffling is so that direct followup queries
1708	# get handled first	2636	# get handled first
1709	my $queue = delete $ns->{query_queue}	2637	my $queue = delete $ns->{query_queue}
1710	or return; # be conservative, not sure how that can happen, but we saw a crash here	2638	or return; # be conservative, not sure how that can happen, but we saw a crash here
1711		2639
1712	(shift @$queue)->[1]->($msg);	2640	(shift @$queue)->[1]->($msg);
		2641	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1713		2642
1714	push @{ $ns->{query_queue} }, @$queue;	2643	push @{ $ns->{query_queue} }, @$queue;
1715		2644
1716	if (@{ $ns->{query_queue} } == @$queue) {	2645	if (@{ $ns->{query_queue} } == @$queue) {
1717	if (@$queue) {	2646	if (@$queue) {
…		…
1719	} else {	2648	} else {
1720	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;	2649	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1721	}	2650	}
1722	}	2651	}
1723	},	2652	},
		2653	on_exticmd => sub {
		2654	my ($ns, $buf) = @_;
		2655
		2656	my $msg = eval { $ns->{json_coder}->decode ($buf) };
		2657
		2658	if (ref $msg) {
		2659	my ($type, $reply, @payload) =
		2660	"ARRAY" eq ref $msg
		2661	? @$msg
		2662	: ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
		2663
		2664	my @reply;
		2665
		2666	if (my $cb = $EXTICMD{$type}) {
		2667	@reply = $cb->($ns, @payload);
		2668	}
		2669
		2670	$ns->ext_reply ($reply, @reply)
		2671	if $reply;
		2672
		2673	} else {
		2674	warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
		2675	}
		2676
		2677	cf::override;
		2678	},
1724	);	2679	);
1725		2680
1726	=item $client->coro (\&cb)	2681	=item $client->async (\&cb)
1727		2682
1728	Create a new coroutine, running the specified callback. The coroutine will	2683	Create a new coroutine, running the specified callback. The coroutine will
1729	be automatically cancelled when the client gets destroyed (e.g. on logout,	2684	be automatically cancelled when the client gets destroyed (e.g. on logout,
1730	or loss of connection).	2685	or loss of connection).
1731		2686
1732	=cut	2687	=cut
1733		2688
1734	sub cf::client::coro {	2689	sub cf::client::async {
1735	my ($self, $cb) = @_;	2690	my ($self, $cb) = @_;
1736		2691
1737	my $coro = &Coro::async_pool ($cb);	2692	my $coro = &Coro::async ($cb);
1738		2693
1739	$coro->on_destroy (sub {	2694	$coro->on_destroy (sub {
1740	delete $self->{_coro}{$coro+0};	2695	delete $self->{_coro}{$coro+0};
1741	});	2696	});
1742		2697
…		…
1769	our $safe = new Safe "safe";	2724	our $safe = new Safe "safe";
1770	our $safe_hole = new Safe::Hole;	2725	our $safe_hole = new Safe::Hole;
1771		2726
1772	$SIG{FPE} = 'IGNORE';	2727	$SIG{FPE} = 'IGNORE';
1773		2728
1774	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2729	$safe->permit_only (Opcode::opset qw(
		2730	:base_core :base_mem :base_orig :base_math
		2731	grepstart grepwhile mapstart mapwhile
		2732	sort time
		2733	));
1775		2734
1776	# here we export the classes and methods available to script code	2735	# here we export the classes and methods available to script code
1777		2736
1778	=pod	2737	=pod
1779		2738
1780	The following fucntions and emthods are available within a safe environment:	2739	The following functions and methods are available within a safe environment:
1781		2740
1782	cf::object contr pay_amount pay_player map	2741	cf::object
		2742	contr pay_amount pay_player map x y force_find force_add
		2743	insert remove name archname title slaying race decrease_ob_nr
		2744
1783	cf::object::player player	2745	cf::object::player
1784	cf::player peaceful	2746	player
1785	cf::map trigger	2747
		2748	cf::player
		2749	peaceful
		2750
		2751	cf::map
		2752	trigger
1786		2753
1787	=cut	2754	=cut
1788		2755
1789	for (	2756	for (
1790	["cf::object" => qw(contr pay_amount pay_player map)],	2757	["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
		2758	insert remove inv name archname title slaying race
		2759	decrease_ob_nr)],
1791	["cf::object::player" => qw(player)],	2760	["cf::object::player" => qw(player)],
1792	["cf::player" => qw(peaceful)],	2761	["cf::player" => qw(peaceful)],
1793	["cf::map" => qw(trigger)],	2762	["cf::map" => qw(trigger)],
1794	) {	2763	) {
1795	no strict 'refs';	2764	no strict 'refs';
…		…
1866	=back	2835	=back
1867		2836
1868	=cut	2837	=cut
1869		2838
1870	#############################################################################	2839	#############################################################################
		2840	# the server's init and main functions
1871		2841
1872	=head2 EXTENSION DATABASE SUPPORT	2842	sub load_facedata($) {
		2843	my ($path) = @_;
1873		2844
1874	Crossfire maintains a very simple database for extension use. It can	2845	# HACK to clear player env face cache, we need some signal framework
1875	currently store anything that can be serialised using Storable, which	2846	# for this (global event?)
1876	excludes objects.	2847	%ext::player_env::MUSIC_FACE_CACHE = ();
1877		2848
1878	The parameter C<$family> should best start with the name of the extension	2849	my $enc = JSON::XS->new->utf8->canonical->relaxed;
1879	using it, it should be unique.
1880		2850
1881	=over 4	2851	warn "loading facedata from $path\n";
1882		2852
1883	=item $hashref = cf::db_get $family	2853	my $facedata;
		2854	0 < aio_load $path, $facedata
		2855	or die "$path: $!";
1884		2856
1885	Return a hashref for use by the extension C<$family>, which can be	2857	$facedata = Coro::Storable::thaw $facedata;
1886	modified. After modifications, you have to call C<cf::db_dirty> or
1887	C<cf::db_sync>.
1888		2858
1889	=item $value = cf::db_get $family => $key	2859	$facedata->{version} == 2
		2860	or cf::cleanup "$path: version mismatch, cannot proceed.";
1890		2861
1891	Returns a single value from the database	2862	# patch in the exptable
1892		2863	$facedata->{resource}{"res/exp_table"} = {
1893	=item cf::db_put $family => $hashref	2864	type => FT_RSRC,
1894		2865	data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1895	Stores the given family hashref into the database. Updates are delayed, if
1896	you want the data to be synced to disk immediately, use C<cf::db_sync>.
1897
1898	=item cf::db_put $family => $key => $value
1899
1900	Stores the given C<$value> in the family hash. Updates are delayed, if you
1901	want the data to be synced to disk immediately, use C<cf::db_sync>.
1902
1903	=item cf::db_dirty
1904
1905	Marks the database as dirty, to be updated at a later time.
1906
1907	=item cf::db_sync
1908
1909	Immediately write the database to disk I<if it is dirty>.
1910
1911	=cut
1912
1913	our $DB;
1914
1915	{
1916	my $path = cf::localdir . "/database.pst";
1917
1918	sub db_load() {
1919	$DB = stat $path ? Storable::retrieve $path : { };
1920	}
1921
1922	my $pid;
1923
1924	sub db_save() {
1925	waitpid $pid, 0 if $pid;
1926	if (0 == ($pid = fork)) {
1927	$DB->{_meta}{version} = 1;
1928	Storable::nstore $DB, "$path~";
1929	rename "$path~", $path;
1930	cf::_exit 0 if defined $pid;
1931	}
1932	}
1933
1934	my $dirty;
1935
1936	sub db_sync() {
1937	db_save if $dirty;
1938	undef $dirty;
1939	}
1940
1941	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1942	db_sync;
1943	});	2866	};
		2867	cf::cede_to_tick;
1944		2868
1945	sub db_dirty() {
1946	$dirty = 1;
1947	$idle->start;
1948	}	2869	{
		2870	my $faces = $facedata->{faceinfo};
1949		2871
1950	sub db_get($;$) {	2872	while (my ($face, $info) = each %$faces) {
1951	@_ >= 2	2873	my $idx = (cf::face::find $face) || cf::face::alloc $face;
1952	? $DB->{$_[0]}{$_[1]}	2874	cf::face::set_visibility $idx, $info->{visibility};
1953	: ($DB->{$_[0]} ||= { })	2875	cf::face::set_magicmap $idx, $info->{magicmap};
1954	}	2876	cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
		2877	cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1955		2878
1956	sub db_put($$;$) {	2879	cf::cede_to_tick;
1957	if (@_ >= 3) {
1958	$DB->{$_[0]}{$_[1]} = $_[2];
1959	} else {
1960	$DB->{$_[0]} = $_[1];
1961	}
1962	db_dirty;
1963	}
1964
1965	cf::global->attach (
1966	prio => 10000,
1967	on_cleanup => sub {
1968	db_sync;
1969	},	2880	}
1970	);
1971	}
1972		2881
1973	#############################################################################	2882	while (my ($face, $info) = each %$faces) {
1974	# the server's main()	2883	next unless $info->{smooth};
		2884	my $idx = cf::face::find $face
		2885	or next;
		2886	if (my $smooth = cf::face::find $info->{smooth}) {
		2887	cf::face::set_smooth $idx, $smooth;
		2888	cf::face::set_smoothlevel $idx, $info->{smoothlevel};
		2889	} else {
		2890	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2891	}
1975		2892
1976	sub cfg_load {	2893	cf::cede_to_tick;
		2894	}
		2895	}
		2896
		2897	{
		2898	my $anims = $facedata->{animinfo};
		2899
		2900	while (my ($anim, $info) = each %$anims) {
		2901	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2902	cf::cede_to_tick;
		2903	}
		2904
		2905	cf::anim::invalidate_all; # d'oh
		2906	}
		2907
		2908	{
		2909	# TODO: for gcfclient pleasure, we should give resources
		2910	# that gcfclient doesn't grok a >10000 face index.
		2911	my $res = $facedata->{resource};
		2912
		2913	my $soundconf = delete $res->{"res/sound.conf"};
		2914
		2915	while (my ($name, $info) = each %$res) {
		2916	my $idx = (cf::face::find $name) || cf::face::alloc $name;
		2917	my $data;
		2918
		2919	if ($info->{type} & 1) {
		2920	# prepend meta info
		2921
		2922	my $meta = $enc->encode ({
		2923	name => $name,
		2924	%{ $info->{meta} || {} },
		2925	});
		2926
		2927	$data = pack "(w/a*)*", $meta, $info->{data};
		2928	} else {
		2929	$data = $info->{data};
		2930	}
		2931
		2932	cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
		2933	cf::face::set_type $idx, $info->{type};
		2934
		2935	cf::cede_to_tick;
		2936	}
		2937
		2938	if ($soundconf) {
		2939	$soundconf = $enc->decode (delete $soundconf->{data});
		2940
		2941	for (0 .. SOUND_CAST_SPELL_0 - 1) {
		2942	my $sound = $soundconf->{compat}[$_]
		2943	or next;
		2944
		2945	my $face = cf::face::find "sound/$sound->[1]";
		2946	cf::sound::set $sound->[0] => $face;
		2947	cf::sound::old_sound_index $_, $face; # gcfclient-compat
		2948	}
		2949
		2950	while (my ($k, $v) = each %{$soundconf->{event}}) {
		2951	my $face = cf::face::find "sound/$v";
		2952	cf::sound::set $k => $face;
		2953	}
		2954	}
		2955	}
		2956
		2957	1
		2958	}
		2959
		2960	register_exticmd fx_want => sub {
		2961	my ($ns, $want) = @_;
		2962
		2963	while (my ($k, $v) = each %$want) {
		2964	$ns->fx_want ($k, $v);
		2965	}
		2966	};
		2967
		2968	sub reload_regions {
		2969	# HACK to clear player env face cache, we need some signal framework
		2970	# for this (global event?)
		2971	%ext::player_env::MUSIC_FACE_CACHE = ();
		2972
		2973	load_resource_file "$MAPDIR/regions"
		2974	or die "unable to load regions file\n";
		2975
		2976	for (cf::region::list) {
		2977	$_->{match} = qr/$_->{match}/
		2978	if exists $_->{match};
		2979	}
		2980	}
		2981
		2982	sub reload_facedata {
		2983	load_facedata "$DATADIR/facedata"
		2984	or die "unable to load facedata\n";
		2985	}
		2986
		2987	sub reload_archetypes {
		2988	load_resource_file "$DATADIR/archetypes"
		2989	or die "unable to load archetypes\n";
		2990	#d# NEED to laod twice to resolve forward references
		2991	# this really needs to be done in an extra post-pass
		2992	# (which needs to be synchronous, so solve it differently)
		2993	load_resource_file "$DATADIR/archetypes"
		2994	or die "unable to load archetypes\n";
		2995	}
		2996
		2997	sub reload_treasures {
		2998	load_resource_file "$DATADIR/treasures"
		2999	or die "unable to load treasurelists\n";
		3000	}
		3001
		3002	sub reload_resources {
		3003	warn "reloading resource files...\n";
		3004
		3005	reload_regions;
		3006	reload_facedata;
		3007	#reload_archetypes;#d#
		3008	reload_archetypes;
		3009	reload_treasures;
		3010
		3011	warn "finished reloading resource files\n";
		3012	}
		3013
		3014	sub init {
		3015	reload_resources;
		3016	}
		3017
		3018	sub reload_config {
1977	open my $fh, "<:utf8", cf::confdir . "/config"	3019	open my $fh, "<:utf8", "$CONFDIR/config"
1978	or return;	3020	or return;
1979		3021
1980	local $/;	3022	local $/;
1981	*CFG = YAML::Syck::Load <$fh>;	3023	*CFG = YAML::Syck::Load <$fh>;
1982		3024
1983	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];	3025	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1984		3026
		3027	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		3028	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		3029
1985	if (exists $CFG{mlockall}) {	3030	if (exists $CFG{mlockall}) {
1986	eval {	3031	eval {
1987	$CFG{mlockall} ? &mlockall : &munlockall	3032	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1988	and die "WARNING: m(un)lockall failed: $!\n";	3033	and die "WARNING: m(un)lockall failed: $!\n";
1989	};	3034	};
1990	warn $@ if $@;	3035	warn $@ if $@;
1991	}	3036	}
1992	}	3037	}
1993		3038
1994	sub main {	3039	sub main {
1995	# we must not ever block the main coroutine	3040	# we must not ever block the main coroutine
1996	local $Coro::idle = sub {	3041	local $Coro::idle = sub {
1997	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#	3042	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1998	(Coro::unblock_sub {	3043	(async {
1999	Event::one_event;	3044	Event::one_event;
2000	})->();	3045	})->prio (Coro::PRIO_MAX);
2001	};	3046	};
2002		3047
2003	cfg_load;	3048	reload_config;
2004	db_load;	3049	db_init;
2005	load_extensions;	3050	load_extensions;
		3051
		3052	$TICK_WATCHER->start;
2006	Event::loop;	3053	Event::loop;
2007	}	3054	}
2008		3055
2009	#############################################################################	3056	#############################################################################
2010	# initialisation	3057	# initialisation and cleanup
2011		3058
		3059	# install some emergency cleanup handlers
		3060	BEGIN {
		3061	for my $signal (qw(INT HUP TERM)) {
		3062	Event->signal (
		3063	reentrant => 0,
		3064	data => WF_AUTOCANCEL,
		3065	signal => $signal,
		3066	prio => 0,
		3067	cb => sub {
		3068	cf::cleanup "SIG$signal";
		3069	},
		3070	);
		3071	}
		3072	}
		3073
		3074	sub write_runtime {
		3075	my $runtime = "$LOCALDIR/runtime";
		3076
		3077	# first touch the runtime file to show we are still running:
		3078	# the fsync below can take a very very long time.
		3079
		3080	IO::AIO::aio_utime $runtime, undef, undef;
		3081
		3082	my $guard = cf::lock_acquire "write_runtime";
		3083
		3084	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		3085	or return;
		3086
		3087	my $value = $cf::RUNTIME + 90 + 10;
		3088	# 10 is the runtime save interval, for a monotonic clock
		3089	# 60 allows for the watchdog to kill the server.
		3090
		3091	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		3092	and return;
		3093
		3094	# always fsync - this file is important
		3095	aio_fsync $fh
		3096	and return;
		3097
		3098	# touch it again to show we are up-to-date
		3099	aio_utime $fh, undef, undef;
		3100
		3101	close $fh
		3102	or return;
		3103
		3104	aio_rename "$runtime~", $runtime
		3105	and return;
		3106
		3107	warn "runtime file written.\n";
		3108
		3109	1
		3110	}
		3111
		3112	sub emergency_save() {
		3113	my $freeze_guard = cf::freeze_mainloop;
		3114
		3115	warn "enter emergency perl save\n";
		3116
		3117	cf::sync_job {
		3118	# use a peculiar iteration method to avoid tripping on perl
		3119	# refcount bugs in for. also avoids problems with players
		3120	# and maps saved/destroyed asynchronously.
		3121	warn "begin emergency player save\n";
		3122	for my $login (keys %cf::PLAYER) {
		3123	my $pl = $cf::PLAYER{$login} or next;
		3124	$pl->valid or next;
		3125	$pl->save;
		3126	}
		3127	warn "end emergency player save\n";
		3128
		3129	warn "begin emergency map save\n";
		3130	for my $path (keys %cf::MAP) {
		3131	my $map = $cf::MAP{$path} or next;
		3132	$map->valid or next;
		3133	$map->save;
		3134	}
		3135	warn "end emergency map save\n";
		3136
		3137	warn "begin emergency database checkpoint\n";
		3138	BDB::db_env_txn_checkpoint $DB_ENV;
		3139	warn "end emergency database checkpoint\n";
		3140	};
		3141
		3142	warn "leave emergency perl save\n";
		3143	}
		3144
		3145	sub post_cleanup {
		3146	my ($make_core) = @_;
		3147
		3148	warn Carp::longmess "post_cleanup backtrace"
		3149	if $make_core;
		3150	}
		3151
2012	sub reload() {	3152	sub do_reload_perl() {
2013	# can/must only be called in main	3153	# can/must only be called in main
2014	if ($Coro::current != $Coro::main) {	3154	if ($Coro::current != $Coro::main) {
2015	warn "can only reload from main coroutine\n";	3155	warn "can only reload from main coroutine";
2016	return;	3156	return;
2017	}	3157	}
2018		3158
2019	warn "reloading...";	3159	warn "reloading...";
2020		3160
2021	my $guard = freeze_mainloop;	3161	warn "entering sync_job";
		3162
		3163	cf::sync_job {
		3164	cf::write_runtime; # external watchdog should not bark
2022	cf::emergency_save;	3165	cf::emergency_save;
		3166	cf::write_runtime; # external watchdog should not bark
2023		3167
2024	eval {	3168	warn "syncing database to disk";
		3169	BDB::db_env_txn_checkpoint $DB_ENV;
		3170
2025	# if anything goes wrong in here, we should simply crash as we already saved	3171	# if anything goes wrong in here, we should simply crash as we already saved
2026		3172
2027	# cancel all watchers	3173	warn "cancelling all WF_AUTOCANCEL watchers";
2028	for (Event::all_watchers) {	3174	for (Event::all_watchers) {
2029	$_->cancel if $_->data & WF_AUTOCANCEL;	3175	$_->cancel if $_->data & WF_AUTOCANCEL;
2030	}	3176	}
2031		3177
		3178	warn "flushing outstanding aio requests";
		3179	for (;;) {
		3180	BDB::flush;
		3181	IO::AIO::flush;
		3182	Coro::cede;
		3183	last unless IO::AIO::nreqs || BDB::nreqs;
		3184	warn "iterate...";
		3185	}
		3186
		3187	++$RELOAD;
		3188
2032	# cancel all extension coros	3189	warn "cancelling all extension coros";
2033	$_->cancel for values %EXT_CORO;	3190	$_->cancel for values %EXT_CORO;
2034	%EXT_CORO = ();	3191	%EXT_CORO = ();
2035		3192
2036	# unload all extensions	3193	warn "removing commands";
2037	for (@exts) {	3194	%COMMAND = ();
		3195
		3196	warn "removing ext/exti commands";
		3197	%EXTCMD = ();
		3198	%EXTICMD = ();
		3199
		3200	warn "unloading/nuking all extensions";
		3201	for my $pkg (@EXTS) {
2038	warn "unloading <$_>";	3202	warn "... unloading $pkg";
2039	unload_extension $_;	3203
		3204	if (my $cb = $pkg->can ("unload")) {
		3205	eval {
		3206	$cb->($pkg);
		3207	1
		3208	} or warn "$pkg unloaded, but with errors: $@";
2040	}	3209	}
2041		3210
		3211	warn "... nuking $pkg";
		3212	Symbol::delete_package $pkg;
		3213	}
		3214
2042	# unload all modules loaded from $LIBDIR	3215	warn "unloading all perl modules loaded from $LIBDIR";
2043	while (my ($k, $v) = each %INC) {	3216	while (my ($k, $v) = each %INC) {
2044	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	3217	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2045		3218
2046	warn "removing <$k>";	3219	warn "... unloading $k";
2047	delete $INC{$k};	3220	delete $INC{$k};
2048		3221
2049	$k =~ s/\.pm$//;	3222	$k =~ s/\.pm$//;
2050	$k =~ s/\//::/g;	3223	$k =~ s/\//::/g;
2051		3224
…		…
2054	}	3227	}
2055		3228
2056	Symbol::delete_package $k;	3229	Symbol::delete_package $k;
2057	}	3230	}
2058		3231
2059	# sync database to disk
2060	cf::db_sync;
2061	IO::AIO::flush;
2062
2063	# get rid of safe::, as good as possible	3232	warn "getting rid of safe::, as good as possible";
2064	Symbol::delete_package "safe::$_"	3233	Symbol::delete_package "safe::$_"
2065	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	3234	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2066		3235
2067	# remove register_script_function callbacks
2068	# TODO
2069
2070	# unload cf.pm "a bit"	3236	warn "unloading cf.pm \"a bit\"";
2071	delete $INC{"cf.pm"};	3237	delete $INC{"cf.pm"};
		3238	delete $INC{"cf/pod.pm"};
2072		3239
2073	# don't, removes xs symbols, too,	3240	# don't, removes xs symbols, too,
2074	# and global variables created in xs	3241	# and global variables created in xs
2075	#Symbol::delete_package __PACKAGE__;	3242	#Symbol::delete_package __PACKAGE__;
2076		3243
2077	# reload cf.pm	3244	warn "unload completed, starting to reload now";
		3245
2078	warn "reloading cf.pm";	3246	warn "reloading cf.pm";
2079	require cf;	3247	require cf;
2080	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt	3248	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2081		3249
2082	# load config and database again	3250	warn "loading config and database again";
2083	cf::cfg_load;	3251	cf::reload_config;
2084	cf::db_load;
2085		3252
2086	# load extensions
2087	warn "load extensions";	3253	warn "loading extensions";
2088	cf::load_extensions;	3254	cf::load_extensions;
2089		3255
2090	# reattach attachments to objects	3256	warn "reattaching attachments to objects/players";
2091	warn "reattach";	3257	_global_reattach; # objects, sockets
2092	_global_reattach;	3258	warn "reattaching attachments to maps";
2093	};	3259	reattach $_ for values %MAP;
		3260	warn "reattaching attachments to players";
		3261	reattach $_ for values %PLAYER;
2094		3262
2095	if ($@) {	3263	warn "leaving sync_job";
		3264
		3265	1
		3266	} or do {
2096	warn $@;	3267	warn $@;
2097	warn "error while reloading, exiting.";	3268	warn "error while reloading, exiting.";
2098	exit 1;	3269	exit 1;
2099	}	3270	};
2100		3271
2101	warn "reloaded successfully";	3272	warn "reloaded";
2102	};	3273	};
2103		3274
2104	#############################################################################	3275	our $RELOAD_WATCHER; # used only during reload
2105		3276
2106	unless ($LINK_MAP) {	3277	sub reload_perl() {
2107	$LINK_MAP = cf::map::new;	3278	# doing reload synchronously and two reloads happen back-to-back,
		3279	# coro crashes during coro_state_free->destroy here.
2108		3280
2109	$LINK_MAP->width (41);	3281	$RELOAD_WATCHER ||= Event->timer (
2110	$LINK_MAP->height (41);	3282	reentrant => 0,
2111	$LINK_MAP->alloc;
2112	$LINK_MAP->path ("{link}");
2113	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2114	$LINK_MAP->in_memory (MAP_IN_MEMORY);
2115
2116	# dirty hack because... archetypes are not yet loaded
2117	Event->timer (
2118	after => 2,	3283	after => 0,
		3284	data => WF_AUTOCANCEL,
2119	cb => sub {	3285	cb => sub {
2120	$_[0]->w->cancel;	3286	do_reload_perl;
2121		3287	undef $RELOAD_WATCHER;
2122	# provide some exits "home"
2123	my $exit = cf::object::new "exit";
2124
2125	$exit->slaying ($EMERGENCY_POSITION->[0]);
2126	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
2127	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
2128
2129	$LINK_MAP->insert ($exit->clone, 19, 19);
2130	$LINK_MAP->insert ($exit->clone, 19, 20);
2131	$LINK_MAP->insert ($exit->clone, 19, 21);
2132	$LINK_MAP->insert ($exit->clone, 20, 19);
2133	$LINK_MAP->insert ($exit->clone, 20, 21);
2134	$LINK_MAP->insert ($exit->clone, 21, 19);
2135	$LINK_MAP->insert ($exit->clone, 21, 20);
2136	$LINK_MAP->insert ($exit->clone, 21, 21);
2137
2138	$exit->destroy;
2139	});	3288	},
2140		3289	);
2141	$LINK_MAP->{deny_save} = 1;
2142	$LINK_MAP->{deny_reset} = 1;
2143
2144	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2145	}	3290	}
2146
2147	register "<global>", __PACKAGE__;
2148		3291
2149	register_command "reload" => sub {	3292	register_command "reload" => sub {
2150	my ($who, $arg) = @_;	3293	my ($who, $arg) = @_;
2151		3294
2152	if ($who->flag (FLAG_WIZ)) {	3295	if ($who->flag (FLAG_WIZ)) {
2153	$who->message ("start of reload.");
2154	reload;
2155	$who->message ("end of reload.");	3296	$who->message ("reloading server.");
		3297	async { reload_perl };
2156	}	3298	}
2157	};	3299	};
2158		3300
2159	unshift @INC, $LIBDIR;	3301	unshift @INC, $LIBDIR;
2160		3302
		3303	my $bug_warning = 0;
		3304
		3305	our @WAIT_FOR_TICK;
		3306	our @WAIT_FOR_TICK_BEGIN;
		3307
		3308	sub wait_for_tick {
		3309	return unless $TICK_WATCHER->is_active;
		3310	return if $Coro::current == $Coro::main;
		3311
		3312	my $signal = new Coro::Signal;
		3313	push @WAIT_FOR_TICK, $signal;
		3314	$signal->wait;
		3315	}
		3316
		3317	sub wait_for_tick_begin {
		3318	return unless $TICK_WATCHER->is_active;
		3319	return if $Coro::current == $Coro::main;
		3320
		3321	my $signal = new Coro::Signal;
		3322	push @WAIT_FOR_TICK_BEGIN, $signal;
		3323	$signal->wait;
		3324	}
		3325
		3326	my $min = 1e6;#d#
		3327	my $avg = 10;
2161	$TICK_WATCHER = Event->timer (	3328	$TICK_WATCHER = Event->timer (
2162	reentrant => 0,	3329	reentrant => 0,
		3330	parked => 1,
2163	prio => 0,	3331	prio => 0,
2164	at => $NEXT_TICK || $TICK,	3332	at => $NEXT_TICK || $TICK,
2165	data => WF_AUTOCANCEL,	3333	data => WF_AUTOCANCEL,
2166	cb => sub {	3334	cb => sub {
		3335	if ($Coro::current != $Coro::main) {
		3336	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		3337	unless ++$bug_warning > 10;
		3338	return;
		3339	}
		3340
		3341	$NOW = $tick_start = Event::time;
		3342
2167	cf::server_tick; # one server iteration	3343	cf::server_tick; # one server iteration
		3344
		3345	0 && sync_job {#d#
		3346	for(1..10) {
		3347	my $t = Event::time;
		3348	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3349	or die;
		3350
		3351	$map->width (50);
		3352	$map->height (50);
		3353	$map->alloc;
		3354	$map->_load_objects ("/tmp/x.map", 1);
		3355	my $t = Event::time - $t;
		3356
		3357	#next unless $t < 0.0013;#d#
		3358	if ($t < $min) {
		3359	$min = $t;
		3360	}
		3361	$avg = $avg * 0.99 + $t * 0.01;
		3362	}
		3363	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3364	exit 0;
		3365	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3366	};
		3367
2168	$RUNTIME += $TICK;	3368	$RUNTIME += $TICK;
2169	$NEXT_TICK += $TICK;	3369	$NEXT_TICK += $TICK;
2170		3370
		3371	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		3372	$NEXT_RUNTIME_WRITE = $NOW + 10;
		3373	Coro::async_pool {
		3374	write_runtime
		3375	or warn "ERROR: unable to write runtime file: $!";
		3376	};
		3377	}
		3378
		3379	# my $AFTER = Event::time;
		3380	# warn $AFTER - $NOW;#d#
		3381
		3382	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3383	$sig->send;
		3384	}
		3385	while (my $sig = shift @WAIT_FOR_TICK) {
		3386	$sig->send;
		3387	}
		3388
		3389	$NOW = Event::time;
		3390
2171	# if we are delayed by four ticks or more, skip them all	3391	# if we are delayed by four ticks or more, skip them all
2172	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3392	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2173		3393
2174	$TICK_WATCHER->at ($NEXT_TICK);	3394	$TICK_WATCHER->at ($NEXT_TICK);
2175	$TICK_WATCHER->start;	3395	$TICK_WATCHER->start;
		3396
		3397	$LOAD = ($NOW - $tick_start) / $TICK;
		3398	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3399
		3400	_post_tick;
		3401
		3402
2176	},	3403	},
2177	);	3404	);
2178		3405
		3406	{
2179	IO::AIO::max_poll_time $TICK * 0.2;	3407	BDB::max_poll_time $TICK * 0.1;
2180		3408	$BDB_POLL_WATCHER = Event->io (
2181	Event->io (	3409	reentrant => 0,
2182	fd => IO::AIO::poll_fileno,	3410	fd => BDB::poll_fileno,
2183	poll => 'r',	3411	poll => 'r',
2184	prio => 5,	3412	prio => 0,
2185	data => WF_AUTOCANCEL,
2186	cb => \&IO::AIO::poll_cb,
2187	);
2188
2189	Event->timer (
2190	data => WF_AUTOCANCEL,	3413	data => WF_AUTOCANCEL,
2191	after => 0,	3414	cb => \&BDB::poll_cb,
2192	interval => 10,	3415	);
2193	cb => sub {	3416	BDB::min_parallel 8;
2194	(Coro::unblock_sub {	3417
2195	write_runtime	3418	BDB::set_sync_prepare {
2196	or warn "ERROR: unable to write runtime file: $!";	3419	my $status;
		3420	my $current = $Coro::current;
		3421	(
		3422	sub {
		3423	$status = $!;
		3424	$current->ready; undef $current;
		3425	},
		3426	sub {
		3427	Coro::schedule while defined $current;
		3428	$! = $status;
		3429	},
		3430	)
		3431	};
		3432
		3433	unless ($DB_ENV) {
		3434	$DB_ENV = BDB::db_env_create;
		3435
		3436	cf::sync_job {
		3437	eval {
		3438	BDB::db_env_open
		3439	$DB_ENV,
		3440	$BDBDIR,
		3441	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3442	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3443	0666;
		3444
		3445	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3446
		3447	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3448	$DB_ENV->set_lk_detect;
		3449	};
		3450
		3451	cf::cleanup "db_env_open(db): $@" if $@;
2197	})->();	3452	};
2198	},	3453	}
2199	);	3454	}
		3455
		3456	{
		3457	IO::AIO::min_parallel 8;
		3458
		3459	undef $Coro::AIO::WATCHER;
		3460	IO::AIO::max_poll_time $TICK * 0.1;
		3461	$AIO_POLL_WATCHER = Event->io (
		3462	reentrant => 0,
		3463	data => WF_AUTOCANCEL,
		3464	fd => IO::AIO::poll_fileno,
		3465	poll => 'r',
		3466	prio => 6,
		3467	cb => \&IO::AIO::poll_cb,
		3468	);
		3469	}
		3470
		3471	my $_log_backtrace;
		3472
		3473	sub _log_backtrace {
		3474	my ($msg, @addr) = @_;
		3475
		3476	$msg =~ s/\n//;
		3477
		3478	# limit the # of concurrent backtraces
		3479	if ($_log_backtrace < 2) {
		3480	++$_log_backtrace;
		3481	async {
		3482	my @bt = fork_call {
		3483	@addr = map { sprintf "%x", $_ } @addr;
		3484	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3485	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3486	or die "addr2line: $!";
		3487
		3488	my @funcs;
		3489	my @res = <$fh>;
		3490	chomp for @res;
		3491	while (@res) {
		3492	my ($func, $line) = splice @res, 0, 2, ();
		3493	push @funcs, "[$func] $line";
		3494	}
		3495
		3496	@funcs
		3497	};
		3498
		3499	LOG llevInfo, "[ABT] $msg\n";
		3500	LOG llevInfo, "[ABT] $_\n" for @bt;
		3501	--$_log_backtrace;
		3502	};
		3503	} else {
		3504	LOG llevInfo, "[ABT] $msg\n";
		3505	LOG llevInfo, "[ABT] [suppressed]\n";
		3506	}
		3507	}
		3508
		3509	# load additional modules
		3510	use cf::pod;
2200		3511
2201	END { cf::emergency_save }	3512	END { cf::emergency_save }
2202		3513
2203	1	3514	1
2204		3515

Diff Legend

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