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.79 by root, Tue Nov 7 14:58:35 2006 UTC vs.
Revision 1.166 by root, Sat Jan 13 23:06:13 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Data::Dumper;
		21	use Digest::MD5;
		22	use Fcntl;
10	use IO::AIO ();	23	use IO::AIO 2.32 ();
11	use YAML::Syck ();	24	use YAML::Syck ();
12	use Time::HiRes;	25	use Time::HiRes;
13	use Event;	26
14	$Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		28
		29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		30
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	32	$YAML::Syck::ImplicitUnicode = 1;
18		33
19	use strict;	34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		35
21	_init_vars;
22
23	our %COMMAND = ();	36	our %COMMAND = ();
		37	our %COMMAND_TIME = ();
		38
		39	our @EXTS = (); # list of extension package names
		40	our %EXTCMD = ();
		41	our %EXT_CORO = (); # coroutines bound to extensions
		42	our %EXT_MAP = (); # pluggable maps
		43
24	our @EVENT;	44	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	45	our $LIBDIR = datadir . "/ext";
26		46
27	our $TICK = MAX_TIME * 1e-6;	47	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	48	our $TICK_WATCHER;
29	our $NEXT_TICK;	49	our $NEXT_TICK;
		50	our $NOW;
30		51
31	our %CFG;	52	our %CFG;
32		53
33	our $uptime;	54	our $UPTIME; $UPTIME ||= time;
		55	our $RUNTIME;
34		56
35	$uptime ||= time;	57	our %PLAYER; # all users
		58	our %MAP; # all maps
		59	our $LINK_MAP; # the special {link} map, which is always available
		60	our $RANDOM_MAPS = cf::localdir . "/random";
		61
		62	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		63	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		64
		65	# used to convert map paths into valid unix filenames by replacing / by ∕
		66	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		67
		68	binmode STDOUT;
		69	binmode STDERR;
		70
		71	# read virtual server time, if available
		72	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		73	open my $fh, "<", cf::localdir . "/runtime"
		74	or die "unable to read runtime file: $!";
		75	$RUNTIME = <$fh> + 0.;
		76	}
		77
		78	mkdir cf::localdir;
		79	mkdir cf::localdir . "/" . cf::playerdir;
		80	mkdir cf::localdir . "/" . cf::tmpdir;
		81	mkdir cf::localdir . "/" . cf::uniquedir;
		82	mkdir $RANDOM_MAPS;
		83
		84	our $EMERGENCY_POSITION;
36		85
37	#############################################################################	86	#############################################################################
38		87
39	=head2 GLOBAL VARIABLES	88	=head2 GLOBAL VARIABLES
40		89
41	=over 4	90	=over 4
		91
		92	=item $cf::UPTIME
		93
		94	The timestamp of the server start (so not actually an uptime).
		95
		96	=item $cf::RUNTIME
		97
		98	The time this server has run, starts at 0 and is increased by $cf::TICK on
		99	every server tick.
42		100
43	=item $cf::LIBDIR	101	=item $cf::LIBDIR
44		102
45	The perl library directory, where extensions and cf-specific modules can	103	The perl library directory, where extensions and cf-specific modules can
46	be found. It will be added to C<@INC> automatically.	104	be found. It will be added to C<@INC> automatically.
47		105
		106	=item $cf::NOW
		107
		108	The time of the last (current) server tick.
		109
48	=item $cf::TICK	110	=item $cf::TICK
49		111
50	The interval between server ticks, in seconds.	112	The interval between server ticks, in seconds.
51		113
52	=item %cf::CFG	114	=item %cf::CFG
53		115
54	Configuration for the server, loaded from C</etc/crossfire/config>, or	116	Configuration for the server, loaded from C</etc/crossfire/config>, or
55	from wherever your confdir points to.	117	from wherever your confdir points to.
		118
		119	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		120
		121	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		122	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		123	processing has been done. Call C<< ->wait >> on them to maximise the
		124	window of cpu time available, or simply to synchronise to the server tick.
56		125
57	=back	126	=back
58		127
59	=cut	128	=cut
60		129
61	BEGIN {	130	BEGIN {
62	*CORE::GLOBAL::warn = sub {	131	*CORE::GLOBAL::warn = sub {
63	my $msg = join "", @_;	132	my $msg = join "", @_;
		133	utf8::encode $msg;
		134
64	$msg .= "\n"	135	$msg .= "\n"
65	unless $msg =~ /\n$/;	136	unless $msg =~ /\n$/;
66		137
67	print STDERR "cfperl: $msg";
68	LOG llevError, "cfperl: $msg";	138	LOG llevError, $msg;
69	};	139	};
70	}	140	}
71		141
		142	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		143	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		144	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		145	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		146	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
72	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	147	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
73		148
74	# we bless all objects into (empty) derived classes to force a method lookup	149	# we bless all objects into (empty) derived classes to force a method lookup
75	# within the Safe compartment.	150	# within the Safe compartment.
76	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	151	for my $pkg (qw(
		152	cf::global cf::attachable
		153	cf::object cf::object::player
		154	cf::client cf::player
		155	cf::arch cf::living
		156	cf::map cf::party cf::region
		157	)) {
77	no strict 'refs';	158	no strict 'refs';
78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	159	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79	}	160	}
80		161
81	$Event::DIED = sub {	162	$Event::DIED = sub {
82	warn "error in event callback: @_";	163	warn "error in event callback: @_";
83	};	164	};
84		165
85	my %ext_pkg;
86	my @exts;
87	my @hook;
88	my %command;
89	my %extcmd;
90
91	=head2 UTILITY FUNCTIONS	166	=head2 UTILITY FUNCTIONS
92		167
93	=over 4	168	=over 4
94		169
		170	=item dumpval $ref
		171
95	=cut	172	=cut
		173
		174	sub dumpval {
		175	eval {
		176	local $SIG{__DIE__};
		177	my $d;
		178	if (1) {
		179	$d = new Data::Dumper([$_[0]], ["*var"]);
		180	$d->Terse(1);
		181	$d->Indent(2);
		182	$d->Quotekeys(0);
		183	$d->Useqq(1);
		184	#$d->Bless(...);
		185	$d->Seen($_[1]) if @_ > 1;
		186	$d = $d->Dump();
		187	}
		188	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		189	$d
		190	} || "[unable to dump $_[0]: '$@']";
		191	}
96		192
97	use JSON::Syck (); # TODO# replace by JSON::PC once working	193	use JSON::Syck (); # TODO# replace by JSON::PC once working
98		194
99	=item $ref = cf::from_json $json	195	=item $ref = cf::from_json $json
100		196
…		…
116	sub to_json($) {	212	sub to_json($) {
117	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	213	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
118	JSON::Syck::Dump $_[0]	214	JSON::Syck::Dump $_[0]
119	}	215	}
120		216
		217	=item cf::lock_wait $string
		218
		219	Wait until the given lock is available. See cf::lock_acquire.
		220
		221	=item my $lock = cf::lock_acquire $string
		222
		223	Wait until the given lock is available and then acquires it and returns
		224	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		225	for example when the coroutine gets canceled), the lock is automatically
		226	returned.
		227
		228	Lock names should begin with a unique identifier (for example, cf::map::find
		229	uses map_find and cf::map::load uses map_load).
		230
		231	=cut
		232
		233	our %LOCK;
		234
		235	sub lock_wait($) {
		236	my ($key) = @_;
		237
		238	# wait for lock, if any
		239	while ($LOCK{$key}) {
		240	push @{ $LOCK{$key} }, $Coro::current;
		241	Coro::schedule;
		242	}
		243	}
		244
		245	sub lock_acquire($) {
		246	my ($key) = @_;
		247
		248	# wait, to be sure we are not locked
		249	lock_wait $key;
		250
		251	$LOCK{$key} = [];
		252
		253	Coro::guard {
		254	# wake up all waiters, to be on the safe side
		255	$_->ready for @{ delete $LOCK{$key} };
		256	}
		257	}
		258
		259	sub freeze_mainloop {
		260	return unless $TICK_WATCHER->is_active;
		261
		262	my $guard = Coro::guard { $TICK_WATCHER->start };
		263	$TICK_WATCHER->stop;
		264	$guard
		265	}
		266
		267	=item cf::async { BLOCK }
		268
		269	Currently the same as Coro::async_pool, meaning you cannot use
		270	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		271	thing you are allowed to do is call C<prio> on it.
		272
		273	=cut
		274
		275	BEGIN { *async = \&Coro::async_pool }
		276
		277	=item cf::sync_job { BLOCK }
		278
		279	The design of crossfire+ requires that the main coro ($Coro::main) is
		280	always able to handle events or runnable, as crossfire+ is only partly
		281	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		282
		283	If it must be done, put the blocking parts into C<sync_job>. This will run
		284	the given BLOCK in another coroutine while waiting for the result. The
		285	server will be frozen during this time, so the block should either finish
		286	fast or be very important.
		287
		288	=cut
		289
		290	sub sync_job(&) {
		291	my ($job) = @_;
		292
		293	if ($Coro::current == $Coro::main) {
		294	# this is the main coro, too bad, we have to block
		295	# till the operation succeeds, freezing the server :/
		296
		297	# TODO: use suspend/resume instead
		298	# (but this is cancel-safe)
		299	my $freeze_guard = freeze_mainloop;
		300
		301	my $busy = 1;
		302	my @res;
		303
		304	(async {
		305	@res = eval { $job->() };
		306	warn $@ if $@;
		307	undef $busy;
		308	})->prio (Coro::PRIO_MAX);
		309
		310	while ($busy) {
		311	Coro::cede or Event::one_event;
		312	}
		313
		314	wantarray ? @res : $res[0]
		315	} else {
		316	# we are in another coroutine, how wonderful, everything just works
		317
		318	$job->()
		319	}
		320	}
		321
		322	=item $coro = cf::async_ext { BLOCK }
		323
		324	Like async, but this coro is automatically being canceled when the
		325	extension calling this is being unloaded.
		326
		327	=cut
		328
		329	sub async_ext(&) {
		330	my $cb = shift;
		331
		332	my $coro = &Coro::async ($cb);
		333
		334	$coro->on_destroy (sub {
		335	delete $EXT_CORO{$coro+0};
		336	});
		337	$EXT_CORO{$coro+0} = $coro;
		338
		339	$coro
		340	}
		341
		342	sub write_runtime {
		343	return unless $TICK_WATCHER->is_active;
		344
		345	my $runtime = cf::localdir . "/runtime";
		346
		347	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		348	or return;
		349
		350	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		351	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		352	and return;
		353
		354	aio_fsync $fh
		355	and return;
		356
		357	close $fh
		358	or return;
		359
		360	aio_rename "$runtime~", $runtime
		361	and return;
		362
		363	1
		364	}
		365
121	=back	366	=back
122		367
123	=cut	368	=cut
124		369
125	#############################################################################	370	#############################################################################
126		371
127	=head2 EVENTS AND OBJECT ATTACHMENTS	372	=head2 ATTACHABLE OBJECTS
		373
		374	Many objects in crossfire are so-called attachable objects. That means you can
		375	attach callbacks/event handlers (a collection of which is called an "attachment")
		376	to it. All such attachable objects support the following methods.
		377
		378	In the following description, CLASS can be any of C<global>, C<object>
		379	C<player>, C<client> or C<map> (i.e. the attachable objects in
		380	crossfire+).
128		381
129	=over 4	382	=over 4
130		383
131	=item $object->attach ($attachment, key => $value...)
132
133	=item $object->detach ($attachment)
134
135	Attach/detach a pre-registered attachment to an object.
136
137	=item $player->attach ($attachment, key => $value...)
138
139	=item $player->detach ($attachment)
140
141	Attach/detach a pre-registered attachment to a player.
142
143	=item $map->attach ($attachment, key => $value...)	384	=item $attachable->attach ($attachment, key => $value...)
144		385
145	=item $map->detach ($attachment)	386	=item $attachable->detach ($attachment)
146		387
147	Attach/detach a pre-registered attachment to a map.	388	Attach/detach a pre-registered attachment to a specific object and give it
		389	the specified key/value pairs as arguments.
148		390
149	=item $bool = $object->attached ($name)	391	Example, attach a minesweeper attachment to the given object, making it a
		392	10x10 minesweeper game:
150		393
151	=item $bool = $player->attached ($name)	394	$obj->attach (minesweeper => width => 10, height => 10);
152		395
153	=item $bool = $map->attached ($name)	396	=item $bool = $attachable->attached ($name)
154		397
155	Checks wether the named attachment is currently attached to the object.	398	Checks wether the named attachment is currently attached to the object.
156		399
157	=item cf::attach_global ...	400	=item cf::CLASS->attach ...
158		401
159	Attach handlers for global events.	402	=item cf::CLASS->detach ...
160		403
161	This and all following C<attach_*>-functions expect any number of the	404	Define an anonymous attachment and attach it to all objects of the given
162	following handler/hook descriptions:	405	CLASS. See the next function for an explanation of its arguments.
		406
		407	You can attach to global events by using the C<cf::global> class.
		408
		409	Example, log all player logins:
		410
		411	cf::player->attach (
		412	on_login => sub {
		413	my ($pl) = @_;
		414	...
		415	},
		416	);
		417
		418	Example, attach to the jeweler skill:
		419
		420	cf::object->attach (
		421	type => cf::SKILL,
		422	subtype => cf::SK_JEWELER,
		423	on_use_skill => sub {
		424	my ($sk, $ob, $part, $dir, $msg) = @_;
		425	...
		426	},
		427	);
		428
		429	=item cf::CLASS::attachment $name, ...
		430
		431	Register an attachment by C<$name> through which attachable objects of the
		432	given CLASS can refer to this attachment.
		433
		434	Some classes such as crossfire maps and objects can specify attachments
		435	that are attached at load/instantiate time, thus the need for a name.
		436
		437	These calls expect any number of the following handler/hook descriptions:
163		438
164	=over 4	439	=over 4
165		440
166	=item prio => $number	441	=item prio => $number
167		442
…		…
169	by another C<prio> setting). Lower priority handlers get executed	444	by another C<prio> setting). Lower priority handlers get executed
170	earlier. The default priority is C<0>, and many built-in handlers are	445	earlier. The default priority is C<0>, and many built-in handlers are
171	registered at priority C<-1000>, so lower priorities should not be used	446	registered at priority C<-1000>, so lower priorities should not be used
172	unless you know what you are doing.	447	unless you know what you are doing.
173		448
		449	=item type => $type
		450
		451	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		452	given type of objects only (the additional parameter C<subtype> can be
		453	used to further limit to the given subtype).
		454
174	=item on_I<event> => \&cb	455	=item on_I<event> => \&cb
175		456
176	Call the given code reference whenever the named event happens (event is	457	Call the given code reference whenever the named event happens (event is
177	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	458	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
178	handlers are recognised generally depends on the type of object these	459	handlers are recognised generally depends on the type of object these
…		…
187	package and register them. Only handlers for eevents supported by the	468	package and register them. Only handlers for eevents supported by the
188	object/class are recognised.	469	object/class are recognised.
189		470
190	=back	471	=back
191		472
192	=item cf::attach_to_type $object_type, $subtype, ...	473	Example, define an attachment called "sockpuppet" that calls the given
		474	event handler when a monster attacks:
193		475
194	Attach handlers for a specific object type (e.g. TRANSPORT) and	476	cf::object::attachment sockpuppet =>
195	subtype. If C<$subtype> is zero or undef, matches all objects of the given	477	on_skill_attack => sub {
196	type.	478	my ($self, $victim) = @_;
197		479	...
198	=item cf::attach_to_objects ...
199
200	Attach handlers to all objects. Do not use this except for debugging or
201	very rare events, as handlers are (obviously) called for I<all> objects in
202	the game.
203
204	=item cf::attach_to_players ...
205
206	Attach handlers to all players.
207
208	=item cf::attach_to_maps ...
209
210	Attach handlers to all maps.
211
212	=item cf:register_attachment $name, ...
213
214	Register an attachment by name through which objects can refer to this
215	attachment.
216
217	=item cf:register_player_attachment $name, ...
218
219	Register an attachment by name through which players can refer to this
220	attachment.
221
222	=item cf:register_map_attachment $name, ...
223
224	Register an attachment by name through which maps can refer to this
225	attachment.
226
227	=cut
228
229	# the following variables are defined in .xs and must not be re-created
230	our @CB_GLOBAL = (); # registry for all global events
231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232	our @CB_PLAYER = ();
233	our @CB_TYPE = (); # registry for type (cf-object class) based events
234	our @CB_MAP = ();
235
236	my %attachment;
237
238	sub _attach_cb($\%$$$) {
239	my ($registry, $undo, $event, $prio, $cb) = @_;
240
241	use sort 'stable';
242
243	$cb = [$prio, $cb];
244
245	@{$registry->[$event]} = sort
246	{ $a->[0] cmp $b->[0] }
247	@{$registry->[$event] || []}, $cb;
248
249	push @{$undo->{cb}}, [$event, $cb];
250	}
251
252	# attach handles attaching event callbacks
253	# the only thing the caller has to do is pass the correct
254	# registry (== where the callback attaches to).
255	sub _attach(\@$@) {
256	my ($registry, $klass, @arg) = @_;
257
258	my $prio = 0;
259
260	my %undo = (
261	registry => $registry,
262	cb => [],
263	);
264
265	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267	while (@arg) {
268	my $type = shift @arg;
269
270	if ($type eq "prio") {
271	$prio = shift @arg;
272
273	} elsif ($type eq "package") {
274	my $pkg = shift @arg;
275
276	while (my ($name, $id) = each %cb_id) {
277	if (my $cb = $pkg->can ($name)) {
278	_attach_cb $registry, %undo, $id, $prio, $cb;
279	}
280	}	480	}
281
282	} elsif (exists $cb_id{$type}) {
283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285	} elsif (ref $type) {
286	warn "attaching objects not supported, ignoring.\n";
287
288	} else {
289	shift @arg;
290	warn "attach argument '$type' not supported, ignoring.\n";
291	}
292	}
293
294	\%undo
295	}
296
297	sub _attach_attachment {
298	my ($obj, $name, %arg) = @_;
299
300	return if exists $obj->{_attachment}{$name};
301
302	my $res;
303
304	if (my $attach = $attachment{$name}) {
305	my $registry = $obj->registry;
306
307	for (@$attach) {
308	my ($klass, @attach) = @$_;
309	$res = _attach @$registry, $klass, @attach;
310	}
311
312	$obj->{$name} = \%arg;
313	} else {
314	warn "object uses attachment '$name' that is not available, postponing.\n";
315	}
316
317	$obj->{_attachment}{$name} = undef;
318
319	$res->{attachment} = $name;
320	$res
321	}
322
323	*cf::object::attach =
324	*cf::player::attach =
325	*cf::map::attach = sub {
326	my ($obj, $name, %arg) = @_;
327
328	_attach_attachment $obj, $name, %arg;
329	};
330
331	# all those should be optimised
332	*cf::object::detach =
333	*cf::player::detach =
334	*cf::map::detach = sub {
335	my ($obj, $name) = @_;
336
337	delete $obj->{_attachment}{$name};
338	reattach ($obj);
339	};
340
341	*cf::object::attached =
342	*cf::player::attached =
343	*cf::map::attached = sub {
344	my ($obj, $name) = @_;
345
346	exists $obj->{_attachment}{$name}
347	};
348
349	sub attach_global {
350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
351	}
352
353	sub attach_to_type {
354	my $type = shift;
355	my $subtype = shift;
356
357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358	}
359
360	sub attach_to_objects {
361	_attach @CB_OBJECT, KLASS_OBJECT, @_
362	}
363
364	sub attach_to_players {
365	_attach @CB_PLAYER, KLASS_PLAYER, @_
366	}
367
368	sub attach_to_maps {
369	_attach @CB_MAP, KLASS_MAP, @_
370	}
371
372	sub register_attachment {
373	my $name = shift;
374
375	$attachment{$name} = [[KLASS_OBJECT, @_]];
376	}
377
378	sub register_player_attachment {
379	my $name = shift;
380
381	$attachment{$name} = [[KLASS_PLAYER, @_]];
382	}
383
384	sub register_map_attachment {
385	my $name = shift;
386
387	$attachment{$name} = [[KLASS_MAP, @_]];
388	}
389
390	our $override;
391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393	sub override {
394	$override = 1;
395	@invoke_results = ();
396	}
397
398	sub do_invoke {
399	my $event = shift;
400	my $callbacks = shift;
401
402	@invoke_results = ();
403
404	local $override;
405
406	for (@$callbacks) {
407	eval { &{$_->[1]} };
408
409	if ($@) {
410	warn "$@";
411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412	override;
413	}
414
415	return 1 if $override;
416	}
417
418	0	481	}
419	}
420		482
421	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	483	=item $attachable->valid
422
423	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429	Generate a global/object/player/map-specific event with the given arguments.
430
431	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432	removed in future versions), and there is no public API to access override
433	results (if you must, access C<@cf::invoke_results> directly).
434
435	=back
436
437	=cut
438
439	#############################################################################
440
441	=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443	=over 4
444
445	=item $object->valid, $player->valid, $map->valid
446		484
447	Just because you have a perl object does not mean that the corresponding	485	Just because you have a perl object does not mean that the corresponding
448	C-level object still exists. If you try to access an object that has no	486	C-level object still exists. If you try to access an object that has no
449	valid C counterpart anymore you get an exception at runtime. This method	487	valid C counterpart anymore you get an exception at runtime. This method
450	can be used to test for existence of the C object part without causing an	488	can be used to test for existence of the C object part without causing an
451	exception.	489	exception.
452		490
		491	=cut
		492
		493	# the following variables are defined in .xs and must not be re-created
		494	our @CB_GLOBAL = (); # registry for all global events
		495	our @CB_ATTACHABLE = (); # registry for all attachables
		496	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		497	our @CB_PLAYER = ();
		498	our @CB_CLIENT = ();
		499	our @CB_TYPE = (); # registry for type (cf-object class) based events
		500	our @CB_MAP = ();
		501
		502	my %attachment;
		503
		504	sub _attach_cb($$$$) {
		505	my ($registry, $event, $prio, $cb) = @_;
		506
		507	use sort 'stable';
		508
		509	$cb = [$prio, $cb];
		510
		511	@{$registry->[$event]} = sort
		512	{ $a->[0] cmp $b->[0] }
		513	@{$registry->[$event] || []}, $cb;
		514	}
		515
		516	# hack
		517	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		518
		519	# attach handles attaching event callbacks
		520	# the only thing the caller has to do is pass the correct
		521	# registry (== where the callback attaches to).
		522	sub _attach {
		523	my ($registry, $klass, @arg) = @_;
		524
		525	my $object_type;
		526	my $prio = 0;
		527	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		528
		529	#TODO: get rid of this hack
		530	if ($attachable_klass{$klass}) {
		531	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		532	}
		533
		534	while (@arg) {
		535	my $type = shift @arg;
		536
		537	if ($type eq "prio") {
		538	$prio = shift @arg;
		539
		540	} elsif ($type eq "type") {
		541	$object_type = shift @arg;
		542	$registry = $CB_TYPE[$object_type] ||= [];
		543
		544	} elsif ($type eq "subtype") {
		545	defined $object_type or Carp::croak "subtype specified without type";
		546	my $object_subtype = shift @arg;
		547	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		548
		549	} elsif ($type eq "package") {
		550	my $pkg = shift @arg;
		551
		552	while (my ($name, $id) = each %cb_id) {
		553	if (my $cb = $pkg->can ($name)) {
		554	_attach_cb $registry, $id, $prio, $cb;
		555	}
		556	}
		557
		558	} elsif (exists $cb_id{$type}) {
		559	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		560
		561	} elsif (ref $type) {
		562	warn "attaching objects not supported, ignoring.\n";
		563
		564	} else {
		565	shift @arg;
		566	warn "attach argument '$type' not supported, ignoring.\n";
		567	}
		568	}
		569	}
		570
		571	sub _object_attach {
		572	my ($obj, $name, %arg) = @_;
		573
		574	return if exists $obj->{_attachment}{$name};
		575
		576	if (my $attach = $attachment{$name}) {
		577	my $registry = $obj->registry;
		578
		579	for (@$attach) {
		580	my ($klass, @attach) = @$_;
		581	_attach $registry, $klass, @attach;
		582	}
		583
		584	$obj->{$name} = \%arg;
		585	} else {
		586	warn "object uses attachment '$name' that is not available, postponing.\n";
		587	}
		588
		589	$obj->{_attachment}{$name} = undef;
		590	}
		591
		592	sub cf::attachable::attach {
		593	if (ref $_[0]) {
		594	_object_attach @_;
		595	} else {
		596	_attach shift->_attach_registry, @_;
		597	}
		598	};
		599
		600	# all those should be optimised
		601	sub cf::attachable::detach {
		602	my ($obj, $name) = @_;
		603
		604	if (ref $obj) {
		605	delete $obj->{_attachment}{$name};
		606	reattach ($obj);
		607	} else {
		608	Carp::croak "cannot, currently, detach class attachments";
		609	}
		610	};
		611
		612	sub cf::attachable::attached {
		613	my ($obj, $name) = @_;
		614
		615	exists $obj->{_attachment}{$name}
		616	}
		617
		618	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		619	eval "#line " . __LINE__ . " 'cf.pm'
		620	sub cf::\L$klass\E::_attach_registry {
		621	(\\\@CB_$klass, KLASS_$klass)
		622	}
		623
		624	sub cf::\L$klass\E::attachment {
		625	my \$name = shift;
		626
		627	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		628	}
		629	";
		630	die if $@;
		631	}
		632
		633	our $override;
		634	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		635
		636	sub override {
		637	$override = 1;
		638	@invoke_results = ();
		639	}
		640
		641	sub do_invoke {
		642	my $event = shift;
		643	my $callbacks = shift;
		644
		645	@invoke_results = ();
		646
		647	local $override;
		648
		649	for (@$callbacks) {
		650	eval { &{$_->[1]} };
		651
		652	if ($@) {
		653	warn "$@";
		654	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		655	override;
		656	}
		657
		658	return 1 if $override;
		659	}
		660
		661	0
		662	}
		663
		664	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		665
		666	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		667
		668	Generate an object-specific event with the given arguments.
		669
		670	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		671	removed in future versions), and there is no public API to access override
		672	results (if you must, access C<@cf::invoke_results> directly).
		673
453	=back	674	=back
454		675
455	=cut	676	=cut
456
457	*cf::object::valid =
458	*cf::player::valid =
459	*cf::map::valid = \&cf::_valid;
460		677
461	#############################################################################	678	#############################################################################
462	# object support	679	# object support
463		680
464	sub instantiate {
465	my ($obj, $data) = @_;
466
467	$data = from_json $data;
468
469	for (@$data) {
470	my ($name, $args) = @$_;
471
472	$obj->attach ($name, %{$args || {} });
473	}
474	}
475
476	# basically do the same as instantiate, without calling instantiate
477	sub reattach {	681	sub reattach {
		682	# basically do the same as instantiate, without calling instantiate
478	my ($obj) = @_;	683	my ($obj) = @_;
		684
479	my $registry = $obj->registry;	685	my $registry = $obj->registry;
480		686
481	@$registry = ();	687	@$registry = ();
482		688
483	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	689	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
484		690
485	for my $name (keys %{ $obj->{_attachment} || {} }) {	691	for my $name (keys %{ $obj->{_attachment} || {} }) {
486	if (my $attach = $attachment{$name}) {	692	if (my $attach = $attachment{$name}) {
487	for (@$attach) {	693	for (@$attach) {
488	my ($klass, @attach) = @$_;	694	my ($klass, @attach) = @$_;
489	_attach @$registry, $klass, @attach;	695	_attach $registry, $klass, @attach;
490	}	696	}
491	} else {	697	} else {
492	warn "object uses attachment '$name' that is not available, postponing.\n";	698	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	699	}
494	}	700	}
495	}	701	}
496		702
497	sub object_freezer_save {	703	cf::attachable->attach (
498	my ($filename, $rdata, $objs) = @_;
499
500	if (length $$rdata) {
501	warn sprintf "saving %s (%d,%d)\n",
502	$filename, length $$rdata, scalar @$objs;
503
504	if (open my $fh, ">:raw", "$filename~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, $$rdata;
507	close $fh;
508
509	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510	chmod SAVE_MODE, $fh;
511	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
512	close $fh;
513	rename "$filename.pst~", "$filename.pst";
514	} else {
515	unlink "$filename.pst";
516	}
517
518	rename "$filename~", $filename;
519	} else {
520	warn "FATAL: $filename~: $!\n";
521	}
522	} else {
523	unlink $filename;
524	unlink "$filename.pst";
525	}
526	}
527
528	sub object_thawer_load {
529	my ($filename) = @_;
530
531	local $/;
532
533	my $av;
534
535	#TODO: use sysread etc.
536	if (open my $data, "<:raw:perlio", $filename) {
537	$data = <$data>;
538	if (open my $pst, "<:raw:perlio", "$filename.pst") {
539	$av = eval { (Storable::thaw <$pst>)->{objs} };
540	}
541	return ($data, $av);
542	}
543
544	()
545	}
546
547	attach_to_objects
548	prio => -1000000,	704	prio => -1000000,
		705	on_instantiate => sub {
		706	my ($obj, $data) = @_;
		707
		708	$data = from_json $data;
		709
		710	for (@$data) {
		711	my ($name, $args) = @$_;
		712
		713	$obj->attach ($name, %{$args || {} });
		714	}
		715	},
		716	on_reattach => \&reattach,
549	on_clone => sub {	717	on_clone => sub {
550	my ($src, $dst) = @_;	718	my ($src, $dst) = @_;
551		719
552	@{$dst->registry} = @{$src->registry};	720	@{$dst->registry} = @{$src->registry};
553		721
554	%$dst = %$src;	722	%$dst = %$src;
555		723
556	%{$dst->{_attachment}} = %{$src->{_attachment}}	724	%{$dst->{_attachment}} = %{$src->{_attachment}}
557	if exists $src->{_attachment};	725	if exists $src->{_attachment};
558	},	726	},
559	;	727	);
		728
		729	sub object_freezer_save {
		730	my ($filename, $rdata, $objs) = @_;
		731
		732	sync_job {
		733	if (length $$rdata) {
		734	warn sprintf "saving %s (%d,%d)\n",
		735	$filename, length $$rdata, scalar @$objs;
		736
		737	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		738	chmod SAVE_MODE, $fh;
		739	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		740	aio_fsync $fh;
		741	close $fh;
		742
		743	if (@$objs) {
		744	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		745	chmod SAVE_MODE, $fh;
		746	my $data = Storable::nfreeze { version => 1, objs => $objs };
		747	aio_write $fh, 0, (length $data), $data, 0;
		748	aio_fsync $fh;
		749	close $fh;
		750	aio_rename "$filename.pst~", "$filename.pst";
		751	}
		752	} else {
		753	aio_unlink "$filename.pst";
		754	}
		755
		756	aio_rename "$filename~", $filename;
		757	} else {
		758	warn "FATAL: $filename~: $!\n";
		759	}
		760	} else {
		761	aio_unlink $filename;
		762	aio_unlink "$filename.pst";
		763	}
		764	}
		765	}
		766
		767	sub object_freezer_as_string {
		768	my ($rdata, $objs) = @_;
		769
		770	use Data::Dumper;
		771
		772	$$rdata . Dumper $objs
		773	}
		774
		775	sub object_thawer_load {
		776	my ($filename) = @_;
		777
		778	my ($data, $av);
		779
		780	(aio_load $filename, $data) >= 0
		781	or return;
		782
		783	unless (aio_stat "$filename.pst") {
		784	(aio_load "$filename.pst", $av) >= 0
		785	or return;
		786	$av = eval { (Storable::thaw $av)->{objs} };
		787	}
		788
		789	warn sprintf "loading %s (%d)\n",
		790	$filename, length $data, scalar @{$av || []};#d#
		791	return ($data, $av);
		792	}
560		793
561	#############################################################################	794	#############################################################################
562	# old plug-in events	795	# command handling &c
563		796
564	sub inject_event {	797	=item cf::register_command $name => \&callback($ob,$args);
565	my $extension = shift;
566	my $event_code = shift;
567		798
568	my $cb = $hook[$event_code]{$extension}	799	Register a callback for execution when the client sends the user command
569	or return;	800	$name.
570		801
571	&$cb	802	=cut
572	}
573
574	sub inject_global_event {
575	my $event = shift;
576
577	my $cb = $hook[$event]
578	or return;
579
580	List::Util::max map &$_, values %$cb
581	}
582
583	sub inject_command {
584	my ($name, $obj, $params) = @_;
585
586	for my $cmd (@{ $command{$name} }) {
587	$cmd->[1]->($obj, $params);
588	}
589
590	-1
591	}
592		803
593	sub register_command {	804	sub register_command {
594	my ($name, $time, $cb) = @_;	805	my ($name, $cb) = @_;
595		806
596	my $caller = caller;	807	my $caller = caller;
597	#warn "registering command '$name/$time' to '$caller'";	808	#warn "registering command '$name/$time' to '$caller'";
598		809
599	push @{ $command{$name} }, [$time, $cb, $caller];	810	push @{ $COMMAND{$name} }, [$caller, $cb];
600	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
601	}	811	}
		812
		813	=item cf::register_extcmd $name => \&callback($pl,$packet);
		814
		815	Register a callbackf ro execution when the client sends an extcmd packet.
		816
		817	If the callback returns something, it is sent back as if reply was being
		818	called.
		819
		820	=cut
602		821
603	sub register_extcmd {	822	sub register_extcmd {
604	my ($name, $cb) = @_;	823	my ($name, $cb) = @_;
605		824
606	my $caller = caller;	825	$EXTCMD{$name} = $cb;
607	#warn "registering extcmd '$name' to '$caller'";
608
609	$extcmd{$name} = [$cb, $caller];
610	}	826	}
611		827
612	sub register {	828	cf::player->attach (
613	my ($base, $pkg) = @_;	829	on_command => sub {
		830	my ($pl, $name, $params) = @_;
614		831
615	#TODO	832	my $cb = $COMMAND{$name}
616	}	833	or return;
		834
		835	for my $cmd (@$cb) {
		836	$cmd->[1]->($pl->ob, $params);
		837	}
		838
		839	cf::override;
		840	},
		841	on_extcmd => sub {
		842	my ($pl, $buf) = @_;
		843
		844	my $msg = eval { from_json $buf };
		845
		846	if (ref $msg) {
		847	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		848	if (my %reply = $cb->($pl, $msg)) {
		849	$pl->ext_reply ($msg->{msgid}, %reply);
		850	}
		851	}
		852	} else {
		853	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		854	}
		855
		856	cf::override;
		857	},
		858	);
617		859
618	sub load_extension {	860	sub load_extension {
619	my ($path) = @_;	861	my ($path) = @_;
620		862
621	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	863	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
622	my $base = $1;	864	my $base = $1;
623	my $pkg = $1;	865	my $pkg = $1;
624	$pkg =~ s/[^[:word:]]/_/g;	866	$pkg =~ s/[^[:word:]]/_/g;
625	$pkg = "ext::$pkg";	867	$pkg = "ext::$pkg";
626		868
627	warn "loading '$path' into '$pkg'\n";	869	warn "... loading '$path' into '$pkg'\n";
628		870
629	open my $fh, "<:utf8", $path	871	open my $fh, "<:utf8", $path
630	or die "$path: $!";	872	or die "$path: $!";
631		873
632	my $source =	874	my $source =
633	"package $pkg; use strict; use utf8;\n"	875	"package $pkg; use strict; use utf8;\n"
634	. "#line 1 \"$path\"\n{\n"	876	. "#line 1 \"$path\"\n{\n"
635	. (do { local $/; <$fh> })	877	. (do { local $/; <$fh> })
636	. "\n};\n1";	878	. "\n};\n1";
637		879
638	eval $source	880	unless (eval $source) {
639	or die "$path: $@";	881	my $msg = $@ ? "$path: $@\n"
640		882	: "extension disabled.\n";
641	push @exts, $pkg;	883	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
642	$ext_pkg{$base} = $pkg;	884	warn $@;
643		885	warn "mandatory extension failed to load, exiting.\n";
644	# no strict 'refs';	886	exit 1;
645	# @{"$pkg\::ISA"} = ext::;	887	}
646		888	die $@;
647	register $base, $pkg;
648	}
649
650	sub unload_extension {
651	my ($pkg) = @_;
652
653	warn "removing extension $pkg\n";
654
655	# remove hooks
656	#TODO
657	# for my $idx (0 .. $#PLUGIN_EVENT) {
658	# delete $hook[$idx]{$pkg};
659	# }	889	}
660		890
661	# remove commands	891	push @EXTS, $pkg;
662	for my $name (keys %command) {
663	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
664
665	if (@cb) {
666	$command{$name} = \@cb;
667	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
668	} else {
669	delete $command{$name};
670	delete $COMMAND{"$name\000"};
671	}
672	}
673
674	# remove extcmds
675	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
676	delete $extcmd{$name};
677	}
678
679	if (my $cb = $pkg->can ("unload")) {
680	eval {
681	$cb->($pkg);
682	1
683	} or warn "$pkg unloaded, but with errors: $@";
684	}
685
686	Symbol::delete_package $pkg;
687	}	892	}
688		893
689	sub load_extensions {	894	sub load_extensions {
690	my $LIBDIR = maps_directory "perl";
691
692	for my $ext (<$LIBDIR/*.ext>) {	895	for my $ext (<$LIBDIR/*.ext>) {
693	next unless -r $ext;	896	next unless -r $ext;
694	eval {	897	eval {
695	load_extension $ext;	898	load_extension $ext;
696	1	899	1
697	} or warn "$ext not loaded: $@";	900	} or warn "$ext not loaded: $@";
698	}	901	}
699	}	902	}
700		903
701	#############################################################################	904	#############################################################################
702	# extcmd framework, basically convert ext <msg>
703	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
704
705	attach_to_players
706	on_extcmd => sub {
707	my ($pl, $buf) = @_;
708
709	my $msg = eval { from_json $buf };
710
711	if (ref $msg) {
712	if (my $cb = $extcmd{$msg->{msgtype}}) {
713	if (my %reply = $cb->[0]->($pl, $msg)) {
714	$pl->ext_reply ($msg->{msgid}, %reply);
715	}
716	}
717	} else {
718	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
719	}
720
721	cf::override;
722	},
723	;
724
725	#############################################################################
726	# load/save/clean perl data associated with a map	905	# load/save/clean perl data associated with a map
727		906
728	*cf::mapsupport::on_clean = sub {	907	*cf::mapsupport::on_clean = sub {
729	my ($map) = @_;	908	my ($map) = @_;
730		909
…		…
732	defined $path or return;	911	defined $path or return;
733		912
734	unlink "$path.pst";	913	unlink "$path.pst";
735	};	914	};
736		915
737	attach_to_maps prio => -10000, package => cf::mapsupport::;	916	cf::map->attach (prio => -10000, package => cf::mapsupport::);
738		917
739	#############################################################################	918	#############################################################################
740	# load/save perl data associated with player->ob objects
741
742	sub all_objects(@) {
743	@_, map all_objects ($_->inv), @_
744	}
745
746	# TODO: compatibility cruft, remove when no longer needed
747	attach_to_players
748	on_load => sub {
749	my ($pl, $path) = @_;
750
751	for my $o (all_objects $pl->ob) {
752	if (my $value = $o->get_ob_key_value ("_perl_data")) {
753	$o->set_ob_key_value ("_perl_data");
754
755	%$o = %{ Storable::thaw pack "H*", $value };
756	}
757	}
758	},
759	;
760
761	#############################################################################
762		919
763	=head2 CORE EXTENSIONS	920	=head2 CORE EXTENSIONS
764		921
765	Functions and methods that extend core crossfire objects.	922	Functions and methods that extend core crossfire objects.
766		923
		924	=cut
		925
		926	package cf::player;
		927
		928	use Coro::AIO;
		929
		930	=head3 cf::player
		931
767	=over 4	932	=over 4
768		933
769	=item cf::player::exists $login	934	=item cf::player::find $login
770		935
771	Returns true when the given account exists.	936	Returns the given player object, loading it if necessary (might block).
772		937
773	=cut	938	=cut
774		939
775	sub cf::player::exists($) {	940	sub playerdir($) {
776	cf::player::find $_[0]	941	cf::localdir
777	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	942	. "/"
		943	. cf::playerdir
		944	. "/"
		945	. (ref $_[0] ? $_[0]->ob->name : $_[0])
778	}	946	}
		947
		948	sub path($) {
		949	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		950
		951	(playerdir $login) . "/$login.pl"
		952	}
		953
		954	sub find_active($) {
		955	$cf::PLAYER{$_[0]}
		956	and $cf::PLAYER{$_[0]}->active
		957	and $cf::PLAYER{$_[0]}
		958	}
		959
		960	sub exists($) {
		961	my ($login) = @_;
		962
		963	$cf::PLAYER{$login}
		964	or cf::sync_job { !aio_stat $login }
		965	}
		966
		967	sub find($) {
		968	return $cf::PLAYER{$_[0]} || do {
		969	my $login = $_[0];
		970
		971	my $guard = cf::lock_acquire "user_find:$login";
		972
		973	$cf::PLAYER{$_[0]} || do {
		974	my $pl = load_pl path $login
		975	or return;
		976	$cf::PLAYER{$login} = $pl
		977	}
		978	}
		979	}
		980
		981	sub save($) {
		982	my ($pl) = @_;
		983
		984	return if $pl->{deny_save};
		985
		986	my $path = path $pl;
		987	my $guard = cf::lock_acquire "user_save:$path";
		988
		989	return if $pl->{deny_save};
		990
		991	aio_mkdir playerdir $pl, 0770;
		992	$pl->{last_save} = $cf::RUNTIME;
		993
		994	$pl->save_pl ($path);
		995	Coro::cede;
		996	}
		997
		998	sub new($) {
		999	my ($login) = @_;
		1000
		1001	my $self = create;
		1002
		1003	$self->ob->name ($login);
		1004	$self->{deny_save} = 1;
		1005
		1006	$cf::PLAYER{$login} = $self;
		1007
		1008	$self
		1009	}
		1010
		1011	=item $pl->quit_character
		1012
		1013	Nukes the player without looking back. If logged in, the connection will
		1014	be destroyed. May block for a long time.
		1015
		1016	=cut
		1017
		1018	sub quit_character {
		1019	my ($pl) = @_;
		1020
		1021	$pl->{deny_save} = 1;
		1022	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1023
		1024	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1025	$pl->deactivate;
		1026	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1027	$pl->ns->destroy if $pl->ns;
		1028
		1029	my $path = playerdir $pl;
		1030	my $temp = "$path~$cf::RUNTIME~deleting~";
		1031	aio_rename $path, $temp;
		1032	delete $cf::PLAYER{$pl->ob->name};
		1033	$pl->destroy;
		1034	IO::AIO::aio_rmtree $temp;
		1035	}
		1036
		1037	=item cf::player::list_logins
		1038
		1039	Returns am arrayref of all valid playernames in the system, can take a
		1040	while and may block, so not sync_job-capable, ever.
		1041
		1042	=cut
		1043
		1044	sub list_logins {
		1045	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1046	or return [];
		1047
		1048	my @logins;
		1049
		1050	for my $login (@$dirs) {
		1051	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1052	aio_read $fh, 0, 512, my $buf, 0 or next;
		1053	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1054
		1055	utf8::decode $login;
		1056	push @logins, $login;
		1057	}
		1058
		1059	\@logins
		1060	}
		1061
		1062	=item $player->maps
		1063
		1064	Returns an arrayref of map paths that are private for this
		1065	player. May block.
		1066
		1067	=cut
		1068
		1069	sub maps($) {
		1070	my ($pl) = @_;
		1071
		1072	my $files = aio_readdir playerdir $pl
		1073	or return;
		1074
		1075	my @paths;
		1076
		1077	for (@$files) {
		1078	utf8::decode $_;
		1079	next if /\.(?:pl|pst)$/;
		1080	next unless /^$PATH_SEP/o;
		1081
		1082	push @paths, "~" . $pl->ob->name . "/" . $_;
		1083	}
		1084
		1085	\@paths
		1086	}
		1087
		1088	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1089
		1090	Sends an ext reply to the player.
		1091
		1092	=cut
		1093
		1094	sub ext_reply($$$%) {
		1095	my ($self, $id, %msg) = @_;
		1096
		1097	$msg{msgid} = $id;
		1098
		1099	$self->send ("ext " . cf::to_json \%msg);
		1100	}
		1101
		1102	package cf;
		1103
		1104	=back
		1105
		1106
		1107	=head3 cf::map
		1108
		1109	=over 4
		1110
		1111	=cut
		1112
		1113	package cf::map;
		1114
		1115	use Fcntl;
		1116	use Coro::AIO;
		1117
		1118	use overload
		1119	'""' => \&as_string;
		1120
		1121	our $MAX_RESET = 3600;
		1122	our $DEFAULT_RESET = 3000;
		1123
		1124	sub generate_random_map {
		1125	my ($self, $rmp) = @_;
		1126
		1127	# mit "rum" bekleckern, nicht
		1128	$self->_create_random_map (
		1129	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1130	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1131	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1132	$rmp->{exit_on_final_map},
		1133	$rmp->{xsize}, $rmp->{ysize},
		1134	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1135	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1136	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1137	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1138	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1139	(cf::region::find $rmp->{region}), $rmp->{custom}
		1140	)
		1141	}
		1142
		1143	sub register {
		1144	my (undef, $regex) = @_;
		1145	my $pkg = caller;
		1146
		1147	no strict;
		1148	push @{"$pkg\::ISA"}, __PACKAGE__;
		1149
		1150	$EXT_MAP{$pkg} = qr<$regex>;
		1151	}
		1152
		1153	# also paths starting with '/'
		1154	$EXT_MAP{"cf::map"} = qr{^(?=/)};
		1155
		1156	sub normalise {
		1157	my ($path, $base) = @_;
		1158
		1159	# map plan:
		1160	#
		1161	# /! non-realised random map exit (special hack!)
		1162	# {... are special paths that are not being touched
		1163	# ?xxx/... are special absolute paths
		1164	# ?random/... random maps
		1165	# /... normal maps
		1166	# ~user/... per-player map of a specific user
		1167
		1168	$path =~ s/$PATH_SEP/\//go;
		1169
		1170	# treat it as relative path if it starts with
		1171	# something that looks reasonable
		1172	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1173	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1174
		1175	$base =~ s{[^/]+/?$}{};
		1176	$path = "$base/$path";
		1177	}
		1178
		1179	for ($path) {
		1180	redo if s{//}{/};
		1181	redo if s{/\.?/}{/};
		1182	redo if s{/[^/]+/\.\./}{/};
		1183	}
		1184
		1185	$path
		1186	}
		1187
		1188	sub new_from_path {
		1189	my (undef, $path, $base) = @_;
		1190
		1191	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1192
		1193	$path = normalise $path, $base;
		1194
		1195	for my $pkg (keys %EXT_MAP) {
		1196	if ($path =~ $EXT_MAP{$pkg}) {
		1197	my $self = bless cf::map::new, $pkg;
		1198	$self->{path} = $path; $self->path ($path);
		1199	$self->init; # pass $1 etc.
		1200	return $self;
		1201	}
		1202	}
		1203
		1204	Carp::carp "unable to resolve path '$path'.";
		1205	()
		1206	}
		1207
		1208	sub init {
		1209	my ($self) = @_;
		1210
		1211	$self
		1212	}
		1213
		1214	sub as_string {
		1215	my ($self) = @_;
		1216
		1217	"$self->{path}"
		1218	}
		1219
		1220	# the displayed name, this is a one way mapping
		1221	sub visible_name {
		1222	&as_string
		1223	}
		1224
		1225	# escape the /'s in the path
		1226	sub _escaped_path {
		1227	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1228
		1229	$path
		1230	}
		1231
		1232	# the original (read-only) location
		1233	sub load_path {
		1234	my ($self) = @_;
		1235
		1236	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1237	}
		1238
		1239	# the temporary/swap location
		1240	sub save_path {
		1241	my ($self) = @_;
		1242
		1243	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $self->_escaped_path
		1244	}
		1245
		1246	# the unique path, undef == no special unique path
		1247	sub uniq_path {
		1248	my ($self) = @_;
		1249
		1250	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		1251	}
		1252
		1253	# and all this just because we cannot iterate over
		1254	# all maps in C++...
		1255	sub change_all_map_light {
		1256	my ($change) = @_;
		1257
		1258	$_->change_map_light ($change)
		1259	for grep $_->outdoor, values %cf::MAP;
		1260	}
		1261
		1262	sub unlink_save {
		1263	my ($self) = @_;
		1264
		1265	utf8::encode (my $save = $self->save_path);
		1266	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
		1267	IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
		1268	}
		1269
		1270	sub load_header_from($) {
		1271	my ($self, $path) = @_;
		1272
		1273	utf8::encode $path;
		1274	aio_open $path, O_RDONLY, 0
		1275	or return;
		1276
		1277	$self->_load_header ($path)
		1278	or return;
		1279
		1280	$self->{load_path} = $path;
		1281
		1282	1
		1283	}
		1284
		1285	sub load_orig {
		1286	my ($self) = @_;
		1287
		1288	$self->load_header_from ($self->load_path)
		1289	}
		1290
		1291	sub load_temp {
		1292	my ($self) = @_;
		1293
		1294	$self->load_header_from ($self->save_path)
		1295	}
		1296
		1297	sub load_header {
		1298	my ($self) = @_;
		1299
		1300	if ($self->load_temp) {
		1301	$self->last_access ((delete $self->{last_access})
		1302	|| $cf::RUNTIME); #d#
		1303	# safety
		1304	$self->{instantiate_time} = $cf::RUNTIME
		1305	if $self->{instantiate_time} > $cf::RUNTIME;
		1306	} else {
		1307	$self->load_orig
		1308	or return;
		1309
		1310	$self->{load_original} = 1;
		1311	$self->{instantiate_time} = $cf::RUNTIME;
		1312	$self->last_access ($cf::RUNTIME);
		1313	$self->instantiate;
		1314	}
		1315
		1316	1
		1317	}
		1318
		1319	sub find;
		1320	sub find {
		1321	my ($path, $origin) = @_;
		1322
		1323	$path = normalise $path, $origin && $origin->path;
		1324
		1325	cf::lock_wait "map_find:$path";
		1326
		1327	$cf::MAP{$path} || do {
		1328	my $guard = cf::lock_acquire "map_find:$path";
		1329	my $map = new_from_path cf::map $path
		1330	or return;
		1331
		1332	$map->{last_save} = $cf::RUNTIME;
		1333
		1334	$map->load_header
		1335	or return;
		1336
		1337	if ($map->should_reset) {
		1338	$map->reset;
		1339	undef $guard;
		1340	$map = find $path
		1341	or return;
		1342	}
		1343
		1344	$cf::MAP{$path} = $map
		1345	}
		1346	}
		1347
		1348	sub load {
		1349	my ($self) = @_;
		1350
		1351	my $path = $self->{path};
		1352	my $guard = cf::lock_acquire "map_load:$path";
		1353
		1354	return if $self->in_memory != cf::MAP_SWAPPED;
		1355
		1356	$self->in_memory (cf::MAP_LOADING);
		1357
		1358	$self->alloc;
		1359	$self->_load_objects ($self->{load_path}, 1)
		1360	or return;
		1361
		1362	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1363	if delete $self->{load_original};
		1364
		1365	if (my $uniq = $self->uniq_path) {
		1366	utf8::encode $uniq;
		1367	if (aio_open $uniq, O_RDONLY, 0) {
		1368	$self->clear_unique_items;
		1369	$self->_load_objects ($uniq, 0);
		1370	}
		1371	}
		1372
		1373	Coro::cede;
		1374
		1375	# now do the right thing for maps
		1376	$self->link_multipart_objects;
		1377
		1378	unless ($self->{deny_activate}) {
		1379	$self->decay_objects;
		1380	$self->fix_auto_apply;
		1381	$self->update_buttons;
		1382	Coro::cede;
		1383	$self->set_darkness_map;
		1384	$self->difficulty ($self->estimate_difficulty)
		1385	unless $self->difficulty;
		1386	Coro::cede;
		1387	$self->activate;
		1388	}
		1389
		1390	$self->in_memory (cf::MAP_IN_MEMORY);
		1391	}
		1392
		1393	sub customise_for {
		1394	my ($self, $ob) = @_;
		1395
		1396	return find "~" . $ob->name . "/" . $self->{path}
		1397	if $self->per_player;
		1398
		1399	$self
		1400	}
		1401
		1402	# find and load all maps in the 3x3 area around a map
		1403	sub load_diag {
		1404	my ($map) = @_;
		1405
		1406	my @diag; # diagonal neighbours
		1407
		1408	for (0 .. 3) {
		1409	my $neigh = $map->tile_path ($_)
		1410	or next;
		1411	$neigh = find $neigh, $map
		1412	or next;
		1413	$neigh->load;
		1414
		1415	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1416	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1417	}
		1418
		1419	for (@diag) {
		1420	my $neigh = find @$_
		1421	or next;
		1422	$neigh->load;
		1423	}
		1424	}
		1425
		1426	sub find_sync {
		1427	my ($path, $origin) = @_;
		1428
		1429	cf::sync_job { find $path, $origin }
		1430	}
		1431
		1432	sub do_load_sync {
		1433	my ($map) = @_;
		1434
		1435	cf::sync_job { $map->load };
		1436	}
		1437
		1438	our %MAP_PREFETCH;
		1439	our $MAP_PREFETCHER = Coro::async {
		1440	while () {
		1441	for my $path (keys %MAP_PREFETCH) {
		1442	my $map = find $path
		1443	or next;
		1444	$map->load;
		1445
		1446	delete $MAP_PREFETCH{$path};
		1447	}
		1448	Coro::schedule;
		1449	}
		1450	};
		1451
		1452	sub find_async {
		1453	my ($path, $origin) = @_;
		1454
		1455	$path = normalise $path, $origin && $origin->{path};
		1456
		1457	if (my $map = $cf::MAP{$path}) {
		1458	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1459	}
		1460
		1461	$MAP_PREFETCH{$path} = 0;
		1462	$MAP_PREFETCHER->ready;
		1463
		1464	()
		1465	}
		1466
		1467	sub save {
		1468	my ($self) = @_;
		1469
		1470	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1471
		1472	$self->{last_save} = $cf::RUNTIME;
		1473
		1474	return unless $self->dirty;
		1475
		1476	my $save = $self->save_path; utf8::encode $save;
		1477	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1478
		1479	$self->{load_path} = $save;
		1480
		1481	return if $self->{deny_save};
		1482
		1483	local $self->{last_access} = $self->last_access;#d#
		1484
		1485	cf::async {
		1486	$_->contr->save for $self->players;
		1487	};
		1488
		1489	if ($uniq) {
		1490	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1491	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1492	} else {
		1493	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1494	}
		1495	}
		1496
		1497	sub swap_out {
		1498	my ($self) = @_;
		1499
		1500	# save first because save cedes
		1501	$self->save;
		1502
		1503	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1504
		1505	return if $self->players;
		1506	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1507	return if $self->{deny_save};
		1508
		1509	$self->clear;
		1510	$self->in_memory (cf::MAP_SWAPPED);
		1511	}
		1512
		1513	sub reset_at {
		1514	my ($self) = @_;
		1515
		1516	# TODO: safety, remove and allow resettable per-player maps
		1517	return 1e99 if $self->isa ("ext::map_per_player");
		1518	return 1e99 if $self->{deny_reset};
		1519
		1520	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1521	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1522
		1523	$time + $to
		1524	}
		1525
		1526	sub should_reset {
		1527	my ($self) = @_;
		1528
		1529	$self->reset_at <= $cf::RUNTIME
		1530	}
		1531
		1532	sub rename {
		1533	my ($self, $new_path) = @_;
		1534
		1535	normalise $new_path;
		1536
		1537	$self->unlink_save;
		1538
		1539	delete $cf::MAP{$self->path};
		1540	$self->{path} = $new_path; $self->path ($self->{path});
		1541	$cf::MAP{$self->path} = $self;
		1542
		1543	$self->save;
		1544	}
		1545
		1546	sub reset {
		1547	my ($self) = @_;
		1548
		1549	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1550
		1551	return if $self->players;
		1552	return if $self->isa ("ext::map_per_player");#d#
		1553
		1554	warn "resetting map ", $self->path;#d#
		1555
		1556	delete $cf::MAP{$self->path};
		1557
		1558	$_->clear_links_to ($self) for values %cf::MAP;
		1559
		1560	$self->unlink_save;
		1561	$self->destroy;
		1562	}
		1563
		1564	my $nuke_counter = "aaaa";
		1565
		1566	sub nuke {
		1567	my ($self) = @_;
		1568
		1569	$self->{deny_save} = 1;
		1570	$self->reset_timeout (1);
		1571	$self->rename ("{nuke}/" . ($nuke_counter++));
		1572	$self->reset; # polite request, might not happen
		1573	}
		1574
		1575	=item cf::map::unique_maps
		1576
		1577	Returns an arrayref of paths of all shared maps that have
		1578	instantiated unique items. May block.
		1579
		1580	=cut
		1581
		1582	sub unique_maps() {
		1583	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1584	or return;
		1585
		1586	my @paths;
		1587
		1588	for (@$files) {
		1589	utf8::decode $_;
		1590	next if /\.pst$/;
		1591	next unless /^$PATH_SEP/o;
		1592
		1593	push @paths, $_;
		1594	}
		1595
		1596	\@paths
		1597	}
		1598
		1599	package cf;
		1600
		1601	=back
		1602
		1603	=head3 cf::object
		1604
		1605	=cut
		1606
		1607	package cf::object;
		1608
		1609	=over 4
		1610
		1611	=item $ob->inv_recursive
		1612
		1613	Returns the inventory of the object _and_ their inventories, recursively.
		1614
		1615	=cut
		1616
		1617	sub inv_recursive_;
		1618	sub inv_recursive_ {
		1619	map { $_, inv_recursive_ $_->inv } @_
		1620	}
		1621
		1622	sub inv_recursive {
		1623	inv_recursive_ inv $_[0]
		1624	}
		1625
		1626	package cf;
		1627
		1628	=back
		1629
		1630	=head3 cf::object::player
		1631
		1632	=over 4
779		1633
780	=item $player_object->reply ($npc, $msg[, $flags])	1634	=item $player_object->reply ($npc, $msg[, $flags])
781		1635
782	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1636	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
783	can be C<undef>. Does the right thing when the player is currently in a	1637	can be C<undef>. Does the right thing when the player is currently in a
…		…
785		1639
786	=cut	1640	=cut
787		1641
788	# rough implementation of a future "reply" method that works	1642	# rough implementation of a future "reply" method that works
789	# with dialog boxes.	1643	# with dialog boxes.
		1644	#TODO: the first argument must go, split into a $npc->reply_to ( method
790	sub cf::object::player::reply($$$;$) {	1645	sub cf::object::player::reply($$$;$) {
791	my ($self, $npc, $msg, $flags) = @_;	1646	my ($self, $npc, $msg, $flags) = @_;
792		1647
793	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1648	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
794		1649
…		…
798	$msg = $npc->name . " says: $msg" if $npc;	1653	$msg = $npc->name . " says: $msg" if $npc;
799	$self->message ($msg, $flags);	1654	$self->message ($msg, $flags);
800	}	1655	}
801	}	1656	}
802		1657
803	=item $player->ext_reply ($msgid, $msgtype, %msg)
804
805	Sends an ext reply to the player.
806
807	=cut
808
809	sub cf::player::ext_reply($$$%) {
810	my ($self, $id, %msg) = @_;
811
812	$msg{msgid} = $id;
813
814	$self->send ("ext " . to_json \%msg);
815	}
816
817	=item $player_object->may ("access")	1658	=item $player_object->may ("access")
818		1659
819	Returns wether the given player is authorized to access resource "access"	1660	Returns wether the given player is authorized to access resource "access"
820	(e.g. "command_wizcast").	1661	(e.g. "command_wizcast").
821		1662
…		…
828	(ref $cf::CFG{"may_$access"}	1669	(ref $cf::CFG{"may_$access"}
829	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1670	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
830	: $cf::CFG{"may_$access"})	1671	: $cf::CFG{"may_$access"})
831	}	1672	}
832		1673
833	=cut	1674	=item $player_object->enter_link
834		1675
835	#############################################################################	1676	Freezes the player and moves him/her to a special map (C<{link}>).
		1677
		1678	The player should be reasonably safe there for short amounts of time. You
		1679	I<MUST> call C<leave_link> as soon as possible, though.
		1680
		1681	Will never block.
		1682
		1683	=item $player_object->leave_link ($map, $x, $y)
		1684
		1685	Moves the player out of the special C<{link}> map onto the specified
		1686	map. If the map is not valid (or omitted), the player will be moved back
		1687	to the location he/she was before the call to C<enter_link>, or, if that
		1688	fails, to the emergency map position.
		1689
		1690	Might block.
		1691
		1692	=cut
		1693
		1694	sub link_map {
		1695	unless ($LINK_MAP) {
		1696	$LINK_MAP = cf::map::find "{link}"
		1697	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
		1698	$LINK_MAP->load;
		1699	}
		1700
		1701	$LINK_MAP
		1702	}
		1703
		1704	sub cf::object::player::enter_link {
		1705	my ($self) = @_;
		1706
		1707	$self->deactivate_recursive;
		1708
		1709	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1710
		1711	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1712	if $self->map;
		1713
		1714	$self->enter_map ($LINK_MAP || link_map, 20, 20);
		1715	}
		1716
		1717	sub cf::object::player::leave_link {
		1718	my ($self, $map, $x, $y) = @_;
		1719
		1720	my $link_pos = delete $self->{_link_pos};
		1721
		1722	unless ($map) {
		1723	# restore original map position
		1724	($map, $x, $y) = @{ $link_pos || [] };
		1725	$map = cf::map::find $map;
		1726
		1727	unless ($map) {
		1728	($map, $x, $y) = @$EMERGENCY_POSITION;
		1729	$map = cf::map::find $map
		1730	or die "FATAL: cannot load emergency map\n";
		1731	}
		1732	}
		1733
		1734	($x, $y) = (-1, -1)
		1735	unless (defined $x) && (defined $y);
		1736
		1737	# use -1 or undef as default coordinates, not 0, 0
		1738	($x, $y) = ($map->enter_x, $map->enter_y)
		1739	if $x <=0 && $y <= 0;
		1740
		1741	$map->load;
		1742	$map->load_diag;
		1743
		1744	return unless $self->contr->active;
		1745	$self->activate_recursive;
		1746	$self->enter_map ($map, $x, $y);
		1747	}
		1748
		1749	cf::player->attach (
		1750	on_logout => sub {
		1751	my ($pl) = @_;
		1752
		1753	# abort map switching before logout
		1754	if ($pl->ob->{_link_pos}) {
		1755	cf::sync_job {
		1756	$pl->ob->leave_link
		1757	};
		1758	}
		1759	},
		1760	on_login => sub {
		1761	my ($pl) = @_;
		1762
		1763	# try to abort aborted map switching on player login :)
		1764	# should happen only on crashes
		1765	if ($pl->ob->{_link_pos}) {
		1766	$pl->ob->enter_link;
		1767	(async {
		1768	# we need this sleep as the login has a concurrent enter_exit running
		1769	# and this sleep increases chances of the player not ending up in scorn
		1770	$pl->ob->reply (undef,
		1771	"There was an internal problem at your last logout, "
		1772	. "the server will try to bring you to your intended destination in a second.",
		1773	cf::NDI_RED);
		1774	Coro::Timer::sleep 1;
		1775	$pl->ob->leave_link;
		1776	})->prio (2);
		1777	}
		1778	},
		1779	);
		1780
		1781	=item $player_object->goto ($path, $x, $y)
		1782
		1783	=cut
		1784
		1785	sub cf::object::player::goto {
		1786	my ($self, $path, $x, $y) = @_;
		1787
		1788	$self->enter_link;
		1789
		1790	(async {
		1791	my $map = cf::map::find $path;
		1792	$map = $map->customise_for ($self) if $map;
		1793
		1794	# warn "entering ", $map->path, " at ($x, $y)\n"
		1795	# if $map;
		1796
		1797	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1798
		1799	$self->leave_link ($map, $x, $y);
		1800	})->prio (1);
		1801	}
		1802
		1803	=item $player_object->enter_exit ($exit_object)
		1804
		1805	=cut
		1806
		1807	sub parse_random_map_params {
		1808	my ($spec) = @_;
		1809
		1810	my $rmp = { # defaults
		1811	xsize => 10,
		1812	ysize => 10,
		1813	};
		1814
		1815	for (split /\n/, $spec) {
		1816	my ($k, $v) = split /\s+/, $_, 2;
		1817
		1818	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1819	}
		1820
		1821	$rmp
		1822	}
		1823
		1824	sub prepare_random_map {
		1825	my ($exit) = @_;
		1826
		1827	# all this does is basically replace the /! path by
		1828	# a new random map path (?random/...) with a seed
		1829	# that depends on the exit object
		1830
		1831	my $rmp = parse_random_map_params $exit->msg;
		1832
		1833	if ($exit->map) {
		1834	$rmp->{region} = $exit->map->region_name;
		1835	$rmp->{origin_map} = $exit->map->path;
		1836	$rmp->{origin_x} = $exit->x;
		1837	$rmp->{origin_y} = $exit->y;
		1838	}
		1839
		1840	$rmp->{random_seed} ||= $exit->random_seed;
		1841
		1842	my $data = cf::to_json $rmp;
		1843	my $md5 = Digest::MD5::md5_hex $data;
		1844
		1845	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1846	aio_write $fh, 0, (length $data), $data, 0;
		1847
		1848	$exit->slaying ("?random/$md5");
		1849	$exit->msg (undef);
		1850	}
		1851	}
		1852
		1853	sub cf::object::player::enter_exit {
		1854	my ($self, $exit) = @_;
		1855
		1856	return unless $self->type == cf::PLAYER;
		1857
		1858	$self->enter_link;
		1859
		1860	(async {
		1861	$self->deactivate_recursive; # just to be sure
		1862	unless (eval {
		1863	prepare_random_map $exit
		1864	if $exit->slaying eq "/!";
		1865
		1866	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
		1867	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1868
		1869	1;
		1870	}) {
		1871	$self->message ("Something went wrong deep within the crossfire server. "
		1872	. "I'll try to bring you back to the map you were before. "
		1873	. "Please report this to the dungeon master!",
		1874	cf::NDI_UNIQUE | cf::NDI_RED);
		1875
		1876	warn "ERROR in enter_exit: $@";
		1877	$self->leave_link;
		1878	}
		1879	})->prio (1);
		1880	}
		1881
		1882	=head3 cf::client
		1883
		1884	=over 4
		1885
		1886	=item $client->send_drawinfo ($text, $flags)
		1887
		1888	Sends a drawinfo packet to the client. Circumvents output buffering so
		1889	should not be used under normal circumstances.
		1890
		1891	=cut
		1892
		1893	sub cf::client::send_drawinfo {
		1894	my ($self, $text, $flags) = @_;
		1895
		1896	utf8::encode $text;
		1897	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1898	}
		1899
		1900
		1901	=item $success = $client->query ($flags, "text", \&cb)
		1902
		1903	Queues a query to the client, calling the given callback with
		1904	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1905	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1906
		1907	Queries can fail, so check the return code. Or don't, as queries will become
		1908	reliable at some point in the future.
		1909
		1910	=cut
		1911
		1912	sub cf::client::query {
		1913	my ($self, $flags, $text, $cb) = @_;
		1914
		1915	return unless $self->state == ST_PLAYING
		1916	|| $self->state == ST_SETUP
		1917	|| $self->state == ST_CUSTOM;
		1918
		1919	$self->state (ST_CUSTOM);
		1920
		1921	utf8::encode $text;
		1922	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1923
		1924	$self->send_packet ($self->{query_queue}[0][0])
		1925	if @{ $self->{query_queue} } == 1;
		1926	}
		1927
		1928	cf::client->attach (
		1929	on_reply => sub {
		1930	my ($ns, $msg) = @_;
		1931
		1932	# this weird shuffling is so that direct followup queries
		1933	# get handled first
		1934	my $queue = delete $ns->{query_queue}
		1935	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1936
		1937	(shift @$queue)->[1]->($msg);
		1938
		1939	push @{ $ns->{query_queue} }, @$queue;
		1940
		1941	if (@{ $ns->{query_queue} } == @$queue) {
		1942	if (@$queue) {
		1943	$ns->send_packet ($ns->{query_queue}[0][0]);
		1944	} else {
		1945	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1946	}
		1947	}
		1948	},
		1949	);
		1950
		1951	=item $client->async (\&cb)
		1952
		1953	Create a new coroutine, running the specified callback. The coroutine will
		1954	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1955	or loss of connection).
		1956
		1957	=cut
		1958
		1959	sub cf::client::async {
		1960	my ($self, $cb) = @_;
		1961
		1962	my $coro = &Coro::async ($cb);
		1963
		1964	$coro->on_destroy (sub {
		1965	delete $self->{_coro}{$coro+0};
		1966	});
		1967
		1968	$self->{_coro}{$coro+0} = $coro;
		1969
		1970	$coro
		1971	}
		1972
		1973	cf::client->attach (
		1974	on_destroy => sub {
		1975	my ($ns) = @_;
		1976
		1977	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1978	},
		1979	);
		1980
		1981	=back
		1982
836		1983
837	=head2 SAFE SCRIPTING	1984	=head2 SAFE SCRIPTING
838		1985
839	Functions that provide a safe environment to compile and execute	1986	Functions that provide a safe environment to compile and execute
840	snippets of perl code without them endangering the safety of the server	1987	snippets of perl code without them endangering the safety of the server
…		…
855		2002
856	=pod	2003	=pod
857		2004
858	The following fucntions and emthods are available within a safe environment:	2005	The following fucntions and emthods are available within a safe environment:
859		2006
860	cf::object contr pay_amount pay_player	2007	cf::object contr pay_amount pay_player map
861	cf::object::player player	2008	cf::object::player player
862	cf::player peaceful	2009	cf::player peaceful
		2010	cf::map trigger
863		2011
864	=cut	2012	=cut
865		2013
866	for (	2014	for (
867	["cf::object" => qw(contr pay_amount pay_player)],	2015	["cf::object" => qw(contr pay_amount pay_player map)],
868	["cf::object::player" => qw(player)],	2016	["cf::object::player" => qw(player)],
869	["cf::player" => qw(peaceful)],	2017	["cf::player" => qw(peaceful)],
		2018	["cf::map" => qw(trigger)],
870	) {	2019	) {
871	no strict 'refs';	2020	no strict 'refs';
872	my ($pkg, @funs) = @$_;	2021	my ($pkg, @funs) = @$_;
873	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2022	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
874	for @funs;	2023	for @funs;
…		…
990		2139
991	{	2140	{
992	my $path = cf::localdir . "/database.pst";	2141	my $path = cf::localdir . "/database.pst";
993		2142
994	sub db_load() {	2143	sub db_load() {
995	warn "loading database $path\n";#d# remove later
996	$DB = stat $path ? Storable::retrieve $path : { };	2144	$DB = stat $path ? Storable::retrieve $path : { };
997	}	2145	}
998		2146
999	my $pid;	2147	my $pid;
1000		2148
1001	sub db_save() {	2149	sub db_save() {
1002	warn "saving database $path\n";#d# remove later
1003	waitpid $pid, 0 if $pid;	2150	waitpid $pid, 0 if $pid;
1004	if (0 == ($pid = fork)) {	2151	if (0 == ($pid = fork)) {
1005	$DB->{_meta}{version} = 1;	2152	$DB->{_meta}{version} = 1;
1006	Storable::nstore $DB, "$path~";	2153	Storable::nstore $DB, "$path~";
1007	rename "$path~", $path;	2154	rename "$path~", $path;
…		…
1014	sub db_sync() {	2161	sub db_sync() {
1015	db_save if $dirty;	2162	db_save if $dirty;
1016	undef $dirty;	2163	undef $dirty;
1017	}	2164	}
1018		2165
1019	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	2166	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1020	db_sync;	2167	db_sync;
1021	});	2168	});
1022		2169
1023	sub db_dirty() {	2170	sub db_dirty() {
1024	$dirty = 1;	2171	$dirty = 1;
…		…
1038	$DB->{$_[0]} = $_[1];	2185	$DB->{$_[0]} = $_[1];
1039	}	2186	}
1040	db_dirty;	2187	db_dirty;
1041	}	2188	}
1042		2189
1043	attach_global	2190	cf::global->attach (
1044	prio => 10000,	2191	prio => 10000,
1045	on_cleanup => sub {	2192	on_cleanup => sub {
1046	db_sync;	2193	db_sync;
1047	},	2194	},
1048	;	2195	);
1049	}	2196	}
1050		2197
1051	#############################################################################	2198	#############################################################################
1052	# the server's main()	2199	# the server's main()
1053		2200
…		…
1055	open my $fh, "<:utf8", cf::confdir . "/config"	2202	open my $fh, "<:utf8", cf::confdir . "/config"
1056	or return;	2203	or return;
1057		2204
1058	local $/;	2205	local $/;
1059	*CFG = YAML::Syck::Load <$fh>;	2206	*CFG = YAML::Syck::Load <$fh>;
		2207
		2208	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2209
		2210	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2211	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2212
		2213	if (exists $CFG{mlockall}) {
		2214	eval {
		2215	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2216	and die "WARNING: m(un)lockall failed: $!\n";
		2217	};
		2218	warn $@ if $@;
		2219	}
1060	}	2220	}
1061		2221
1062	sub main {	2222	sub main {
		2223	# we must not ever block the main coroutine
		2224	local $Coro::idle = sub {
		2225	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2226	async { Event::one_event };
		2227	};
		2228
1063	cfg_load;	2229	cfg_load;
1064	db_load;	2230	db_load;
1065	load_extensions;	2231	load_extensions;
1066	Event::loop;	2232	Event::loop;
1067	}	2233	}
1068		2234
1069	#############################################################################	2235	#############################################################################
1070	# initialisation	2236	# initialisation and cleanup
1071		2237
		2238	# install some emergency cleanup handlers
		2239	BEGIN {
		2240	for my $signal (qw(INT HUP TERM)) {
		2241	Event->signal (
		2242	data => WF_AUTOCANCEL,
		2243	signal => $signal,
		2244	cb => sub {
		2245	cf::cleanup "SIG$signal";
		2246	},
		2247	);
		2248	}
		2249	}
		2250
		2251	sub emergency_save() {
		2252	my $freeze_guard = cf::freeze_mainloop;
		2253
		2254	warn "enter emergency perl save\n";
		2255
		2256	cf::sync_job {
		2257	# use a peculiar iteration method to avoid tripping on perl
		2258	# refcount bugs in for. also avoids problems with players
		2259	# and maps saved/Destroyed asynchronously.
		2260	warn "begin emergency player save\n";
		2261	for my $login (keys %cf::PLAYER) {
		2262	my $pl = $cf::PLAYER{$login} or next;
		2263	$pl->valid or next;
		2264	$pl->save;
		2265	}
		2266	warn "end emergency player save\n";
		2267
		2268	warn "begin emergency map save\n";
		2269	for my $path (keys %cf::MAP) {
		2270	my $map = $cf::MAP{$path} or next;
		2271	$map->valid or next;
		2272	$map->save;
		2273	}
		2274	warn "end emergency map save\n";
		2275	};
		2276
		2277	warn "leave emergency perl save\n";
		2278	}
		2279
1072	sub _perl_reload(&) {	2280	sub reload() {
1073	my ($msg) = @_;	2281	# can/must only be called in main
		2282	if ($Coro::current != $Coro::main) {
		2283	warn "can only reload from main coroutine\n";
		2284	return;
		2285	}
1074		2286
1075	$msg->("reloading...");	2287	warn "reloading...";
		2288
		2289	warn "freezing server";
		2290	my $guard = freeze_mainloop;
		2291	cf::emergency_save;
		2292
		2293	warn "sync database to disk";
		2294	cf::db_sync;
		2295	IO::AIO::flush;
1076		2296
1077	eval {	2297	eval {
		2298	# if anything goes wrong in here, we should simply crash as we already saved
		2299
1078	# cancel all watchers	2300	warn "cancel all watchers";
1079	$_->cancel for Event::all_watchers;	2301	for (Event::all_watchers) {
		2302	$_->cancel if $_->data & WF_AUTOCANCEL;
		2303	}
1080		2304
		2305	warn "cancel all extension coros";
		2306	$_->cancel for values %EXT_CORO;
		2307	%EXT_CORO = ();
		2308
		2309	warn "remove commands";
		2310	%COMMAND = ();
		2311
		2312	warn "remove ext commands";
		2313	%EXTCMD = ();
		2314
1081	# unload all extensions	2315	warn "unload/nuke all extensions";
1082	for (@exts) {	2316	for my $pkg (@EXTS) {
1083	$msg->("unloading <$_>");	2317	warn "... unloading $pkg";
1084	unload_extension $_;	2318
		2319	if (my $cb = $pkg->can ("unload")) {
		2320	eval {
		2321	$cb->($pkg);
		2322	1
		2323	} or warn "$pkg unloaded, but with errors: $@";
1085	}	2324	}
1086		2325
		2326	warn "... nuking $pkg";
		2327	Symbol::delete_package $pkg;
		2328	}
		2329
1087	# unload all modules loaded from $LIBDIR	2330	warn "unload all perl modules loaded from $LIBDIR";
1088	while (my ($k, $v) = each %INC) {	2331	while (my ($k, $v) = each %INC) {
1089	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2332	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090		2333
1091	$msg->("removing <$k>");	2334	warn "removing <$k>";
1092	delete $INC{$k};	2335	delete $INC{$k};
1093		2336
1094	$k =~ s/\.pm$//;	2337	$k =~ s/\.pm$//;
1095	$k =~ s/\//::/g;	2338	$k =~ s/\//::/g;
1096		2339
…		…
1099	}	2342	}
1100		2343
1101	Symbol::delete_package $k;	2344	Symbol::delete_package $k;
1102	}	2345	}
1103		2346
1104	# sync database to disk
1105	cf::db_sync;
1106
1107	# get rid of safe::, as good as possible	2347	warn "get rid of safe::, as good as possible";
1108	Symbol::delete_package "safe::$_"	2348	Symbol::delete_package "safe::$_"
1109	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2349	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110		2350
1111	# remove register_script_function callbacks
1112	# TODO
1113
1114	# unload cf.pm "a bit"	2351	warn "unload cf.pm \"a bit\"";
1115	delete $INC{"cf.pm"};	2352	delete $INC{"cf.pm"};
1116		2353
1117	# don't, removes xs symbols, too,	2354	# don't, removes xs symbols, too,
1118	# and global variables created in xs	2355	# and global variables created in xs
1119	#Symbol::delete_package __PACKAGE__;	2356	#Symbol::delete_package __PACKAGE__;
1120		2357
1121	# reload cf.pm
1122	$msg->("reloading cf.pm");	2358	warn "reloading cf.pm";
1123	require cf;	2359	require cf;
		2360	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124		2361
1125	# load config and database again	2362	warn "load config and database again";
1126	cf::cfg_load;	2363	cf::cfg_load;
1127	cf::db_load;	2364	cf::db_load;
1128		2365
1129	# load extensions	2366	warn "load extensions";
1130	$msg->("load extensions");
1131	cf::load_extensions;	2367	cf::load_extensions;
1132		2368
1133	# reattach attachments to objects	2369	warn "reattach attachments to objects/players";
1134	$msg->("reattach");
1135	_global_reattach;	2370	_global_reattach;
		2371	warn "reattach attachments to maps";
		2372	reattach $_ for values %MAP;
1136	};	2373	};
1137	$msg->($@) if $@;
1138		2374
1139	$msg->("reloaded");	2375	if ($@) {
		2376	warn $@;
		2377	warn "error while reloading, exiting.";
		2378	exit 1;
		2379	}
		2380
		2381	warn "reloaded";
1140	};	2382	};
1141		2383
1142	sub perl_reload() {
1143	_perl_reload {
1144	warn $_[0];
1145	print "$_[0]\n";
1146	};
1147	}
1148
1149	register_command "perl-reload", 0, sub {	2384	register_command "reload" => sub {
1150	my ($who, $arg) = @_;	2385	my ($who, $arg) = @_;
1151		2386
1152	if ($who->flag (FLAG_WIZ)) {	2387	if ($who->flag (FLAG_WIZ)) {
1153	_perl_reload {	2388	$who->message ("start of reload.");
1154	warn $_[0];	2389	reload;
1155	$who->message ($_[0]);	2390	$who->message ("end of reload.");
1156	};
1157	}	2391	}
1158	};	2392	};
1159		2393
1160	register "<global>", __PACKAGE__;
1161
1162	unshift @INC, $LIBDIR;	2394	unshift @INC, $LIBDIR;
1163		2395
1164	$TICK_WATCHER = Event->timer (	2396	$TICK_WATCHER = Event->timer (
		2397	reentrant => 0,
1165	prio => 1,	2398	prio => 0,
1166	async => 1,
1167	at => $NEXT_TICK || 1,	2399	at => $NEXT_TICK || $TICK,
		2400	data => WF_AUTOCANCEL,
1168	cb => sub {	2401	cb => sub {
		2402	$NOW = Event::time;
		2403
1169	cf::server_tick; # one server iteration	2404	cf::server_tick; # one server iteration
1170		2405	$RUNTIME += $TICK;
1171	my $NOW = Event::time;
1172	$NEXT_TICK += $TICK;	2406	$NEXT_TICK += $TICK;
1173		2407
		2408	$WAIT_FOR_TICK->broadcast;
		2409	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2410
1174	# if we are delayed by four ticks or more, skip them all	2411	# if we are delayed by four ticks or more, skip them all
1175	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2412	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1176		2413
1177	$TICK_WATCHER->at ($NEXT_TICK);	2414	$TICK_WATCHER->at ($NEXT_TICK);
1178	$TICK_WATCHER->start;	2415	$TICK_WATCHER->start;
1179	},	2416	},
1180	);	2417	);
1181		2418
1182	eval { IO::AIO::max_poll_time $TICK * 0.2 }; #d# remove eval after restart	2419	IO::AIO::max_poll_time $TICK * 0.2;
1183		2420
		2421	Event->io (
1184	Event->io (fd => IO::AIO::poll_fileno,	2422	fd => IO::AIO::poll_fileno,
1185	poll => 'r',	2423	poll => 'r',
1186	prio => 5,	2424	prio => 5,
		2425	data => WF_AUTOCANCEL,
1187	cb => \&IO::AIO::poll_cb);	2426	cb => \&IO::AIO::poll_cb,
		2427	);
		2428
		2429	Event->timer (
		2430	data => WF_AUTOCANCEL,
		2431	after => 0,
		2432	interval => 10,
		2433	cb => sub {
		2434	(Coro::unblock_sub {
		2435	write_runtime
		2436	or warn "ERROR: unable to write runtime file: $!";
		2437	})->();
		2438	},
		2439	);
		2440
		2441	END { cf::emergency_save }
1188		2442
1189	1	2443	1
1190		2444

Diff Legend

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