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.70 by root, Sun Oct 1 10:55:37 2006 UTC vs.
Revision 1.237 by root, Fri Apr 13 05:08:51 2007 UTC

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

Diff Legend

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