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

Diff Legend

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