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

Diff Legend

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