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.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.173 by root, Sun Jan 14 18:00:34 2007 UTC

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

Diff Legend

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