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

Diff Legend

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