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.80 by root, Tue Nov 7 16:30:55 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;	56	our $UPTIME; $UPTIME ||= time;
		57	our $RUNTIME;
34		58
35	$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;
36		87
37	#############################################################################	88	#############################################################################
38		89
39	=head2 GLOBAL VARIABLES	90	=head2 GLOBAL VARIABLES
40		91
41	=over 4	92	=over 4
		93
		94	=item $cf::UPTIME
		95
		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.
42		102
43	=item $cf::LIBDIR	103	=item $cf::LIBDIR
44		104
45	The perl library directory, where extensions and cf-specific modules can	105	The perl library directory, where extensions and cf-specific modules can
46	be found. It will be added to C<@INC> automatically.	106	be found. It will be added to C<@INC> automatically.
47		107
		108	=item $cf::NOW
		109
		110	The time of the last (current) server tick.
		111
48	=item $cf::TICK	112	=item $cf::TICK
49		113
50	The interval between server ticks, in seconds.	114	The interval between server ticks, in seconds.
51		115
52	=item %cf::CFG	116	=item %cf::CFG
53		117
54	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
55	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.
56		127
57	=back	128	=back
58		129
59	=cut	130	=cut
60		131
61	BEGIN {	132	BEGIN {
62	*CORE::GLOBAL::warn = sub {	133	*CORE::GLOBAL::warn = sub {
63	my $msg = join "", @_;	134	my $msg = join "", @_;
		135	utf8::encode $msg;
		136
64	$msg .= "\n"	137	$msg .= "\n"
65	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
66		139
67	print STDERR "cfperl: $msg";
68	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
69	};	141	};
70	}	142	}
71		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';
72	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
73		150
74	# 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
75	# within the Safe compartment.	152	# within the Safe compartment.
76	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	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	)) {
77	no strict 'refs';	160	no strict 'refs';
78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79	}	162	}
80		163
81	$Event::DIED = sub {	164	$Event::DIED = sub {
82	warn "error in event callback: @_";	165	warn "error in event callback: @_";
83	};	166	};
84		167
85	my %ext_pkg;
86	my @exts;
87	my @hook;
88	my %command;
89	my %extcmd;
90
91	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
92		169
93	=over 4	170	=over 4
94		171
		172	=item dumpval $ref
		173
95	=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	}
96		194
97	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
98		196
99	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
100		198
…		…
116	sub to_json($) {	214	sub to_json($) {
117	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
118	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
119	}	217	}
120		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
121	=back	370	=back
122		371
123	=cut	372	=cut
124		373
125	#############################################################################	374	#############################################################################
126		375
127	=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+).
128		385
129	=over 4	386	=over 4
130		387
131	=item $object->attach ($attachment, key => $value...)
132
133	=item $object->detach ($attachment)
134
135	Attach/detach a pre-registered attachment to an object.
136
137	=item $player->attach ($attachment, key => $value...)
138
139	=item $player->detach ($attachment)
140
141	Attach/detach a pre-registered attachment to a player.
142
143	=item $map->attach ($attachment, key => $value...)	388	=item $attachable->attach ($attachment, key => $value...)
144		389
145	=item $map->detach ($attachment)	390	=item $attachable->detach ($attachment)
146		391
147	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.
148		394
149	=item $bool = $object->attached ($name)	395	Example, attach a minesweeper attachment to the given object, making it a
		396	10x10 minesweeper game:
150		397
151	=item $bool = $player->attached ($name)	398	$obj->attach (minesweeper => width => 10, height => 10);
152		399
153	=item $bool = $map->attached ($name)	400	=item $bool = $attachable->attached ($name)
154		401
155	Checks wether the named attachment is currently attached to the object.	402	Checks wether the named attachment is currently attached to the object.
156		403
157	=item cf::attach_global ...	404	=item cf::CLASS->attach ...
158		405
159	Attach handlers for global events.	406	=item cf::CLASS->detach ...
160		407
161	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
162	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:
163		442
164	=over 4	443	=over 4
165		444
166	=item prio => $number	445	=item prio => $number
167		446
…		…
169	by another C<prio> setting). Lower priority handlers get executed	448	by another C<prio> setting). Lower priority handlers get executed
170	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
171	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
172	unless you know what you are doing.	451	unless you know what you are doing.
173		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
174	=item on_I<event> => \&cb	459	=item on_I<event> => \&cb
175		460
176	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
177	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
178	handlers are recognised generally depends on the type of object these	463	handlers are recognised generally depends on the type of object these
…		…
187	package and register them. Only handlers for eevents supported by the	472	package and register them. Only handlers for eevents supported by the
188	object/class are recognised.	473	object/class are recognised.
189		474
190	=back	475	=back
191		476
192	=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:
193		479
194	Attach handlers for a specific object type (e.g. TRANSPORT) and	480	cf::object::attachment sockpuppet =>
195	subtype. If C<$subtype> is zero or undef, matches all objects of the given	481	on_skill_attack => sub {
196	type.	482	my ($self, $victim) = @_;
197		483	...
198	=item cf::attach_to_objects ...
199
200	Attach handlers to all objects. Do not use this except for debugging or
201	very rare events, as handlers are (obviously) called for I<all> objects in
202	the game.
203
204	=item cf::attach_to_players ...
205
206	Attach handlers to all players.
207
208	=item cf::attach_to_maps ...
209
210	Attach handlers to all maps.
211
212	=item cf:register_attachment $name, ...
213
214	Register an attachment by name through which objects can refer to this
215	attachment.
216
217	=item cf:register_player_attachment $name, ...
218
219	Register an attachment by name through which players can refer to this
220	attachment.
221
222	=item cf:register_map_attachment $name, ...
223
224	Register an attachment by name through which maps can refer to this
225	attachment.
226
227	=cut
228
229	# the following variables are defined in .xs and must not be re-created
230	our @CB_GLOBAL = (); # registry for all global events
231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232	our @CB_PLAYER = ();
233	our @CB_TYPE = (); # registry for type (cf-object class) based events
234	our @CB_MAP = ();
235
236	my %attachment;
237
238	sub _attach_cb($\%$$$) {
239	my ($registry, $undo, $event, $prio, $cb) = @_;
240
241	use sort 'stable';
242
243	$cb = [$prio, $cb];
244
245	@{$registry->[$event]} = sort
246	{ $a->[0] cmp $b->[0] }
247	@{$registry->[$event] || []}, $cb;
248
249	push @{$undo->{cb}}, [$event, $cb];
250	}
251
252	# attach handles attaching event callbacks
253	# the only thing the caller has to do is pass the correct
254	# registry (== where the callback attaches to).
255	sub _attach(\@$@) {
256	my ($registry, $klass, @arg) = @_;
257
258	my $prio = 0;
259
260	my %undo = (
261	registry => $registry,
262	cb => [],
263	);
264
265	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267	while (@arg) {
268	my $type = shift @arg;
269
270	if ($type eq "prio") {
271	$prio = shift @arg;
272
273	} elsif ($type eq "package") {
274	my $pkg = shift @arg;
275
276	while (my ($name, $id) = each %cb_id) {
277	if (my $cb = $pkg->can ($name)) {
278	_attach_cb $registry, %undo, $id, $prio, $cb;
279	}
280	}	484	}
281
282	} elsif (exists $cb_id{$type}) {
283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285	} elsif (ref $type) {
286	warn "attaching objects not supported, ignoring.\n";
287
288	} else {
289	shift @arg;
290	warn "attach argument '$type' not supported, ignoring.\n";
291	}
292	}
293
294	\%undo
295	}
296
297	sub _attach_attachment {
298	my ($obj, $name, %arg) = @_;
299
300	return if exists $obj->{_attachment}{$name};
301
302	my $res;
303
304	if (my $attach = $attachment{$name}) {
305	my $registry = $obj->registry;
306
307	for (@$attach) {
308	my ($klass, @attach) = @$_;
309	$res = _attach @$registry, $klass, @attach;
310	}
311
312	$obj->{$name} = \%arg;
313	} else {
314	warn "object uses attachment '$name' that is not available, postponing.\n";
315	}
316
317	$obj->{_attachment}{$name} = undef;
318
319	$res->{attachment} = $name;
320	$res
321	}
322
323	*cf::object::attach =
324	*cf::player::attach =
325	*cf::map::attach = sub {
326	my ($obj, $name, %arg) = @_;
327
328	_attach_attachment $obj, $name, %arg;
329	};
330
331	# all those should be optimised
332	*cf::object::detach =
333	*cf::player::detach =
334	*cf::map::detach = sub {
335	my ($obj, $name) = @_;
336
337	delete $obj->{_attachment}{$name};
338	reattach ($obj);
339	};
340
341	*cf::object::attached =
342	*cf::player::attached =
343	*cf::map::attached = sub {
344	my ($obj, $name) = @_;
345
346	exists $obj->{_attachment}{$name}
347	};
348
349	sub attach_global {
350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
351	}
352
353	sub attach_to_type {
354	my $type = shift;
355	my $subtype = shift;
356
357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358	}
359
360	sub attach_to_objects {
361	_attach @CB_OBJECT, KLASS_OBJECT, @_
362	}
363
364	sub attach_to_players {
365	_attach @CB_PLAYER, KLASS_PLAYER, @_
366	}
367
368	sub attach_to_maps {
369	_attach @CB_MAP, KLASS_MAP, @_
370	}
371
372	sub register_attachment {
373	my $name = shift;
374
375	$attachment{$name} = [[KLASS_OBJECT, @_]];
376	}
377
378	sub register_player_attachment {
379	my $name = shift;
380
381	$attachment{$name} = [[KLASS_PLAYER, @_]];
382	}
383
384	sub register_map_attachment {
385	my $name = shift;
386
387	$attachment{$name} = [[KLASS_MAP, @_]];
388	}
389
390	our $override;
391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393	sub override {
394	$override = 1;
395	@invoke_results = ();
396	}
397
398	sub do_invoke {
399	my $event = shift;
400	my $callbacks = shift;
401
402	@invoke_results = ();
403
404	local $override;
405
406	for (@$callbacks) {
407	eval { &{$_->[1]} };
408
409	if ($@) {
410	warn "$@";
411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412	override;
413	}
414
415	return 1 if $override;
416	}
417
418	0	485	}
419	}
420		486
421	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	487	=item $attachable->valid
422
423	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429	Generate a global/object/player/map-specific event with the given arguments.
430
431	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432	removed in future versions), and there is no public API to access override
433	results (if you must, access C<@cf::invoke_results> directly).
434
435	=back
436
437	=cut
438
439	#############################################################################
440
441	=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443	=over 4
444
445	=item $object->valid, $player->valid, $map->valid
446		488
447	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
448	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
449	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
450	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
451	exception.	493	exception.
452		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
453	=back	678	=back
454		679
455	=cut	680	=cut
456
457	*cf::object::valid =
458	*cf::player::valid =
459	*cf::map::valid = \&cf::_valid;
460		681
461	#############################################################################	682	#############################################################################
462	# object support	683	# object support
463		684
464	sub instantiate {
465	my ($obj, $data) = @_;
466
467	$data = from_json $data;
468
469	for (@$data) {
470	my ($name, $args) = @$_;
471
472	$obj->attach ($name, %{$args || {} });
473	}
474	}
475
476	# basically do the same as instantiate, without calling instantiate
477	sub reattach {	685	sub reattach {
		686	# basically do the same as instantiate, without calling instantiate
478	my ($obj) = @_;	687	my ($obj) = @_;
		688
		689	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		690
479	my $registry = $obj->registry;	691	my $registry = $obj->registry;
480		692
481	@$registry = ();	693	@$registry = ();
482		694
483	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	695	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
484		696
485	for my $name (keys %{ $obj->{_attachment} || {} }) {	697	for my $name (keys %{ $obj->{_attachment} || {} }) {
486	if (my $attach = $attachment{$name}) {	698	if (my $attach = $attachment{$name}) {
487	for (@$attach) {	699	for (@$attach) {
488	my ($klass, @attach) = @$_;	700	my ($klass, @attach) = @$_;
489	_attach @$registry, $klass, @attach;	701	_attach $registry, $klass, @attach;
490	}	702	}
491	} else {	703	} else {
492	warn "object uses attachment '$name' that is not available, postponing.\n";	704	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	705	}
494	}	706	}
495	}	707	}
496		708
497	sub object_freezer_save {	709	cf::attachable->attach (
498	my ($filename, $rdata, $objs) = @_;
499
500	if (length $$rdata) {
501	warn sprintf "saving %s (%d,%d)\n",
502	$filename, length $$rdata, scalar @$objs;
503
504	if (open my $fh, ">:raw", "$filename~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, $$rdata;
507	close $fh;
508
509	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510	chmod SAVE_MODE, $fh;
511	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
512	close $fh;
513	rename "$filename.pst~", "$filename.pst";
514	} else {
515	unlink "$filename.pst";
516	}
517
518	rename "$filename~", $filename;
519	} else {
520	warn "FATAL: $filename~: $!\n";
521	}
522	} else {
523	unlink $filename;
524	unlink "$filename.pst";
525	}
526	}
527
528	sub object_freezer_as_string {
529	my ($rdata, $objs) = @_;
530
531	use Data::Dumper;
532
533	"$$rdata\n" . Dumper $objs
534	}
535
536	sub object_thawer_load {
537	my ($filename) = @_;
538
539	local $/;
540
541	my $av;
542
543	#TODO: use sysread etc.
544	if (open my $data, "<:raw:perlio", $filename) {
545	$data = <$data>;
546	if (open my $pst, "<:raw:perlio", "$filename.pst") {
547	$av = eval { (Storable::thaw <$pst>)->{objs} };
548	}
549	return ($data, $av);
550	}
551
552	()
553	}
554
555	attach_to_objects
556	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,
557	on_clone => sub {	723	on_clone => sub {
558	my ($src, $dst) = @_;	724	my ($src, $dst) = @_;
559		725
560	@{$dst->registry} = @{$src->registry};	726	@{$dst->registry} = @{$src->registry};
561		727
562	%$dst = %$src;	728	%$dst = %$src;
563		729
564	%{$dst->{_attachment}} = %{$src->{_attachment}}	730	%{$dst->{_attachment}} = %{$src->{_attachment}}
565	if exists $src->{_attachment};	731	if exists $src->{_attachment};
566	},	732	},
567	;	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	}
568		799
569	#############################################################################	800	#############################################################################
570	# old plug-in events	801	# command handling &c
571		802
572	sub inject_event {	803	=item cf::register_command $name => \&callback($ob,$args);
573	my $extension = shift;
574	my $event_code = shift;
575		804
576	my $cb = $hook[$event_code]{$extension}	805	Register a callback for execution when the client sends the user command
577	or return;	806	$name.
578		807
579	&$cb	808	=cut
580	}
581
582	sub inject_global_event {
583	my $event = shift;
584
585	my $cb = $hook[$event]
586	or return;
587
588	List::Util::max map &$_, values %$cb
589	}
590
591	sub inject_command {
592	my ($name, $obj, $params) = @_;
593
594	for my $cmd (@{ $command{$name} }) {
595	$cmd->[1]->($obj, $params);
596	}
597
598	-1
599	}
600		809
601	sub register_command {	810	sub register_command {
602	my ($name, $time, $cb) = @_;	811	my ($name, $cb) = @_;
603		812
604	my $caller = caller;	813	my $caller = caller;
605	#warn "registering command '$name/$time' to '$caller'";	814	#warn "registering command '$name/$time' to '$caller'";
606		815
607	push @{ $command{$name} }, [$time, $cb, $caller];	816	push @{ $COMMAND{$name} }, [$caller, $cb];
608	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
609	}	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
610		827
611	sub register_extcmd {	828	sub register_extcmd {
612	my ($name, $cb) = @_;	829	my ($name, $cb) = @_;
613		830
614	my $caller = caller;	831	$EXTCMD{$name} = $cb;
615	#warn "registering extcmd '$name' to '$caller'";
616
617	$extcmd{$name} = [$cb, $caller];
618	}	832	}
619		833
620	sub register {	834	cf::player->attach (
621	my ($base, $pkg) = @_;	835	on_command => sub {
		836	my ($pl, $name, $params) = @_;
622		837
623	#TODO	838	my $cb = $COMMAND{$name}
624	}	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	);
625		865
626	sub load_extension {	866	sub load_extension {
627	my ($path) = @_;	867	my ($path) = @_;
628		868
629	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	869	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
630	my $base = $1;	870	my $base = $1;
631	my $pkg = $1;	871	my $pkg = $1;
632	$pkg =~ s/[^[:word:]]/_/g;	872	$pkg =~ s/[^[:word:]]/_/g;
633	$pkg = "ext::$pkg";	873	$pkg = "ext::$pkg";
634		874
635	warn "loading '$path' into '$pkg'\n";	875	warn "... loading '$path' into '$pkg'\n";
636		876
637	open my $fh, "<:utf8", $path	877	open my $fh, "<:utf8", $path
638	or die "$path: $!";	878	or die "$path: $!";
639		879
640	my $source =	880	my $source =
641	"package $pkg; use strict; use utf8;\n"	881	"package $pkg; use strict; use utf8;\n"
642	. "#line 1 \"$path\"\n{\n"	882	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	883	. (do { local $/; <$fh> })
644	. "\n};\n1";	884	. "\n};\n1";
645		885
646	eval $source	886	unless (eval $source) {
647	or die "$path: $@";	887	my $msg = $@ ? "$path: $@\n"
648		888	: "extension disabled.\n";
649	push @exts, $pkg;	889	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
650	$ext_pkg{$base} = $pkg;	890	warn $@;
651		891	warn "mandatory extension failed to load, exiting.\n";
652	# no strict 'refs';	892	exit 1;
653	# @{"$pkg\::ISA"} = ext::;	893	}
654		894	die $@;
655	register $base, $pkg;
656	}
657
658	sub unload_extension {
659	my ($pkg) = @_;
660
661	warn "removing extension $pkg\n";
662
663	# remove hooks
664	#TODO
665	# for my $idx (0 .. $#PLUGIN_EVENT) {
666	# delete $hook[$idx]{$pkg};
667	# }	895	}
668		896
669	# remove commands	897	push @EXTS, $pkg;
670	for my $name (keys %command) {
671	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
672
673	if (@cb) {
674	$command{$name} = \@cb;
675	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
676	} else {
677	delete $command{$name};
678	delete $COMMAND{"$name\000"};
679	}
680	}
681
682	# remove extcmds
683	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
684	delete $extcmd{$name};
685	}
686
687	if (my $cb = $pkg->can ("unload")) {
688	eval {
689	$cb->($pkg);
690	1
691	} or warn "$pkg unloaded, but with errors: $@";
692	}
693
694	Symbol::delete_package $pkg;
695	}	898	}
696		899
697	sub load_extensions {	900	sub load_extensions {
698	my $LIBDIR = maps_directory "perl";
699
700	for my $ext (<$LIBDIR/*.ext>) {	901	for my $ext (<$LIBDIR/*.ext>) {
701	next unless -r $ext;	902	next unless -r $ext;
702	eval {	903	eval {
703	load_extension $ext;	904	load_extension $ext;
704	1	905	1
705	} or warn "$ext not loaded: $@";	906	} or warn "$ext not loaded: $@";
706	}	907	}
707	}	908	}
708		909
709	#############################################################################	910	#############################################################################
710	# extcmd framework, basically convert ext <msg>
711	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
712		911
713	attach_to_players	912	=head2 CORE EXTENSIONS
714	on_extcmd => sub {
715	my ($pl, $buf) = @_;
716		913
717	my $msg = eval { from_json $buf };	914	Functions and methods that extend core crossfire objects.
718		915
719	if (ref $msg) {	916	=cut
720	if (my $cb = $extcmd{$msg->{msgtype}}) {	917
721	if (my %reply = $cb->[0]->($pl, $msg)) {	918	package cf::player;
722	$pl->ext_reply ($msg->{msgid}, %reply);	919
723	}	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
724	}	969	}
725	} else {
726	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
727	}
728
729	cf::override;
730	},	970	}
731	;	971	}
732		972
733	#############################################################################	973	sub save($) {
734	# load/save/clean perl data associated with a map	974	my ($pl) = @_;
735		975
736	*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 {
737	my ($map) = @_;	1392	my ($map) = @_;
738		1393
739	my $path = $map->tmpname;	1394	my @diag; # diagonal neighbours
740	defined $path or return;
741		1395
742	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	}
743	};	1438	};
744		1439
745	attach_to_maps prio => -10000, package => cf::mapsupport::;	1440	sub find_async {
		1441	my ($path, $origin) = @_;
746		1442
747	#############################################################################	1443	$path = normalise $path, $origin && $origin->{path};
748	# load/save perl data associated with player->ob objects
749		1444
750	sub all_objects(@) {	1445	if (my $map = $cf::MAP{$path}) {
751	@_, map all_objects ($_->inv), @_	1446	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
752	}
753
754	# TODO: compatibility cruft, remove when no longer needed
755	attach_to_players
756	on_load => sub {
757	my ($pl, $path) = @_;
758
759	for my $o (all_objects $pl->ob) {
760	if (my $value = $o->get_ob_key_value ("_perl_data")) {
761	$o->set_ob_key_value ("_perl_data");
762
763	%$o = %{ Storable::thaw pack "H*", $value };
764	}
765	}
766	},	1447	}
767	;
768		1448
769	#############################################################################	1449	$MAP_PREFETCH{$path} = 0;
		1450	$MAP_PREFETCHER->ready;
770		1451
771	=head2 CORE EXTENSIONS	1452	()
		1453	}
772		1454
773	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;
774		1600
775	=over 4	1601	=over 4
776		1602
777	=item cf::player::exists $login	1603	=item $ob->inv_recursive
778		1604
779	Returns true when the given account exists.	1605	Returns the inventory of the object _and_ their inventories, recursively.
780		1606
781	=cut	1607	=cut
782		1608
783	sub cf::player::exists($) {	1609	sub inv_recursive_;
784	cf::player::find $_[0]	1610	sub inv_recursive_ {
785	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1611	map { $_, inv_recursive_ $_->inv } @_
786	}	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
787		1625
788	=item $player_object->reply ($npc, $msg[, $flags])	1626	=item $player_object->reply ($npc, $msg[, $flags])
789		1627
790	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>
791	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
…		…
793		1631
794	=cut	1632	=cut
795		1633
796	# rough implementation of a future "reply" method that works	1634	# rough implementation of a future "reply" method that works
797	# with dialog boxes.	1635	# with dialog boxes.
		1636	#TODO: the first argument must go, split into a $npc->reply_to ( method
798	sub cf::object::player::reply($$$;$) {	1637	sub cf::object::player::reply($$$;$) {
799	my ($self, $npc, $msg, $flags) = @_;	1638	my ($self, $npc, $msg, $flags) = @_;
800		1639
801	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1640	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
802		1641
…		…
806	$msg = $npc->name . " says: $msg" if $npc;	1645	$msg = $npc->name . " says: $msg" if $npc;
807	$self->message ($msg, $flags);	1646	$self->message ($msg, $flags);
808	}	1647	}
809	}	1648	}
810		1649
811	=item $player->ext_reply ($msgid, $msgtype, %msg)
812
813	Sends an ext reply to the player.
814
815	=cut
816
817	sub cf::player::ext_reply($$$%) {
818	my ($self, $id, %msg) = @_;
819
820	$msg{msgid} = $id;
821
822	$self->send ("ext " . to_json \%msg);
823	}
824
825	=item $player_object->may ("access")	1650	=item $player_object->may ("access")
826		1651
827	Returns wether the given player is authorized to access resource "access"	1652	Returns wether the given player is authorized to access resource "access"
828	(e.g. "command_wizcast").	1653	(e.g. "command_wizcast").
829		1654
…		…
836	(ref $cf::CFG{"may_$access"}	1661	(ref $cf::CFG{"may_$access"}
837	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1662	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
838	: $cf::CFG{"may_$access"})	1663	: $cf::CFG{"may_$access"})
839	}	1664	}
840		1665
841	=cut	1666	=item $player_object->enter_link
842		1667
843	#############################################################################	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
844		1975
845	=head2 SAFE SCRIPTING	1976	=head2 SAFE SCRIPTING
846		1977
847	Functions that provide a safe environment to compile and execute	1978	Functions that provide a safe environment to compile and execute
848	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
…		…
863		1994
864	=pod	1995	=pod
865		1996
866	The following fucntions and emthods are available within a safe environment:	1997	The following fucntions and emthods are available within a safe environment:
867		1998
868	cf::object contr pay_amount pay_player	1999	cf::object contr pay_amount pay_player map
869	cf::object::player player	2000	cf::object::player player
870	cf::player peaceful	2001	cf::player peaceful
		2002	cf::map trigger
871		2003
872	=cut	2004	=cut
873		2005
874	for (	2006	for (
875	["cf::object" => qw(contr pay_amount pay_player)],	2007	["cf::object" => qw(contr pay_amount pay_player map)],
876	["cf::object::player" => qw(player)],	2008	["cf::object::player" => qw(player)],
877	["cf::player" => qw(peaceful)],	2009	["cf::player" => qw(peaceful)],
		2010	["cf::map" => qw(trigger)],
878	) {	2011	) {
879	no strict 'refs';	2012	no strict 'refs';
880	my ($pkg, @funs) = @$_;	2013	my ($pkg, @funs) = @$_;
881	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2014	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
882	for @funs;	2015	for @funs;
…		…
998		2131
999	{	2132	{
1000	my $path = cf::localdir . "/database.pst";	2133	my $path = cf::localdir . "/database.pst";
1001		2134
1002	sub db_load() {	2135	sub db_load() {
1003	warn "loading database $path\n";#d# remove later
1004	$DB = stat $path ? Storable::retrieve $path : { };	2136	$DB = stat $path ? Storable::retrieve $path : { };
1005	}	2137	}
1006		2138
1007	my $pid;	2139	my $pid;
1008		2140
1009	sub db_save() {	2141	sub db_save() {
1010	warn "saving database $path\n";#d# remove later
1011	waitpid $pid, 0 if $pid;	2142	waitpid $pid, 0 if $pid;
1012	if (0 == ($pid = fork)) {	2143	if (0 == ($pid = fork)) {
1013	$DB->{_meta}{version} = 1;	2144	$DB->{_meta}{version} = 1;
1014	Storable::nstore $DB, "$path~";	2145	Storable::nstore $DB, "$path~";
1015	rename "$path~", $path;	2146	rename "$path~", $path;
…		…
1022	sub db_sync() {	2153	sub db_sync() {
1023	db_save if $dirty;	2154	db_save if $dirty;
1024	undef $dirty;	2155	undef $dirty;
1025	}	2156	}
1026		2157
1027	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 {
1028	db_sync;	2159	db_sync;
1029	});	2160	});
1030		2161
1031	sub db_dirty() {	2162	sub db_dirty() {
1032	$dirty = 1;	2163	$dirty = 1;
…		…
1046	$DB->{$_[0]} = $_[1];	2177	$DB->{$_[0]} = $_[1];
1047	}	2178	}
1048	db_dirty;	2179	db_dirty;
1049	}	2180	}
1050		2181
1051	attach_global	2182	cf::global->attach (
1052	prio => 10000,	2183	prio => 10000,
1053	on_cleanup => sub {	2184	on_cleanup => sub {
1054	db_sync;	2185	db_sync;
1055	},	2186	},
1056	;	2187	);
1057	}	2188	}
1058		2189
1059	#############################################################################	2190	#############################################################################
1060	# the server's main()	2191	# the server's main()
1061		2192
…		…
1063	open my $fh, "<:utf8", cf::confdir . "/config"	2194	open my $fh, "<:utf8", cf::confdir . "/config"
1064	or return;	2195	or return;
1065		2196
1066	local $/;	2197	local $/;
1067	*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	}
1068	}	2212	}
1069		2213
1070	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
1071	cfg_load;	2221	cfg_load;
1072	db_load;	2222	db_load;
1073	load_extensions;	2223	load_extensions;
1074	Event::loop;	2224	Event::loop;
1075	}	2225	}
1076		2226
1077	#############################################################################	2227	#############################################################################
1078	# initialisation	2228	# initialisation and cleanup
1079		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
1080	sub _perl_reload(&) {	2272	sub reload() {
1081	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	}
1082		2278
1083	$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;
1084		2288
1085	eval {	2289	eval {
		2290	# if anything goes wrong in here, we should simply crash as we already saved
		2291
1086	# cancel all watchers	2292	warn "cancel all watchers";
1087	$_->cancel for Event::all_watchers;	2293	for (Event::all_watchers) {
		2294	$_->cancel if $_->data & WF_AUTOCANCEL;
		2295	}
1088		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
1089	# unload all extensions	2307	warn "unload/nuke all extensions";
1090	for (@exts) {	2308	for my $pkg (@EXTS) {
1091	$msg->("unloading <$_>");	2309	warn "... unloading $pkg";
1092	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: $@";
1093	}	2316	}
1094		2317
		2318	warn "... nuking $pkg";
		2319	Symbol::delete_package $pkg;
		2320	}
		2321
1095	# unload all modules loaded from $LIBDIR	2322	warn "unload all perl modules loaded from $LIBDIR";
1096	while (my ($k, $v) = each %INC) {	2323	while (my ($k, $v) = each %INC) {
1097	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2324	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1098		2325
1099	$msg->("removing <$k>");	2326	warn "removing <$k>";
1100	delete $INC{$k};	2327	delete $INC{$k};
1101		2328
1102	$k =~ s/\.pm$//;	2329	$k =~ s/\.pm$//;
1103	$k =~ s/\//::/g;	2330	$k =~ s/\//::/g;
1104		2331
…		…
1107	}	2334	}
1108		2335
1109	Symbol::delete_package $k;	2336	Symbol::delete_package $k;
1110	}	2337	}
1111		2338
1112	# sync database to disk
1113	cf::db_sync;
1114
1115	# get rid of safe::, as good as possible	2339	warn "get rid of safe::, as good as possible";
1116	Symbol::delete_package "safe::$_"	2340	Symbol::delete_package "safe::$_"
1117	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);
1118		2342
1119	# remove register_script_function callbacks
1120	# TODO
1121
1122	# unload cf.pm "a bit"	2343	warn "unload cf.pm \"a bit\"";
1123	delete $INC{"cf.pm"};	2344	delete $INC{"cf.pm"};
1124		2345
1125	# don't, removes xs symbols, too,	2346	# don't, removes xs symbols, too,
1126	# and global variables created in xs	2347	# and global variables created in xs
1127	#Symbol::delete_package __PACKAGE__;	2348	#Symbol::delete_package __PACKAGE__;
1128		2349
1129	# reload cf.pm
1130	$msg->("reloading cf.pm");	2350	warn "reloading cf.pm";
1131	require cf;	2351	require cf;
		2352	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1132		2353
1133	# load config and database again	2354	warn "load config and database again";
1134	cf::cfg_load;	2355	cf::cfg_load;
1135	cf::db_load;	2356	cf::db_load;
1136		2357
1137	# load extensions	2358	warn "load extensions";
1138	$msg->("load extensions");
1139	cf::load_extensions;	2359	cf::load_extensions;
1140		2360
1141	# reattach attachments to objects	2361	warn "reattach attachments to objects/players";
1142	$msg->("reattach");
1143	_global_reattach;	2362	_global_reattach;
		2363	warn "reattach attachments to maps";
		2364	reattach $_ for values %MAP;
1144	};	2365	};
1145	$msg->($@) if $@;
1146		2366
1147	$msg->("reloaded");	2367	if ($@) {
		2368	warn $@;
		2369	warn "error while reloading, exiting.";
		2370	exit 1;
		2371	}
		2372
		2373	warn "reloaded";
1148	};	2374	};
1149		2375
1150	sub perl_reload() {
1151	_perl_reload {
1152	warn $_[0];
1153	print "$_[0]\n";
1154	};
1155	}
1156
1157	register_command "perl-reload", 0, sub {	2376	register_command "reload" => sub {
1158	my ($who, $arg) = @_;	2377	my ($who, $arg) = @_;
1159		2378
1160	if ($who->flag (FLAG_WIZ)) {	2379	if ($who->flag (FLAG_WIZ)) {
1161	_perl_reload {	2380	$who->message ("start of reload.");
1162	warn $_[0];	2381	reload;
1163	$who->message ($_[0]);	2382	$who->message ("end of reload.");
1164	};
1165	}	2383	}
1166	};	2384	};
1167		2385
1168	register "<global>", __PACKAGE__;
1169
1170	unshift @INC, $LIBDIR;	2386	unshift @INC, $LIBDIR;
1171		2387
1172	$TICK_WATCHER = Event->timer (	2388	$TICK_WATCHER = Event->timer (
		2389	reentrant => 0,
1173	prio => 1,	2390	prio => 0,
1174	async => 1,
1175	at => $NEXT_TICK || 1,	2391	at => $NEXT_TICK || $TICK,
		2392	data => WF_AUTOCANCEL,
1176	cb => sub {	2393	cb => sub {
		2394	$NOW = Event::time;
		2395
1177	cf::server_tick; # one server iteration	2396	cf::server_tick; # one server iteration
1178		2397	$RUNTIME += $TICK;
1179	my $NOW = Event::time;
1180	$NEXT_TICK += $TICK;	2398	$NEXT_TICK += $TICK;
1181		2399
		2400	$WAIT_FOR_TICK->broadcast;
		2401	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2402
1182	# 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
1183	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2404	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1184		2405
1185	$TICK_WATCHER->at ($NEXT_TICK);	2406	$TICK_WATCHER->at ($NEXT_TICK);
1186	$TICK_WATCHER->start;	2407	$TICK_WATCHER->start;
1187	},	2408	},
1188	);	2409	);
1189		2410
1190	IO::AIO::max_poll_time $TICK * 0.2;	2411	IO::AIO::max_poll_time $TICK * 0.2;
1191		2412
		2413	$AIO_POLL_WATCHER = Event->io (
1192	Event->io (fd => IO::AIO::poll_fileno,	2414	fd => IO::AIO::poll_fileno,
1193	poll => 'r',	2415	poll => 'r',
1194	prio => 5,	2416	prio => 5,
		2417	data => WF_AUTOCANCEL,
1195	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 }
1196		2434
1197	1	2435	1
1198		2436

Diff Legend

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