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

Diff Legend

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