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

Diff Legend

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