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

Diff Legend

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