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

Diff Legend

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