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

Diff Legend

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