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.87 by root, Thu Dec 14 22:45:40 2006 UTC vs.
Revision 1.180 by root, Fri Jan 19 00:38:02 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.4 ();
		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 = maps_directory "perl";	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_socket 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	)) {
89	no strict 'refs';	160	no strict 'refs';
90	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
…		…
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 cf::attachable::thawer_merge {
		509	# simply override everything except _meta
		510	local $_[0]{_meta};
		511	%{$_[0]} = %{$_[1]};
		512	}
		513
		514	sub _attach_cb($$$$) {
		515	my ($registry, $event, $prio, $cb) = @_;
		516
		517	use sort 'stable';
		518
		519	$cb = [$prio, $cb];
		520
		521	@{$registry->[$event]} = sort
		522	{ $a->[0] cmp $b->[0] }
		523	@{$registry->[$event] || []}, $cb;
		524	}
		525
		526	# hack
		527	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		528
		529	# attach handles attaching event callbacks
		530	# the only thing the caller has to do is pass the correct
		531	# registry (== where the callback attaches to).
		532	sub _attach {
		533	my ($registry, $klass, @arg) = @_;
		534
		535	my $object_type;
		536	my $prio = 0;
		537	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		538
		539	#TODO: get rid of this hack
		540	if ($attachable_klass{$klass}) {
		541	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		542	}
		543
		544	while (@arg) {
		545	my $type = shift @arg;
		546
		547	if ($type eq "prio") {
		548	$prio = shift @arg;
		549
		550	} elsif ($type eq "type") {
		551	$object_type = shift @arg;
		552	$registry = $CB_TYPE[$object_type] ||= [];
		553
		554	} elsif ($type eq "subtype") {
		555	defined $object_type or Carp::croak "subtype specified without type";
		556	my $object_subtype = shift @arg;
		557	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		558
		559	} elsif ($type eq "package") {
		560	my $pkg = shift @arg;
		561
		562	while (my ($name, $id) = each %cb_id) {
		563	if (my $cb = $pkg->can ($name)) {
		564	_attach_cb $registry, $id, $prio, $cb;
		565	}
		566	}
		567
		568	} elsif (exists $cb_id{$type}) {
		569	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		570
		571	} elsif (ref $type) {
		572	warn "attaching objects not supported, ignoring.\n";
		573
		574	} else {
		575	shift @arg;
		576	warn "attach argument '$type' not supported, ignoring.\n";
		577	}
		578	}
		579	}
		580
		581	sub _object_attach {
		582	my ($obj, $name, %arg) = @_;
		583
		584	return if exists $obj->{_attachment}{$name};
		585
		586	if (my $attach = $attachment{$name}) {
		587	my $registry = $obj->registry;
		588
		589	for (@$attach) {
		590	my ($klass, @attach) = @$_;
		591	_attach $registry, $klass, @attach;
		592	}
		593
		594	$obj->{$name} = \%arg;
		595	} else {
		596	warn "object uses attachment '$name' that is not available, postponing.\n";
		597	}
		598
		599	$obj->{_attachment}{$name} = undef;
		600	}
		601
		602	sub cf::attachable::attach {
		603	if (ref $_[0]) {
		604	_object_attach @_;
		605	} else {
		606	_attach shift->_attach_registry, @_;
		607	}
		608	};
		609
		610	# all those should be optimised
		611	sub cf::attachable::detach {
		612	my ($obj, $name) = @_;
		613
		614	if (ref $obj) {
		615	delete $obj->{_attachment}{$name};
		616	reattach ($obj);
		617	} else {
		618	Carp::croak "cannot, currently, detach class attachments";
		619	}
		620	};
		621
		622	sub cf::attachable::attached {
		623	my ($obj, $name) = @_;
		624
		625	exists $obj->{_attachment}{$name}
		626	}
		627
		628	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		629	eval "#line " . __LINE__ . " 'cf.pm'
		630	sub cf::\L$klass\E::_attach_registry {
		631	(\\\@CB_$klass, KLASS_$klass)
		632	}
		633
		634	sub cf::\L$klass\E::attachment {
		635	my \$name = shift;
		636
		637	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		638	}
		639	";
		640	die if $@;
		641	}
		642
		643	our $override;
		644	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		645
		646	sub override {
		647	$override = 1;
		648	@invoke_results = ();
		649	}
		650
		651	sub do_invoke {
		652	my $event = shift;
		653	my $callbacks = shift;
		654
		655	@invoke_results = ();
		656
		657	local $override;
		658
		659	for (@$callbacks) {
		660	eval { &{$_->[1]} };
		661
		662	if ($@) {
		663	warn "$@";
		664	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		665	override;
		666	}
		667
		668	return 1 if $override;
		669	}
		670
		671	0
		672	}
		673
		674	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		675
		676	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		677
		678	Generate an object-specific event with the given arguments.
		679
		680	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		681	removed in future versions), and there is no public API to access override
		682	results (if you must, access C<@cf::invoke_results> directly).
		683
463	=back	684	=back
464		685
465	=cut	686	=cut
466
467	*cf::object::valid =
468	*cf::player::valid =
469	*cf::map::valid = \&cf::_valid;
470		687
471	#############################################################################	688	#############################################################################
472	# object support	689	# object support
473		690
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 {	691	sub reattach {
		692	# basically do the same as instantiate, without calling instantiate
488	my ($obj) = @_;	693	my ($obj) = @_;
		694
		695	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		696
489	my $registry = $obj->registry;	697	my $registry = $obj->registry;
490		698
491	@$registry = ();	699	@$registry = ();
492		700
493	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	701	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494		702
495	for my $name (keys %{ $obj->{_attachment} || {} }) {	703	for my $name (keys %{ $obj->{_attachment} || {} }) {
496	if (my $attach = $attachment{$name}) {	704	if (my $attach = $attachment{$name}) {
497	for (@$attach) {	705	for (@$attach) {
498	my ($klass, @attach) = @$_;	706	my ($klass, @attach) = @$_;
499	_attach @$registry, $klass, @attach;	707	_attach $registry, $klass, @attach;
500	}	708	}
501	} else {	709	} else {
502	warn "object uses attachment '$name' that is not available, postponing.\n";	710	warn "object uses attachment '$name' that is not available, postponing.\n";
503	}	711	}
504	}	712	}
505	}	713	}
506		714
507	sub object_freezer_save {	715	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,	716	prio => -1000000,
		717	on_instantiate => sub {
		718	my ($obj, $data) = @_;
		719
		720	$data = from_json $data;
		721
		722	for (@$data) {
		723	my ($name, $args) = @$_;
		724
		725	$obj->attach ($name, %{$args || {} });
		726	}
		727	},
		728	on_reattach => \&reattach,
567	on_clone => sub {	729	on_clone => sub {
568	my ($src, $dst) = @_;	730	my ($src, $dst) = @_;
569		731
570	@{$dst->registry} = @{$src->registry};	732	@{$dst->registry} = @{$src->registry};
571		733
572	%$dst = %$src;	734	%$dst = %$src;
573		735
574	%{$dst->{_attachment}} = %{$src->{_attachment}}	736	%{$dst->{_attachment}} = %{$src->{_attachment}}
575	if exists $src->{_attachment};	737	if exists $src->{_attachment};
576	},	738	},
577	;	739	);
		740
		741	sub object_freezer_save {
		742	my ($filename, $rdata, $objs) = @_;
		743
		744	sync_job {
		745	if (length $$rdata) {
		746	warn sprintf "saving %s (%d,%d)\n",
		747	$filename, length $$rdata, scalar @$objs;
		748
		749	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		750	chmod SAVE_MODE, $fh;
		751	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		752	aio_fsync $fh;
		753	close $fh;
		754
		755	if (@$objs) {
		756	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		757	chmod SAVE_MODE, $fh;
		758	my $data = Storable::nfreeze { version => 1, objs => $objs };
		759	aio_write $fh, 0, (length $data), $data, 0;
		760	aio_fsync $fh;
		761	close $fh;
		762	aio_rename "$filename.pst~", "$filename.pst";
		763	}
		764	} else {
		765	aio_unlink "$filename.pst";
		766	}
		767
		768	aio_rename "$filename~", $filename;
		769	} else {
		770	warn "FATAL: $filename~: $!\n";
		771	}
		772	} else {
		773	aio_unlink $filename;
		774	aio_unlink "$filename.pst";
		775	}
		776	}
		777	}
		778
		779	sub object_freezer_as_string {
		780	my ($rdata, $objs) = @_;
		781
		782	use Data::Dumper;
		783
		784	$$rdata . Dumper $objs
		785	}
		786
		787	sub object_thawer_load {
		788	my ($filename) = @_;
		789
		790	my ($data, $av);
		791
		792	(aio_load $filename, $data) >= 0
		793	or return;
		794
		795	unless (aio_stat "$filename.pst") {
		796	(aio_load "$filename.pst", $av) >= 0
		797	or return;
		798	$av = eval { (Storable::thaw $av)->{objs} };
		799	}
		800
		801	warn sprintf "loading %s (%d)\n",
		802	$filename, length $data, scalar @{$av || []};#d#
		803	return ($data, $av);
		804	}
578		805
579	#############################################################################	806	#############################################################################
580	# command handling &c	807	# command handling &c
581		808
582	=item cf::register_command $name => \&callback($ob,$args);	809	=item cf::register_command $name => \&callback($ob,$args);
…		…
605	=cut	832	=cut
606		833
607	sub register_extcmd {	834	sub register_extcmd {
608	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
609		836
610	my $caller = caller;
611	#warn "registering extcmd '$name' to '$caller'";
612
613	$EXTCMD{$name} = [$cb, $caller];	837	$EXTCMD{$name} = $cb;
614	}	838	}
615		839
616	attach_to_players	840	cf::player->attach (
617	on_command => sub {	841	on_command => sub {
618	my ($pl, $name, $params) = @_;	842	my ($pl, $name, $params) = @_;
619		843
620	my $cb = $COMMAND{$name}	844	my $cb = $COMMAND{$name}
621	or return;	845	or return;
…		…
631		855
632	my $msg = eval { from_json $buf };	856	my $msg = eval { from_json $buf };
633		857
634	if (ref $msg) {	858	if (ref $msg) {
635	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
636	if (my %reply = $cb->[0]->($pl, $msg)) {	860	if (my %reply = $cb->($pl, $msg)) {
637	$pl->ext_reply ($msg->{msgid}, %reply);	861	$pl->ext_reply ($msg->{msgid}, %reply);
638	}	862	}
639	}	863	}
640	} else {	864	} else {
641	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642	}	866	}
643		867
644	cf::override;	868	cf::override;
645	},	869	},
646	;	870	);
647
648	sub register {
649	my ($base, $pkg) = @_;
650
651	#TODO
652	}
653		871
654	sub load_extension {	872	sub load_extension {
655	my ($path) = @_;	873	my ($path) = @_;
656		874
657	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
658	my $base = $1;	876	my $base = $1;
659	my $pkg = $1;	877	my $pkg = $1;
660	$pkg =~ s/[^[:word:]]/_/g;	878	$pkg =~ s/[^[:word:]]/_/g;
661	$pkg = "ext::$pkg";	879	$pkg = "ext::$pkg";
662		880
663	warn "loading '$path' into '$pkg'\n";	881	warn "... loading '$path' into '$pkg'\n";
664		882
665	open my $fh, "<:utf8", $path	883	open my $fh, "<:utf8", $path
666	or die "$path: $!";	884	or die "$path: $!";
667		885
668	my $source =	886	my $source =
669	"package $pkg; use strict; use utf8;\n"	887	"package $pkg; use strict; use utf8;\n"
670	. "#line 1 \"$path\"\n{\n"	888	. "#line 1 \"$path\"\n{\n"
671	. (do { local $/; <$fh> })	889	. (do { local $/; <$fh> })
672	. "\n};\n1";	890	. "\n};\n1";
673		891
674	eval $source	892	unless (eval $source) {
675	or die $@ ? "$path: $@\n"	893	my $msg = $@ ? "$path: $@\n"
676	: "extension disabled.\n";	894	: "extension disabled.\n";
677		895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
678	push @exts, $pkg;	896	warn $@;
679	$ext_pkg{$base} = $pkg;	897	warn "mandatory extension failed to load, exiting.\n";
680		898	exit 1;
681	# no strict 'refs';	899	}
682	# @{"$pkg\::ISA"} = ext::;	900	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	# }	901	}
697		902
698	# remove commands	903	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	}	904	}
723		905
724	sub load_extensions {	906	sub load_extensions {
725	my $LIBDIR = maps_directory "perl";
726
727	for my $ext (<$LIBDIR/*.ext>) {	907	for my $ext (<$LIBDIR/*.ext>) {
728	next unless -r $ext;	908	next unless -r $ext;
729	eval {	909	eval {
730	load_extension $ext;	910	load_extension $ext;
731	1	911	1
732	} or warn "$ext not loaded: $@";	912	} or warn "$ext not loaded: $@";
733	}	913	}
734	}	914	}
735		915
736	#############################################################################	916	#############################################################################
737	# load/save/clean perl data associated with a map
738		917
739	*cf::mapsupport::on_clean = sub {	918	=head2 CORE EXTENSIONS
		919
		920	Functions and methods that extend core crossfire objects.
		921
		922	=cut
		923
		924	package cf::player;
		925
		926	use Coro::AIO;
		927
		928	=head3 cf::player
		929
		930	=over 4
		931
		932	=item cf::player::find $login
		933
		934	Returns the given player object, loading it if necessary (might block).
		935
		936	=cut
		937
		938	sub playerdir($) {
		939	cf::localdir
		940	. "/"
		941	. cf::playerdir
		942	. "/"
		943	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		944	}
		945
		946	sub path($) {
		947	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		948
		949	(playerdir $login) . "/$login.pl"
		950	}
		951
		952	sub find_active($) {
		953	$cf::PLAYER{$_[0]}
		954	and $cf::PLAYER{$_[0]}->active
		955	and $cf::PLAYER{$_[0]}
		956	}
		957
		958	sub exists($) {
		959	my ($login) = @_;
		960
		961	$cf::PLAYER{$login}
		962	or cf::sync_job { !aio_stat path $login }
		963	}
		964
		965	sub find($) {
		966	return $cf::PLAYER{$_[0]} || do {
		967	my $login = $_[0];
		968
		969	my $guard = cf::lock_acquire "user_find:$login";
		970
		971	$cf::PLAYER{$_[0]} || do {
		972	my $pl = load_pl path $login
		973	or return;
		974	$cf::PLAYER{$login} = $pl
		975	}
		976	}
		977	}
		978
		979	sub save($) {
		980	my ($pl) = @_;
		981
		982	return if $pl->{deny_save};
		983
		984	my $path = path $pl;
		985	my $guard = cf::lock_acquire "user_save:$path";
		986
		987	return if $pl->{deny_save};
		988
		989	aio_mkdir playerdir $pl, 0770;
		990	$pl->{last_save} = $cf::RUNTIME;
		991
		992	$pl->save_pl ($path);
		993	Coro::cede;
		994	}
		995
		996	sub new($) {
		997	my ($login) = @_;
		998
		999	my $self = create;
		1000
		1001	$self->ob->name ($login);
		1002	$self->{deny_save} = 1;
		1003
		1004	$cf::PLAYER{$login} = $self;
		1005
		1006	$self
		1007	}
		1008
		1009	=item $pl->quit_character
		1010
		1011	Nukes the player without looking back. If logged in, the connection will
		1012	be destroyed. May block for a long time.
		1013
		1014	=cut
		1015
		1016	sub quit_character {
		1017	my ($pl) = @_;
		1018
		1019	$pl->{deny_save} = 1;
		1020	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1021
		1022	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1023	$pl->deactivate;
		1024	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1025	$pl->ns->destroy if $pl->ns;
		1026
		1027	my $path = playerdir $pl;
		1028	my $temp = "$path~$cf::RUNTIME~deleting~";
		1029	aio_rename $path, $temp;
		1030	delete $cf::PLAYER{$pl->ob->name};
		1031	$pl->destroy;
		1032	IO::AIO::aio_rmtree $temp;
		1033	}
		1034
		1035	=item cf::player::list_logins
		1036
		1037	Returns am arrayref of all valid playernames in the system, can take a
		1038	while and may block, so not sync_job-capable, ever.
		1039
		1040	=cut
		1041
		1042	sub list_logins {
		1043	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1044	or return [];
		1045
		1046	my @logins;
		1047
		1048	for my $login (@$dirs) {
		1049	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1050	aio_read $fh, 0, 512, my $buf, 0 or next;
		1051	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1052
		1053	utf8::decode $login;
		1054	push @logins, $login;
		1055	}
		1056
		1057	\@logins
		1058	}
		1059
		1060	=item $player->maps
		1061
		1062	Returns an arrayref of map paths that are private for this
		1063	player. May block.
		1064
		1065	=cut
		1066
		1067	sub maps($) {
		1068	my ($pl) = @_;
		1069
		1070	my $files = aio_readdir playerdir $pl
		1071	or return;
		1072
		1073	my @paths;
		1074
		1075	for (@$files) {
		1076	utf8::decode $_;
		1077	next if /\.(?:pl|pst)$/;
		1078	next unless /^$PATH_SEP/o;
		1079
		1080	s/\.map$//;
		1081	push @paths, "~" . $pl->ob->name . "/" . $_;
		1082	}
		1083
		1084	\@paths
		1085	}
		1086
		1087	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1088
		1089	Sends an ext reply to the player.
		1090
		1091	=cut
		1092
		1093	sub ext_reply($$$%) {
		1094	my ($self, $id, %msg) = @_;
		1095
		1096	$msg{msgid} = $id;
		1097
		1098	$self->send ("ext " . cf::to_json \%msg);
		1099	}
		1100
		1101	package cf;
		1102
		1103	=back
		1104
		1105
		1106	=head3 cf::map
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
		1112	package cf::map;
		1113
		1114	use Fcntl;
		1115	use Coro::AIO;
		1116
		1117	use overload
		1118	'""' => \&as_string,
		1119	fallback => 1;
		1120
		1121	our $MAX_RESET = 3600;
		1122	our $DEFAULT_RESET = 3000;
		1123
		1124	sub generate_random_map {
		1125	my ($self, $rmp) = @_;
		1126	# mit "rum" bekleckern, nicht
		1127	$self->_create_random_map (
		1128	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1129	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1130	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1131	$rmp->{exit_on_final_map},
		1132	$rmp->{xsize}, $rmp->{ysize},
		1133	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1134	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1135	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1136	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1137	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1138	(cf::region::find $rmp->{region}), $rmp->{custom}
		1139	)
		1140	}
		1141
		1142	sub register {
		1143	my (undef, $regex) = @_;
		1144	my $pkg = caller;
		1145
		1146	no strict;
		1147	push @{"$pkg\::ISA"}, __PACKAGE__;
		1148
		1149	$EXT_MAP{$pkg} = qr<$regex>;
		1150	}
		1151
		1152	# also paths starting with '/'
		1153	$EXT_MAP{"cf::map"} = qr{^(?=/)};
		1154
		1155	sub thawer_merge {
		1156	my ($self, $merge) = @_;
		1157
		1158	# we have to keep some variables in memory intact
		1159	local $self->{path};
		1160	local $self->{load_path};
		1161	local $self->{deny_save};
		1162	local $self->{deny_reset};
		1163
		1164	$self->SUPER::thawer_merge ($merge);
		1165	}
		1166
		1167	sub normalise {
		1168	my ($path, $base) = @_;
		1169
		1170	# map plan:
		1171	#
		1172	# /! non-realised random map exit (special hack!)
		1173	# {... are special paths that are not being touched
		1174	# ?xxx/... are special absolute paths
		1175	# ?random/... random maps
		1176	# /... normal maps
		1177	# ~user/... per-player map of a specific user
		1178
		1179	$path =~ s/$PATH_SEP/\//go;
		1180
		1181	# treat it as relative path if it starts with
		1182	# something that looks reasonable
		1183	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1184	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1185
		1186	$base =~ s{[^/]+/?$}{};
		1187	$path = "$base/$path";
		1188	}
		1189
		1190	for ($path) {
		1191	redo if s{//}{/};
		1192	redo if s{/\.?/}{/};
		1193	redo if s{/[^/]+/\.\./}{/};
		1194	}
		1195
		1196	$path
		1197	}
		1198
		1199	sub new_from_path {
		1200	my (undef, $path, $base) = @_;
		1201
		1202	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1203
		1204	$path = normalise $path, $base;
		1205
		1206	for my $pkg (keys %EXT_MAP) {
		1207	if ($path =~ $EXT_MAP{$pkg}) {
		1208	my $self = bless cf::map::new, $pkg;
		1209	$self->{path} = $path; $self->path ($path);
		1210	$self->init; # pass $1 etc.
		1211	return $self;
		1212	}
		1213	}
		1214
		1215	Carp::carp "unable to resolve path '$path'.";
		1216	()
		1217	}
		1218
		1219	sub init {
		1220	my ($self) = @_;
		1221
		1222	$self
		1223	}
		1224
		1225	sub as_string {
		1226	my ($self) = @_;
		1227
		1228	"$self->{path}"
		1229	}
		1230
		1231	# the displayed name, this is a one way mapping
		1232	sub visible_name {
		1233	&as_string
		1234	}
		1235
		1236	# the original (read-only) location
		1237	sub load_path {
		1238	my ($self) = @_;
		1239
		1240	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1241	}
		1242
		1243	# the temporary/swap location
		1244	sub save_path {
		1245	my ($self) = @_;
		1246
		1247	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1248	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
		1249	}
		1250
		1251	# the unique path, undef == no special unique path
		1252	sub uniq_path {
		1253	my ($self) = @_;
		1254
		1255	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1256	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1257	}
		1258
		1259	# and all this just because we cannot iterate over
		1260	# all maps in C++...
		1261	sub change_all_map_light {
		1262	my ($change) = @_;
		1263
		1264	$_->change_map_light ($change)
		1265	for grep $_->outdoor, values %cf::MAP;
		1266	}
		1267
		1268	sub unlink_save {
		1269	my ($self) = @_;
		1270
		1271	utf8::encode (my $save = $self->save_path);
		1272	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1273	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1274	}
		1275
		1276	sub load_header_from($) {
		1277	my ($self, $path) = @_;
		1278
		1279	utf8::encode $path;
		1280	aio_open $path, O_RDONLY, 0
		1281	or return;
		1282
		1283	$self->_load_header ($path)
		1284	or return;
		1285
		1286	$self->{load_path} = $path;
		1287
		1288	1
		1289	}
		1290
		1291	sub load_orig {
		1292	my ($self) = @_;
		1293
		1294	$self->load_header_from ($self->load_path)
		1295	}
		1296
		1297	sub load_temp {
		1298	my ($self) = @_;
		1299
		1300	$self->load_header_from ($self->save_path)
		1301	}
		1302
		1303	sub load_header {
		1304	my ($self) = @_;
		1305
		1306	if ($self->load_temp) {
		1307	$self->last_access ((delete $self->{last_access})
		1308	|| $cf::RUNTIME); #d#
		1309	# safety
		1310	$self->{instantiate_time} = $cf::RUNTIME
		1311	if $self->{instantiate_time} > $cf::RUNTIME;
		1312	} else {
		1313	$self->load_orig
		1314	or return;
		1315
		1316	$self->{load_original} = 1;
		1317	$self->{instantiate_time} = $cf::RUNTIME;
		1318	$self->last_access ($cf::RUNTIME);
		1319	$self->instantiate;
		1320	}
		1321
		1322	1
		1323	}
		1324
		1325	sub find;
		1326	sub find {
		1327	my ($path, $origin) = @_;
		1328
		1329	$path = normalise $path, $origin && $origin->path;
		1330
		1331	cf::lock_wait "map_find:$path";
		1332
		1333	$cf::MAP{$path} || do {
		1334	my $guard = cf::lock_acquire "map_find:$path";
		1335	my $map = new_from_path cf::map $path
		1336	or return;
		1337
		1338	$map->{last_save} = $cf::RUNTIME;
		1339
		1340	$map->load_header
		1341	or return;
		1342
		1343	if ($map->should_reset) {
		1344	$cf::WAIT_FOR_TICK->wait;
		1345	$map->reset;
		1346	undef $guard;
		1347	$map = find $path
		1348	or return;
		1349	}
		1350
		1351	$cf::MAP{$path} = $map
		1352	}
		1353	}
		1354
		1355	sub load {
		1356	my ($self) = @_;
		1357
		1358	my $path = $self->{path};
		1359	my $guard = cf::lock_acquire "map_load:$path";
		1360
		1361	return if $self->in_memory != cf::MAP_SWAPPED;
		1362
		1363	$self->in_memory (cf::MAP_LOADING);
		1364
		1365	$self->alloc;
		1366	$self->_load_objects ($self->{load_path}, 1)
		1367	or return;
		1368
		1369	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1370	if delete $self->{load_original};
		1371
		1372	if (my $uniq = $self->uniq_path) {
		1373	utf8::encode $uniq;
		1374	if (aio_open $uniq, O_RDONLY, 0) {
		1375	$self->clear_unique_items;
		1376	$self->_load_objects ($uniq, 0);
		1377	}
		1378	}
		1379
		1380	Coro::cede;
		1381
		1382	# now do the right thing for maps
		1383	$self->link_multipart_objects;
		1384
		1385	unless ($self->{deny_activate}) {
		1386	$self->decay_objects;
		1387	$self->fix_auto_apply;
		1388	$self->update_buttons;
		1389	Coro::cede;
		1390	$self->set_darkness_map;
		1391	$self->difficulty ($self->estimate_difficulty)
		1392	unless $self->difficulty;
		1393	Coro::cede;
		1394	$self->activate;
		1395	}
		1396
		1397	$self->in_memory (cf::MAP_IN_MEMORY);
		1398	}
		1399
		1400	sub customise_for {
		1401	my ($self, $ob) = @_;
		1402
		1403	return find "~" . $ob->name . "/" . $self->{path}
		1404	if $self->per_player;
		1405
		1406	$self
		1407	}
		1408
		1409	# find and load all maps in the 3x3 area around a map
		1410	sub load_diag {
740	my ($map) = @_;	1411	my ($map) = @_;
741		1412
742	my $path = $map->tmpname;	1413	my @diag; # diagonal neighbours
743	defined $path or return;
744		1414
745	unlink "$path.pst";	1415	for (0 .. 3) {
		1416	my $neigh = $map->tile_path ($_)
		1417	or next;
		1418	$neigh = find $neigh, $map
		1419	or next;
		1420	$neigh->load;
		1421
		1422	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1423	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1424	}
		1425
		1426	for (@diag) {
		1427	my $neigh = find @$_
		1428	or next;
		1429	$neigh->load;
		1430	}
		1431	}
		1432
		1433	sub find_sync {
		1434	my ($path, $origin) = @_;
		1435
		1436	cf::sync_job { find $path, $origin }
		1437	}
		1438
		1439	sub do_load_sync {
		1440	my ($map) = @_;
		1441
		1442	cf::sync_job { $map->load };
		1443	}
		1444
		1445	our %MAP_PREFETCH;
		1446	our $MAP_PREFETCHER = Coro::async {
		1447	while () {
		1448	for my $path (keys %MAP_PREFETCH) {
		1449	my $map = find $path
		1450	or next;
		1451	$map->load;
		1452
		1453	delete $MAP_PREFETCH{$path};
		1454	}
		1455	Coro::schedule;
		1456	}
746	};	1457	};
747		1458
748	attach_to_maps prio => -10000, package => cf::mapsupport::;	1459	sub find_async {
		1460	my ($path, $origin) = @_;
749		1461
750	#############################################################################	1462	$path = normalise $path, $origin && $origin->{path};
751	# load/save perl data associated with player->ob objects
752		1463
753	sub all_objects(@) {	1464	if (my $map = $cf::MAP{$path}) {
754	@_, map all_objects ($_->inv), @_	1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
755	}
756
757	# TODO: compatibility cruft, remove when no longer needed
758	attach_to_players
759	on_load => sub {
760	my ($pl, $path) = @_;
761
762	for my $o (all_objects $pl->ob) {
763	if (my $value = $o->get_ob_key_value ("_perl_data")) {
764	$o->set_ob_key_value ("_perl_data");
765
766	%$o = %{ Storable::thaw pack "H*", $value };
767	}
768	}
769	},	1466	}
770	;
771		1467
772	#############################################################################	1468	$MAP_PREFETCH{$path} = 0;
		1469	$MAP_PREFETCHER->ready;
773		1470
774	=head2 CORE EXTENSIONS	1471	()
		1472	}
775		1473
776	Functions and methods that extend core crossfire objects.	1474	sub save {
		1475	my ($self) = @_;
		1476
		1477	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1478
		1479	$self->{last_save} = $cf::RUNTIME;
		1480
		1481	return unless $self->dirty;
		1482
		1483	my $save = $self->save_path; utf8::encode $save;
		1484	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1485
		1486	$self->{load_path} = $save;
		1487
		1488	return if $self->{deny_save};
		1489
		1490	local $self->{last_access} = $self->last_access;#d#
		1491
		1492	cf::async {
		1493	$_->contr->save for $self->players;
		1494	};
		1495
		1496	if ($uniq) {
		1497	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1498	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1499	} else {
		1500	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1501	}
		1502	}
		1503
		1504	sub swap_out {
		1505	my ($self) = @_;
		1506
		1507	# save first because save cedes
		1508	$self->save;
		1509
		1510	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1511
		1512	return if $self->players;
		1513	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1514	return if $self->{deny_save};
		1515
		1516	$self->clear;
		1517	$self->in_memory (cf::MAP_SWAPPED);
		1518	}
		1519
		1520	sub reset_at {
		1521	my ($self) = @_;
		1522
		1523	# TODO: safety, remove and allow resettable per-player maps
		1524	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1525	return 1e99 if $self->{deny_reset};
		1526
		1527	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1528	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1529
		1530	$time + $to
		1531	}
		1532
		1533	sub should_reset {
		1534	my ($self) = @_;
		1535
		1536	$self->reset_at <= $cf::RUNTIME
		1537	}
		1538
		1539	sub reset {
		1540	my ($self) = @_;
		1541
		1542	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1543
		1544	return if $self->players;
		1545	return if $self->isa ("ext::map_per_player");#d#
		1546
		1547	warn "resetting map ", $self->path;#d#
		1548
		1549	delete $cf::MAP{$self->path};
		1550
		1551	$self->in_memory (cf::MAP_SWAPPED);
		1552	$self->clear;
		1553
		1554	$_->clear_links_to ($self) for values %cf::MAP;
		1555
		1556	$self->unlink_save;
		1557	$self->destroy;
		1558	}
		1559
		1560	my $nuke_counter = "aaaa";
		1561
		1562	sub nuke {
		1563	my ($self) = @_;
		1564
		1565	delete $cf::MAP{$self->path};
		1566
		1567	$self->unlink_save;
		1568
		1569	bless $self, "cf::map";
		1570	delete $self->{deny_reset};
		1571	$self->{deny_save} = 1;
		1572	$self->reset_timeout (1);
		1573	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1574
		1575	$cf::MAP{$self->path} = $self;
		1576
		1577	$self->reset; # polite request, might not happen
		1578	}
		1579
		1580	=item cf::map::unique_maps
		1581
		1582	Returns an arrayref of paths of all shared maps that have
		1583	instantiated unique items. May block.
		1584
		1585	=cut
		1586
		1587	sub unique_maps() {
		1588	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1589	or return;
		1590
		1591	my @paths;
		1592
		1593	for (@$files) {
		1594	utf8::decode $_;
		1595	next if /\.pst$/;
		1596	next unless /^$PATH_SEP/o;
		1597
		1598	s/\.map$//;
		1599	push @paths, $_;
		1600	}
		1601
		1602	\@paths
		1603	}
		1604
		1605	package cf;
		1606
		1607	=back
		1608
		1609	=head3 cf::object
		1610
		1611	=cut
		1612
		1613	package cf::object;
777		1614
778	=over 4	1615	=over 4
779		1616
780	=item cf::player::exists $login	1617	=item $ob->inv_recursive
781		1618
782	Returns true when the given account exists.	1619	Returns the inventory of the object _and_ their inventories, recursively.
783		1620
784	=cut	1621	=cut
785		1622
786	sub cf::player::exists($) {	1623	sub inv_recursive_;
787	cf::player::find $_[0]	1624	sub inv_recursive_ {
788	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1625	map { $_, inv_recursive_ $_->inv } @_
789	}	1626	}
		1627
		1628	sub inv_recursive {
		1629	inv_recursive_ inv $_[0]
		1630	}
		1631
		1632	package cf;
		1633
		1634	=back
		1635
		1636	=head3 cf::object::player
		1637
		1638	=over 4
790		1639
791	=item $player_object->reply ($npc, $msg[, $flags])	1640	=item $player_object->reply ($npc, $msg[, $flags])
792		1641
793	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1642	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
794	can be C<undef>. Does the right thing when the player is currently in a	1643	can be C<undef>. Does the right thing when the player is currently in a
…		…
796		1645
797	=cut	1646	=cut
798		1647
799	# rough implementation of a future "reply" method that works	1648	# rough implementation of a future "reply" method that works
800	# with dialog boxes.	1649	# with dialog boxes.
		1650	#TODO: the first argument must go, split into a $npc->reply_to ( method
801	sub cf::object::player::reply($$$;$) {	1651	sub cf::object::player::reply($$$;$) {
802	my ($self, $npc, $msg, $flags) = @_;	1652	my ($self, $npc, $msg, $flags) = @_;
803		1653
804	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1654	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
805		1655
…		…
809	$msg = $npc->name . " says: $msg" if $npc;	1659	$msg = $npc->name . " says: $msg" if $npc;
810	$self->message ($msg, $flags);	1660	$self->message ($msg, $flags);
811	}	1661	}
812	}	1662	}
813		1663
814	=item $player->ext_reply ($msgid, $msgtype, %msg)
815
816	Sends an ext reply to the player.
817
818	=cut
819
820	sub cf::player::ext_reply($$$%) {
821	my ($self, $id, %msg) = @_;
822
823	$msg{msgid} = $id;
824
825	$self->send ("ext " . to_json \%msg);
826	}
827
828	=item $player_object->may ("access")	1664	=item $player_object->may ("access")
829		1665
830	Returns wether the given player is authorized to access resource "access"	1666	Returns wether the given player is authorized to access resource "access"
831	(e.g. "command_wizcast").	1667	(e.g. "command_wizcast").
832		1668
…		…
839	(ref $cf::CFG{"may_$access"}	1675	(ref $cf::CFG{"may_$access"}
840	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1676	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
841	: $cf::CFG{"may_$access"})	1677	: $cf::CFG{"may_$access"})
842	}	1678	}
843		1679
844	=cut	1680	=item $player_object->enter_link
845		1681
846	#############################################################################	1682	Freezes the player and moves him/her to a special map (C<{link}>).
		1683
		1684	The player should be reasonably safe there for short amounts of time. You
		1685	I<MUST> call C<leave_link> as soon as possible, though.
		1686
		1687	Will never block.
		1688
		1689	=item $player_object->leave_link ($map, $x, $y)
		1690
		1691	Moves the player out of the special C<{link}> map onto the specified
		1692	map. If the map is not valid (or omitted), the player will be moved back
		1693	to the location he/she was before the call to C<enter_link>, or, if that
		1694	fails, to the emergency map position.
		1695
		1696	Might block.
		1697
		1698	=cut
		1699
		1700	sub link_map {
		1701	unless ($LINK_MAP) {
		1702	$LINK_MAP = cf::map::find "{link}"
		1703	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
		1704	$LINK_MAP->load;
		1705	}
		1706
		1707	$LINK_MAP
		1708	}
		1709
		1710	sub cf::object::player::enter_link {
		1711	my ($self) = @_;
		1712
		1713	$self->deactivate_recursive;
		1714
		1715	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1716
		1717	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1718	if $self->map;
		1719
		1720	$self->enter_map ($LINK_MAP || link_map, 20, 20);
		1721	}
		1722
		1723	sub cf::object::player::leave_link {
		1724	my ($self, $map, $x, $y) = @_;
		1725
		1726	my $link_pos = delete $self->{_link_pos};
		1727
		1728	unless ($map) {
		1729	# restore original map position
		1730	($map, $x, $y) = @{ $link_pos || [] };
		1731	$map = cf::map::find $map;
		1732
		1733	unless ($map) {
		1734	($map, $x, $y) = @$EMERGENCY_POSITION;
		1735	$map = cf::map::find $map
		1736	or die "FATAL: cannot load emergency map\n";
		1737	}
		1738	}
		1739
		1740	($x, $y) = (-1, -1)
		1741	unless (defined $x) && (defined $y);
		1742
		1743	# use -1 or undef as default coordinates, not 0, 0
		1744	($x, $y) = ($map->enter_x, $map->enter_y)
		1745	if $x <=0 && $y <= 0;
		1746
		1747	$map->load;
		1748	$map->load_diag;
		1749
		1750	return unless $self->contr->active;
		1751	$self->activate_recursive;
		1752	$self->enter_map ($map, $x, $y);
		1753	}
		1754
		1755	cf::player->attach (
		1756	on_logout => sub {
		1757	my ($pl) = @_;
		1758
		1759	# abort map switching before logout
		1760	if ($pl->ob->{_link_pos}) {
		1761	cf::sync_job {
		1762	$pl->ob->leave_link
		1763	};
		1764	}
		1765	},
		1766	on_login => sub {
		1767	my ($pl) = @_;
		1768
		1769	# try to abort aborted map switching on player login :)
		1770	# should happen only on crashes
		1771	if ($pl->ob->{_link_pos}) {
		1772	$pl->ob->enter_link;
		1773	(async {
		1774	# we need this sleep as the login has a concurrent enter_exit running
		1775	# and this sleep increases chances of the player not ending up in scorn
		1776	$pl->ob->reply (undef,
		1777	"There was an internal problem at your last logout, "
		1778	. "the server will try to bring you to your intended destination in a second.",
		1779	cf::NDI_RED);
		1780	Coro::Timer::sleep 1;
		1781	$pl->ob->leave_link;
		1782	})->prio (2);
		1783	}
		1784	},
		1785	);
		1786
		1787	=item $player_object->goto ($path, $x, $y)
		1788
		1789	=cut
		1790
		1791	sub cf::object::player::goto {
		1792	my ($self, $path, $x, $y) = @_;
		1793
		1794	$self->enter_link;
		1795
		1796	(async {
		1797	my $map = cf::map::find $path;
		1798	$map = $map->customise_for ($self) if $map;
		1799
		1800	# warn "entering ", $map->path, " at ($x, $y)\n"
		1801	# if $map;
		1802
		1803	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1804
		1805	$self->leave_link ($map, $x, $y);
		1806	})->prio (1);
		1807	}
		1808
		1809	=item $player_object->enter_exit ($exit_object)
		1810
		1811	=cut
		1812
		1813	sub parse_random_map_params {
		1814	my ($spec) = @_;
		1815
		1816	my $rmp = { # defaults
		1817	xsize => -1,
		1818	ysize => -1,
		1819	};
		1820
		1821	for (split /\n/, $spec) {
		1822	my ($k, $v) = split /\s+/, $_, 2;
		1823
		1824	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1825	}
		1826
		1827	$rmp
		1828	}
		1829
		1830	sub prepare_random_map {
		1831	my ($exit) = @_;
		1832
		1833	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1834
		1835	# all this does is basically replace the /! path by
		1836	# a new random map path (?random/...) with a seed
		1837	# that depends on the exit object
		1838
		1839	my $rmp = parse_random_map_params $exit->msg;
		1840
		1841	if ($exit->map) {
		1842	$rmp->{region} = $exit->map->region_name;
		1843	$rmp->{origin_map} = $exit->map->path;
		1844	$rmp->{origin_x} = $exit->x;
		1845	$rmp->{origin_y} = $exit->y;
		1846	}
		1847
		1848	$rmp->{random_seed} ||= $exit->random_seed;
		1849
		1850	my $data = cf::to_json $rmp;
		1851	my $md5 = Digest::MD5::md5_hex $data;
		1852	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1853
		1854	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1855	aio_write $fh, 0, (length $data), $data, 0;
		1856	undef $fh;
		1857	aio_rename "$meta~", $meta;
		1858
		1859	$exit->slaying ("?random/$md5");
		1860	$exit->msg (undef);
		1861	}
		1862	}
		1863
		1864	sub cf::object::player::enter_exit {
		1865	my ($self, $exit) = @_;
		1866
		1867	return unless $self->type == cf::PLAYER;
		1868
		1869	$self->enter_link;
		1870
		1871	(async {
		1872	$self->deactivate_recursive; # just to be sure
		1873	unless (eval {
		1874	prepare_random_map $exit
		1875	if $exit->slaying eq "/!";
		1876
		1877	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
		1878	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1879
		1880	1;
		1881	}) {
		1882	$self->message ("Something went wrong deep within the crossfire server. "
		1883	. "I'll try to bring you back to the map you were before. "
		1884	. "Please report this to the dungeon master!",
		1885	cf::NDI_UNIQUE | cf::NDI_RED);
		1886
		1887	warn "ERROR in enter_exit: $@";
		1888	$self->leave_link;
		1889	}
		1890	})->prio (1);
		1891	}
		1892
		1893	=head3 cf::client
		1894
		1895	=over 4
		1896
		1897	=item $client->send_drawinfo ($text, $flags)
		1898
		1899	Sends a drawinfo packet to the client. Circumvents output buffering so
		1900	should not be used under normal circumstances.
		1901
		1902	=cut
		1903
		1904	sub cf::client::send_drawinfo {
		1905	my ($self, $text, $flags) = @_;
		1906
		1907	utf8::encode $text;
		1908	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1909	}
		1910
		1911
		1912	=item $success = $client->query ($flags, "text", \&cb)
		1913
		1914	Queues a query to the client, calling the given callback with
		1915	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1916	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1917
		1918	Queries can fail, so check the return code. Or don't, as queries will become
		1919	reliable at some point in the future.
		1920
		1921	=cut
		1922
		1923	sub cf::client::query {
		1924	my ($self, $flags, $text, $cb) = @_;
		1925
		1926	return unless $self->state == ST_PLAYING
		1927	|| $self->state == ST_SETUP
		1928	|| $self->state == ST_CUSTOM;
		1929
		1930	$self->state (ST_CUSTOM);
		1931
		1932	utf8::encode $text;
		1933	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1934
		1935	$self->send_packet ($self->{query_queue}[0][0])
		1936	if @{ $self->{query_queue} } == 1;
		1937	}
		1938
		1939	cf::client->attach (
		1940	on_reply => sub {
		1941	my ($ns, $msg) = @_;
		1942
		1943	# this weird shuffling is so that direct followup queries
		1944	# get handled first
		1945	my $queue = delete $ns->{query_queue}
		1946	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1947
		1948	(shift @$queue)->[1]->($msg);
		1949
		1950	push @{ $ns->{query_queue} }, @$queue;
		1951
		1952	if (@{ $ns->{query_queue} } == @$queue) {
		1953	if (@$queue) {
		1954	$ns->send_packet ($ns->{query_queue}[0][0]);
		1955	} else {
		1956	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1957	}
		1958	}
		1959	},
		1960	);
		1961
		1962	=item $client->async (\&cb)
		1963
		1964	Create a new coroutine, running the specified callback. The coroutine will
		1965	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1966	or loss of connection).
		1967
		1968	=cut
		1969
		1970	sub cf::client::async {
		1971	my ($self, $cb) = @_;
		1972
		1973	my $coro = &Coro::async ($cb);
		1974
		1975	$coro->on_destroy (sub {
		1976	delete $self->{_coro}{$coro+0};
		1977	});
		1978
		1979	$self->{_coro}{$coro+0} = $coro;
		1980
		1981	$coro
		1982	}
		1983
		1984	cf::client->attach (
		1985	on_destroy => sub {
		1986	my ($ns) = @_;
		1987
		1988	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1989	},
		1990	);
		1991
		1992	=back
		1993
847		1994
848	=head2 SAFE SCRIPTING	1995	=head2 SAFE SCRIPTING
849		1996
850	Functions that provide a safe environment to compile and execute	1997	Functions that provide a safe environment to compile and execute
851	snippets of perl code without them endangering the safety of the server	1998	snippets of perl code without them endangering the safety of the server
…		…
866		2013
867	=pod	2014	=pod
868		2015
869	The following fucntions and emthods are available within a safe environment:	2016	The following fucntions and emthods are available within a safe environment:
870		2017
871	cf::object contr pay_amount pay_player	2018	cf::object contr pay_amount pay_player map
872	cf::object::player player	2019	cf::object::player player
873	cf::player peaceful	2020	cf::player peaceful
		2021	cf::map trigger
874		2022
875	=cut	2023	=cut
876		2024
877	for (	2025	for (
878	["cf::object" => qw(contr pay_amount pay_player)],	2026	["cf::object" => qw(contr pay_amount pay_player map)],
879	["cf::object::player" => qw(player)],	2027	["cf::object::player" => qw(player)],
880	["cf::player" => qw(peaceful)],	2028	["cf::player" => qw(peaceful)],
		2029	["cf::map" => qw(trigger)],
881	) {	2030	) {
882	no strict 'refs';	2031	no strict 'refs';
883	my ($pkg, @funs) = @$_;	2032	my ($pkg, @funs) = @$_;
884	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2033	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
885	for @funs;	2034	for @funs;
…		…
1001		2150
1002	{	2151	{
1003	my $path = cf::localdir . "/database.pst";	2152	my $path = cf::localdir . "/database.pst";
1004		2153
1005	sub db_load() {	2154	sub db_load() {
1006	warn "loading database $path\n";#d# remove later
1007	$DB = stat $path ? Storable::retrieve $path : { };	2155	$DB = stat $path ? Storable::retrieve $path : { };
1008	}	2156	}
1009		2157
1010	my $pid;	2158	my $pid;
1011		2159
1012	sub db_save() {	2160	sub db_save() {
1013	warn "saving database $path\n";#d# remove later
1014	waitpid $pid, 0 if $pid;	2161	waitpid $pid, 0 if $pid;
1015	if (0 == ($pid = fork)) {	2162	if (0 == ($pid = fork)) {
1016	$DB->{_meta}{version} = 1;	2163	$DB->{_meta}{version} = 1;
1017	Storable::nstore $DB, "$path~";	2164	Storable::nstore $DB, "$path~";
1018	rename "$path~", $path;	2165	rename "$path~", $path;
…		…
1049	$DB->{$_[0]} = $_[1];	2196	$DB->{$_[0]} = $_[1];
1050	}	2197	}
1051	db_dirty;	2198	db_dirty;
1052	}	2199	}
1053		2200
1054	attach_global	2201	cf::global->attach (
1055	prio => 10000,	2202	prio => 10000,
1056	on_cleanup => sub {	2203	on_cleanup => sub {
1057	db_sync;	2204	db_sync;
1058	},	2205	},
1059	;	2206	);
1060	}	2207	}
1061		2208
1062	#############################################################################	2209	#############################################################################
1063	# the server's main()	2210	# the server's main()
1064		2211
…		…
1066	open my $fh, "<:utf8", cf::confdir . "/config"	2213	open my $fh, "<:utf8", cf::confdir . "/config"
1067	or return;	2214	or return;
1068		2215
1069	local $/;	2216	local $/;
1070	*CFG = YAML::Syck::Load <$fh>;	2217	*CFG = YAML::Syck::Load <$fh>;
		2218
		2219	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2220
		2221	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2222	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2223
		2224	if (exists $CFG{mlockall}) {
		2225	eval {
		2226	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2227	and die "WARNING: m(un)lockall failed: $!\n";
		2228	};
		2229	warn $@ if $@;
		2230	}
1071	}	2231	}
1072		2232
1073	sub main {	2233	sub main {
		2234	# we must not ever block the main coroutine
		2235	local $Coro::idle = sub {
		2236	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2237	(async {
		2238	Event::one_event;
		2239	})->prio (Coro::PRIO_MAX);
		2240	};
		2241
1074	cfg_load;	2242	cfg_load;
1075	db_load;	2243	db_load;
1076	load_extensions;	2244	load_extensions;
1077	Event::loop;	2245	Event::loop;
1078	}	2246	}
1079		2247
1080	#############################################################################	2248	#############################################################################
1081	# initialisation	2249	# initialisation and cleanup
1082		2250
		2251	# install some emergency cleanup handlers
		2252	BEGIN {
		2253	for my $signal (qw(INT HUP TERM)) {
		2254	Event->signal (
		2255	data => WF_AUTOCANCEL,
		2256	signal => $signal,
		2257	cb => sub {
		2258	cf::cleanup "SIG$signal";
		2259	},
		2260	);
		2261	}
		2262	}
		2263
		2264	sub emergency_save() {
		2265	my $freeze_guard = cf::freeze_mainloop;
		2266
		2267	warn "enter emergency perl save\n";
		2268
		2269	cf::sync_job {
		2270	# use a peculiar iteration method to avoid tripping on perl
		2271	# refcount bugs in for. also avoids problems with players
		2272	# and maps saved/destroyed asynchronously.
		2273	warn "begin emergency player save\n";
		2274	for my $login (keys %cf::PLAYER) {
		2275	my $pl = $cf::PLAYER{$login} or next;
		2276	$pl->valid or next;
		2277	$pl->save;
		2278	}
		2279	warn "end emergency player save\n";
		2280
		2281	warn "begin emergency map save\n";
		2282	for my $path (keys %cf::MAP) {
		2283	my $map = $cf::MAP{$path} or next;
		2284	$map->valid or next;
		2285	$map->save;
		2286	}
		2287	warn "end emergency map save\n";
		2288	};
		2289
		2290	warn "leave emergency perl save\n";
		2291	}
		2292
1083	sub _perl_reload(&) {	2293	sub reload() {
1084	my ($msg) = @_;	2294	# can/must only be called in main
		2295	if ($Coro::current != $Coro::main) {
		2296	warn "can only reload from main coroutine\n";
		2297	return;
		2298	}
1085		2299
1086	$msg->("reloading...");	2300	warn "reloading...";
		2301
		2302	warn "freezing server";
		2303	my $guard = freeze_mainloop;
		2304	cf::emergency_save;
		2305
		2306	warn "sync database to disk";
		2307	cf::db_sync;
		2308	IO::AIO::flush;
1087		2309
1088	eval {	2310	eval {
		2311	# if anything goes wrong in here, we should simply crash as we already saved
		2312
1089	# cancel all watchers	2313	warn "cancel all watchers";
1090	for (Event::all_watchers) {	2314	for (Event::all_watchers) {
1091	$_->cancel if $_->data & WF_AUTOCANCEL;	2315	$_->cancel if $_->data & WF_AUTOCANCEL;
1092	}	2316	}
1093		2317
		2318	warn "cancel all extension coros";
		2319	$_->cancel for values %EXT_CORO;
		2320	%EXT_CORO = ();
		2321
		2322	warn "remove commands";
		2323	%COMMAND = ();
		2324
		2325	warn "remove ext commands";
		2326	%EXTCMD = ();
		2327
1094	# unload all extensions	2328	warn "unload/nuke all extensions";
1095	for (@exts) {	2329	for my $pkg (@EXTS) {
1096	$msg->("unloading <$_>");	2330	warn "... unloading $pkg";
1097	unload_extension $_;	2331
		2332	if (my $cb = $pkg->can ("unload")) {
		2333	eval {
		2334	$cb->($pkg);
		2335	1
		2336	} or warn "$pkg unloaded, but with errors: $@";
1098	}	2337	}
1099		2338
		2339	warn "... nuking $pkg";
		2340	Symbol::delete_package $pkg;
		2341	}
		2342
1100	# unload all modules loaded from $LIBDIR	2343	warn "unload all perl modules loaded from $LIBDIR";
1101	while (my ($k, $v) = each %INC) {	2344	while (my ($k, $v) = each %INC) {
1102	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2345	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1103		2346
1104	$msg->("removing <$k>");	2347	warn "removing <$k>";
1105	delete $INC{$k};	2348	delete $INC{$k};
1106		2349
1107	$k =~ s/\.pm$//;	2350	$k =~ s/\.pm$//;
1108	$k =~ s/\//::/g;	2351	$k =~ s/\//::/g;
1109		2352
…		…
1112	}	2355	}
1113		2356
1114	Symbol::delete_package $k;	2357	Symbol::delete_package $k;
1115	}	2358	}
1116		2359
1117	# sync database to disk
1118	cf::db_sync;
1119
1120	# get rid of safe::, as good as possible	2360	warn "get rid of safe::, as good as possible";
1121	Symbol::delete_package "safe::$_"	2361	Symbol::delete_package "safe::$_"
1122	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2362	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1123		2363
1124	# remove register_script_function callbacks
1125	# TODO
1126
1127	# unload cf.pm "a bit"	2364	warn "unload cf.pm \"a bit\"";
1128	delete $INC{"cf.pm"};	2365	delete $INC{"cf.pm"};
1129		2366
1130	# don't, removes xs symbols, too,	2367	# don't, removes xs symbols, too,
1131	# and global variables created in xs	2368	# and global variables created in xs
1132	#Symbol::delete_package __PACKAGE__;	2369	#Symbol::delete_package __PACKAGE__;
1133		2370
1134	# reload cf.pm
1135	$msg->("reloading cf.pm");	2371	warn "reloading cf.pm";
1136	require cf;	2372	require cf;
		2373	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1137		2374
1138	# load config and database again	2375	warn "load config and database again";
1139	cf::cfg_load;	2376	cf::cfg_load;
1140	cf::db_load;	2377	cf::db_load;
1141		2378
1142	# load extensions	2379	warn "load extensions";
1143	$msg->("load extensions");
1144	cf::load_extensions;	2380	cf::load_extensions;
1145		2381
1146	# reattach attachments to objects	2382	warn "reattach attachments to objects/players";
1147	$msg->("reattach");
1148	_global_reattach;	2383	_global_reattach;
		2384	warn "reattach attachments to maps";
		2385	reattach $_ for values %MAP;
1149	};	2386	};
1150	$msg->($@) if $@;
1151		2387
1152	$msg->("reloaded");	2388	if ($@) {
		2389	warn $@;
		2390	warn "error while reloading, exiting.";
		2391	exit 1;
		2392	}
		2393
		2394	warn "reloaded";
1153	};	2395	};
1154		2396
1155	sub perl_reload() {	2397	our $RELOAD_WATCHER; # used only during reload
1156	_perl_reload {
1157	warn $_[0];
1158	print "$_[0]\n";
1159	};
1160	}
1161		2398
1162	register "<global>", __PACKAGE__;
1163
1164	register_command "perl-reload" => sub {	2399	register_command "reload" => sub {
1165	my ($who, $arg) = @_;	2400	my ($who, $arg) = @_;
1166		2401
1167	if ($who->flag (FLAG_WIZ)) {	2402	if ($who->flag (FLAG_WIZ)) {
1168	_perl_reload {	2403	$who->message ("reloading server.");
1169	warn $_[0];	2404
1170	$who->message ($_[0]);	2405	# doing reload synchronously and two reloads happen back-to-back,
		2406	# coro crashes during coro_state_free->destroy here.
		2407
		2408	$RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
		2409	reload;
		2410	undef $RELOAD_WATCHER;
1171	};	2411	});
1172	}	2412	}
1173	};	2413	};
1174		2414
1175	unshift @INC, $LIBDIR;	2415	unshift @INC, $LIBDIR;
1176		2416
1177	$TICK_WATCHER = Event->timer (	2417	$TICK_WATCHER = Event->timer (
		2418	reentrant => 0,
1178	prio => 1,	2419	prio => 0,
1179	async => 1,
1180	at => $NEXT_TICK || 1,	2420	at => $NEXT_TICK || $TICK,
1181	data => WF_AUTOCANCEL,	2421	data => WF_AUTOCANCEL,
1182	cb => sub {	2422	cb => sub {
		2423	$NOW = Event::time;
		2424
1183	cf::server_tick; # one server iteration	2425	cf::server_tick; # one server iteration
1184		2426	$RUNTIME += $TICK;
1185	my $NOW = Event::time;
1186	$NEXT_TICK += $TICK;	2427	$NEXT_TICK += $TICK;
1187		2428
		2429	$WAIT_FOR_TICK->broadcast;
		2430	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2431
1188	# if we are delayed by four ticks or more, skip them all	2432	# if we are delayed by four ticks or more, skip them all
1189	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2433	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1190		2434
1191	$TICK_WATCHER->at ($NEXT_TICK);	2435	$TICK_WATCHER->at ($NEXT_TICK);
1192	$TICK_WATCHER->start;	2436	$TICK_WATCHER->start;
1193	},	2437	},
1194	);	2438	);
1195		2439
1196	IO::AIO::max_poll_time $TICK * 0.2;	2440	IO::AIO::max_poll_time $TICK * 0.2;
1197		2441
		2442	$AIO_POLL_WATCHER = Event->io (
1198	Event->io (fd => IO::AIO::poll_fileno,	2443	fd => IO::AIO::poll_fileno,
1199	poll => 'r',	2444	poll => 'r',
1200	prio => 5,	2445	prio => 5,
1201	data => WF_AUTOCANCEL,	2446	data => WF_AUTOCANCEL,
1202	cb => \&IO::AIO::poll_cb);	2447	cb => \&IO::AIO::poll_cb,
		2448	);
		2449
		2450	$WRITE_RUNTIME_WATCHER = Event->timer (
		2451	data => WF_AUTOCANCEL,
		2452	after => 0,
		2453	interval => 10,
		2454	cb => sub {
		2455	(Coro::unblock_sub {
		2456	write_runtime
		2457	or warn "ERROR: unable to write runtime file: $!";
		2458	})->();
		2459	},
		2460	);
		2461
		2462	END { cf::emergency_save }
1203		2463
1204	1	2464	1
1205		2465

Diff Legend

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