ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC

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

Diff Legend

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