ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.87 by root, Thu Dec 14 22:45:40 2006 UTC vs.
Revision 1.167 by root, Sat Jan 13 23:32:43 2007 UTC

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

Diff Legend

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