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.85 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.172 by root, Sun Jan 14 13:32:48 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(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	153	for my $pkg (qw(
		154	cf::global cf::attachable
		155	cf::object cf::object::player
		156	cf::client cf::player
		157	cf::arch cf::living
		158	cf::map cf::party cf::region
		159	)) {
82	no strict 'refs';	160	no strict 'refs';
83	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	161	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	162	}
85		163
86	$Event::DIED = sub {	164	$Event::DIED = sub {
87	warn "error in event callback: @_";	165	warn "error in event callback: @_";
88	};	166	};
89		167
90	my %ext_pkg;
91	my @exts;
92	my @hook;
93
94	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
95		169
96	=over 4	170	=over 4
97		171
		172	=item dumpval $ref
		173
98	=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	}
99		194
100	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
101		196
102	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
103		198
…		…
119	sub to_json($) {	214	sub to_json($) {
120	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
121	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
122	}	217	}
123		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
124	=back	370	=back
125		371
126	=cut	372	=cut
127		373
128	#############################################################################	374	#############################################################################
129		375
130	=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+).
131		385
132	=over 4	386	=over 4
133		387
134	=item $object->attach ($attachment, key => $value...)
135
136	=item $object->detach ($attachment)
137
138	Attach/detach a pre-registered attachment to an object.
139
140	=item $player->attach ($attachment, key => $value...)
141
142	=item $player->detach ($attachment)
143
144	Attach/detach a pre-registered attachment to a player.
145
146	=item $map->attach ($attachment, key => $value...)	388	=item $attachable->attach ($attachment, key => $value...)
147		389
148	=item $map->detach ($attachment)	390	=item $attachable->detach ($attachment)
149		391
150	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.
151		394
152	=item $bool = $object->attached ($name)	395	Example, attach a minesweeper attachment to the given object, making it a
		396	10x10 minesweeper game:
153		397
154	=item $bool = $player->attached ($name)	398	$obj->attach (minesweeper => width => 10, height => 10);
155		399
156	=item $bool = $map->attached ($name)	400	=item $bool = $attachable->attached ($name)
157		401
158	Checks wether the named attachment is currently attached to the object.	402	Checks wether the named attachment is currently attached to the object.
159		403
160	=item cf::attach_global ...	404	=item cf::CLASS->attach ...
161		405
162	Attach handlers for global events.	406	=item cf::CLASS->detach ...
163		407
164	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
165	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:
166		442
167	=over 4	443	=over 4
168		444
169	=item prio => $number	445	=item prio => $number
170		446
…		…
172	by another C<prio> setting). Lower priority handlers get executed	448	by another C<prio> setting). Lower priority handlers get executed
173	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
174	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
175	unless you know what you are doing.	451	unless you know what you are doing.
176		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
177	=item on_I<event> => \&cb	459	=item on_I<event> => \&cb
178		460
179	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
180	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
181	handlers are recognised generally depends on the type of object these	463	handlers are recognised generally depends on the type of object these
…		…
190	package and register them. Only handlers for eevents supported by the	472	package and register them. Only handlers for eevents supported by the
191	object/class are recognised.	473	object/class are recognised.
192		474
193	=back	475	=back
194		476
195	=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:
196		479
197	Attach handlers for a specific object type (e.g. TRANSPORT) and	480	cf::object::attachment sockpuppet =>
198	subtype. If C<$subtype> is zero or undef, matches all objects of the given	481	on_skill_attack => sub {
199	type.	482	my ($self, $victim) = @_;
200		483	...
201	=item cf::attach_to_objects ...
202
203	Attach handlers to all objects. Do not use this except for debugging or
204	very rare events, as handlers are (obviously) called for I<all> objects in
205	the game.
206
207	=item cf::attach_to_players ...
208
209	Attach handlers to all players.
210
211	=item cf::attach_to_maps ...
212
213	Attach handlers to all maps.
214
215	=item cf:register_attachment $name, ...
216
217	Register an attachment by name through which objects can refer to this
218	attachment.
219
220	=item cf:register_player_attachment $name, ...
221
222	Register an attachment by name through which players can refer to this
223	attachment.
224
225	=item cf:register_map_attachment $name, ...
226
227	Register an attachment by name through which maps can refer to this
228	attachment.
229
230	=cut
231
232	# the following variables are defined in .xs and must not be re-created
233	our @CB_GLOBAL = (); # registry for all global events
234	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
235	our @CB_PLAYER = ();
236	our @CB_TYPE = (); # registry for type (cf-object class) based events
237	our @CB_MAP = ();
238
239	my %attachment;
240
241	sub _attach_cb($\%$$$) {
242	my ($registry, $undo, $event, $prio, $cb) = @_;
243
244	use sort 'stable';
245
246	$cb = [$prio, $cb];
247
248	@{$registry->[$event]} = sort
249	{ $a->[0] cmp $b->[0] }
250	@{$registry->[$event] || []}, $cb;
251
252	push @{$undo->{cb}}, [$event, $cb];
253	}
254
255	# attach handles attaching event callbacks
256	# the only thing the caller has to do is pass the correct
257	# registry (== where the callback attaches to).
258	sub _attach(\@$@) {
259	my ($registry, $klass, @arg) = @_;
260
261	my $prio = 0;
262
263	my %undo = (
264	registry => $registry,
265	cb => [],
266	);
267
268	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
269
270	while (@arg) {
271	my $type = shift @arg;
272
273	if ($type eq "prio") {
274	$prio = shift @arg;
275
276	} elsif ($type eq "package") {
277	my $pkg = shift @arg;
278
279	while (my ($name, $id) = each %cb_id) {
280	if (my $cb = $pkg->can ($name)) {
281	_attach_cb $registry, %undo, $id, $prio, $cb;
282	}
283	}	484	}
284
285	} elsif (exists $cb_id{$type}) {
286	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
287
288	} elsif (ref $type) {
289	warn "attaching objects not supported, ignoring.\n";
290
291	} else {
292	shift @arg;
293	warn "attach argument '$type' not supported, ignoring.\n";
294	}
295	}
296
297	\%undo
298	}
299
300	sub _attach_attachment {
301	my ($obj, $name, %arg) = @_;
302
303	return if exists $obj->{_attachment}{$name};
304
305	my $res;
306
307	if (my $attach = $attachment{$name}) {
308	my $registry = $obj->registry;
309
310	for (@$attach) {
311	my ($klass, @attach) = @$_;
312	$res = _attach @$registry, $klass, @attach;
313	}
314
315	$obj->{$name} = \%arg;
316	} else {
317	warn "object uses attachment '$name' that is not available, postponing.\n";
318	}
319
320	$obj->{_attachment}{$name} = undef;
321
322	$res->{attachment} = $name;
323	$res
324	}
325
326	*cf::object::attach =
327	*cf::player::attach =
328	*cf::map::attach = sub {
329	my ($obj, $name, %arg) = @_;
330
331	_attach_attachment $obj, $name, %arg;
332	};
333
334	# all those should be optimised
335	*cf::object::detach =
336	*cf::player::detach =
337	*cf::map::detach = sub {
338	my ($obj, $name) = @_;
339
340	delete $obj->{_attachment}{$name};
341	reattach ($obj);
342	};
343
344	*cf::object::attached =
345	*cf::player::attached =
346	*cf::map::attached = sub {
347	my ($obj, $name) = @_;
348
349	exists $obj->{_attachment}{$name}
350	};
351
352	sub attach_global {
353	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
354	}
355
356	sub attach_to_type {
357	my $type = shift;
358	my $subtype = shift;
359
360	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
361	}
362
363	sub attach_to_objects {
364	_attach @CB_OBJECT, KLASS_OBJECT, @_
365	}
366
367	sub attach_to_players {
368	_attach @CB_PLAYER, KLASS_PLAYER, @_
369	}
370
371	sub attach_to_maps {
372	_attach @CB_MAP, KLASS_MAP, @_
373	}
374
375	sub register_attachment {
376	my $name = shift;
377
378	$attachment{$name} = [[KLASS_OBJECT, @_]];
379	}
380
381	sub register_player_attachment {
382	my $name = shift;
383
384	$attachment{$name} = [[KLASS_PLAYER, @_]];
385	}
386
387	sub register_map_attachment {
388	my $name = shift;
389
390	$attachment{$name} = [[KLASS_MAP, @_]];
391	}
392
393	our $override;
394	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
395
396	sub override {
397	$override = 1;
398	@invoke_results = ();
399	}
400
401	sub do_invoke {
402	my $event = shift;
403	my $callbacks = shift;
404
405	@invoke_results = ();
406
407	local $override;
408
409	for (@$callbacks) {
410	eval { &{$_->[1]} };
411
412	if ($@) {
413	warn "$@";
414	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
415	override;
416	}
417
418	return 1 if $override;
419	}
420
421	0	485	}
422	}
423		486
424	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	487	=item $attachable->valid
425
426	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
427
428	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
429
430	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
431
432	Generate a global/object/player/map-specific event with the given arguments.
433
434	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
435	removed in future versions), and there is no public API to access override
436	results (if you must, access C<@cf::invoke_results> directly).
437
438	=back
439
440	=cut
441
442	#############################################################################
443
444	=head2 METHODS VALID FOR ALL CORE OBJECTS
445
446	=over 4
447
448	=item $object->valid, $player->valid, $map->valid
449		488
450	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
451	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
452	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
453	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
454	exception.	493	exception.
455		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
456	=back	684	=back
457		685
458	=cut	686	=cut
459
460	*cf::object::valid =
461	*cf::player::valid =
462	*cf::map::valid = \&cf::_valid;
463		687
464	#############################################################################	688	#############################################################################
465	# object support	689	# object support
466		690
467	sub instantiate {
468	my ($obj, $data) = @_;
469
470	$data = from_json $data;
471
472	for (@$data) {
473	my ($name, $args) = @$_;
474
475	$obj->attach ($name, %{$args || {} });
476	}
477	}
478
479	# basically do the same as instantiate, without calling instantiate
480	sub reattach {	691	sub reattach {
		692	# basically do the same as instantiate, without calling instantiate
481	my ($obj) = @_;	693	my ($obj) = @_;
		694
		695	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		696
482	my $registry = $obj->registry;	697	my $registry = $obj->registry;
483		698
484	@$registry = ();	699	@$registry = ();
485		700
486	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	701	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
487		702
488	for my $name (keys %{ $obj->{_attachment} || {} }) {	703	for my $name (keys %{ $obj->{_attachment} || {} }) {
489	if (my $attach = $attachment{$name}) {	704	if (my $attach = $attachment{$name}) {
490	for (@$attach) {	705	for (@$attach) {
491	my ($klass, @attach) = @$_;	706	my ($klass, @attach) = @$_;
492	_attach @$registry, $klass, @attach;	707	_attach $registry, $klass, @attach;
493	}	708	}
494	} else {	709	} else {
495	warn "object uses attachment '$name' that is not available, postponing.\n";	710	warn "object uses attachment '$name' that is not available, postponing.\n";
496	}	711	}
497	}	712	}
498	}	713	}
499		714
500	sub object_freezer_save {	715	cf::attachable->attach (
501	my ($filename, $rdata, $objs) = @_;
502
503	if (length $$rdata) {
504	warn sprintf "saving %s (%d,%d)\n",
505	$filename, length $$rdata, scalar @$objs;
506
507	if (open my $fh, ">:raw", "$filename~") {
508	chmod SAVE_MODE, $fh;
509	syswrite $fh, $$rdata;
510	close $fh;
511
512	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
513	chmod SAVE_MODE, $fh;
514	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
515	close $fh;
516	rename "$filename.pst~", "$filename.pst";
517	} else {
518	unlink "$filename.pst";
519	}
520
521	rename "$filename~", $filename;
522	} else {
523	warn "FATAL: $filename~: $!\n";
524	}
525	} else {
526	unlink $filename;
527	unlink "$filename.pst";
528	}
529	}
530
531	sub object_freezer_as_string {
532	my ($rdata, $objs) = @_;
533
534	use Data::Dumper;
535
536	$$rdata . Dumper $objs
537	}
538
539	sub object_thawer_load {
540	my ($filename) = @_;
541
542	local $/;
543
544	my $av;
545
546	#TODO: use sysread etc.
547	if (open my $data, "<:raw:perlio", $filename) {
548	$data = <$data>;
549	if (open my $pst, "<:raw:perlio", "$filename.pst") {
550	$av = eval { (Storable::thaw <$pst>)->{objs} };
551	}
552	return ($data, $av);
553	}
554
555	()
556	}
557
558	attach_to_objects
559	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,
560	on_clone => sub {	729	on_clone => sub {
561	my ($src, $dst) = @_;	730	my ($src, $dst) = @_;
562		731
563	@{$dst->registry} = @{$src->registry};	732	@{$dst->registry} = @{$src->registry};
564		733
565	%$dst = %$src;	734	%$dst = %$src;
566		735
567	%{$dst->{_attachment}} = %{$src->{_attachment}}	736	%{$dst->{_attachment}} = %{$src->{_attachment}}
568	if exists $src->{_attachment};	737	if exists $src->{_attachment};
569	},	738	},
570	;	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	}
571		805
572	#############################################################################	806	#############################################################################
573	# command handling &c	807	# command handling &c
574		808
575	=item cf::register_command $name => \&callback($ob,$args);	809	=item cf::register_command $name => \&callback($ob,$args);
…		…
598	=cut	832	=cut
599		833
600	sub register_extcmd {	834	sub register_extcmd {
601	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
602		836
603	my $caller = caller;
604	#warn "registering extcmd '$name' to '$caller'";
605
606	$EXTCMD{$name} = [$cb, $caller];	837	$EXTCMD{$name} = $cb;
607	}	838	}
608		839
609	attach_to_players	840	cf::player->attach (
610	on_command => sub {	841	on_command => sub {
611	my ($pl, $name, $params) = @_;	842	my ($pl, $name, $params) = @_;
612		843
613	my $cb = $COMMAND{$name}	844	my $cb = $COMMAND{$name}
614	or return;	845	or return;
…		…
624		855
625	my $msg = eval { from_json $buf };	856	my $msg = eval { from_json $buf };
626		857
627	if (ref $msg) {	858	if (ref $msg) {
628	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	859	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
629	if (my %reply = $cb->[0]->($pl, $msg)) {	860	if (my %reply = $cb->($pl, $msg)) {
630	$pl->ext_reply ($msg->{msgid}, %reply);	861	$pl->ext_reply ($msg->{msgid}, %reply);
631	}	862	}
632	}	863	}
633	} else {	864	} else {
634	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	865	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
635	}	866	}
636		867
637	cf::override;	868	cf::override;
638	},	869	},
639	;	870	);
640
641	sub register {
642	my ($base, $pkg) = @_;
643
644	#TODO
645	}
646		871
647	sub load_extension {	872	sub load_extension {
648	my ($path) = @_;	873	my ($path) = @_;
649		874
650	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	875	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
651	my $base = $1;	876	my $base = $1;
652	my $pkg = $1;	877	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	878	$pkg =~ s/[^[:word:]]/_/g;
654	$pkg = "ext::$pkg";	879	$pkg = "ext::$pkg";
655		880
656	warn "loading '$path' into '$pkg'\n";	881	warn "... loading '$path' into '$pkg'\n";
657		882
658	open my $fh, "<:utf8", $path	883	open my $fh, "<:utf8", $path
659	or die "$path: $!";	884	or die "$path: $!";
660		885
661	my $source =	886	my $source =
662	"package $pkg; use strict; use utf8;\n"	887	"package $pkg; use strict; use utf8;\n"
663	. "#line 1 \"$path\"\n{\n"	888	. "#line 1 \"$path\"\n{\n"
664	. (do { local $/; <$fh> })	889	. (do { local $/; <$fh> })
665	. "\n};\n1";	890	. "\n};\n1";
666		891
667	eval $source	892	unless (eval $source) {
668	or die $@ ? "$path: $@\n"	893	my $msg = $@ ? "$path: $@\n"
669	: "extension disabled.\n";	894	: "extension disabled.\n";
670		895	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
671	push @exts, $pkg;	896	warn $@;
672	$ext_pkg{$base} = $pkg;	897	warn "mandatory extension failed to load, exiting.\n";
673		898	exit 1;
674	# no strict 'refs';	899	}
675	# @{"$pkg\::ISA"} = ext::;	900	die $@;
676
677	register $base, $pkg;
678	}
679
680	sub unload_extension {
681	my ($pkg) = @_;
682
683	warn "removing extension $pkg\n";
684
685	# remove hooks
686	#TODO
687	# for my $idx (0 .. $#PLUGIN_EVENT) {
688	# delete $hook[$idx]{$pkg};
689	# }	901	}
690		902
691	# remove commands	903	push @EXTS, $pkg;
692	for my $name (keys %COMMAND) {
693	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
694
695	if (@cb) {
696	$COMMAND{$name} = \@cb;
697	} else {
698	delete $COMMAND{$name};
699	}
700	}
701
702	# remove extcmds
703	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
704	delete $EXTCMD{$name};
705	}
706
707	if (my $cb = $pkg->can ("unload")) {
708	eval {
709	$cb->($pkg);
710	1
711	} or warn "$pkg unloaded, but with errors: $@";
712	}
713
714	Symbol::delete_package $pkg;
715	}	904	}
716		905
717	sub load_extensions {	906	sub load_extensions {
718	my $LIBDIR = maps_directory "perl";
719
720	for my $ext (<$LIBDIR/*.ext>) {	907	for my $ext (<$LIBDIR/*.ext>) {
721	next unless -r $ext;	908	next unless -r $ext;
722	eval {	909	eval {
723	load_extension $ext;	910	load_extension $ext;
724	1	911	1
725	} or warn "$ext not loaded: $@";	912	} or warn "$ext not loaded: $@";
726	}	913	}
727	}	914	}
728		915
729	#############################################################################	916	#############################################################################
730	# load/save/clean perl data associated with a map
731		917
732	*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 $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
		1120	our $MAX_RESET = 3600;
		1121	our $DEFAULT_RESET = 3000;
		1122
		1123	sub generate_random_map {
		1124	my ($self, $rmp) = @_;
		1125
		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 {
733	my ($map) = @_;	1411	my ($map) = @_;
734		1412
735	my $path = $map->tmpname;	1413	my @diag; # diagonal neighbours
736	defined $path or return;
737		1414
738	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	}
739	};	1457	};
740		1458
741	attach_to_maps prio => -10000, package => cf::mapsupport::;	1459	sub find_async {
		1460	my ($path, $origin) = @_;
742		1461
743	#############################################################################	1462	$path = normalise $path, $origin && $origin->{path};
744	# load/save perl data associated with player->ob objects
745		1463
746	sub all_objects(@) {	1464	if (my $map = $cf::MAP{$path}) {
747	@_, map all_objects ($_->inv), @_	1465	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
748	}
749
750	# TODO: compatibility cruft, remove when no longer needed
751	attach_to_players
752	on_load => sub {
753	my ($pl, $path) = @_;
754
755	for my $o (all_objects $pl->ob) {
756	if (my $value = $o->get_ob_key_value ("_perl_data")) {
757	$o->set_ob_key_value ("_perl_data");
758
759	%$o = %{ Storable::thaw pack "H*", $value };
760	}
761	}
762	},	1466	}
763	;
764		1467
765	#############################################################################	1468	$MAP_PREFETCH{$path} = 0;
		1469	$MAP_PREFETCHER->ready;
766		1470
767	=head2 CORE EXTENSIONS	1471	()
		1472	}
768		1473
769	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 rename {
		1540	my ($self, $new_path) = @_;
		1541
		1542	normalise $new_path;
		1543
		1544	$self->unlink_save;
		1545
		1546	delete $cf::MAP{$self->path};
		1547	$self->{path} = $new_path; $self->path ($self->{path});
		1548	$cf::MAP{$self->path} = $self;
		1549
		1550	$self->save;
		1551	}
		1552
		1553	sub reset {
		1554	my ($self) = @_;
		1555
		1556	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1557
		1558	return if $self->players;
		1559	return if $self->isa ("ext::map_per_player");#d#
		1560
		1561	warn "resetting map ", $self->path;#d#
		1562
		1563	delete $cf::MAP{$self->path};
		1564
		1565	$self->in_memory (cf::MAP_SWAPPED);
		1566	$self->clear;
		1567
		1568	$_->clear_links_to ($self) for values %cf::MAP;
		1569
		1570	$self->unlink_save;
		1571	$self->destroy;
		1572	}
		1573
		1574	my $nuke_counter = "aaaa";
		1575
		1576	sub nuke {
		1577	my ($self) = @_;
		1578
		1579	$self->{deny_save} = 1;
		1580	$self->reset_timeout (1);
		1581	$self->rename ("{nuke}/" . ($nuke_counter++));
		1582	$self->reset; # polite request, might not happen
		1583	}
		1584
		1585	=item cf::map::unique_maps
		1586
		1587	Returns an arrayref of paths of all shared maps that have
		1588	instantiated unique items. May block.
		1589
		1590	=cut
		1591
		1592	sub unique_maps() {
		1593	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1594	or return;
		1595
		1596	my @paths;
		1597
		1598	for (@$files) {
		1599	utf8::decode $_;
		1600	next if /\.pst$/;
		1601	next unless /^$PATH_SEP/o;
		1602
		1603	s/\.map$//;
		1604	push @paths, $_;
		1605	}
		1606
		1607	\@paths
		1608	}
		1609
		1610	package cf;
		1611
		1612	=back
		1613
		1614	=head3 cf::object
		1615
		1616	=cut
		1617
		1618	package cf::object;
770		1619
771	=over 4	1620	=over 4
772		1621
773	=item cf::player::exists $login	1622	=item $ob->inv_recursive
774		1623
775	Returns true when the given account exists.	1624	Returns the inventory of the object _and_ their inventories, recursively.
776		1625
777	=cut	1626	=cut
778		1627
779	sub cf::player::exists($) {	1628	sub inv_recursive_;
780	cf::player::find $_[0]	1629	sub inv_recursive_ {
781	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1630	map { $_, inv_recursive_ $_->inv } @_
782	}	1631	}
		1632
		1633	sub inv_recursive {
		1634	inv_recursive_ inv $_[0]
		1635	}
		1636
		1637	package cf;
		1638
		1639	=back
		1640
		1641	=head3 cf::object::player
		1642
		1643	=over 4
783		1644
784	=item $player_object->reply ($npc, $msg[, $flags])	1645	=item $player_object->reply ($npc, $msg[, $flags])
785		1646
786	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1647	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
787	can be C<undef>. Does the right thing when the player is currently in a	1648	can be C<undef>. Does the right thing when the player is currently in a
…		…
789		1650
790	=cut	1651	=cut
791		1652
792	# rough implementation of a future "reply" method that works	1653	# rough implementation of a future "reply" method that works
793	# with dialog boxes.	1654	# with dialog boxes.
		1655	#TODO: the first argument must go, split into a $npc->reply_to ( method
794	sub cf::object::player::reply($$$;$) {	1656	sub cf::object::player::reply($$$;$) {
795	my ($self, $npc, $msg, $flags) = @_;	1657	my ($self, $npc, $msg, $flags) = @_;
796		1658
797	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1659	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
798		1660
…		…
802	$msg = $npc->name . " says: $msg" if $npc;	1664	$msg = $npc->name . " says: $msg" if $npc;
803	$self->message ($msg, $flags);	1665	$self->message ($msg, $flags);
804	}	1666	}
805	}	1667	}
806		1668
807	=item $player->ext_reply ($msgid, $msgtype, %msg)
808
809	Sends an ext reply to the player.
810
811	=cut
812
813	sub cf::player::ext_reply($$$%) {
814	my ($self, $id, %msg) = @_;
815
816	$msg{msgid} = $id;
817
818	$self->send ("ext " . to_json \%msg);
819	}
820
821	=item $player_object->may ("access")	1669	=item $player_object->may ("access")
822		1670
823	Returns wether the given player is authorized to access resource "access"	1671	Returns wether the given player is authorized to access resource "access"
824	(e.g. "command_wizcast").	1672	(e.g. "command_wizcast").
825		1673
…		…
832	(ref $cf::CFG{"may_$access"}	1680	(ref $cf::CFG{"may_$access"}
833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1681	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
834	: $cf::CFG{"may_$access"})	1682	: $cf::CFG{"may_$access"})
835	}	1683	}
836		1684
837	=cut	1685	=item $player_object->enter_link
838		1686
839	#############################################################################	1687	Freezes the player and moves him/her to a special map (C<{link}>).
		1688
		1689	The player should be reasonably safe there for short amounts of time. You
		1690	I<MUST> call C<leave_link> as soon as possible, though.
		1691
		1692	Will never block.
		1693
		1694	=item $player_object->leave_link ($map, $x, $y)
		1695
		1696	Moves the player out of the special C<{link}> map onto the specified
		1697	map. If the map is not valid (or omitted), the player will be moved back
		1698	to the location he/she was before the call to C<enter_link>, or, if that
		1699	fails, to the emergency map position.
		1700
		1701	Might block.
		1702
		1703	=cut
		1704
		1705	sub link_map {
		1706	unless ($LINK_MAP) {
		1707	$LINK_MAP = cf::map::find "{link}"
		1708	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
		1709	$LINK_MAP->load;
		1710	}
		1711
		1712	$LINK_MAP
		1713	}
		1714
		1715	sub cf::object::player::enter_link {
		1716	my ($self) = @_;
		1717
		1718	$self->deactivate_recursive;
		1719
		1720	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1721
		1722	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1723	if $self->map;
		1724
		1725	$self->enter_map ($LINK_MAP || link_map, 20, 20);
		1726	}
		1727
		1728	sub cf::object::player::leave_link {
		1729	my ($self, $map, $x, $y) = @_;
		1730
		1731	my $link_pos = delete $self->{_link_pos};
		1732
		1733	unless ($map) {
		1734	# restore original map position
		1735	($map, $x, $y) = @{ $link_pos || [] };
		1736	$map = cf::map::find $map;
		1737
		1738	unless ($map) {
		1739	($map, $x, $y) = @$EMERGENCY_POSITION;
		1740	$map = cf::map::find $map
		1741	or die "FATAL: cannot load emergency map\n";
		1742	}
		1743	}
		1744
		1745	($x, $y) = (-1, -1)
		1746	unless (defined $x) && (defined $y);
		1747
		1748	# use -1 or undef as default coordinates, not 0, 0
		1749	($x, $y) = ($map->enter_x, $map->enter_y)
		1750	if $x <=0 && $y <= 0;
		1751
		1752	$map->load;
		1753	$map->load_diag;
		1754
		1755	return unless $self->contr->active;
		1756	$self->activate_recursive;
		1757	$self->enter_map ($map, $x, $y);
		1758	}
		1759
		1760	cf::player->attach (
		1761	on_logout => sub {
		1762	my ($pl) = @_;
		1763
		1764	# abort map switching before logout
		1765	if ($pl->ob->{_link_pos}) {
		1766	cf::sync_job {
		1767	$pl->ob->leave_link
		1768	};
		1769	}
		1770	},
		1771	on_login => sub {
		1772	my ($pl) = @_;
		1773
		1774	# try to abort aborted map switching on player login :)
		1775	# should happen only on crashes
		1776	if ($pl->ob->{_link_pos}) {
		1777	$pl->ob->enter_link;
		1778	(async {
		1779	# we need this sleep as the login has a concurrent enter_exit running
		1780	# and this sleep increases chances of the player not ending up in scorn
		1781	$pl->ob->reply (undef,
		1782	"There was an internal problem at your last logout, "
		1783	. "the server will try to bring you to your intended destination in a second.",
		1784	cf::NDI_RED);
		1785	Coro::Timer::sleep 1;
		1786	$pl->ob->leave_link;
		1787	})->prio (2);
		1788	}
		1789	},
		1790	);
		1791
		1792	=item $player_object->goto ($path, $x, $y)
		1793
		1794	=cut
		1795
		1796	sub cf::object::player::goto {
		1797	my ($self, $path, $x, $y) = @_;
		1798
		1799	$self->enter_link;
		1800
		1801	(async {
		1802	my $map = cf::map::find $path;
		1803	$map = $map->customise_for ($self) if $map;
		1804
		1805	# warn "entering ", $map->path, " at ($x, $y)\n"
		1806	# if $map;
		1807
		1808	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1809
		1810	$self->leave_link ($map, $x, $y);
		1811	})->prio (1);
		1812	}
		1813
		1814	=item $player_object->enter_exit ($exit_object)
		1815
		1816	=cut
		1817
		1818	sub parse_random_map_params {
		1819	my ($spec) = @_;
		1820
		1821	my $rmp = { # defaults
		1822	xsize => 10,
		1823	ysize => 10,
		1824	};
		1825
		1826	for (split /\n/, $spec) {
		1827	my ($k, $v) = split /\s+/, $_, 2;
		1828
		1829	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1830	}
		1831
		1832	$rmp
		1833	}
		1834
		1835	sub prepare_random_map {
		1836	my ($exit) = @_;
		1837
		1838	# all this does is basically replace the /! path by
		1839	# a new random map path (?random/...) with a seed
		1840	# that depends on the exit object
		1841
		1842	my $rmp = parse_random_map_params $exit->msg;
		1843
		1844	if ($exit->map) {
		1845	$rmp->{region} = $exit->map->region_name;
		1846	$rmp->{origin_map} = $exit->map->path;
		1847	$rmp->{origin_x} = $exit->x;
		1848	$rmp->{origin_y} = $exit->y;
		1849	}
		1850
		1851	$rmp->{random_seed} ||= $exit->random_seed;
		1852
		1853	my $data = cf::to_json $rmp;
		1854	my $md5 = Digest::MD5::md5_hex $data;
		1855
		1856	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1857	aio_write $fh, 0, (length $data), $data, 0;
		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
840		1994
841	=head2 SAFE SCRIPTING	1995	=head2 SAFE SCRIPTING
842		1996
843	Functions that provide a safe environment to compile and execute	1997	Functions that provide a safe environment to compile and execute
844	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
…		…
859		2013
860	=pod	2014	=pod
861		2015
862	The following fucntions and emthods are available within a safe environment:	2016	The following fucntions and emthods are available within a safe environment:
863		2017
864	cf::object contr pay_amount pay_player	2018	cf::object contr pay_amount pay_player map
865	cf::object::player player	2019	cf::object::player player
866	cf::player peaceful	2020	cf::player peaceful
		2021	cf::map trigger
867		2022
868	=cut	2023	=cut
869		2024
870	for (	2025	for (
871	["cf::object" => qw(contr pay_amount pay_player)],	2026	["cf::object" => qw(contr pay_amount pay_player map)],
872	["cf::object::player" => qw(player)],	2027	["cf::object::player" => qw(player)],
873	["cf::player" => qw(peaceful)],	2028	["cf::player" => qw(peaceful)],
		2029	["cf::map" => qw(trigger)],
874	) {	2030	) {
875	no strict 'refs';	2031	no strict 'refs';
876	my ($pkg, @funs) = @$_;	2032	my ($pkg, @funs) = @$_;
877	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2033	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
878	for @funs;	2034	for @funs;
…		…
994		2150
995	{	2151	{
996	my $path = cf::localdir . "/database.pst";	2152	my $path = cf::localdir . "/database.pst";
997		2153
998	sub db_load() {	2154	sub db_load() {
999	warn "loading database $path\n";#d# remove later
1000	$DB = stat $path ? Storable::retrieve $path : { };	2155	$DB = stat $path ? Storable::retrieve $path : { };
1001	}	2156	}
1002		2157
1003	my $pid;	2158	my $pid;
1004		2159
1005	sub db_save() {	2160	sub db_save() {
1006	warn "saving database $path\n";#d# remove later
1007	waitpid $pid, 0 if $pid;	2161	waitpid $pid, 0 if $pid;
1008	if (0 == ($pid = fork)) {	2162	if (0 == ($pid = fork)) {
1009	$DB->{_meta}{version} = 1;	2163	$DB->{_meta}{version} = 1;
1010	Storable::nstore $DB, "$path~";	2164	Storable::nstore $DB, "$path~";
1011	rename "$path~", $path;	2165	rename "$path~", $path;
…		…
1018	sub db_sync() {	2172	sub db_sync() {
1019	db_save if $dirty;	2173	db_save if $dirty;
1020	undef $dirty;	2174	undef $dirty;
1021	}	2175	}
1022		2176
1023	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	2177	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1024	db_sync;	2178	db_sync;
1025	});	2179	});
1026		2180
1027	sub db_dirty() {	2181	sub db_dirty() {
1028	$dirty = 1;	2182	$dirty = 1;
…		…
1042	$DB->{$_[0]} = $_[1];	2196	$DB->{$_[0]} = $_[1];
1043	}	2197	}
1044	db_dirty;	2198	db_dirty;
1045	}	2199	}
1046		2200
1047	attach_global	2201	cf::global->attach (
1048	prio => 10000,	2202	prio => 10000,
1049	on_cleanup => sub {	2203	on_cleanup => sub {
1050	db_sync;	2204	db_sync;
1051	},	2205	},
1052	;	2206	);
1053	}	2207	}
1054		2208
1055	#############################################################################	2209	#############################################################################
1056	# the server's main()	2210	# the server's main()
1057		2211
…		…
1059	open my $fh, "<:utf8", cf::confdir . "/config"	2213	open my $fh, "<:utf8", cf::confdir . "/config"
1060	or return;	2214	or return;
1061		2215
1062	local $/;	2216	local $/;
1063	*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	}
1064	}	2231	}
1065		2232
1066	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 { Event::one_event };
		2238	};
		2239
1067	cfg_load;	2240	cfg_load;
1068	db_load;	2241	db_load;
1069	load_extensions;	2242	load_extensions;
1070	Event::loop;	2243	Event::loop;
1071	}	2244	}
1072		2245
1073	#############################################################################	2246	#############################################################################
1074	# initialisation	2247	# initialisation and cleanup
1075		2248
		2249	# install some emergency cleanup handlers
		2250	BEGIN {
		2251	for my $signal (qw(INT HUP TERM)) {
		2252	Event->signal (
		2253	data => WF_AUTOCANCEL,
		2254	signal => $signal,
		2255	cb => sub {
		2256	cf::cleanup "SIG$signal";
		2257	},
		2258	);
		2259	}
		2260	}
		2261
		2262	sub emergency_save() {
		2263	my $freeze_guard = cf::freeze_mainloop;
		2264
		2265	warn "enter emergency perl save\n";
		2266
		2267	cf::sync_job {
		2268	# use a peculiar iteration method to avoid tripping on perl
		2269	# refcount bugs in for. also avoids problems with players
		2270	# and maps saved/destroyed asynchronously.
		2271	warn "begin emergency player save\n";
		2272	for my $login (keys %cf::PLAYER) {
		2273	my $pl = $cf::PLAYER{$login} or next;
		2274	$pl->valid or next;
		2275	$pl->save;
		2276	}
		2277	warn "end emergency player save\n";
		2278
		2279	warn "begin emergency map save\n";
		2280	for my $path (keys %cf::MAP) {
		2281	my $map = $cf::MAP{$path} or next;
		2282	$map->valid or next;
		2283	$map->save;
		2284	}
		2285	warn "end emergency map save\n";
		2286	};
		2287
		2288	warn "leave emergency perl save\n";
		2289	}
		2290
1076	sub _perl_reload(&) {	2291	sub reload() {
1077	my ($msg) = @_;	2292	# can/must only be called in main
		2293	if ($Coro::current != $Coro::main) {
		2294	warn "can only reload from main coroutine\n";
		2295	return;
		2296	}
1078		2297
1079	$msg->("reloading...");	2298	warn "reloading...";
		2299
		2300	warn "freezing server";
		2301	my $guard = freeze_mainloop;
		2302	cf::emergency_save;
		2303
		2304	warn "sync database to disk";
		2305	cf::db_sync;
		2306	IO::AIO::flush;
1080		2307
1081	eval {	2308	eval {
		2309	# if anything goes wrong in here, we should simply crash as we already saved
		2310
1082	# cancel all watchers	2311	warn "cancel all watchers";
1083	$_->cancel for Event::all_watchers;	2312	for (Event::all_watchers) {
		2313	$_->cancel if $_->data & WF_AUTOCANCEL;
		2314	}
1084		2315
		2316	warn "cancel all extension coros";
		2317	$_->cancel for values %EXT_CORO;
		2318	%EXT_CORO = ();
		2319
		2320	warn "remove commands";
		2321	%COMMAND = ();
		2322
		2323	warn "remove ext commands";
		2324	%EXTCMD = ();
		2325
1085	# unload all extensions	2326	warn "unload/nuke all extensions";
1086	for (@exts) {	2327	for my $pkg (@EXTS) {
1087	$msg->("unloading <$_>");	2328	warn "... unloading $pkg";
1088	unload_extension $_;	2329
		2330	if (my $cb = $pkg->can ("unload")) {
		2331	eval {
		2332	$cb->($pkg);
		2333	1
		2334	} or warn "$pkg unloaded, but with errors: $@";
1089	}	2335	}
1090		2336
		2337	warn "... nuking $pkg";
		2338	Symbol::delete_package $pkg;
		2339	}
		2340
1091	# unload all modules loaded from $LIBDIR	2341	warn "unload all perl modules loaded from $LIBDIR";
1092	while (my ($k, $v) = each %INC) {	2342	while (my ($k, $v) = each %INC) {
1093	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2343	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1094		2344
1095	$msg->("removing <$k>");	2345	warn "removing <$k>";
1096	delete $INC{$k};	2346	delete $INC{$k};
1097		2347
1098	$k =~ s/\.pm$//;	2348	$k =~ s/\.pm$//;
1099	$k =~ s/\//::/g;	2349	$k =~ s/\//::/g;
1100		2350
…		…
1103	}	2353	}
1104		2354
1105	Symbol::delete_package $k;	2355	Symbol::delete_package $k;
1106	}	2356	}
1107		2357
1108	# sync database to disk
1109	cf::db_sync;
1110
1111	# get rid of safe::, as good as possible	2358	warn "get rid of safe::, as good as possible";
1112	Symbol::delete_package "safe::$_"	2359	Symbol::delete_package "safe::$_"
1113	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2360	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1114		2361
1115	# remove register_script_function callbacks
1116	# TODO
1117
1118	# unload cf.pm "a bit"	2362	warn "unload cf.pm \"a bit\"";
1119	delete $INC{"cf.pm"};	2363	delete $INC{"cf.pm"};
1120		2364
1121	# don't, removes xs symbols, too,	2365	# don't, removes xs symbols, too,
1122	# and global variables created in xs	2366	# and global variables created in xs
1123	#Symbol::delete_package __PACKAGE__;	2367	#Symbol::delete_package __PACKAGE__;
1124		2368
1125	# reload cf.pm
1126	$msg->("reloading cf.pm");	2369	warn "reloading cf.pm";
1127	require cf;	2370	require cf;
		2371	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1128		2372
1129	# load config and database again	2373	warn "load config and database again";
1130	cf::cfg_load;	2374	cf::cfg_load;
1131	cf::db_load;	2375	cf::db_load;
1132		2376
1133	# load extensions	2377	warn "load extensions";
1134	$msg->("load extensions");
1135	cf::load_extensions;	2378	cf::load_extensions;
1136		2379
1137	# reattach attachments to objects	2380	warn "reattach attachments to objects/players";
1138	$msg->("reattach");
1139	_global_reattach;	2381	_global_reattach;
		2382	warn "reattach attachments to maps";
		2383	reattach $_ for values %MAP;
1140	};	2384	};
1141	$msg->($@) if $@;
1142		2385
1143	$msg->("reloaded");	2386	if ($@) {
		2387	warn $@;
		2388	warn "error while reloading, exiting.";
		2389	exit 1;
		2390	}
		2391
		2392	warn "reloaded";
1144	};	2393	};
1145		2394
1146	sub perl_reload() {
1147	_perl_reload {
1148	warn $_[0];
1149	print "$_[0]\n";
1150	};
1151	}
1152
1153	register "<global>", __PACKAGE__;
1154
1155	register_command "perl-reload" => sub {	2395	register_command "reload" => sub {
1156	my ($who, $arg) = @_;	2396	my ($who, $arg) = @_;
1157		2397
1158	if ($who->flag (FLAG_WIZ)) {	2398	if ($who->flag (FLAG_WIZ)) {
1159	_perl_reload {	2399	$who->message ("start of reload.");
1160	warn $_[0];	2400	reload;
1161	$who->message ($_[0]);	2401	$who->message ("end of reload.");
1162	};
1163	}	2402	}
1164	};	2403	};
1165		2404
1166	unshift @INC, $LIBDIR;	2405	unshift @INC, $LIBDIR;
1167		2406
1168	$TICK_WATCHER = Event->timer (	2407	$TICK_WATCHER = Event->timer (
		2408	reentrant => 0,
1169	prio => 1,	2409	prio => 0,
1170	async => 1,
1171	at => $NEXT_TICK || 1,	2410	at => $NEXT_TICK || $TICK,
		2411	data => WF_AUTOCANCEL,
1172	cb => sub {	2412	cb => sub {
		2413	$NOW = Event::time;
		2414
1173	cf::server_tick; # one server iteration	2415	cf::server_tick; # one server iteration
1174		2416	$RUNTIME += $TICK;
1175	my $NOW = Event::time;
1176	$NEXT_TICK += $TICK;	2417	$NEXT_TICK += $TICK;
1177		2418
		2419	$WAIT_FOR_TICK->broadcast;
		2420	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2421
1178	# if we are delayed by four ticks or more, skip them all	2422	# if we are delayed by four ticks or more, skip them all
1179	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2423	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1180		2424
1181	$TICK_WATCHER->at ($NEXT_TICK);	2425	$TICK_WATCHER->at ($NEXT_TICK);
1182	$TICK_WATCHER->start;	2426	$TICK_WATCHER->start;
1183	},	2427	},
1184	);	2428	);
1185		2429
1186	IO::AIO::max_poll_time $TICK * 0.2;	2430	IO::AIO::max_poll_time $TICK * 0.2;
1187		2431
		2432	$AIO_POLL_WATCHER = Event->io (
1188	Event->io (fd => IO::AIO::poll_fileno,	2433	fd => IO::AIO::poll_fileno,
1189	poll => 'r',	2434	poll => 'r',
1190	prio => 5,	2435	prio => 5,
		2436	data => WF_AUTOCANCEL,
1191	cb => \&IO::AIO::poll_cb);	2437	cb => \&IO::AIO::poll_cb,
		2438	);
		2439
		2440	$WRITE_RUNTIME_WATCHER = Event->timer (
		2441	data => WF_AUTOCANCEL,
		2442	after => 0,
		2443	interval => 10,
		2444	cb => sub {
		2445	(Coro::unblock_sub {
		2446	write_runtime
		2447	or warn "ERROR: unable to write runtime file: $!";
		2448	})->();
		2449	},
		2450	);
		2451
		2452	END { cf::emergency_save }
1192		2453
1193	1	2454	1
1194		2455

Diff Legend

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