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

Diff Legend

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