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.44 by root, Sat Aug 26 08:44:06 2006 UTC vs.
Revision 1.277 by root, Sun Jun 10 04:24:50 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	# object support
98		449
99	sub reattach {	450	=head2 ATTACHABLE OBJECTS
100	warn "reattach<@_>\n";
101	}
102		451
103	sub instantiate {	452	Many objects in crossfire are so-called attachable objects. That means you can
104	warn "instantiate<@_>\n";	453	attach callbacks/event handlers (a collection of which is called an "attachment")
105	}	454	to it. All such attachable objects support the following methods.
106		455
107	sub clone {	456	In the following description, CLASS can be any of C<global>, C<object>
108	warn "clone<@_>\n";	457	C<player>, C<client> or C<map> (i.e. the attachable objects in
109	}	458	crossfire+).
110		459
111	#############################################################################	460	=over 4
112	# "new" plug-in system
113		461
114	=item cf::object::attach ... # NYI	462	=item $attachable->attach ($attachment, key => $value...)
115		463
116	=item cf::attach_global ...	464	=item $attachable->detach ($attachment)
117		465
118	=item cf::attach_to_type ...	466	Attach/detach a pre-registered attachment to a specific object and give it
		467	the specified key/value pairs as arguments.
119		468
120	=item cf::attach_to_objects ...	469	Example, attach a minesweeper attachment to the given object, making it a
		470	10x10 minesweeper game:
121		471
122	=item cf::attach_to_players ...	472	$obj->attach (minesweeper => width => 10, height => 10);
123		473
124	=item cf::attach_to_maps ...	474	=item $bool = $attachable->attached ($name)
125		475
126	prio => $number, # lower is earlier	476	Checks wether the named attachment is currently attached to the object.
127	on_xxx => \&cb,	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
128	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.
129		568
130	=cut	569	=cut
131		570
132	# 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
133	our @CB_GLOBAL = (); # registry for all global events	572	our @CB_GLOBAL = (); # registry for all global events
134	our @CB_OBJECT = ();	573	our @CB_ATTACHABLE = (); # registry for all attachables
		574	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
135	our @CB_PLAYER = ();	575	our @CB_PLAYER = ();
		576	our @CB_CLIENT = ();
136	our @CB_TYPE = (); # registry for type (cf-object class) based events	577	our @CB_TYPE = (); # registry for type (cf-object class) based events
137	our @CB_MAP = ();	578	our @CB_MAP = ();
138		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
139	sub _attach_cb($\%$$$) {	588	sub _attach_cb($$$$) {
140	my ($registry, $undo, $event, $prio, $cb) = @_;	589	my ($registry, $event, $prio, $cb) = @_;
141		590
142	use sort 'stable';	591	use sort 'stable';
143		592
144	$cb = [$prio, $cb];	593	$cb = [$prio, $cb];
145		594
146	@{$registry->[$event]} = sort	595	@{$registry->[$event]} = sort
147	{ $a->[0] cmp $b->[0] }	596	{ $a->[0] cmp $b->[0] }
148	@{$registry->[$event] || []}, $cb;	597	@{$registry->[$event] || []}, $cb;
149
150	push @{$undo->{cb}}, [$event, $cb];
151	}	598	}
		599
		600	# hack
		601	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
152		602
153	# attach handles attaching event callbacks	603	# attach handles attaching event callbacks
154	# 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
155	# registry (== where the callback attaches to).	605	# registry (== where the callback attaches to).
156	sub _attach(\@$\@) {	606	sub _attach {
157	my ($registry, $klass, $arg) = @_;	607	my ($registry, $klass, @arg) = @_;
158		608
		609	my $object_type;
159	my $prio = 0;	610	my $prio = 0;
160
161	my %undo = (
162	registry => $registry,
163	cb => [],
164	);
165
166	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;
167		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
168	while (@$arg) {	618	while (@arg) {
169	my $type = shift @$arg;	619	my $type = shift @arg;
170		620
171	if ($type eq "prio") {	621	if ($type eq "prio") {
172	$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] ||= [];
173		632
174	} elsif ($type eq "package") {	633	} elsif ($type eq "package") {
175	my $pkg = shift @$arg;	634	my $pkg = shift @arg;
176		635
177	while (my ($name, $id) = each %cb_id) {	636	while (my ($name, $id) = each %cb_id) {
178	if (my $cb = $pkg->can ($name)) {	637	if (my $cb = $pkg->can ($name)) {
179	_attach_cb $registry, %undo, $id, $prio, $cb;	638	_attach_cb $registry, $id, $prio, $cb;
180	}	639	}
181	}	640	}
182		641
183	} elsif (exists $cb_id{$type}) {	642	} elsif (exists $cb_id{$type}) {
184	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;	643	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
185		644
186	} elsif (ref $type) {	645	} elsif (ref $type) {
187	warn "attaching objects not supported, ignoring.\n";	646	warn "attaching objects not supported, ignoring.\n";
188		647
189	} else {	648	} else {
190	shift @$arg;	649	shift @arg;
191	warn "attach argument '$type' not supported, ignoring.\n";	650	warn "attach argument '$type' not supported, ignoring.\n";
192	}	651	}
193	}	652	}
194
195	\%undo
196	}	653	}
197		654
198	sub cf::object::attach {	655	sub _object_attach {
199	die;	656	my ($obj, $name, %arg) = @_;
200	}
201		657
202	sub attach_global {	658	return if exists $obj->{_attachment}{$name};
203	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
204	}
205		659
206	sub attach_to_type {	660	if (my $attach = $attachment{$name}) {
207	my $type = shift;	661	my $registry = $obj->registry;
208	_attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
209	}
210		662
211	sub attach_to_objects {	663	for (@$attach) {
212	_attach @CB_OBJECT, KLASS_OBJECT, @_	664	my ($klass, @attach) = @$_;
213	}	665	_attach $registry, $klass, @attach;
		666	}
214		667
215	sub attach_to_players {	668	$obj->{$name} = \%arg;
216	_attach @CB_PLAYER, KLASS_PLAYER, @_	669	} else {
217	}	670	warn "object uses attachment '$name' that is not available, postponing.\n";
		671	}
218		672
219	sub attach_to_maps {	673	$obj->{_attachment}{$name} = undef;
220	_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 $@;
221	}	717	}
222		718
223	our $override;	719	our $override;
		720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
224		721
225	sub override() {	722	sub override {
226	$override = 1	723	$override = 1;
		724	@invoke_results = ();
227	}	725	}
228		726
229	sub invoke {	727	sub do_invoke {
230	my $event = shift;	728	my $event = shift;
231	my $callbacks = shift;	729	my $callbacks = shift;
232		730
		731	@invoke_results = ();
		732
233	local $override;	733	local $override;
234		734
235	for (@$callbacks) {	735	for (@$callbacks) {
236	eval { &{$_->[1]} };	736	eval { &{$_->[1]} };
237		737
238	if ($@) {	738	if ($@) {
239	warn "$@";	739	warn "$@";
240	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	740	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
241	override;	741	override;
242	}	742	}
243		743
244	return 1 if $override;	744	return 1 if $override;
245	}	745	}
246		746
247	0	747	0
248	}	748	}
249		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
250	#############################################################################	764	#############################################################################
251	# old plug-in events	765	# object support
252		766
253	sub inject_event {	767	sub reattach {
254	my $extension = shift;	768	# basically do the same as instantiate, without calling instantiate
255	my $event_code = shift;	769	my ($obj) = @_;
256		770
257	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
258	or return;	869	or return;
259		870
260	&$cb	871	unless (aio_stat "$filename.pst") {
261	}	872	(aio_load "$filename.pst", $av) >= 0
262
263	sub inject_global_event {
264	my $event = shift;
265
266	my $cb = $hook[$event]
267	or return;	873	or return;
268		874	$av = eval { (Storable::thaw $av)->{objs} };
269	List::Util::max map &$_, values %$cb
270	}
271
272	sub inject_command {
273	my ($name, $obj, $params) = @_;
274
275	for my $cmd (@{ $command{$name} }) {
276	$cmd->[1]->($obj, $params);
277	}	875	}
278		876
279	-1	877	warn sprintf "loading %s (%d)\n",
		878	$filename, length $data, scalar @{$av || []};
		879	return ($data, $av);
280	}	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
281		891
282	sub register_command {	892	sub register_command {
283	my ($name, $time, $cb) = @_;	893	my ($name, $cb) = @_;
284		894
285	my $caller = caller;	895	my $caller = caller;
286	#warn "registering command '$name/$time' to '$caller'";	896	#warn "registering command '$name/$time' to '$caller'";
287		897
288	push @{ $command{$name} }, [$time, $cb, $caller];	898	push @{ $COMMAND{$name} }, [$caller, $cb];
289	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
290	}	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
291		909
292	sub register_extcmd {	910	sub register_extcmd {
293	my ($name, $cb) = @_;	911	my ($name, $cb) = @_;
294		912
295	my $caller = caller;	913	$EXTCMD{$name} = $cb;
296	#warn "registering extcmd '$name' to '$caller'";
297
298	$extcmd{$name} = [$cb, $caller];
299	}	914	}
300		915
301	sub register {	916	cf::player->attach (
302	my ($base, $pkg) = @_;	917	on_command => sub {
		918	my ($pl, $name, $params) = @_;
303		919
304	for my $idx (0 .. $#PLUGIN_EVENT) {	920	my $cb = $COMMAND{$name}
305	if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {	921	or return;
306	#warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";	922
307	$hook[$idx]{$base} = $ref;	923	for my $cmd (@$cb) {
		924	$cmd->[1]->($pl->ob, $params);
308	}	925	}
		926
		927	cf::override;
309	}	928	},
310	}	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	);
311		947
312	sub load_extension {	948	sub load_extension {
313	my ($path) = @_;	949	my ($path) = @_;
314		950
315	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	951	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
316	my $base = $1;	952	my $base = $1;
317	my $pkg = $1;	953	my $pkg = $1;
318	$pkg =~ s/[^[:word:]]/_/g;	954	$pkg =~ s/[^[:word:]]/_/g;
319	$pkg = "ext::$pkg";	955	$pkg = "ext::$pkg";
320		956
321	warn "loading '$path' into '$pkg'\n";	957	warn "... loading '$path' into '$pkg'\n";
322		958
323	open my $fh, "<:utf8", $path	959	open my $fh, "<:utf8", $path
324	or die "$path: $!";	960	or die "$path: $!";
325		961
326	my $source =	962	my $source =
327	"package $pkg; use strict; use utf8;\n"	963	"package $pkg; use strict; use utf8;\n"
328	. "#line 1 \"$path\"\n{\n"	964	. "#line 1 \"$path\"\n{\n"
329	. (do { local $/; <$fh> })	965	. (do { local $/; <$fh> })
330	. "\n};\n1";	966	. "\n};\n1";
331		967
332	eval $source	968	unless (eval $source) {
333	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	}
334		978
335	push @exts, $pkg;	979	push @EXTS, $pkg;
336	$ext_pkg{$base} = $pkg;
337
338	# no strict 'refs';
339	# @{"$pkg\::ISA"} = ext::;
340
341	register $base, $pkg;
342	}
343
344	sub unload_extension {
345	my ($pkg) = @_;
346
347	warn "removing extension $pkg\n";
348
349	# remove hooks
350	for my $idx (0 .. $#PLUGIN_EVENT) {
351	delete $hook[$idx]{$pkg};
352	}
353
354	# remove commands
355	for my $name (keys %command) {
356	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
357
358	if (@cb) {
359	$command{$name} = \@cb;
360	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
361	} else {
362	delete $command{$name};
363	delete $COMMAND{"$name\000"};
364	}
365	}
366
367	# remove extcmds
368	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
369	delete $extcmd{$name};
370	}
371
372	if (my $cb = $pkg->can ("unload")) {
373	eval {
374	$cb->($pkg);
375	1
376	} or warn "$pkg unloaded, but with errors: $@";
377	}
378
379	Symbol::delete_package $pkg;
380	}	980	}
381		981
382	sub load_extensions {	982	sub load_extensions {
383	my $LIBDIR = maps_directory "perl";
384
385	for my $ext (<$LIBDIR/*.ext>) {	983	for my $ext (<$LIBDIR/*.ext>) {
386	next unless -r $ext;	984	next unless -r $ext;
387	eval {	985	eval {
388	load_extension $ext;	986	load_extension $ext;
389	1	987	1
390	} or warn "$ext not loaded: $@";	988	} or warn "$ext not loaded: $@";
391	}	989	}
392	}	990	}
393		991
394	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 {
395	my ($msg) = @_;	1371	my ($self) = @_;
396		1372
397	$msg->("reloading...");	1373	$self
		1374	}
398		1375
399	eval {	1376	sub as_string {
400	# 1. cancel all watchers	1377	my ($self) = @_;
401	$_->cancel for Event::all_watchers;
402		1378
403	# 2. unload all extensions	1379	"$self->{path}"
404	for (@exts) {	1380	}
405	$msg->("unloading <$_>");
406	unload_extension $_;
407	}
408		1381
409	# 3. unload all modules loaded from $LIBDIR	1382	# the displayed name, this is a one way mapping
410	while (my ($k, $v) = each %INC) {	1383	sub visible_name {
411	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1384	&as_string
		1385	}
412		1386
413	$msg->("removing <$k>");	1387	# the original (read-only) location
414	delete $INC{$k};	1388	sub load_path {
		1389	my ($self) = @_;
415		1390
416	$k =~ s/\.pm$//;	1391	"$MAPDIR/$self->{path}.map"
417	$k =~ s/\//::/g;	1392	}
418		1393
419	if (my $cb = $k->can ("unload_module")) {	1394	# the temporary/swap location
420	$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);
421	}	1564	}
422
423	Symbol::delete_package $k;
424	}
425
426	# 4. get rid of safe::, as good as possible
427	Symbol::delete_package "safe::$_"
428	for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
429
430	# 5. remove register_script_function callbacks
431	# TODO
432		1565	}
433	# 6. unload cf.pm "a bit"
434	delete $INC{"cf.pm"};
435		1566
436	# don't, removes xs symbols, too,	1567	Coro::cede;
437	# and global variables created in xs	1568	# now do the right thing for maps
438	#Symbol::delete_package __PACKAGE__;	1569	$self->link_multipart_objects;
		1570	$self->difficulty ($self->estimate_difficulty)
		1571	unless $self->difficulty;
		1572	Coro::cede;
439		1573
440	# 7. reload cf.pm	1574	unless ($self->{deny_activate}) {
441	$msg->("reloading cf.pm");	1575	$self->decay_objects;
442	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;
443	};	1662	};
444	$msg->($@) if $@;	1663	$MAP_PREFETCHER->prio (6);
445		1664
446	$msg->("reloaded");	1665	()
447	};	1666	}
448		1667
449	sub perl_reload() {	1668	sub save {
450	_perl_reload {	1669	my ($self) = @_;
451	warn $_[0];	1670
452	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;
453	};	1688	};
454	}
455		1689
456	register_command "perl-reload", 0, sub {	1690	if ($uniq) {
457	my ($who, $arg) = @_;	1691	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
458		1692	$self->_save_objects ($uniq, cf::IO_UNIQUES);
459	if ($who->flag (FLAG_WIZ)) {
460	_perl_reload {
461	warn $_[0];
462	$who->message ($_[0]);
463	};
464	}
465	};
466
467	#############################################################################
468	# utility functions
469
470	use JSON::Syck (); # TODO# replace by JSON::PC once working
471
472	sub from_json($) {
473	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
474	JSON::Syck::Load $_[0]
475	}
476
477	sub to_json($) {
478	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
479	JSON::Syck::Dump $_[0]
480	}
481
482	#############################################################################
483	# extcmd framework, basically convert ext <msg>
484	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
485
486	attach_to_players
487	on_extcmd => sub {
488	my ($pl, $buf) = @_;
489
490	my $msg = eval { from_json $buf };
491
492	if (ref $msg) {
493	if (my $cb = $extcmd{$msg->{msgtype}}) {
494	if (my %reply = $cb->[0]->($pl, $msg)) {
495	$pl->ext_reply ($msg->{msgid}, %reply);
496	}
497	}
498	} else {
499	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
500	}
501
502	cf::override;
503	},
504	;
505
506	#############################################################################
507	# load/save/clean perl data associated with a map
508
509	*cf::mapsupport::on_clean = sub {
510	my ($map) = @_;
511
512	my $path = $map->tmpname;
513	defined $path or return;
514
515	unlink "$path.cfperl";
516	};
517
518	*cf::mapsupport::on_swapin =
519	*cf::mapsupport::on_load = sub {
520	my ($map) = @_;
521
522	my $path = $map->tmpname;
523	$path = $map->path unless defined $path;
524
525	open my $fh, "<:raw", "$path.cfperl"
526	or return; # no perl data
527
528	my $data = Storable::thaw do { local $/; <$fh> };
529
530	$data->{version} <= 1
531	or return; # too new
532
533	$map->_set_obs ($data->{obs});
534	};
535
536	*cf::mapsupport::on_swapout = sub {
537	my ($map) = @_;
538
539	my $path = $map->tmpname;
540	$path = $map->path unless defined $path;
541
542	my $obs = $map->_get_obs;
543
544	if (defined $obs) {
545	open my $fh, ">:raw", "$path.cfperl"
546	or die "$path.cfperl: $!";
547
548	stat $path;
549
550	print $fh Storable::nfreeze {
551	size => (stat _)[7],
552	time => (stat _)[9],
553	version => 1,
554	obs => $obs,
555	};
556
557	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
558	} else {	1693	} else {
559	unlink "$path.cfperl";	1694	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
560	}
561	};
562
563	attach_to_maps prio => -10000, package => cf::mapsupport::;
564
565	#############################################################################
566	# load/save perl data associated with player->ob objects
567
568	sub all_objects(@) {
569	@_, map all_objects ($_->inv), @_
570	}
571
572	attach_to_players
573	on_load => sub {
574	my ($pl, $path) = @_;
575
576	for my $o (all_objects $pl->ob) {
577	if (my $value = $o->get_ob_key_value ("_perl_data")) {
578	$o->set_ob_key_value ("_perl_data");
579
580	%$o = %{ Storable::thaw pack "H*", $value };
581	}
582	}
583	},	1695	}
584	on_save => sub {	1696	}
585	my ($pl, $path) = @_;
586		1697
587	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)	1698	sub swap_out {
588	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;
589	},	1749	}
590	;
591		1750
592	#############################################################################	1751	delete $cf::MAP{$self->path};
593	# core extensions - in perl
594		1752
595	=item cf::player::exists $login	1753	$self->clear;
596		1754
597	Returns true when the given account exists.	1755	$_->clear_links_to ($self) for values %cf::MAP;
598		1756
599	=cut	1757	$self->unlink_save;
600		1758	$self->destroy;
601	sub cf::player::exists($) {
602	cf::player::find $_[0]
603	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
604	}	1759	}
605		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. May block.
		1785
		1786	=cut
		1787
		1788	sub tmp_maps() {
		1789	[
		1790	map {
		1791	utf8::decode $_;
		1792	/\.map$/
		1793	? normalise $_
		1794	: ()
		1795	} @{ aio_readdir $TMPDIR or [] }
		1796	]
		1797	}
		1798
		1799	=item $maps = cf::map::random_maps
		1800
		1801	Returns an arrayref with all map paths of currently instantiated and saved
		1802	random maps. May block.
		1803
		1804	=cut
		1805
		1806	sub random_maps() {
		1807	[
		1808	map {
		1809	utf8::decode $_;
		1810	/\.map$/
		1811	? normalise "?random/$_"
		1812	: ()
		1813	} @{ aio_readdir $RANDOMDIR or [] }
		1814	]
		1815	}
		1816
		1817	=item cf::map::unique_maps
		1818
		1819	Returns an arrayref of paths of all shared maps that have
		1820	instantiated unique items. May block.
		1821
		1822	=cut
		1823
		1824	sub unique_maps() {
		1825	[
		1826	map {
		1827	utf8::decode $_;
		1828	/\.map$/
		1829	? normalise $_
		1830	: ()
		1831	} @{ aio_readdir $UNIQUEDIR or [] }
		1832	]
		1833	}
		1834
		1835	package cf;
		1836
		1837	=back
		1838
		1839	=head3 cf::object
		1840
		1841	=cut
		1842
		1843	package cf::object;
		1844
		1845	=over 4
		1846
		1847	=item $ob->inv_recursive
		1848
		1849	Returns the inventory of the object _and_ their inventories, recursively.
		1850
		1851	=cut
		1852
		1853	sub inv_recursive_;
		1854	sub inv_recursive_ {
		1855	map { $_, inv_recursive_ $_->inv } @_
		1856	}
		1857
		1858	sub inv_recursive {
		1859	inv_recursive_ inv $_[0]
		1860	}
		1861
		1862	package cf;
		1863
		1864	=back
		1865
		1866	=head3 cf::object::player
		1867
		1868	=over 4
		1869
606	=item $player->reply ($npc, $msg[, $flags])	1870	=item $player_object->reply ($npc, $msg[, $flags])
607		1871
608	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1872	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
609	can be C<undef>. Does the right thing when the player is currently in a	1873	can be C<undef>. Does the right thing when the player is currently in a
610	dialogue with the given NPC character.	1874	dialogue with the given NPC character.
611		1875
612	=cut	1876	=cut
613		1877
614	# rough implementation of a future "reply" method that works	1878	# rough implementation of a future "reply" method that works
615	# with dialog boxes.	1879	# with dialog boxes.
		1880	#TODO: the first argument must go, split into a $npc->reply_to ( method
616	sub cf::object::player::reply($$$;$) {	1881	sub cf::object::player::reply($$$;$) {
617	my ($self, $npc, $msg, $flags) = @_;	1882	my ($self, $npc, $msg, $flags) = @_;
618		1883
619	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1884	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
620		1885
…		…
624	$msg = $npc->name . " says: $msg" if $npc;	1889	$msg = $npc->name . " says: $msg" if $npc;
625	$self->message ($msg, $flags);	1890	$self->message ($msg, $flags);
626	}	1891	}
627	}	1892	}
628		1893
629	=item $player->ext_reply ($msgid, $msgtype, %msg)	1894	=item $player_object->may ("access")
630		1895
631	Sends an ext reply to the player.	1896	Returns wether the given player is authorized to access resource "access"
		1897	(e.g. "command_wizcast").
632		1898
633	=cut	1899	=cut
634		1900
635	sub cf::player::ext_reply($$$%) {	1901	sub cf::object::player::may {
		1902	my ($self, $access) = @_;
		1903
		1904	$self->flag (cf::FLAG_WIZ) ||
		1905	(ref $cf::CFG{"may_$access"}
		1906	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1907	: $cf::CFG{"may_$access"})
		1908	}
		1909
		1910	=item $player_object->enter_link
		1911
		1912	Freezes the player and moves him/her to a special map (C<{link}>).
		1913
		1914	The player should be reasonably safe there for short amounts of time. You
		1915	I<MUST> call C<leave_link> as soon as possible, though.
		1916
		1917	Will never block.
		1918
		1919	=item $player_object->leave_link ($map, $x, $y)
		1920
		1921	Moves the player out of the special C<{link}> map onto the specified
		1922	map. If the map is not valid (or omitted), the player will be moved back
		1923	to the location he/she was before the call to C<enter_link>, or, if that
		1924	fails, to the emergency map position.
		1925
		1926	Might block.
		1927
		1928	=cut
		1929
		1930	sub link_map {
		1931	unless ($LINK_MAP) {
		1932	$LINK_MAP = cf::map::find "{link}"
		1933	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1934	$LINK_MAP->load;
		1935	}
		1936
		1937	$LINK_MAP
		1938	}
		1939
		1940	sub cf::object::player::enter_link {
		1941	my ($self) = @_;
		1942
		1943	$self->deactivate_recursive;
		1944
		1945	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1946
		1947	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1948	if $self->map && $self->map->{path} ne "{link}";
		1949
		1950	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1951	}
		1952
		1953	sub cf::object::player::leave_link {
		1954	my ($self, $map, $x, $y) = @_;
		1955
		1956	return unless $self->contr->active;
		1957
		1958	my $link_pos = delete $self->{_link_pos};
		1959
		1960	unless ($map) {
		1961	# restore original map position
		1962	($map, $x, $y) = @{ $link_pos || [] };
		1963	$map = cf::map::find $map;
		1964
		1965	unless ($map) {
		1966	($map, $x, $y) = @$EMERGENCY_POSITION;
		1967	$map = cf::map::find $map
		1968	or die "FATAL: cannot load emergency map\n";
		1969	}
		1970	}
		1971
		1972	($x, $y) = (-1, -1)
		1973	unless (defined $x) && (defined $y);
		1974
		1975	# use -1 or undef as default coordinates, not 0, 0
		1976	($x, $y) = ($map->enter_x, $map->enter_y)
		1977	if $x <=0 && $y <= 0;
		1978
		1979	$map->load;
		1980	$map->load_diag;
		1981
		1982	return unless $self->contr->active;
		1983	$self->activate_recursive;
		1984
		1985	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1986	$self->enter_map ($map, $x, $y);
		1987	}
		1988
		1989	=item $player_object->goto ($path, $x, $y[, $check->($map)])
		1990
		1991	Moves the player to the given map-path and coordinates by first freezing
		1992	her, loading and preparing them map, calling the provided $check callback
		1993	that has to return the map if sucecssful, and then unfreezes the player on
		1994	the new (success) or old (failed) map position.
		1995
		1996	=cut
		1997
		1998	our $GOTOGEN;
		1999
		2000	sub cf::object::player::goto {
		2001	my ($self, $path, $x, $y, $check) = @_;
		2002
		2003	# do generation counting so two concurrent goto's will be executed in-order
		2004	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
		2005
		2006	$self->enter_link;
		2007
		2008	(async {
		2009	my $map = eval {
		2010	my $map = cf::map::find $path;
		2011
		2012	if ($map) {
		2013	$map = $map->customise_for ($self);
		2014	$map = $check->($map) if $check && $map;
		2015	} else {
		2016	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2017	}
		2018
		2019	$map
		2020	};
		2021
		2022	if ($@) {
		2023	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2024	LOG llevError | logBacktrace, Carp::longmess $@;
		2025	}
		2026
		2027	if ($gen == $self->{_goto_generation}) {
		2028	delete $self->{_goto_generation};
		2029	$self->leave_link ($map, $x, $y);
		2030	}
		2031	})->prio (1);
		2032	}
		2033
		2034	=item $player_object->enter_exit ($exit_object)
		2035
		2036	=cut
		2037
		2038	sub parse_random_map_params {
		2039	my ($spec) = @_;
		2040
		2041	my $rmp = { # defaults
		2042	xsize => (cf::rndm 15, 40),
		2043	ysize => (cf::rndm 15, 40),
		2044	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		2045	#layout => string,
		2046	};
		2047
		2048	for (split /\n/, $spec) {
		2049	my ($k, $v) = split /\s+/, $_, 2;
		2050
		2051	$rmp->{lc $k} = $v if (length $k) && (length $v);
		2052	}
		2053
		2054	$rmp
		2055	}
		2056
		2057	sub prepare_random_map {
		2058	my ($exit) = @_;
		2059
		2060	my $guard = cf::lock_acquire "exit_prepare:$exit";
		2061
		2062	# all this does is basically replace the /! path by
		2063	# a new random map path (?random/...) with a seed
		2064	# that depends on the exit object
		2065
		2066	my $rmp = parse_random_map_params $exit->msg;
		2067
		2068	if ($exit->map) {
		2069	$rmp->{region} = $exit->region->name;
		2070	$rmp->{origin_map} = $exit->map->path;
		2071	$rmp->{origin_x} = $exit->x;
		2072	$rmp->{origin_y} = $exit->y;
		2073	}
		2074
		2075	$rmp->{random_seed} ||= $exit->random_seed;
		2076
		2077	my $data = cf::to_json $rmp;
		2078	my $md5 = Digest::MD5::md5_hex $data;
		2079	my $meta = "$RANDOMDIR/$md5.meta";
		2080
		2081	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		2082	aio_write $fh, 0, (length $data), $data, 0;
		2083	undef $fh;
		2084	aio_rename "$meta~", $meta;
		2085
		2086	$exit->slaying ("?random/$md5");
		2087	$exit->msg (undef);
		2088	}
		2089	}
		2090
		2091	sub cf::object::player::enter_exit {
		2092	my ($self, $exit) = @_;
		2093
		2094	return unless $self->type == cf::PLAYER;
		2095
		2096	if ($exit->slaying eq "/!") {
		2097	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2098	# the problem is that $exit might not survive long enough
		2099	# so it needs to be done right now, right here
		2100	cf::sync_job { prepare_random_map $exit };
		2101	}
		2102
		2103	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		2104	my $hp = $exit->stats->hp;
		2105	my $sp = $exit->stats->sp;
		2106
		2107	$self->enter_link;
		2108
		2109	(async {
		2110	$self->deactivate_recursive; # just to be sure
		2111	unless (eval {
		2112	$self->goto ($slaying, $hp, $sp);
		2113
		2114	1;
		2115	}) {
		2116	$self->message ("Something went wrong deep within the crossfire server. "
		2117	. "I'll try to bring you back to the map you were before. "
		2118	. "Please report this to the dungeon master!",
		2119	cf::NDI_UNIQUE | cf::NDI_RED);
		2120
		2121	warn "ERROR in enter_exit: $@";
		2122	$self->leave_link;
		2123	}
		2124	})->prio (1);
		2125	}
		2126
		2127	=head3 cf::client
		2128
		2129	=over 4
		2130
		2131	=item $client->send_drawinfo ($text, $flags)
		2132
		2133	Sends a drawinfo packet to the client. Circumvents output buffering so
		2134	should not be used under normal circumstances.
		2135
		2136	=cut
		2137
		2138	sub cf::client::send_drawinfo {
		2139	my ($self, $text, $flags) = @_;
		2140
		2141	utf8::encode $text;
		2142	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2143	}
		2144
		2145	=item $client->ext_event ($type, %msg)
		2146
		2147	Sends an exti event to the client.
		2148
		2149	=cut
		2150
		2151	sub cf::client::ext_event($$%) {
636	my ($self, $id, %msg) = @_;	2152	my ($self, $type, %msg) = @_;
637		2153
638	$msg{msgid} = $id;	2154	$msg{msgtype} = "event_$type";
639
640	$self->send ("ext " . to_json \%msg);	2155	$self->send_packet ("ext " . cf::to_json \%msg);
641	}	2156	}
642		2157
643	#############################################################################	2158	=item $success = $client->query ($flags, "text", \&cb)
644	# map scripting support	2159
		2160	Queues a query to the client, calling the given callback with
		2161	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2162	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2163
		2164	Queries can fail, so check the return code. Or don't, as queries will become
		2165	reliable at some point in the future.
		2166
		2167	=cut
		2168
		2169	sub cf::client::query {
		2170	my ($self, $flags, $text, $cb) = @_;
		2171
		2172	return unless $self->state == ST_PLAYING
		2173	|| $self->state == ST_SETUP
		2174	|| $self->state == ST_CUSTOM;
		2175
		2176	$self->state (ST_CUSTOM);
		2177
		2178	utf8::encode $text;
		2179	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2180
		2181	$self->send_packet ($self->{query_queue}[0][0])
		2182	if @{ $self->{query_queue} } == 1;
		2183	}
		2184
		2185	cf::client->attach (
		2186	on_reply => sub {
		2187	my ($ns, $msg) = @_;
		2188
		2189	# this weird shuffling is so that direct followup queries
		2190	# get handled first
		2191	my $queue = delete $ns->{query_queue}
		2192	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2193
		2194	(shift @$queue)->[1]->($msg);
		2195	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2196
		2197	push @{ $ns->{query_queue} }, @$queue;
		2198
		2199	if (@{ $ns->{query_queue} } == @$queue) {
		2200	if (@$queue) {
		2201	$ns->send_packet ($ns->{query_queue}[0][0]);
		2202	} else {
		2203	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2204	}
		2205	}
		2206	},
		2207	);
		2208
		2209	=item $client->async (\&cb)
		2210
		2211	Create a new coroutine, running the specified callback. The coroutine will
		2212	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2213	or loss of connection).
		2214
		2215	=cut
		2216
		2217	sub cf::client::async {
		2218	my ($self, $cb) = @_;
		2219
		2220	my $coro = &Coro::async ($cb);
		2221
		2222	$coro->on_destroy (sub {
		2223	delete $self->{_coro}{$coro+0};
		2224	});
		2225
		2226	$self->{_coro}{$coro+0} = $coro;
		2227
		2228	$coro
		2229	}
		2230
		2231	cf::client->attach (
		2232	on_destroy => sub {
		2233	my ($ns) = @_;
		2234
		2235	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2236	},
		2237	);
		2238
		2239	=back
		2240
		2241
		2242	=head2 SAFE SCRIPTING
		2243
		2244	Functions that provide a safe environment to compile and execute
		2245	snippets of perl code without them endangering the safety of the server
		2246	itself. Looping constructs, I/O operators and other built-in functionality
		2247	is not available in the safe scripting environment, and the number of
		2248	functions and methods that can be called is greatly reduced.
		2249
		2250	=cut
645		2251
646	our $safe = new Safe "safe";	2252	our $safe = new Safe "safe";
647	our $safe_hole = new Safe::Hole;	2253	our $safe_hole = new Safe::Hole;
648		2254
649	$SIG{FPE} = 'IGNORE';	2255	$SIG{FPE} = 'IGNORE';
650		2256
651	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2257	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
652		2258
653	# here we export the classes and methods available to script code	2259	# here we export the classes and methods available to script code
654		2260
		2261	=pod
		2262
		2263	The following functions and methods are available within a safe environment:
		2264
		2265	cf::object contr pay_amount pay_player map
		2266	cf::object::player player
		2267	cf::player peaceful
		2268	cf::map trigger
		2269
		2270	=cut
		2271
655	for (	2272	for (
656	["cf::object" => qw(contr pay_amount pay_player)],	2273	["cf::object" => qw(contr pay_amount pay_player map)],
657	["cf::object::player" => qw(player)],	2274	["cf::object::player" => qw(player)],
658	["cf::player" => qw(peaceful)],	2275	["cf::player" => qw(peaceful)],
		2276	["cf::map" => qw(trigger)],
659	) {	2277	) {
660	no strict 'refs';	2278	no strict 'refs';
661	my ($pkg, @funs) = @$_;	2279	my ($pkg, @funs) = @$_;
662	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2280	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
663	for @funs;	2281	for @funs;
664	}	2282	}
		2283
		2284	=over 4
		2285
		2286	=item @retval = safe_eval $code, [var => value, ...]
		2287
		2288	Compiled and executes the given perl code snippet. additional var/value
		2289	pairs result in temporary local (my) scalar variables of the given name
		2290	that are available in the code snippet. Example:
		2291
		2292	my $five = safe_eval '$first + $second', first => 1, second => 4;
		2293
		2294	=cut
665		2295
666	sub safe_eval($;@) {	2296	sub safe_eval($;@) {
667	my ($code, %vars) = @_;	2297	my ($code, %vars) = @_;
668		2298
669	my $qcode = $code;	2299	my $qcode = $code;
…		…
692	}	2322	}
693		2323
694	wantarray ? @res : $res[0]	2324	wantarray ? @res : $res[0]
695	}	2325	}
696		2326
		2327	=item cf::register_script_function $function => $cb
		2328
		2329	Register a function that can be called from within map/npc scripts. The
		2330	function should be reasonably secure and should be put into a package name
		2331	like the extension.
		2332
		2333	Example: register a function that gets called whenever a map script calls
		2334	C<rent::overview>, as used by the C<rent> extension.
		2335
		2336	cf::register_script_function "rent::overview" => sub {
		2337	...
		2338	};
		2339
		2340	=cut
		2341
697	sub register_script_function {	2342	sub register_script_function {
698	my ($fun, $cb) = @_;	2343	my ($fun, $cb) = @_;
699		2344
700	no strict 'refs';	2345	no strict 'refs';
701	*{"safe::$fun"} = $safe_hole->wrap ($cb);	2346	*{"safe::$fun"} = $safe_hole->wrap ($cb);
702	}	2347	}
703		2348
		2349	=back
		2350
		2351	=cut
		2352
704	#############################################################################	2353	#############################################################################
705	# the server's main()	2354
		2355	=head2 EXTENSION DATABASE SUPPORT
		2356
		2357	Crossfire maintains a very simple database for extension use. It can
		2358	currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
		2359	convert to/from binary).
		2360
		2361	The parameter C<$family> should best start with the name of the extension
		2362	using it, it should be unique.
		2363
		2364	=over 4
		2365
		2366	=item $value = cf::db_get $family => $key
		2367
		2368	Returns a single value from the database.
		2369
		2370	=item cf::db_put $family => $key => $value
		2371
		2372	Stores the given C<$value> in the family.
		2373
		2374	=cut
		2375
		2376	our $DB;
		2377
		2378	sub db_init {
		2379	unless ($DB) {
		2380	$DB = BDB::db_create $DB_ENV;
		2381
		2382	cf::sync_job {
		2383	eval {
		2384	$DB->set_flags (BDB::CHKSUM);
		2385
		2386	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2387	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2388	cf::cleanup "db_open(db): $!" if $!;
		2389	};
		2390	cf::cleanup "db_open(db): $@" if $@;
		2391	};
		2392	}
		2393	}
		2394
		2395	sub db_get($$) {
		2396	my $key = "$_[0]/$_[1]";
		2397
		2398	cf::sync_job {
		2399	BDB::db_get $DB, undef, $key, my $data;
		2400
		2401	$! ? ()
		2402	: $data
		2403	}
		2404	}
		2405
		2406	sub db_put($$$) {
		2407	BDB::dbreq_pri 4;
		2408	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		2409	}
		2410
		2411	=item cf::cache $id => [$paths...], $processversion => $process
		2412
		2413	Generic caching function that returns the value of the resource $id,
		2414	caching and regenerating as required.
		2415
		2416	This function can block.
		2417
		2418	=cut
		2419
		2420	sub cache {
		2421	my ($id, $src, $processversion, $process) = @_;
		2422
		2423	my $meta =
		2424	join "\x00",
		2425	$processversion,
		2426	map {
		2427	aio_stat $_
		2428	and Carp::croak "$_: $!";
		2429
		2430	($_, (stat _)[7,9])
		2431	} @$src;
		2432
		2433	my $dbmeta = db_get cache => "$id/meta";
		2434	if ($dbmeta ne $meta) {
		2435	# changed, we may need to process
		2436
		2437	my @data;
		2438	my $md5;
		2439
		2440	for (0 .. $#$src) {
		2441	0 <= aio_load $src->[$_], $data[$_]
		2442	or Carp::croak "$src->[$_]: $!";
		2443	}
		2444
		2445	# if processing is expensive, check
		2446	# checksum first
		2447	if (1) {
		2448	$md5 =
		2449	join "\x00",
		2450	$processversion,
		2451	map {
		2452	Coro::cede;
		2453	($src->[$_], Digest::MD5::md5_hex $data[$_])
		2454	} 0.. $#$src;
		2455
		2456
		2457	my $dbmd5 = db_get cache => "$id/md5";
		2458	if ($dbmd5 eq $md5) {
		2459	db_put cache => "$id/meta", $meta;
		2460
		2461	return db_get cache => "$id/data";
		2462	}
		2463	}
		2464
		2465	my $t1 = Time::HiRes::time;
		2466	my $data = $process->(\@data);
		2467	my $t2 = Time::HiRes::time;
		2468
		2469	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		2470
		2471	db_put cache => "$id/data", $data;
		2472	db_put cache => "$id/md5" , $md5;
		2473	db_put cache => "$id/meta", $meta;
		2474
		2475	return $data;
		2476	}
		2477
		2478	db_get cache => "$id/data"
		2479	}
		2480
		2481	=item fork_call { }, $args
		2482
		2483	Executes the given code block with the given arguments in a seperate
		2484	process, returning the results. Everything must be serialisable with
		2485	Coro::Storable. May, of course, block. Note that the executed sub may
		2486	never block itself or use any form of Event handling.
		2487
		2488	=cut
		2489
		2490	sub fork_call(&@) {
		2491	my ($cb, @args) = @_;
		2492
		2493	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
		2494	# or die "socketpair: $!";
		2495	pipe my $fh1, my $fh2
		2496	or die "pipe: $!";
		2497
		2498	if (my $pid = fork) {
		2499	close $fh2;
		2500
		2501	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
		2502	$res = Coro::Storable::thaw $res;
		2503
		2504	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		2505
		2506	die $$res unless "ARRAY" eq ref $res;
		2507
		2508	return wantarray ? @$res : $res->[-1];
		2509	} else {
		2510	reset_signals;
		2511	local $SIG{__WARN__};
		2512	local $SIG{__DIE__};
		2513	eval {
		2514	close $fh1;
		2515
		2516	my @res = eval { $cb->(@args) };
		2517	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		2518	};
		2519
		2520	warn $@ if $@;
		2521	_exit 0;
		2522	}
		2523	}
		2524
		2525	#############################################################################
		2526	# the server's init and main functions
		2527
		2528	sub load_facedata($) {
		2529	my ($path) = @_;
		2530
		2531	warn "loading facedata from $path\n";
		2532
		2533	my $facedata;
		2534	0 < aio_load $path, $facedata
		2535	or die "$path: $!";
		2536
		2537	$facedata = Coro::Storable::thaw $facedata;
		2538
		2539	$facedata->{version} == 2
		2540	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2541
		2542	{
		2543	my $faces = $facedata->{faceinfo};
		2544
		2545	while (my ($face, $info) = each %$faces) {
		2546	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2547	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2548	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2549	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2550	Coro::cede;
		2551	}
		2552
		2553	while (my ($face, $info) = each %$faces) {
		2554	next unless $info->{smooth};
		2555	my $idx = cf::face::find $face
		2556	or next;
		2557	if (my $smooth = cf::face::find $info->{smooth}) {
		2558	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2559	} else {
		2560	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2561	}
		2562	Coro::cede;
		2563	}
		2564	}
		2565
		2566	{
		2567	my $anims = $facedata->{animinfo};
		2568
		2569	while (my ($anim, $info) = each %$anims) {
		2570	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2571	Coro::cede;
		2572	}
		2573
		2574	cf::anim::invalidate_all; # d'oh
		2575	}
		2576
		2577	1
		2578	}
		2579
		2580	sub reload_regions {
		2581	load_resource_file "$MAPDIR/regions"
		2582	or die "unable to load regions file\n";
		2583	}
		2584
		2585	sub reload_facedata {
		2586	load_facedata "$DATADIR/facedata"
		2587	or die "unable to load facedata\n";
		2588	}
		2589
		2590	sub reload_archetypes {
		2591	load_resource_file "$DATADIR/archetypes"
		2592	or die "unable to load archetypes\n";
		2593	}
		2594
		2595	sub reload_treasures {
		2596	load_resource_file "$DATADIR/treasures"
		2597	or die "unable to load treasurelists\n";
		2598	}
		2599
		2600	sub reload_resources {
		2601	warn "reloading resource files...\n";
		2602
		2603	reload_regions;
		2604	reload_facedata;
		2605	#reload_archetypes;#d#
		2606	reload_archetypes;
		2607	reload_treasures;
		2608
		2609	warn "finished reloading resource files\n";
		2610	}
		2611
		2612	sub init {
		2613	reload_resources;
		2614	}
		2615
		2616	sub cfg_load {
		2617	open my $fh, "<:utf8", "$CONFDIR/config"
		2618	or return;
		2619
		2620	local $/;
		2621	*CFG = YAML::Syck::Load <$fh>;
		2622
		2623	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2624
		2625	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2626	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2627
		2628	if (exists $CFG{mlockall}) {
		2629	eval {
		2630	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2631	and die "WARNING: m(un)lockall failed: $!\n";
		2632	};
		2633	warn $@ if $@;
		2634	}
		2635	}
706		2636
707	sub main {	2637	sub main {
		2638	# we must not ever block the main coroutine
		2639	local $Coro::idle = sub {
		2640	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2641	(async {
		2642	Event::one_event;
		2643	})->prio (Coro::PRIO_MAX);
		2644	};
		2645
		2646	cfg_load;
		2647	db_init;
		2648	load_extensions;
		2649
		2650	$TICK_WATCHER->start;
708	Event::loop;	2651	Event::loop;
709	}	2652	}
710		2653
711	#############################################################################	2654	#############################################################################
712	# initialisation	2655	# initialisation and cleanup
713		2656
714	register "<global>", __PACKAGE__;	2657	# install some emergency cleanup handlers
		2658	BEGIN {
		2659	for my $signal (qw(INT HUP TERM)) {
		2660	Event->signal (
		2661	reentrant => 0,
		2662	data => WF_AUTOCANCEL,
		2663	signal => $signal,
		2664	prio => 0,
		2665	cb => sub {
		2666	cf::cleanup "SIG$signal";
		2667	},
		2668	);
		2669	}
		2670	}
		2671
		2672	sub emergency_save() {
		2673	my $freeze_guard = cf::freeze_mainloop;
		2674
		2675	warn "enter emergency perl save\n";
		2676
		2677	cf::sync_job {
		2678	# use a peculiar iteration method to avoid tripping on perl
		2679	# refcount bugs in for. also avoids problems with players
		2680	# and maps saved/destroyed asynchronously.
		2681	warn "begin emergency player save\n";
		2682	for my $login (keys %cf::PLAYER) {
		2683	my $pl = $cf::PLAYER{$login} or next;
		2684	$pl->valid or next;
		2685	$pl->save;
		2686	}
		2687	warn "end emergency player save\n";
		2688
		2689	warn "begin emergency map save\n";
		2690	for my $path (keys %cf::MAP) {
		2691	my $map = $cf::MAP{$path} or next;
		2692	$map->valid or next;
		2693	$map->save;
		2694	}
		2695	warn "end emergency map save\n";
		2696
		2697	warn "begin emergency database checkpoint\n";
		2698	BDB::db_env_txn_checkpoint $DB_ENV;
		2699	warn "end emergency database checkpoint\n";
		2700	};
		2701
		2702	warn "leave emergency perl save\n";
		2703	}
		2704
		2705	sub post_cleanup {
		2706	my ($make_core) = @_;
		2707
		2708	warn Carp::longmess "post_cleanup backtrace"
		2709	if $make_core;
		2710	}
		2711
		2712	sub do_reload_perl() {
		2713	# can/must only be called in main
		2714	if ($Coro::current != $Coro::main) {
		2715	warn "can only reload from main coroutine";
		2716	return;
		2717	}
		2718
		2719	warn "reloading...";
		2720
		2721	warn "entering sync_job";
		2722
		2723	cf::sync_job {
		2724	cf::write_runtime; # external watchdog should not bark
		2725	cf::emergency_save;
		2726	cf::write_runtime; # external watchdog should not bark
		2727
		2728	warn "syncing database to disk";
		2729	BDB::db_env_txn_checkpoint $DB_ENV;
		2730
		2731	# if anything goes wrong in here, we should simply crash as we already saved
		2732
		2733	warn "cancelling all WF_AUTOCANCEL watchers";
		2734	for (Event::all_watchers) {
		2735	$_->cancel if $_->data & WF_AUTOCANCEL;
		2736	}
		2737
		2738	warn "flushing outstanding aio requests";
		2739	for (;;) {
		2740	BDB::flush;
		2741	IO::AIO::flush;
		2742	Coro::cede;
		2743	last unless IO::AIO::nreqs || BDB::nreqs;
		2744	warn "iterate...";
		2745	}
		2746
		2747	++$RELOAD;
		2748
		2749	warn "cancelling all extension coros";
		2750	$_->cancel for values %EXT_CORO;
		2751	%EXT_CORO = ();
		2752
		2753	warn "removing commands";
		2754	%COMMAND = ();
		2755
		2756	warn "removing ext commands";
		2757	%EXTCMD = ();
		2758
		2759	warn "unloading/nuking all extensions";
		2760	for my $pkg (@EXTS) {
		2761	warn "... unloading $pkg";
		2762
		2763	if (my $cb = $pkg->can ("unload")) {
		2764	eval {
		2765	$cb->($pkg);
		2766	1
		2767	} or warn "$pkg unloaded, but with errors: $@";
		2768	}
		2769
		2770	warn "... nuking $pkg";
		2771	Symbol::delete_package $pkg;
		2772	}
		2773
		2774	warn "unloading all perl modules loaded from $LIBDIR";
		2775	while (my ($k, $v) = each %INC) {
		2776	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2777
		2778	warn "... unloading $k";
		2779	delete $INC{$k};
		2780
		2781	$k =~ s/\.pm$//;
		2782	$k =~ s/\//::/g;
		2783
		2784	if (my $cb = $k->can ("unload_module")) {
		2785	$cb->();
		2786	}
		2787
		2788	Symbol::delete_package $k;
		2789	}
		2790
		2791	warn "getting rid of safe::, as good as possible";
		2792	Symbol::delete_package "safe::$_"
		2793	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2794
		2795	warn "unloading cf.pm \"a bit\"";
		2796	delete $INC{"cf.pm"};
		2797	delete $INC{"cf/pod.pm"};
		2798
		2799	# don't, removes xs symbols, too,
		2800	# and global variables created in xs
		2801	#Symbol::delete_package __PACKAGE__;
		2802
		2803	warn "unload completed, starting to reload now";
		2804
		2805	warn "reloading cf.pm";
		2806	require cf;
		2807	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2808
		2809	warn "loading config and database again";
		2810	cf::cfg_load;
		2811
		2812	warn "loading extensions";
		2813	cf::load_extensions;
		2814
		2815	warn "reattaching attachments to objects/players";
		2816	_global_reattach; # objects, sockets
		2817	warn "reattaching attachments to maps";
		2818	reattach $_ for values %MAP;
		2819	warn "reattaching attachments to players";
		2820	reattach $_ for values %PLAYER;
		2821
		2822	warn "leaving sync_job";
		2823
		2824	1
		2825	} or do {
		2826	warn $@;
		2827	warn "error while reloading, exiting.";
		2828	exit 1;
		2829	};
		2830
		2831	warn "reloaded";
		2832	};
		2833
		2834	our $RELOAD_WATCHER; # used only during reload
		2835
		2836	sub reload_perl() {
		2837	# doing reload synchronously and two reloads happen back-to-back,
		2838	# coro crashes during coro_state_free->destroy here.
		2839
		2840	$RELOAD_WATCHER ||= Event->timer (
		2841	reentrant => 0,
		2842	after => 0,
		2843	data => WF_AUTOCANCEL,
		2844	cb => sub {
		2845	do_reload_perl;
		2846	undef $RELOAD_WATCHER;
		2847	},
		2848	);
		2849	}
		2850
		2851	register_command "reload" => sub {
		2852	my ($who, $arg) = @_;
		2853
		2854	if ($who->flag (FLAG_WIZ)) {
		2855	$who->message ("reloading server.");
		2856	async { reload_perl };
		2857	}
		2858	};
715		2859
716	unshift @INC, $LIBDIR;	2860	unshift @INC, $LIBDIR;
717		2861
718	load_extensions;	2862	my $bug_warning = 0;
719		2863
		2864	our @WAIT_FOR_TICK;
		2865	our @WAIT_FOR_TICK_BEGIN;
		2866
		2867	sub wait_for_tick {
		2868	return unless $TICK_WATCHER->is_active;
		2869	return if $Coro::current == $Coro::main;
		2870
		2871	my $signal = new Coro::Signal;
		2872	push @WAIT_FOR_TICK, $signal;
		2873	$signal->wait;
		2874	}
		2875
		2876	sub wait_for_tick_begin {
		2877	return unless $TICK_WATCHER->is_active;
		2878	return if $Coro::current == $Coro::main;
		2879
		2880	my $signal = new Coro::Signal;
		2881	push @WAIT_FOR_TICK_BEGIN, $signal;
		2882	$signal->wait;
		2883	}
		2884
		2885	my $min = 1e6;#d#
		2886	my $avg = 10;
720	$TICK_WATCHER = Event->timer (	2887	$TICK_WATCHER = Event->timer (
		2888	reentrant => 0,
		2889	parked => 1,
721	prio => 1,	2890	prio => 0,
722	at => $NEXT_TICK || 1,	2891	at => $NEXT_TICK || $TICK,
		2892	data => WF_AUTOCANCEL,
723	cb => sub {	2893	cb => sub {
		2894	if ($Coro::current != $Coro::main) {
		2895	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2896	unless ++$bug_warning > 10;
		2897	return;
		2898	}
		2899
		2900	$NOW = $tick_start = Event::time;
		2901
724	cf::server_tick; # one server iteration	2902	cf::server_tick; # one server iteration
725		2903
		2904	0 && sync_job {#d#
		2905	for(1..10) {
726	my $NOW = Event::time;	2906	my $t = Event::time;
		2907	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		2908	or die;
		2909
		2910	$map->width (50);
		2911	$map->height (50);
		2912	$map->alloc;
		2913	$map->_load_objects ("/tmp/x.map", 1);
		2914	my $t = Event::time - $t;
		2915
		2916	#next unless $t < 0.0013;#d#
		2917	if ($t < $min) {
		2918	$min = $t;
		2919	}
		2920	$avg = $avg * 0.99 + $t * 0.01;
		2921	}
		2922	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		2923	exit 0;
		2924	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		2925	};
		2926
		2927	$RUNTIME += $TICK;
727	$NEXT_TICK += $TICK;	2928	$NEXT_TICK += $TICK;
728		2929
		2930	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2931	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2932	Coro::async_pool {
		2933	write_runtime
		2934	or warn "ERROR: unable to write runtime file: $!";
		2935	};
		2936	}
		2937
		2938	# my $AFTER = Event::time;
		2939	# warn $AFTER - $NOW;#d#
		2940
		2941	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		2942	$sig->send;
		2943	}
		2944	while (my $sig = shift @WAIT_FOR_TICK) {
		2945	$sig->send;
		2946	}
		2947
		2948	$NOW = Event::time;
		2949
729	# if we are delayed by four ticks, skip them all	2950	# if we are delayed by four ticks or more, skip them all
730	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2951	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
731		2952
732	$TICK_WATCHER->at ($NEXT_TICK);	2953	$TICK_WATCHER->at ($NEXT_TICK);
733	$TICK_WATCHER->start;	2954	$TICK_WATCHER->start;
		2955
		2956	$LOAD = ($NOW - $tick_start) / $TICK;
		2957	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		2958
		2959	_post_tick;
		2960
		2961
734	},	2962	},
735	);	2963	);
736		2964
		2965	{
		2966	BDB::max_poll_time $TICK * 0.1;
		2967	$BDB_POLL_WATCHER = Event->io (
		2968	reentrant => 0,
		2969	fd => BDB::poll_fileno,
		2970	poll => 'r',
		2971	prio => 0,
		2972	data => WF_AUTOCANCEL,
		2973	cb => \&BDB::poll_cb,
		2974	);
		2975	BDB::min_parallel 8;
		2976
		2977	BDB::set_sync_prepare {
		2978	my $status;
		2979	my $current = $Coro::current;
		2980	(
		2981	sub {
		2982	$status = $!;
		2983	$current->ready; undef $current;
		2984	},
		2985	sub {
		2986	Coro::schedule while defined $current;
		2987	$! = $status;
		2988	},
		2989	)
		2990	};
		2991
		2992	unless ($DB_ENV) {
		2993	$DB_ENV = BDB::db_env_create;
		2994
		2995	cf::sync_job {
		2996	eval {
		2997	BDB::db_env_open
		2998	$DB_ENV,
		2999	$BDBDIR,
		3000	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		3001	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		3002	0666;
		3003
		3004	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
		3005
		3006	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		3007	$DB_ENV->set_lk_detect;
		3008	};
		3009
		3010	cf::cleanup "db_env_open(db): $@" if $@;
		3011	};
		3012	}
		3013	}
		3014
		3015	{
		3016	IO::AIO::min_parallel 8;
		3017
		3018	undef $Coro::AIO::WATCHER;
		3019	IO::AIO::max_poll_time $TICK * 0.1;
		3020	$AIO_POLL_WATCHER = Event->io (
		3021	reentrant => 0,
		3022	data => WF_AUTOCANCEL,
		3023	fd => IO::AIO::poll_fileno,
		3024	poll => 'r',
		3025	prio => 6,
		3026	cb => \&IO::AIO::poll_cb,
		3027	);
		3028	}
		3029
		3030	my $_log_backtrace;
		3031
		3032	sub _log_backtrace {
		3033	my ($msg, @addr) = @_;
		3034
		3035	$msg =~ s/\n//;
		3036
		3037	# limit the # of concurrent backtraces
		3038	if ($_log_backtrace < 2) {
		3039	++$_log_backtrace;
		3040	async {
		3041	my @bt = fork_call {
		3042	@addr = map { sprintf "%x", $_ } @addr;
		3043	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3044	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3045	or die "addr2line: $!";
		3046
		3047	my @funcs;
		3048	my @res = <$fh>;
		3049	chomp for @res;
		3050	while (@res) {
		3051	my ($func, $line) = splice @res, 0, 2, ();
		3052	push @funcs, "[$func] $line";
		3053	}
		3054
		3055	@funcs
		3056	};
		3057
		3058	LOG llevInfo, "[ABT] $msg\n";
		3059	LOG llevInfo, "[ABT] $_\n" for @bt;
		3060	--$_log_backtrace;
		3061	};
		3062	} else {
		3063	LOG llevInfo, "[ABT] $msg\n";
		3064	LOG llevInfo, "[ABT] [suppressed]\n";
		3065	}
		3066	}
		3067
		3068	# load additional modules
		3069	use cf::pod;
		3070
		3071	END { cf::emergency_save }
		3072
737	1	3073	1
738		3074

Diff Legend

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