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.209 by root, Mon Feb 12 01:25:55 2007 UTC vs.
Revision 1.283 by root, Sun Jun 24 04:09:29 2007 UTC

…		…
3	use utf8;	3	use utf8;
4	use strict;	4	use strict;
5		5
6	use Symbol;	6	use Symbol;
7	use List::Util;	7	use List::Util;
		8	use Socket;
8	use Storable;	9	use Storable;
		10	use Event;
9	use Opcode;	11	use Opcode;
10	use Safe;	12	use Safe;
11	use Safe::Hole;	13	use Safe::Hole;
12		14
13	use Coro 3.5 ();	15	use Coro 3.61 ();
		16	use Coro::State;
		17	use Coro::Handle;
14	use Coro::Event;	18	use Coro::Event;
15	use Coro::Timer;	19	use Coro::Timer;
16	use Coro::Signal;	20	use Coro::Signal;
17	use Coro::Semaphore;	21	use Coro::Semaphore;
18	use Coro::AIO;	22	use Coro::AIO;
		23	use Coro::Storable;
19		24
20	use BDB ();	25	use BDB ();
21	use Data::Dumper;	26	use Data::Dumper;
22	use Digest::MD5;	27	use Digest::MD5;
23	use Fcntl;	28	use Fcntl;
		29	use YAML::Syck ();
24	use IO::AIO 2.32 ();	30	use IO::AIO 2.32 ();
25	use YAML::Syck ();
26	use Time::HiRes;	31	use Time::HiRes;
27	use Compress::LZF;	32	use Compress::LZF;
28		33
		34	# configure various modules to our taste
		35	#
		36	$Storable::canonical = 1; # reduce rsync transfers
		37	Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later	38	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30		39
31	use Event; $Event::Eval = 1; # no idea why this is required, but it is	40	$Event::Eval = 1; # no idea why this is required, but it is
32
33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34		41
35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	42	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36	$YAML::Syck::ImplicitUnicode = 1;	43	$YAML::Syck::ImplicitUnicode = 1;
37		44
38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority	45	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
		46
		47	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
39		48
40	our %COMMAND = ();	49	our %COMMAND = ();
41	our %COMMAND_TIME = ();	50	our %COMMAND_TIME = ();
42		51
43	our @EXTS = (); # list of extension package names	52	our @EXTS = (); # list of extension package names
44	our %EXTCMD = ();	53	our %EXTCMD = ();
45	our %EXT_CORO = (); # coroutines bound to extensions	54	our %EXT_CORO = (); # coroutines bound to extensions
46	our %EXT_MAP = (); # pluggable maps	55	our %EXT_MAP = (); # pluggable maps
47		56
		57	our $RELOAD; # number of reloads so far
48	our @EVENT;	58	our @EVENT;
49	our $LIBDIR = datadir . "/ext";
50		59
51	our $TICK = MAX_TIME * 1e-6;	60	our $CONFDIR = confdir;
		61	our $DATADIR = datadir;
		62	our $LIBDIR = "$DATADIR/ext";
		63	our $PODDIR = "$DATADIR/pod";
		64	our $MAPDIR = "$DATADIR/" . mapdir;
		65	our $LOCALDIR = localdir;
		66	our $TMPDIR = "$LOCALDIR/" . tmpdir;
		67	our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
		68	our $PLAYERDIR = "$LOCALDIR/" . playerdir;
		69	our $RANDOMDIR = "$LOCALDIR/random";
		70	our $BDBDIR = "$LOCALDIR/db";
		71
		72	our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52	our $TICK_WATCHER;	73	our $TICK_WATCHER;
53	our $AIO_POLL_WATCHER;	74	our $AIO_POLL_WATCHER;
54	our $WRITE_RUNTIME_WATCHER;	75	our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55	our $NEXT_TICK;	76	our $NEXT_TICK;
56	our $NOW;	77	our $NOW;
57	our $USE_FSYNC = 1; # use fsync to write maps - default off	78	our $USE_FSYNC = 1; # use fsync to write maps - default off
58		79
59	our $BDB_POLL_WATCHER;	80	our $BDB_POLL_WATCHER;
…		…
65	our $RUNTIME;	86	our $RUNTIME;
66		87
67	our %PLAYER; # all users	88	our %PLAYER; # all users
68	our %MAP; # all maps	89	our %MAP; # all maps
69	our $LINK_MAP; # the special {link} map, which is always available	90	our $LINK_MAP; # the special {link} map, which is always available
70	our $RANDOM_MAPS = cf::localdir . "/random";
71	our $BDB_ENV_DIR = cf::localdir . "/db";
72
73	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75		91
76	# used to convert map paths into valid unix filenames by replacing / by ∕	92	# used to convert map paths into valid unix filenames by replacing / by ∕
77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons	93	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78		94
		95	our $LOAD; # a number between 0 (idle) and 1 (too many objects)
		96	our $LOADAVG; # same thing, but with alpha-smoothing
		97	our $tick_start; # for load detecting purposes
		98
79	binmode STDOUT;	99	binmode STDOUT;
80	binmode STDERR;	100	binmode STDERR;
81		101
82	# read virtual server time, if available	102	# read virtual server time, if available
83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {	103	unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84	open my $fh, "<", cf::localdir . "/runtime"	104	open my $fh, "<", "$LOCALDIR/runtime"
85	or die "unable to read runtime file: $!";	105	or die "unable to read runtime file: $!";
86	$RUNTIME = <$fh> + 0.;	106	$RUNTIME = <$fh> + 0.;
87	}	107	}
88		108
89	mkdir cf::localdir;	109	mkdir $_
90	mkdir cf::localdir . "/" . cf::playerdir;	110	for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91	mkdir cf::localdir . "/" . cf::tmpdir;
92	mkdir cf::localdir . "/" . cf::uniquedir;
93	mkdir $RANDOM_MAPS;
94	mkdir $BDB_ENV_DIR;
95		111
96	our $EMERGENCY_POSITION;	112	our $EMERGENCY_POSITION;
97		113
98	sub cf::map::normalise;	114	sub cf::map::normalise;
99		115
…		…
110	=item $cf::RUNTIME	126	=item $cf::RUNTIME
111		127
112	The time this server has run, starts at 0 and is increased by $cf::TICK on	128	The time this server has run, starts at 0 and is increased by $cf::TICK on
113	every server tick.	129	every server tick.
114		130
115	=item $cf::LIBDIR	131	=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
		132	$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
		133	$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116		134
117	The perl library directory, where extensions and cf-specific modules can	135	Various directories - "/etc", read-only install directory, perl-library
118	be found. It will be added to C<@INC> automatically.	136	directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
		137	unique-items directory, player file directory, random maps directory and
		138	database environment.
119		139
120	=item $cf::NOW	140	=item $cf::NOW
121		141
122	The time of the last (current) server tick.	142	The time of the last (current) server tick.
123		143
124	=item $cf::TICK	144	=item $cf::TICK
125		145
126	The interval between server ticks, in seconds.	146	The interval between server ticks, in seconds.
		147
		148	=item $cf::LOADAVG
		149
		150	The current CPU load on the server (alpha-smoothed), as a value between 0
		151	(none) and 1 (overloaded), indicating how much time is spent on processing
		152	objects per tick. Healthy values are < 0.5.
		153
		154	=item $cf::LOAD
		155
		156	The raw value load value from the last tick.
127		157
128	=item %cf::CFG	158	=item %cf::CFG
129		159
130	Configuration for the server, loaded from C</etc/crossfire/config>, or	160	Configuration for the server, loaded from C</etc/crossfire/config>, or
131	from wherever your confdir points to.	161	from wherever your confdir points to.
132		162
133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE	163	=item cf::wait_for_tick, cf::wait_for_tick_begin
134		164
135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)	165	These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick	166	returns directly I<after> the tick processing (and consequently, can only wake one process
137	processing has been done. Call C<< ->wait >> on them to maximise the	167	per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138	window of cpu time available, or simply to synchronise to the server tick.
139		168
140	=back	169	=back
141		170
142	=cut	171	=cut
143		172
144	BEGIN {	173	BEGIN {
145	*CORE::GLOBAL::warn = sub {	174	*CORE::GLOBAL::warn = sub {
146	my $msg = join "", @_;	175	my $msg = join "", @_;
147	utf8::encode $msg;
148		176
149	$msg .= "\n"	177	$msg .= "\n"
150	unless $msg =~ /\n$/;	178	unless $msg =~ /\n$/;
151		179
		180	$msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
		181
		182	utf8::encode $msg;
152	LOG llevError, $msg;	183	LOG llevError, $msg;
153	};	184	};
154	}	185	}
155		186
156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	187	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	188	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';	189	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';	190	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';	191	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
		192	@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	193	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162		194
163	# we bless all objects into (empty) derived classes to force a method lookup	195	# we bless all objects into (empty) derived classes to force a method lookup
164	# within the Safe compartment.	196	# within the Safe compartment.
165	for my $pkg (qw(	197	for my $pkg (qw(
166	cf::global cf::attachable	198	cf::global cf::attachable
…		…
174	}	206	}
175		207
176	$Event::DIED = sub {	208	$Event::DIED = sub {
177	warn "error in event callback: @_";	209	warn "error in event callback: @_";
178	};	210	};
		211
		212	#############################################################################
179		213
180	=head2 UTILITY FUNCTIONS	214	=head2 UTILITY FUNCTIONS
181		215
182	=over 4	216	=over 4
183		217
…		…
202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;	236	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203	$d	237	$d
204	} || "[unable to dump $_[0]: '$@']";	238	} || "[unable to dump $_[0]: '$@']";
205	}	239	}
206		240
207	use JSON::Syck (); # TODO# replace by JSON::PC once working	241	use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
208		242
209	=item $ref = cf::from_json $json	243	=item $ref = cf::from_json $json
210		244
211	Converts a JSON string into the corresponding perl data structure.	245	Converts a JSON string into the corresponding perl data structure.
212		246
213	=cut
214
215	sub from_json($) {
216	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217	JSON::Syck::Load $_[0]
218	}
219
220	=item $json = cf::to_json $ref	247	=item $json = cf::to_json $ref
221		248
222	Converts a perl data structure into its JSON representation.	249	Converts a perl data structure into its JSON representation.
223
224	=cut
225
226	sub to_json($) {
227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
228	JSON::Syck::Dump $_[0]
229	}
230		250
231	=item cf::lock_wait $string	251	=item cf::lock_wait $string
232		252
233	Wait until the given lock is available. See cf::lock_acquire.	253	Wait until the given lock is available. See cf::lock_acquire.
234		254
…		…
240	returned.	260	returned.
241		261
242	Lock names should begin with a unique identifier (for example, cf::map::find	262	Lock names should begin with a unique identifier (for example, cf::map::find
243	uses map_find and cf::map::load uses map_load).	263	uses map_find and cf::map::load uses map_load).
244		264
		265	=item $locked = cf::lock_active $string
		266
		267	Return true if the lock is currently active, i.e. somebody has locked it.
		268
245	=cut	269	=cut
246		270
247	our %LOCK;	271	our %LOCK;
248		272
249	sub lock_wait($) {	273	sub lock_wait($) {
…		…
268	# wake up all waiters, to be on the safe side	292	# wake up all waiters, to be on the safe side
269	$_->ready for @{ delete $LOCK{$key} };	293	$_->ready for @{ delete $LOCK{$key} };
270	}	294	}
271	}	295	}
272		296
		297	sub lock_active($) {
		298	my ($key) = @_;
		299
		300	! ! $LOCK{$key}
		301	}
		302
273	sub freeze_mainloop {	303	sub freeze_mainloop {
274	return unless $TICK_WATCHER->is_active;	304	return unless $TICK_WATCHER->is_active;
275		305
276	my $guard = Coro::guard {	306	my $guard = Coro::guard {
277	$TICK_WATCHER->start;	307	$TICK_WATCHER->start;
278	$WRITE_RUNTIME_WATCHER->start;
279	};	308	};
280	$WRITE_RUNTIME_WATCHER->stop;
281	$TICK_WATCHER->stop;	309	$TICK_WATCHER->stop;
282	$guard	310	$guard
283	}	311	}
284		312
285	=item cf::async { BLOCK }	313	=item cf::async { BLOCK }
…		…
292		320
293	BEGIN { *async = \&Coro::async_pool }	321	BEGIN { *async = \&Coro::async_pool }
294		322
295	=item cf::sync_job { BLOCK }	323	=item cf::sync_job { BLOCK }
296		324
297	The design of crossfire+ requires that the main coro ($Coro::main) is	325	The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298	always able to handle events or runnable, as crossfire+ is only partly	326	is always able to handle events or runnable, as Crossfire TRT is only
299	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.	327	partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
		328	acceptable.
300		329
301	If it must be done, put the blocking parts into C<sync_job>. This will run	330	If it must be done, put the blocking parts into C<sync_job>. This will run
302	the given BLOCK in another coroutine while waiting for the result. The	331	the given BLOCK in another coroutine while waiting for the result. The
303	server will be frozen during this time, so the block should either finish	332	server will be frozen during this time, so the block should either finish
304	fast or be very important.	333	fast or be very important.
…		…
307		336
308	sub sync_job(&) {	337	sub sync_job(&) {
309	my ($job) = @_;	338	my ($job) = @_;
310		339
311	if ($Coro::current == $Coro::main) {	340	if ($Coro::current == $Coro::main) {
		341	my $time = Event::time;
		342
312	# this is the main coro, too bad, we have to block	343	# this is the main coro, too bad, we have to block
313	# till the operation succeeds, freezing the server :/	344	# till the operation succeeds, freezing the server :/
314		345
315	# TODO: use suspend/resume instead	346	# TODO: use suspend/resume instead
316	# (but this is cancel-safe)	347	# (but this is cancel-safe)
…		…
327		358
328	while ($busy) {	359	while ($busy) {
329	Coro::cede or Event::one_event;	360	Coro::cede or Event::one_event;
330	}	361	}
331		362
		363	$time = Event::time - $time;
		364
		365	LOG llevError | logBacktrace, Carp::longmess "long sync job"
		366	if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
		367
		368	$tick_start += $time; # do not account sync jobs to server load
		369
332	wantarray ? @res : $res[0]	370	wantarray ? @res : $res[0]
333	} else {	371	} else {
334	# we are in another coroutine, how wonderful, everything just works	372	# we are in another coroutine, how wonderful, everything just works
335		373
336	$job->()	374	$job->()
…		…
355	$EXT_CORO{$coro+0} = $coro;	393	$EXT_CORO{$coro+0} = $coro;
356		394
357	$coro	395	$coro
358	}	396	}
359		397
360	sub write_runtime {	398	=item fork_call { }, $args
361	my $runtime = cf::localdir . "/runtime";
362		399
363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644	400	Executes the given code block with the given arguments in a seperate
364	or return;	401	process, returning the results. Everything must be serialisable with
		402	Coro::Storable. May, of course, block. Note that the executed sub may
		403	never block itself or use any form of Event handling.
365		404
366	my $value = $cf::RUNTIME + 90 + 10;	405	=cut
367	# 10 is the runtime save interval, for a monotonic clock
368	# 60 allows for the watchdog to kill the server.
369		406
370	(aio_write $fh, 0, (length $value), $value, 0) <= 0	407	sub fork_call(&@) {
371	and return;	408	my ($cb, @args) = @_;
372		409
373	# always fsync - this file is important	410	# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
374	aio_fsync $fh	411	# or die "socketpair: $!";
375	and return;	412	pipe my $fh1, my $fh2
		413	or die "pipe: $!";
376		414
		415	if (my $pid = fork) {
377	close $fh	416	close $fh2;
378	or return;
379		417
380	aio_rename "$runtime~", $runtime	418	my $res = (Coro::Handle::unblock $fh1)->readline (undef);
381	and return;	419	$res = Coro::Storable::thaw $res;
382		420
		421	waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
		422
		423	die $$res unless "ARRAY" eq ref $res;
		424
		425	return wantarray ? @$res : $res->[-1];
		426	} else {
		427	reset_signals;
		428	local $SIG{__WARN__};
		429	local $SIG{__DIE__};
		430	eval {
		431	close $fh1;
		432
		433	my @res = eval { $cb->(@args) };
		434	syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
		435	};
		436
		437	warn $@ if $@;
		438	_exit 0;
383	1	439	}
		440	}
		441
		442	=item $value = cf::db_get $family => $key
		443
		444	Returns a single value from the environment database.
		445
		446	=item cf::db_put $family => $key => $value
		447
		448	Stores the given C<$value> in the family. It can currently store binary
		449	data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
		450
		451	=cut
		452
		453	our $DB;
		454
		455	sub db_init {
		456	unless ($DB) {
		457	$DB = BDB::db_create $DB_ENV;
		458
		459	cf::sync_job {
		460	eval {
		461	$DB->set_flags (BDB::CHKSUM);
		462
		463	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		464	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		465	cf::cleanup "db_open(db): $!" if $!;
		466	};
		467	cf::cleanup "db_open(db): $@" if $@;
		468	};
		469	}
		470	}
		471
		472	sub db_get($$) {
		473	my $key = "$_[0]/$_[1]";
		474
		475	cf::sync_job {
		476	BDB::db_get $DB, undef, $key, my $data;
		477
		478	$! ? ()
		479	: $data
		480	}
		481	}
		482
		483	sub db_put($$$) {
		484	BDB::dbreq_pri 4;
		485	BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
		486	}
		487
		488	=item cf::cache $id => [$paths...], $processversion => $process
		489
		490	Generic caching function that returns the value of the resource $id,
		491	caching and regenerating as required.
		492
		493	This function can block.
		494
		495	=cut
		496
		497	sub cache {
		498	my ($id, $src, $processversion, $process) = @_;
		499
		500	my $meta =
		501	join "\x00",
		502	$processversion,
		503	map {
		504	aio_stat $_
		505	and Carp::croak "$_: $!";
		506
		507	($_, (stat _)[7,9])
		508	} @$src;
		509
		510	my $dbmeta = db_get cache => "$id/meta";
		511	if ($dbmeta ne $meta) {
		512	# changed, we may need to process
		513
		514	my @data;
		515	my $md5;
		516
		517	for (0 .. $#$src) {
		518	0 <= aio_load $src->[$_], $data[$_]
		519	or Carp::croak "$src->[$_]: $!";
		520	}
		521
		522	# if processing is expensive, check
		523	# checksum first
		524	if (1) {
		525	$md5 =
		526	join "\x00",
		527	$processversion,
		528	map {
		529	Coro::cede;
		530	($src->[$_], Digest::MD5::md5_hex $data[$_])
		531	} 0.. $#$src;
		532
		533
		534	my $dbmd5 = db_get cache => "$id/md5";
		535	if ($dbmd5 eq $md5) {
		536	db_put cache => "$id/meta", $meta;
		537
		538	return db_get cache => "$id/data";
		539	}
		540	}
		541
		542	my $t1 = Time::HiRes::time;
		543	my $data = $process->(\@data);
		544	my $t2 = Time::HiRes::time;
		545
		546	warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
		547
		548	db_put cache => "$id/data", $data;
		549	db_put cache => "$id/md5" , $md5;
		550	db_put cache => "$id/meta", $meta;
		551
		552	return $data;
		553	}
		554
		555	db_get cache => "$id/data"
		556	}
		557
		558	=item cf::datalog type => key => value, ...
		559
		560	Log a datalog packet of the given type with the given key-value pairs.
		561
		562	=cut
		563
		564	sub datalog($@) {
		565	my ($type, %kv) = @_;
		566	warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384	}	567	}
385		568
386	=back	569	=back
387		570
388	=cut	571	=cut
…		…
395	attach callbacks/event handlers (a collection of which is called an "attachment")	578	attach callbacks/event handlers (a collection of which is called an "attachment")
396	to it. All such attachable objects support the following methods.	579	to it. All such attachable objects support the following methods.
397		580
398	In the following description, CLASS can be any of C<global>, C<object>	581	In the following description, CLASS can be any of C<global>, C<object>
399	C<player>, C<client> or C<map> (i.e. the attachable objects in	582	C<player>, C<client> or C<map> (i.e. the attachable objects in
400	crossfire+).	583	Crossfire TRT).
401		584
402	=over 4	585	=over 4
403		586
404	=item $attachable->attach ($attachment, key => $value...)	587	=item $attachable->attach ($attachment, key => $value...)
405		588
…		…
568	$registry = $CB_TYPE[$object_type] ||= [];	751	$registry = $CB_TYPE[$object_type] ||= [];
569		752
570	} elsif ($type eq "subtype") {	753	} elsif ($type eq "subtype") {
571	defined $object_type or Carp::croak "subtype specified without type";	754	defined $object_type or Carp::croak "subtype specified without type";
572	my $object_subtype = shift @arg;	755	my $object_subtype = shift @arg;
573	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];	756	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574		757
575	} elsif ($type eq "package") {	758	} elsif ($type eq "package") {
576	my $pkg = shift @arg;	759	my $pkg = shift @arg;
577		760
578	while (my ($name, $id) = each %cb_id) {	761	while (my ($name, $id) = each %cb_id) {
…		…
607	_attach $registry, $klass, @attach;	790	_attach $registry, $klass, @attach;
608	}	791	}
609		792
610	$obj->{$name} = \%arg;	793	$obj->{$name} = \%arg;
611	} else {	794	} else {
612	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' which is not available, postponing.\n";
613	}	796	}
614		797
615	$obj->{_attachment}{$name} = undef;	798	$obj->{_attachment}{$name} = undef;
616	}	799	}
617		800
…		…
619	if (ref $_[0]) {	802	if (ref $_[0]) {
620	_object_attach @_;	803	_object_attach @_;
621	} else {	804	} else {
622	_attach shift->_attach_registry, @_;	805	_attach shift->_attach_registry, @_;
623	}	806	}
		807	_recalc_want;
624	};	808	};
625		809
626	# all those should be optimised	810	# all those should be optimised
627	sub cf::attachable::detach {	811	sub cf::attachable::detach {
628	my ($obj, $name) = @_;	812	my ($obj, $name) = @_;
…		…
631	delete $obj->{_attachment}{$name};	815	delete $obj->{_attachment}{$name};
632	reattach ($obj);	816	reattach ($obj);
633	} else {	817	} else {
634	Carp::croak "cannot, currently, detach class attachments";	818	Carp::croak "cannot, currently, detach class attachments";
635	}	819	}
		820	_recalc_want;
636	};	821	};
637		822
638	sub cf::attachable::attached {	823	sub cf::attachable::attached {
639	my ($obj, $name) = @_;	824	my ($obj, $name) = @_;
640		825
…		…
787	}	972	}
788	} else {	973	} else {
789	aio_unlink $filename;	974	aio_unlink $filename;
790	aio_unlink "$filename.pst";	975	aio_unlink "$filename.pst";
791	}	976	}
792
793	#d##TODO# nuke non .map-files if exist
794	if ($filename =~ s/\.map$//) {
795	aio_unlink $filename;
796	aio_unlink "$filename.pst";
797	}
798	}	977	}
799	}	978	}
800		979
801	sub object_freezer_as_string {	980	sub object_freezer_as_string {
802	my ($rdata, $objs) = @_;	981	my ($rdata, $objs) = @_;
…		…
808		987
809	sub object_thawer_load {	988	sub object_thawer_load {
810	my ($filename) = @_;	989	my ($filename) = @_;
811		990
812	my ($data, $av);	991	my ($data, $av);
813
814	#d#TODO remove .map if file does not exist
815	aio_stat $filename and $filename =~ s/\.map$//;
816		992
817	(aio_load $filename, $data) >= 0	993	(aio_load $filename, $data) >= 0
818	or return;	994	or return;
819		995
820	unless (aio_stat "$filename.pst") {	996	unless (aio_stat "$filename.pst") {
…		…
822	or return;	998	or return;
823	$av = eval { (Storable::thaw $av)->{objs} };	999	$av = eval { (Storable::thaw $av)->{objs} };
824	}	1000	}
825		1001
826	warn sprintf "loading %s (%d)\n",	1002	warn sprintf "loading %s (%d)\n",
827	$filename, length $data, scalar @{$av || []};#d#	1003	$filename, length $data, scalar @{$av || []};
828	return ($data, $av);	1004	return ($data, $av);
829	}	1005	}
		1006
		1007	=head2 COMMAND CALLBACKS
		1008
		1009	=over 4
		1010
		1011	=cut
830		1012
831	#############################################################################	1013	#############################################################################
832	# command handling &c	1014	# command handling &c
833		1015
834	=item cf::register_command $name => \&callback($ob,$args);	1016	=item cf::register_command $name => \&callback($ob,$args);
…		…
847	push @{ $COMMAND{$name} }, [$caller, $cb];	1029	push @{ $COMMAND{$name} }, [$caller, $cb];
848	}	1030	}
849		1031
850	=item cf::register_extcmd $name => \&callback($pl,$packet);	1032	=item cf::register_extcmd $name => \&callback($pl,$packet);
851		1033
852	Register a callbackf ro execution when the client sends an extcmd packet.	1034	Register a callback fro execution when the client sends an extcmd packet.
853		1035
854	If the callback returns something, it is sent back as if reply was being	1036	If the callback returns something, it is sent back as if reply was being
855	called.	1037	called.
856		1038
857	=cut	1039	=cut
…		…
892		1074
893	cf::override;	1075	cf::override;
894	},	1076	},
895	);	1077	);
896		1078
897	sub load_extension {
898	my ($path) = @_;
899
900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
901	my $base = $1;
902	my $pkg = $1;
903	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "ext::$pkg";
905
906	warn "... loading '$path' into '$pkg'\n";
907
908	open my $fh, "<:utf8", $path
909	or die "$path: $!";
910
911	my $source =
912	"package $pkg; use strict; use utf8;\n"
913	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })
915	. "\n};\n1";
916
917	unless (eval $source) {
918	my $msg = $@ ? "$path: $@\n"
919	: "extension disabled.\n";
920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921	warn $@;
922	warn "mandatory extension failed to load, exiting.\n";
923	exit 1;
924	}
925	die $@;
926	}
927
928	push @EXTS, $pkg;
929	}
930
931	sub load_extensions {	1079	sub load_extensions {
		1080	cf::sync_job {
		1081	my %todo;
		1082
932	for my $ext (<$LIBDIR/*.ext>) {	1083	for my $path (<$LIBDIR/*.ext>) {
933	next unless -r $ext;	1084	next unless -r $path;
934	eval {	1085
935	load_extension $ext;	1086	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
		1087	my $base = $1;
		1088	my $pkg = $1;
		1089	$pkg =~ s/[^[:word:]]/_/g;
		1090	$pkg = "ext::$pkg";
		1091
		1092	open my $fh, "<:utf8", $path
		1093	or die "$path: $!";
		1094
		1095	my $source = do { local $/; <$fh> };
		1096
		1097	my %ext = (
		1098	path => $path,
		1099	base => $base,
		1100	pkg => $pkg,
		1101	);
		1102
		1103	$ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
		1104	if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
		1105
		1106	$ext{source} =
		1107	"package $pkg; use strict; use utf8;\n"
		1108	. "#line 1 \"$path\"\n{\n"
		1109	. $source
		1110	. "\n};\n1";
		1111
		1112	$todo{$base} = \%ext;
		1113	}
		1114
		1115	my %done;
		1116	while (%todo) {
		1117	my $progress;
		1118
		1119	while (my ($k, $v) = each %todo) {
		1120	for (split /,\s*/, $v->{meta}{depends}) {
		1121	goto skip
		1122	unless exists $done{$_};
		1123	}
		1124
		1125	warn "... loading '$k' into '$v->{pkg}'\n";
		1126
		1127	unless (eval $v->{source}) {
		1128	my $msg = $@ ? "$v->{path}: $@\n"
		1129	: "$v->{base}: extension inactive.\n";
		1130
		1131	if (exists $v->{meta}{mandatory}) {
		1132	warn $msg;
		1133	warn "mandatory extension failed to load, exiting.\n";
		1134	exit 1;
		1135	}
		1136
		1137	warn $msg;
		1138	}
		1139
		1140	$done{$k} = delete $todo{$k};
		1141	push @EXTS, $v->{pkg};
		1142	$progress = 1;
936	1	1143	}
937	} or warn "$ext not loaded: $@";	1144
		1145	skip:
		1146	die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
		1147	unless $progress;
		1148	}
938	}	1149	};
939	}	1150	}
940		1151
941	#############################################################################	1152	#############################################################################
942		1153
		1154	=back
		1155
943	=head2 CORE EXTENSIONS	1156	=head2 CORE EXTENSIONS
944		1157
945	Functions and methods that extend core crossfire objects.	1158	Functions and methods that extend core crossfire objects.
946		1159
947	=cut	1160	=cut
…		…
959	Returns the given player object, loading it if necessary (might block).	1172	Returns the given player object, loading it if necessary (might block).
960		1173
961	=cut	1174	=cut
962		1175
963	sub playerdir($) {	1176	sub playerdir($) {
964	cf::localdir	1177	"$PLAYERDIR/"
965	. "/"
966	. cf::playerdir
967	. "/"
968	. (ref $_[0] ? $_[0]->ob->name : $_[0])	1178	. (ref $_[0] ? $_[0]->ob->name : $_[0])
969	}	1179	}
970		1180
971	sub path($) {	1181	sub path($) {
972	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];	1182	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973		1183
974	(playerdir $login) . "/$login.pl"	1184	(playerdir $login) . "/playerdata"
975	}	1185	}
976		1186
977	sub find_active($) {	1187	sub find_active($) {
978	$cf::PLAYER{$_[0]}	1188	$cf::PLAYER{$_[0]}
979	and $cf::PLAYER{$_[0]}->active	1189	and $cf::PLAYER{$_[0]}->active
…		…
992	my $login = $_[0];	1202	my $login = $_[0];
993		1203
994	my $guard = cf::lock_acquire "user_find:$login";	1204	my $guard = cf::lock_acquire "user_find:$login";
995		1205
996	$cf::PLAYER{$_[0]} || do {	1206	$cf::PLAYER{$_[0]} || do {
		1207	# rename old playerfiles to new ones
		1208	#TODO: remove when no longer required
		1209	aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
		1210	aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
		1211	aio_unlink +(playerdir $login) . "/$login.pl.pst";
		1212	aio_unlink +(playerdir $login) . "/$login.pl";
		1213
997	my $pl = load_pl path $login	1214	my $pl = load_pl path $login
998	or return;	1215	or return;
999	$cf::PLAYER{$login} = $pl	1216	$cf::PLAYER{$login} = $pl
1000	}	1217	}
1001	}	1218	}
…		…
1038		1255
1039	=cut	1256	=cut
1040		1257
1041	sub quit_character {	1258	sub quit_character {
1042	my ($pl) = @_;	1259	my ($pl) = @_;
		1260
		1261	my $name = $pl->ob->name;
1043		1262
1044	$pl->{deny_save} = 1;	1263	$pl->{deny_save} = 1;
1045	$pl->password ("*"); # this should lock out the player until we nuked the dir	1264	$pl->password ("*"); # this should lock out the player until we nuked the dir
1046		1265
1047	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;	1266	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
…		…
1052	my $path = playerdir $pl;	1271	my $path = playerdir $pl;
1053	my $temp = "$path~$cf::RUNTIME~deleting~";	1272	my $temp = "$path~$cf::RUNTIME~deleting~";
1054	aio_rename $path, $temp;	1273	aio_rename $path, $temp;
1055	delete $cf::PLAYER{$pl->ob->name};	1274	delete $cf::PLAYER{$pl->ob->name};
1056	$pl->destroy;	1275	$pl->destroy;
		1276
		1277	my $prefix = qr<^~\Q$name\E/>;
		1278
		1279	# nuke player maps
		1280	$cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
		1281
1057	IO::AIO::aio_rmtree $temp;	1282	IO::AIO::aio_rmtree $temp;
		1283	}
		1284
		1285	=item $pl->kick
		1286
		1287	Kicks a player out of the game. This destroys the connection.
		1288
		1289	=cut
		1290
		1291	sub kick {
		1292	my ($pl, $kicker) = @_;
		1293
		1294	$pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
		1295	$pl->killer ("kicked");
		1296	$pl->ns->destroy;
1058	}	1297	}
1059		1298
1060	=item cf::player::list_logins	1299	=item cf::player::list_logins
1061		1300
1062	Returns am arrayref of all valid playernames in the system, can take a	1301	Returns am arrayref of all valid playernames in the system, can take a
1063	while and may block, so not sync_job-capable, ever.	1302	while and may block, so not sync_job-capable, ever.
1064		1303
1065	=cut	1304	=cut
1066		1305
1067	sub list_logins {	1306	sub list_logins {
1068	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir	1307	my $dirs = aio_readdir $PLAYERDIR
1069	or return [];	1308	or return [];
1070		1309
1071	my @logins;	1310	my @logins;
1072		1311
1073	for my $login (@$dirs) {	1312	for my $login (@$dirs) {
…		…
1108	}	1347	}
1109		1348
1110	\@paths	1349	\@paths
1111	}	1350	}
1112		1351
		1352	=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
		1353
		1354	Expand crossfire pod fragments into protocol xml.
		1355
		1356	=cut
		1357
		1358	sub expand_cfpod {
		1359	((my $self), (local $_)) = @_;
		1360
		1361	# escape & and <
		1362	s/&/&amp;/g;
		1363	s/(?<![BIUGH])</&lt;/g;
		1364
		1365	# this is buggy, it needs to properly take care of nested <'s
		1366
		1367	1 while
		1368	# replace B<>, I<>, U<> etc.
		1369	s/B<([^\>]*)>/<b>$1<\/b>/
		1370	|| s/I<([^\>]*)>/<i>$1<\/i>/
		1371	|| s/U<([^\>]*)>/<u>$1<\/u>/
		1372	# replace G<male|female> tags
		1373	|| s{G<([^>|]*)\|([^>]*)>}{
		1374	$self->gender ? $2 : $1
		1375	}ge
		1376	# replace H<hint text>
		1377	|| s/H<([^\>]*)>/<fg name="lightblue">[$1]<\/fg>/g;
		1378
		1379	# create single paragraphs (very hackish)
		1380	s/(?<=\S)\n(?=\w)/ /g;
		1381
		1382	$_
		1383	}
		1384
1113	=item $player->ext_reply ($msgid, $msgtype, %msg)	1385	=item $player->ext_reply ($msgid, %msg)
1114		1386
1115	Sends an ext reply to the player.	1387	Sends an ext reply to the player.
1116		1388
1117	=cut	1389	=cut
1118		1390
1119	sub ext_reply($$$%) {	1391	sub ext_reply($$%) {
1120	my ($self, $id, %msg) = @_;	1392	my ($self, $id, %msg) = @_;
1121		1393
1122	$msg{msgid} = $id;	1394	$msg{msgid} = $id;
1123		1395
1124	$self->send ("ext " . cf::to_json \%msg);	1396	$self->send ("ext " . cf::to_json \%msg);
1125	}	1397	}
1126		1398
1127	package cf;	1399	=item $player->ext_event ($type, %msg)
		1400
		1401	Sends an ext event to the client.
		1402
		1403	=cut
		1404
		1405	sub ext_event($$%) {
		1406	my ($self, $type, %msg) = @_;
		1407
		1408	$self->ns->ext_event ($type, %msg);
		1409	}
		1410
		1411	=head3 cf::region
		1412
		1413	=over 4
		1414
		1415	=cut
		1416
		1417	package cf::region;
		1418
		1419	=item cf::region::find_by_path $path
		1420
		1421	Tries to decuce the likely region for a map knowing only its path.
		1422
		1423	=cut
		1424
		1425	sub find_by_path($) {
		1426	my ($path) = @_;
		1427
		1428	my ($match, $specificity);
		1429
		1430	for my $region (list) {
		1431	if ($region->match && $path =~ $region->match) {
		1432	($match, $specificity) = ($region, $region->specificity)
		1433	if $region->specificity > $specificity;
		1434	}
		1435	}
		1436
		1437	$match
		1438	}
1128		1439
1129	=back	1440	=back
1130
1131		1441
1132	=head3 cf::map	1442	=head3 cf::map
1133		1443
1134	=over 4	1444	=over 4
1135		1445
…		…
1190	my ($self, $merge) = @_;	1500	my ($self, $merge) = @_;
1191		1501
1192	# we have to keep some variables in memory intact	1502	# we have to keep some variables in memory intact
1193	local $self->{path};	1503	local $self->{path};
1194	local $self->{load_path};	1504	local $self->{load_path};
1195	local $self->{deny_save};
1196	local $self->{deny_reset};
1197		1505
1198	$self->SUPER::thawer_merge ($merge);	1506	$self->SUPER::thawer_merge ($merge);
1199	}	1507	}
1200		1508
1201	sub normalise {	1509	sub normalise {
…		…
1273		1581
1274	# the original (read-only) location	1582	# the original (read-only) location
1275	sub load_path {	1583	sub load_path {
1276	my ($self) = @_;	1584	my ($self) = @_;
1277		1585
1278	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}	1586	"$MAPDIR/$self->{path}.map"
1279	}	1587	}
1280		1588
1281	# the temporary/swap location	1589	# the temporary/swap location
1282	sub save_path {	1590	sub save_path {
1283	my ($self) = @_;	1591	my ($self) = @_;
1284		1592
1285	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1593	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path	1594	"$TMPDIR/$path.map"
1287	}	1595	}
1288		1596
1289	# the unique path, undef == no special unique path	1597	# the unique path, undef == no special unique path
1290	sub uniq_path {	1598	sub uniq_path {
1291	my ($self) = @_;	1599	my ($self) = @_;
1292		1600
1293	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;	1601	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path	1602	"$UNIQUEDIR/$path"
1295	}	1603	}
1296		1604
1297	# and all this just because we cannot iterate over	1605	# and all this just because we cannot iterate over
1298	# all maps in C++...	1606	# all maps in C++...
1299	sub change_all_map_light {	1607	sub change_all_map_light {
…		…
1301		1609
1302	$_->change_map_light ($change)	1610	$_->change_map_light ($change)
1303	for grep $_->outdoor, values %cf::MAP;	1611	for grep $_->outdoor, values %cf::MAP;
1304	}	1612	}
1305		1613
		1614	sub decay_objects {
		1615	my ($self) = @_;
		1616
		1617	return if $self->{deny_reset};
		1618
		1619	$self->do_decay_objects;
		1620	}
		1621
1306	sub unlink_save {	1622	sub unlink_save {
1307	my ($self) = @_;	1623	my ($self) = @_;
1308		1624
1309	utf8::encode (my $save = $self->save_path);	1625	utf8::encode (my $save = $self->save_path);
1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;	1626	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";	1627	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313	#d#TODO remove .map and also nuke
1314	$save =~ s/\.map// or return;#d#
1315	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317	}	1628	}
1318		1629
1319	sub load_header_from($) {	1630	sub load_header_from($) {
1320	my ($self, $path) = @_;	1631	my ($self, $path) = @_;
1321		1632
…		…
1371	$self->load_header_orig	1682	$self->load_header_orig
1372	or return;	1683	or return;
1373	$self->prepare_orig;	1684	$self->prepare_orig;
1374	}	1685	}
1375		1686
		1687	$self->{deny_reset} = 1
		1688	if $self->no_reset;
		1689
		1690	$self->default_region (cf::region::find_by_path $self->{path})
		1691	unless $self->default_region;
		1692
1376	1	1693	1
1377	}	1694	}
1378		1695
1379	sub find;	1696	sub find;
1380	sub find {	1697	sub find {
…		…
1392	$map->{last_save} = $cf::RUNTIME;	1709	$map->{last_save} = $cf::RUNTIME;
1393		1710
1394	$map->load_header	1711	$map->load_header
1395	or return;	1712	or return;
1396		1713
1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)	1714	if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398	# doing this can freeze the server in a sync job, obviously	1715	# doing this can freeze the server in a sync job, obviously
1399	#$cf::WAIT_FOR_TICK->wait;	1716	#$cf::WAIT_FOR_TICK->wait;
1400	$map->reset;	1717	$map->reset;
1401	undef $guard;	1718	undef $guard;
1402	return find $path;	1719	return find $path;
…		…
1413	my ($self) = @_;	1730	my ($self) = @_;
1414		1731
1415	local $self->{deny_reset} = 1; # loading can take a long time	1732	local $self->{deny_reset} = 1; # loading can take a long time
1416		1733
1417	my $path = $self->{path};	1734	my $path = $self->{path};
		1735
		1736	{
1418	my $guard = cf::lock_acquire "map_load:$path";	1737	my $guard = cf::lock_acquire "map_load:$path";
1419		1738
1420	return if $self->in_memory != cf::MAP_SWAPPED;	1739	return if $self->in_memory != cf::MAP_SWAPPED;
1421		1740
1422	$self->in_memory (cf::MAP_LOADING);	1741	$self->in_memory (cf::MAP_LOADING);
1423		1742
1424	$self->alloc;	1743	$self->alloc;
1425		1744
1426	$self->pre_load;	1745	$self->pre_load;
1427
1428	$self->_load_objects ($self->{load_path}, 1)
1429	or return;
1430
1431	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432	if delete $self->{load_original};
1433
1434	if (my $uniq = $self->uniq_path) {
1435	utf8::encode $uniq;
1436	if (aio_open $uniq, O_RDONLY, 0) {
1437	$self->clear_unique_items;
1438	$self->_load_objects ($uniq, 0);
1439	}
1440	}
1441
1442	Coro::cede;
1443
1444	# now do the right thing for maps
1445	$self->link_multipart_objects;
1446
1447	unless ($self->{deny_activate}) {
1448	$self->decay_objects;
1449	$self->fix_auto_apply;
1450	$self->update_buttons;
1451	Coro::cede;	1746	Coro::cede;
1452	$self->set_darkness_map;	1747
		1748	$self->_load_objects ($self->{load_path}, 1)
		1749	or return;
		1750
		1751	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1752	if delete $self->{load_original};
		1753
		1754	if (my $uniq = $self->uniq_path) {
		1755	utf8::encode $uniq;
		1756	if (aio_open $uniq, O_RDONLY, 0) {
		1757	$self->clear_unique_items;
		1758	$self->_load_objects ($uniq, 0);
		1759	}
		1760	}
		1761
		1762	Coro::cede;
		1763	# now do the right thing for maps
		1764	$self->link_multipart_objects;
1453	$self->difficulty ($self->estimate_difficulty)	1765	$self->difficulty ($self->estimate_difficulty)
1454	unless $self->difficulty;	1766	unless $self->difficulty;
1455	Coro::cede;	1767	Coro::cede;
		1768
		1769	unless ($self->{deny_activate}) {
		1770	$self->decay_objects;
		1771	$self->fix_auto_apply;
		1772	$self->update_buttons;
		1773	Coro::cede;
		1774	$self->set_darkness_map;
		1775	Coro::cede;
1456	$self->activate;	1776	$self->activate;
		1777	}
		1778
		1779	$self->in_memory (cf::MAP_IN_MEMORY);
1457	}	1780	}
1458		1781
1459	$self->post_load;	1782	$self->post_load;
1460
1461	$self->in_memory (cf::MAP_IN_MEMORY);
1462	}	1783	}
1463		1784
1464	sub customise_for {	1785	sub customise_for {
1465	my ($self, $ob) = @_;	1786	my ($self, $ob) = @_;
1466		1787
1467	return find "~" . $ob->name . "/" . $self->{path}	1788	return find "~" . $ob->name . "/" . $self->{path}
1468	if $self->per_player;	1789	if $self->per_player;
		1790
		1791	# return find "?party/" . $ob->name . "/" . $self->{path}
		1792	# if $self->per_party;
1469		1793
1470	$self	1794	$self
1471	}	1795	}
1472		1796
1473	# find and load all maps in the 3x3 area around a map	1797	# find and load all maps in the 3x3 area around a map
…		…
1584		1908
1585	sub reset_at {	1909	sub reset_at {
1586	my ($self) = @_;	1910	my ($self) = @_;
1587		1911
1588	# TODO: safety, remove and allow resettable per-player maps	1912	# TODO: safety, remove and allow resettable per-player maps
1589	return 1e99 if $self->isa ("ext::map_per_player");#d#
1590	return 1e99 if $self->{deny_reset};	1913	return 1e99 if $self->{deny_reset};
1591		1914
1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;	1915	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;	1916	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594		1917
…		…
1605	my ($self) = @_;	1928	my ($self) = @_;
1606		1929
1607	my $lock = cf::lock_acquire "map_data:$self->{path}";	1930	my $lock = cf::lock_acquire "map_data:$self->{path}";
1608		1931
1609	return if $self->players;	1932	return if $self->players;
1610	return if $self->isa ("ext::map_per_player");#d#
1611		1933
1612	warn "resetting map ", $self->path;#d#	1934	warn "resetting map ", $self->path;
		1935
		1936	$self->in_memory (cf::MAP_SWAPPED);
		1937
		1938	# need to save uniques path
		1939	unless ($self->{deny_save}) {
		1940	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1941
		1942	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1943	if $uniq;
		1944	}
1613		1945
1614	delete $cf::MAP{$self->path};	1946	delete $cf::MAP{$self->path};
1615		1947
1616	$self->in_memory (cf::MAP_SWAPPED);
1617	$self->clear;	1948	$self->clear;
1618		1949
1619	$_->clear_links_to ($self) for values %cf::MAP;	1950	$_->clear_links_to ($self) for values %cf::MAP;
1620		1951
1621	$self->unlink_save;	1952	$self->unlink_save;
…		…
1640	$cf::MAP{$self->path} = $self;	1971	$cf::MAP{$self->path} = $self;
1641		1972
1642	$self->reset; # polite request, might not happen	1973	$self->reset; # polite request, might not happen
1643	}	1974	}
1644		1975
		1976	=item $maps = cf::map::tmp_maps
		1977
		1978	Returns an arrayref with all map paths of currently instantiated and saved
		1979	maps. May block.
		1980
		1981	=cut
		1982
		1983	sub tmp_maps() {
		1984	[
		1985	map {
		1986	utf8::decode $_;
		1987	/\.map$/
		1988	? normalise $_
		1989	: ()
		1990	} @{ aio_readdir $TMPDIR or [] }
		1991	]
		1992	}
		1993
		1994	=item $maps = cf::map::random_maps
		1995
		1996	Returns an arrayref with all map paths of currently instantiated and saved
		1997	random maps. May block.
		1998
		1999	=cut
		2000
		2001	sub random_maps() {
		2002	[
		2003	map {
		2004	utf8::decode $_;
		2005	/\.map$/
		2006	? normalise "?random/$_"
		2007	: ()
		2008	} @{ aio_readdir $RANDOMDIR or [] }
		2009	]
		2010	}
		2011
1645	=item cf::map::unique_maps	2012	=item cf::map::unique_maps
1646		2013
1647	Returns an arrayref of paths of all shared maps that have	2014	Returns an arrayref of paths of all shared maps that have
1648	instantiated unique items. May block.	2015	instantiated unique items. May block.
1649		2016
1650	=cut	2017	=cut
1651		2018
1652	sub unique_maps() {	2019	sub unique_maps() {
1653	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir	2020	[
1654	or return;	2021	map {
1655
1656	my @paths;
1657
1658	for (@$files) {
1659	utf8::decode $_;	2022	utf8::decode $_;
1660	next if /\.pst$/;	2023	/\.map$/
1661	next unless /^$PATH_SEP/o;	2024	? normalise $_
1662		2025	: ()
1663	push @paths, cf::map::normalise $_;	2026	} @{ aio_readdir $UNIQUEDIR or [] }
1664	}	2027	]
1665
1666	\@paths
1667	}	2028	}
1668		2029
1669	package cf;	2030	package cf;
1670		2031
1671	=back	2032	=back
…		…
1717		2078
1718	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	2079	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719		2080
1720	if ($self->{record_replies}) {	2081	if ($self->{record_replies}) {
1721	push @{ $self->{record_replies} }, [$npc, $msg, $flags];	2082	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
		2083
1722	} else {	2084	} else {
		2085	my $pl = $self->contr;
		2086
		2087	if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
		2088	my $diag = $pl->{npc_dialog};
		2089	$diag->{pl}->ext_reply (
		2090	$diag->{id},
		2091	msgtype => "reply",
		2092	msg => $diag->{pl}->expand_cfpod ($msg),
		2093	add_topics => []
		2094	);
		2095
		2096	} else {
1723	$msg = $npc->name . " says: $msg" if $npc;	2097	$msg = $npc->name . " says: $msg" if $npc;
1724	$self->message ($msg, $flags);	2098	$self->message ($msg, $flags);
		2099	}
1725	}	2100	}
1726	}	2101	}
1727		2102
1728	=item $player_object->may ("access")	2103	=item $player_object->may ("access")
1729		2104
…		…
1777	$self->deactivate_recursive;	2152	$self->deactivate_recursive;
1778		2153
1779	return if UNIVERSAL::isa $self->map, "ext::map_link";	2154	return if UNIVERSAL::isa $self->map, "ext::map_link";
1780		2155
1781	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]	2156	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782	if $self->map;	2157	if $self->map && $self->map->{path} ne "{link}";
1783		2158
1784	$self->enter_map ($LINK_MAP || link_map, 10, 10);	2159	$self->enter_map ($LINK_MAP || link_map, 10, 10);
1785	}	2160	}
1786		2161
1787	sub cf::object::player::leave_link {	2162	sub cf::object::player::leave_link {
1788	my ($self, $map, $x, $y) = @_;	2163	my ($self, $map, $x, $y) = @_;
		2164
		2165	return unless $self->contr->active;
1789		2166
1790	my $link_pos = delete $self->{_link_pos};	2167	my $link_pos = delete $self->{_link_pos};
1791		2168
1792	unless ($map) {	2169	unless ($map) {
1793	# restore original map position	2170	# restore original map position
…		…
1811	$map->load;	2188	$map->load;
1812	$map->load_diag;	2189	$map->load_diag;
1813		2190
1814	return unless $self->contr->active;	2191	return unless $self->contr->active;
1815	$self->activate_recursive;	2192	$self->activate_recursive;
		2193
		2194	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1816	$self->enter_map ($map, $x, $y);	2195	$self->enter_map ($map, $x, $y);
1817	}	2196	}
1818		2197
1819	cf::player->attach (
1820	on_logout => sub {
1821	my ($pl) = @_;
1822
1823	# abort map switching before logout
1824	if ($pl->ob->{_link_pos}) {
1825	cf::sync_job {
1826	$pl->ob->leave_link
1827	};
1828	}
1829	},
1830	on_login => sub {
1831	my ($pl) = @_;
1832
1833	# try to abort aborted map switching on player login :)
1834	# should happen only on crashes
1835	if ($pl->ob->{_link_pos}) {
1836	$pl->ob->enter_link;
1837	(async {
1838	# we need this sleep as the login has a concurrent enter_exit running
1839	# and this sleep increases chances of the player not ending up in scorn
1840	$pl->ob->reply (undef,
1841	"There was an internal problem at your last logout, "
1842	. "the server will try to bring you to your intended destination in a second.",
1843	cf::NDI_RED);
1844	Coro::Timer::sleep 1;
1845	$pl->ob->leave_link;
1846	})->prio (2);
1847	}
1848	},
1849	);
1850
1851	=item $player_object->goto ($path, $x, $y)	2198	=item $player_object->goto ($path, $x, $y[, $check->($map)])
1852		2199
		2200	Moves the player to the given map-path and coordinates by first freezing
		2201	her, loading and preparing them map, calling the provided $check callback
		2202	that has to return the map if sucecssful, and then unfreezes the player on
		2203	the new (success) or old (failed) map position.
		2204
1853	=cut	2205	=cut
		2206
		2207	our $GOTOGEN;
1854		2208
1855	sub cf::object::player::goto {	2209	sub cf::object::player::goto {
1856	my ($self, $path, $x, $y) = @_;	2210	my ($self, $path, $x, $y, $check) = @_;
		2211
		2212	# do generation counting so two concurrent goto's will be executed in-order
		2213	my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857		2214
1858	$self->enter_link;	2215	$self->enter_link;
1859		2216
1860	(async {	2217	(async {
1861	my $map = eval {	2218	my $map = eval {
1862	my $map = cf::map::find $path;	2219	my $map = cf::map::find $path;
		2220
		2221	if ($map) {
1863	$map = $map->customise_for ($self) if $map;	2222	$map = $map->customise_for ($self);
		2223	$map = $check->($map) if $check && $map;
		2224	} else {
		2225	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		2226	}
		2227
1864	$map	2228	$map
		2229	};
		2230
		2231	if ($@) {
		2232	$self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
		2233	LOG llevError | logBacktrace, Carp::longmess $@;
1865	} or	2234	}
1866	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867		2235
		2236	if ($gen == $self->{_goto_generation}) {
		2237	delete $self->{_goto_generation};
1868	$self->leave_link ($map, $x, $y);	2238	$self->leave_link ($map, $x, $y);
		2239	}
1869	})->prio (1);	2240	})->prio (1);
1870	}	2241	}
1871		2242
1872	=item $player_object->enter_exit ($exit_object)	2243	=item $player_object->enter_exit ($exit_object)
1873		2244
…		…
1912		2283
1913	$rmp->{random_seed} ||= $exit->random_seed;	2284	$rmp->{random_seed} ||= $exit->random_seed;
1914		2285
1915	my $data = cf::to_json $rmp;	2286	my $data = cf::to_json $rmp;
1916	my $md5 = Digest::MD5::md5_hex $data;	2287	my $md5 = Digest::MD5::md5_hex $data;
1917	my $meta = "$cf::RANDOM_MAPS/$md5.meta";	2288	my $meta = "$RANDOMDIR/$md5.meta";
1918		2289
1919	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {	2290	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920	aio_write $fh, 0, (length $data), $data, 0;	2291	aio_write $fh, 0, (length $data), $data, 0;
1921	undef $fh;	2292	undef $fh;
1922	aio_rename "$meta~", $meta;	2293	aio_rename "$meta~", $meta;
…		…
1931		2302
1932	return unless $self->type == cf::PLAYER;	2303	return unless $self->type == cf::PLAYER;
1933		2304
1934	if ($exit->slaying eq "/!") {	2305	if ($exit->slaying eq "/!") {
1935	#TODO: this should de-fi-ni-te-ly not be a sync-job	2306	#TODO: this should de-fi-ni-te-ly not be a sync-job
		2307	# the problem is that $exit might not survive long enough
		2308	# so it needs to be done right now, right here
1936	cf::sync_job { prepare_random_map $exit };	2309	cf::sync_job { prepare_random_map $exit };
1937	}	2310	}
1938		2311
1939	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;	2312	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940	my $hp = $exit->stats->hp;	2313	my $hp = $exit->stats->hp;
…		…
1948	$self->goto ($slaying, $hp, $sp);	2321	$self->goto ($slaying, $hp, $sp);
1949		2322
1950	1;	2323	1;
1951	}) {	2324	}) {
1952	$self->message ("Something went wrong deep within the crossfire server. "	2325	$self->message ("Something went wrong deep within the crossfire server. "
1953	. "I'll try to bring you back to the map you were before. "	2326	. "I'll try to bring you back to the map you were before. "
1954	. "Please report this to the dungeon master!",	2327	. "Please report this to the dungeon master!",
1955	cf::NDI_UNIQUE | cf::NDI_RED);	2328	cf::NDI_UNIQUE | cf::NDI_RED);
1956		2329
1957	warn "ERROR in enter_exit: $@";	2330	warn "ERROR in enter_exit: $@";
1958	$self->leave_link;	2331	$self->leave_link;
1959	}	2332	}
1960	})->prio (1);	2333	})->prio (1);
…		…
1973		2346
1974	sub cf::client::send_drawinfo {	2347	sub cf::client::send_drawinfo {
1975	my ($self, $text, $flags) = @_;	2348	my ($self, $text, $flags) = @_;
1976		2349
1977	utf8::encode $text;	2350	utf8::encode $text;
1978	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);	2351	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979	}	2352	}
1980		2353
		2354	=item $client->send_msg ($color, $type, $msg, [extra...])
		2355
		2356	Send a drawinfo or msg packet to the client, formatting the msg for the
		2357	client if neccessary. C<$type> should be a string identifying the type of
		2358	the message, with C<log> being the default. If C<$color> is negative, suppress
		2359	the message unless the client supports the msg packet.
		2360
		2361	=cut
		2362
		2363	sub cf::client::send_msg {
		2364	my ($self, $color, $type, $msg, @extra) = @_;
		2365
		2366	$msg = $self->pl->expand_cfpod ($msg);
		2367
		2368	if ($self->can_msg) {
		2369	$self->send_packet ("msg " . cf::to_json [$color, $type, $msg, @extra]);
		2370	} else {
		2371	# replace some tags by gcfclient-compatible ones
		2372	for ($msg) {
		2373	1 while
		2374	s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
		2375	|| s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
		2376	|| s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
		2377	|| s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
		2378	|| s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${1}[\/color]/;
		2379	}
		2380
		2381	if ($color >= 0) {
		2382	if ($msg =~ /\[/) {
		2383	$self->send_packet ("drawextinfo $color 4 0 $msg")
		2384	} else {
		2385	$self->send_packet ("drawinfo $color $msg")
		2386	}
		2387	}
		2388	}
		2389	}
		2390
		2391	=item $client->ext_event ($type, %msg)
		2392
		2393	Sends an exti event to the client.
		2394
		2395	=cut
		2396
		2397	sub cf::client::ext_event($$%) {
		2398	my ($self, $type, %msg) = @_;
		2399
		2400	$msg{msgtype} = "event_$type";
		2401	$self->send_packet ("ext " . cf::to_json \%msg);
		2402	}
1981		2403
1982	=item $success = $client->query ($flags, "text", \&cb)	2404	=item $success = $client->query ($flags, "text", \&cb)
1983		2405
1984	Queues a query to the client, calling the given callback with	2406	Queues a query to the client, calling the given callback with
1985	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,	2407	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
…		…
2082		2504
2083	# here we export the classes and methods available to script code	2505	# here we export the classes and methods available to script code
2084		2506
2085	=pod	2507	=pod
2086		2508
2087	The following fucntions and emthods are available within a safe environment:	2509	The following functions and methods are available within a safe environment:
2088		2510
2089	cf::object contr pay_amount pay_player map	2511	cf::object contr pay_amount pay_player map
2090	cf::object::player player	2512	cf::object::player player
2091	cf::player peaceful	2513	cf::player peaceful
2092	cf::map trigger	2514	cf::map trigger
…		…
2173	=back	2595	=back
2174		2596
2175	=cut	2597	=cut
2176		2598
2177	#############################################################################	2599	#############################################################################
2178
2179	=head2 EXTENSION DATABASE SUPPORT
2180
2181	Crossfire maintains a very simple database for extension use. It can
2182	currently store anything that can be serialised using Storable, which
2183	excludes objects.
2184
2185	The parameter C<$family> should best start with the name of the extension
2186	using it, it should be unique.
2187
2188	=over 4
2189
2190	=item $value = cf::db_get $family => $key
2191
2192	Returns a single value from the database.
2193
2194	=item cf::db_put $family => $key => $value
2195
2196	Stores the given C<$value> in the family.
2197
2198	=cut
2199
2200	our $DB;
2201
2202	unless ($DB) {
2203	$DB = BDB::db_create $DB_ENV;
2204
2205	cf::sync_job {
2206	eval {
2207	$DB->set_flags (BDB::CHKSUM);
2208
2209	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2210	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2211	cf::cleanup "db_open(db): $!" if $!;
2212	};
2213	cf::cleanup "db_open(db): $@" if $@;
2214	};
2215
2216	my $path = cf::localdir . "/database.pst";
2217	if (stat $path) {
2218	cf::sync_job {
2219	my $pst = Storable::retrieve $path;
2220
2221	cf::db_put (board => data => $pst->{board});
2222	cf::db_put (guildrules => data => $pst->{guildrules});
2223	cf::db_put (rent => balance => $pst->{rent}{balance});
2224	BDB::db_env_txn_checkpoint $DB_ENV;
2225
2226	unlink $path;
2227	};
2228	}
2229	}
2230
2231	sub db_get($$) {
2232	my $key = "$_[0]/$_[1]";
2233
2234	cf::sync_job {
2235	BDB::db_get $DB, undef, $key, my $data;
2236
2237	$! ? ()
2238	: Compress::LZF::sthaw $data
2239	}
2240	}
2241
2242	sub db_put($$$) {
2243	BDB::dbreq_pri 4;
2244	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2245	}
2246
2247	#############################################################################
2248	# the server's init and main functions	2600	# the server's init and main functions
2249		2601
2250	sub load_resources {	2602	sub load_facedata($) {
2251	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir	2603	my ($path) = @_;
		2604
		2605	warn "loading facedata from $path\n";
		2606
		2607	my $facedata;
		2608	0 < aio_load $path, $facedata
		2609	or die "$path: $!";
		2610
		2611	$facedata = Coro::Storable::thaw $facedata;
		2612
		2613	$facedata->{version} == 2
		2614	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2615
		2616	{
		2617	my $faces = $facedata->{faceinfo};
		2618
		2619	while (my ($face, $info) = each %$faces) {
		2620	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2621	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2622	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2623	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2624	Coro::cede;
		2625	}
		2626
		2627	while (my ($face, $info) = each %$faces) {
		2628	next unless $info->{smooth};
		2629	my $idx = cf::face::find $face
		2630	or next;
		2631	if (my $smooth = cf::face::find $info->{smooth}) {
		2632	cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
		2633	} else {
		2634	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2635	}
		2636	Coro::cede;
		2637	}
		2638	}
		2639
		2640	{
		2641	my $anims = $facedata->{animinfo};
		2642
		2643	while (my ($anim, $info) = each %$anims) {
		2644	cf::anim::set $anim, $info->{frames}, $info->{facings};
		2645	Coro::cede;
		2646	}
		2647
		2648	cf::anim::invalidate_all; # d'oh
		2649	}
		2650
		2651	1
		2652	}
		2653
		2654	sub reload_regions {
		2655	load_resource_file "$MAPDIR/regions"
2252	or die "unable to load regions file\n";#d#	2656	or die "unable to load regions file\n";
		2657	}
		2658
		2659	sub reload_facedata {
		2660	load_facedata "$DATADIR/facedata"
		2661	or die "unable to load facedata\n";
		2662	}
		2663
		2664	sub reload_archetypes {
		2665	load_resource_file "$DATADIR/archetypes"
		2666	or die "unable to load archetypes\n";
		2667	}
		2668
		2669	sub reload_treasures {
		2670	load_resource_file "$DATADIR/treasures"
		2671	or die "unable to load treasurelists\n";
		2672	}
		2673
		2674	sub reload_resources {
		2675	warn "reloading resource files...\n";
		2676
		2677	reload_regions;
		2678	reload_facedata;
		2679	#reload_archetypes;#d#
		2680	reload_archetypes;
		2681	reload_treasures;
		2682
		2683	warn "finished reloading resource files\n";
		2684	}
		2685
		2686	sub init {
		2687	reload_resources;
2253	}	2688	}
2254		2689
2255	sub cfg_load {	2690	sub cfg_load {
2256	open my $fh, "<:utf8", cf::confdir . "/config"	2691	open my $fh, "<:utf8", "$CONFDIR/config"
2257	or return;	2692	or return;
2258		2693
2259	local $/;	2694	local $/;
2260	*CFG = YAML::Syck::Load <$fh>;	2695	*CFG = YAML::Syck::Load <$fh>;
2261		2696
…		…
2269	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"	2704	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2270	and die "WARNING: m(un)lockall failed: $!\n";	2705	and die "WARNING: m(un)lockall failed: $!\n";
2271	};	2706	};
2272	warn $@ if $@;	2707	warn $@ if $@;
2273	}	2708	}
2274	}
2275
2276	sub init {
2277	load_resources;
2278	}	2709	}
2279		2710
2280	sub main {	2711	sub main {
2281	# we must not ever block the main coroutine	2712	# we must not ever block the main coroutine
2282	local $Coro::idle = sub {	2713	local $Coro::idle = sub {
…		…
2285	Event::one_event;	2716	Event::one_event;
2286	})->prio (Coro::PRIO_MAX);	2717	})->prio (Coro::PRIO_MAX);
2287	};	2718	};
2288		2719
2289	cfg_load;	2720	cfg_load;
		2721	db_init;
2290	load_extensions;	2722	load_extensions;
2291		2723
2292	$TICK_WATCHER->start;	2724	$TICK_WATCHER->start;
2293	Event::loop;	2725	Event::loop;
2294	}	2726	}
…		…
2309	},	2741	},
2310	);	2742	);
2311	}	2743	}
2312	}	2744	}
2313		2745
		2746	sub write_runtime {
		2747	my $runtime = "$LOCALDIR/runtime";
		2748
		2749	# first touch the runtime file to show we are still running:
		2750	# the fsync below can take a very very long time.
		2751
		2752	IO::AIO::aio_utime $runtime, undef, undef;
		2753
		2754	my $guard = cf::lock_acquire "write_runtime";
		2755
		2756	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		2757	or return;
		2758
		2759	my $value = $cf::RUNTIME + 90 + 10;
		2760	# 10 is the runtime save interval, for a monotonic clock
		2761	# 60 allows for the watchdog to kill the server.
		2762
		2763	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		2764	and return;
		2765
		2766	# always fsync - this file is important
		2767	aio_fsync $fh
		2768	and return;
		2769
		2770	# touch it again to show we are up-to-date
		2771	aio_utime $fh, undef, undef;
		2772
		2773	close $fh
		2774	or return;
		2775
		2776	aio_rename "$runtime~", $runtime
		2777	and return;
		2778
		2779	warn "runtime file written.\n";
		2780
		2781	1
		2782	}
		2783
2314	sub emergency_save() {	2784	sub emergency_save() {
2315	my $freeze_guard = cf::freeze_mainloop;	2785	my $freeze_guard = cf::freeze_mainloop;
2316		2786
2317	warn "enter emergency perl save\n";	2787	warn "enter emergency perl save\n";
2318		2788
…		…
2342	};	2812	};
2343		2813
2344	warn "leave emergency perl save\n";	2814	warn "leave emergency perl save\n";
2345	}	2815	}
2346		2816
		2817	sub post_cleanup {
		2818	my ($make_core) = @_;
		2819
		2820	warn Carp::longmess "post_cleanup backtrace"
		2821	if $make_core;
		2822	}
		2823
2347	sub reload() {	2824	sub do_reload_perl() {
2348	# can/must only be called in main	2825	# can/must only be called in main
2349	if ($Coro::current != $Coro::main) {	2826	if ($Coro::current != $Coro::main) {
2350	warn "can only reload from main coroutine";	2827	warn "can only reload from main coroutine";
2351	return;	2828	return;
2352	}	2829	}
2353		2830
2354	warn "reloading...";	2831	warn "reloading...";
2355		2832
2356	warn "cancelling server ticker";	2833	warn "entering sync_job";
2357	$TICK_WATCHER->cancel;
2358		2834
		2835	cf::sync_job {
		2836	cf::write_runtime; # external watchdog should not bark
2359	cf::emergency_save;	2837	cf::emergency_save;
		2838	cf::write_runtime; # external watchdog should not bark
2360		2839
2361	eval {	2840	warn "syncing database to disk";
		2841	BDB::db_env_txn_checkpoint $DB_ENV;
		2842
2362	# if anything goes wrong in here, we should simply crash as we already saved	2843	# if anything goes wrong in here, we should simply crash as we already saved
2363		2844
2364	warn "cancelling all WF_AUTOCANCEL watchers";	2845	warn "cancelling all WF_AUTOCANCEL watchers";
2365	for (Event::all_watchers) {	2846	for (Event::all_watchers) {
2366	$_->cancel if $_->data & WF_AUTOCANCEL;	2847	$_->cancel if $_->data & WF_AUTOCANCEL;
2367	}	2848	}
2368
2369	warn "syncing database to disk";
2370	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2371		2849
2372	warn "flushing outstanding aio requests";	2850	warn "flushing outstanding aio requests";
2373	for (;;) {	2851	for (;;) {
2374	BDB::flush;	2852	BDB::flush;
2375	IO::AIO::flush;	2853	IO::AIO::flush;
2376	Coro::cede;	2854	Coro::cede;
2377	last unless IO::AIO::nreqs || BDB::nreqs;	2855	last unless IO::AIO::nreqs || BDB::nreqs;
2378	warn "iterate...";	2856	warn "iterate...";
2379	}	2857	}
2380		2858
		2859	++$RELOAD;
		2860
2381	warn "cancelling all extension coros";	2861	warn "cancelling all extension coros";
2382	$_->cancel for values %EXT_CORO;	2862	$_->cancel for values %EXT_CORO;
2383	%EXT_CORO = ();	2863	%EXT_CORO = ();
2384		2864
2385	warn "removing commands";	2865	warn "removing commands";
…		…
2424	Symbol::delete_package "safe::$_"	2904	Symbol::delete_package "safe::$_"
2425	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);	2905	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2426		2906
2427	warn "unloading cf.pm \"a bit\"";	2907	warn "unloading cf.pm \"a bit\"";
2428	delete $INC{"cf.pm"};	2908	delete $INC{"cf.pm"};
		2909	delete $INC{"cf/pod.pm"};
2429		2910
2430	# don't, removes xs symbols, too,	2911	# don't, removes xs symbols, too,
2431	# and global variables created in xs	2912	# and global variables created in xs
2432	#Symbol::delete_package __PACKAGE__;	2913	#Symbol::delete_package __PACKAGE__;
2433		2914
…		…
2442		2923
2443	warn "loading extensions";	2924	warn "loading extensions";
2444	cf::load_extensions;	2925	cf::load_extensions;
2445		2926
2446	warn "reattaching attachments to objects/players";	2927	warn "reattaching attachments to objects/players";
2447	_global_reattach;	2928	_global_reattach; # objects, sockets
2448	warn "reattaching attachments to maps";	2929	warn "reattaching attachments to maps";
2449	reattach $_ for values %MAP;	2930	reattach $_ for values %MAP;
		2931	warn "reattaching attachments to players";
		2932	reattach $_ for values %PLAYER;
2450		2933
2451	warn "loading reloadable resources";	2934	warn "leaving sync_job";
2452	load_resources;
2453		2935
2454	warn "restarting server ticker";	2936	1
2455		2937	} or do {
2456	$TICK_WATCHER->start;
2457	};
2458
2459	if ($@) {
2460	warn $@;	2938	warn $@;
2461	warn "error while reloading, exiting.";	2939	warn "error while reloading, exiting.";
2462	exit 1;	2940	exit 1;
2463	}	2941	};
2464		2942
2465	warn "reloaded";	2943	warn "reloaded";
2466	};	2944	};
2467		2945
2468	our $RELOAD_WATCHER; # used only during reload	2946	our $RELOAD_WATCHER; # used only during reload
2469		2947
		2948	sub reload_perl() {
		2949	# doing reload synchronously and two reloads happen back-to-back,
		2950	# coro crashes during coro_state_free->destroy here.
		2951
		2952	$RELOAD_WATCHER ||= Event->timer (
		2953	reentrant => 0,
		2954	after => 0,
		2955	data => WF_AUTOCANCEL,
		2956	cb => sub {
		2957	do_reload_perl;
		2958	undef $RELOAD_WATCHER;
		2959	},
		2960	);
		2961	}
		2962
2470	register_command "reload" => sub {	2963	register_command "reload" => sub {
2471	my ($who, $arg) = @_;	2964	my ($who, $arg) = @_;
2472		2965
2473	if ($who->flag (FLAG_WIZ)) {	2966	if ($who->flag (FLAG_WIZ)) {
2474	$who->message ("reloading server.");	2967	$who->message ("reloading server.");
2475		2968	async { reload_perl };
2476	# doing reload synchronously and two reloads happen back-to-back,
2477	# coro crashes during coro_state_free->destroy here.
2478
2479	$RELOAD_WATCHER ||= Event->timer (
2480	reentrant => 0,
2481	after => 0,
2482	data => WF_AUTOCANCEL,
2483	cb => sub {
2484	reload;
2485	undef $RELOAD_WATCHER;
2486	},
2487	);
2488	}	2969	}
2489	};	2970	};
2490		2971
2491	unshift @INC, $LIBDIR;	2972	unshift @INC, $LIBDIR;
2492		2973
2493	my $bug_warning = 0;	2974	my $bug_warning = 0;
2494		2975
		2976	our @WAIT_FOR_TICK;
		2977	our @WAIT_FOR_TICK_BEGIN;
		2978
		2979	sub wait_for_tick {
		2980	return unless $TICK_WATCHER->is_active;
		2981	return if $Coro::current == $Coro::main;
		2982
		2983	my $signal = new Coro::Signal;
		2984	push @WAIT_FOR_TICK, $signal;
		2985	$signal->wait;
		2986	}
		2987
		2988	sub wait_for_tick_begin {
		2989	return unless $TICK_WATCHER->is_active;
		2990	return if $Coro::current == $Coro::main;
		2991
		2992	my $signal = new Coro::Signal;
		2993	push @WAIT_FOR_TICK_BEGIN, $signal;
		2994	$signal->wait;
		2995	}
		2996
		2997	my $min = 1e6;#d#
		2998	my $avg = 10;
2495	$TICK_WATCHER = Event->timer (	2999	$TICK_WATCHER = Event->timer (
2496	reentrant => 0,	3000	reentrant => 0,
2497	parked => 1,	3001	parked => 1,
2498	prio => 0,	3002	prio => 0,
2499	at => $NEXT_TICK || $TICK,	3003	at => $NEXT_TICK || $TICK,
…		…
2503	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"	3007	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2504	unless ++$bug_warning > 10;	3008	unless ++$bug_warning > 10;
2505	return;	3009	return;
2506	}	3010	}
2507		3011
2508	$NOW = Event::time;	3012	$NOW = $tick_start = Event::time;
2509		3013
2510	cf::server_tick; # one server iteration	3014	cf::server_tick; # one server iteration
		3015
		3016	0 && sync_job {#d#
		3017	for(1..10) {
		3018	my $t = Event::time;
		3019	my $map = my $map = new_from_path cf::map "/tmp/x.map"
		3020	or die;
		3021
		3022	$map->width (50);
		3023	$map->height (50);
		3024	$map->alloc;
		3025	$map->_load_objects ("/tmp/x.map", 1);
		3026	my $t = Event::time - $t;
		3027
		3028	#next unless $t < 0.0013;#d#
		3029	if ($t < $min) {
		3030	$min = $t;
		3031	}
		3032	$avg = $avg * 0.99 + $t * 0.01;
		3033	}
		3034	warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
		3035	exit 0;
		3036	# 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
		3037	};
		3038
2511	$RUNTIME += $TICK;	3039	$RUNTIME += $TICK;
2512	$NEXT_TICK += $TICK;	3040	$NEXT_TICK += $TICK;
2513		3041
2514	$WAIT_FOR_TICK->broadcast;	3042	if ($NOW >= $NEXT_RUNTIME_WRITE) {
2515	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;	3043	$NEXT_RUNTIME_WRITE = $NOW + 10;
2516		3044	Coro::async_pool {
2517	Event::sweep;	3045	write_runtime
2518	Coro::cede_notself;	3046	or warn "ERROR: unable to write runtime file: $!";
		3047	};
2519		3048	}
		3049
2520	# my $AFTER = Event::time;	3050	# my $AFTER = Event::time;
2521	# warn $AFTER - $NOW;#d#	3051	# warn $AFTER - $NOW;#d#
2522		3052
		3053	if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
		3054	$sig->send;
		3055	}
		3056	while (my $sig = shift @WAIT_FOR_TICK) {
		3057	$sig->send;
		3058	}
		3059
		3060	$NOW = Event::time;
		3061
2523	# if we are delayed by four ticks or more, skip them all	3062	# if we are delayed by four ticks or more, skip them all
2524	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;	3063	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2525		3064
2526	$TICK_WATCHER->at ($NEXT_TICK);	3065	$TICK_WATCHER->at ($NEXT_TICK);
2527	$TICK_WATCHER->start;	3066	$TICK_WATCHER->start;
		3067
		3068	$LOAD = ($NOW - $tick_start) / $TICK;
		3069	$LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
		3070
		3071	_post_tick;
		3072
		3073
2528	},	3074	},
2529	);	3075	);
2530		3076
2531	{	3077	{
2532	BDB::max_poll_time $TICK * 0.1;	3078	BDB::max_poll_time $TICK * 0.1;
…		…
2560		3106
2561	cf::sync_job {	3107	cf::sync_job {
2562	eval {	3108	eval {
2563	BDB::db_env_open	3109	BDB::db_env_open
2564	$DB_ENV,	3110	$DB_ENV,
2565	$BDB_ENV_DIR,	3111	$BDBDIR,
2566	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN	3112	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2567	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,	3113	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2568	0666;	3114	0666;
2569		3115
2570	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;	3116	cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2571		3117
2572	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);	3118	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2573	$DB_ENV->set_lk_detect;	3119	$DB_ENV->set_lk_detect;
2574	};	3120	};
2575		3121
…		…
2583		3129
2584	undef $Coro::AIO::WATCHER;	3130	undef $Coro::AIO::WATCHER;
2585	IO::AIO::max_poll_time $TICK * 0.1;	3131	IO::AIO::max_poll_time $TICK * 0.1;
2586	$AIO_POLL_WATCHER = Event->io (	3132	$AIO_POLL_WATCHER = Event->io (
2587	reentrant => 0,	3133	reentrant => 0,
		3134	data => WF_AUTOCANCEL,
2588	fd => IO::AIO::poll_fileno,	3135	fd => IO::AIO::poll_fileno,
2589	poll => 'r',	3136	poll => 'r',
2590	prio => 6,	3137	prio => 6,
2591	data => WF_AUTOCANCEL,
2592	cb => \&IO::AIO::poll_cb,	3138	cb => \&IO::AIO::poll_cb,
2593	);	3139	);
2594	}	3140	}
2595		3141
2596	$WRITE_RUNTIME_WATCHER = Event->timer (	3142	my $_log_backtrace;
2597	reentrant => 0,	3143
2598	data => WF_AUTOCANCEL,	3144	sub _log_backtrace {
2599	after => 1,	3145	my ($msg, @addr) = @_;
2600	interval => 10,	3146
2601	prio => 6, # keep it lowest so it acts like a watchdog	3147	$msg =~ s/\n//;
2602	cb => Coro::unblock_sub {	3148
2603	write_runtime	3149	# limit the # of concurrent backtraces
2604	or warn "ERROR: unable to write runtime file: $!";	3150	if ($_log_backtrace < 2) {
		3151	++$_log_backtrace;
		3152	async {
		3153	my @bt = fork_call {
		3154	@addr = map { sprintf "%x", $_ } @addr;
		3155	my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
		3156	open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
		3157	or die "addr2line: $!";
		3158
		3159	my @funcs;
		3160	my @res = <$fh>;
		3161	chomp for @res;
		3162	while (@res) {
		3163	my ($func, $line) = splice @res, 0, 2, ();
		3164	push @funcs, "[$func] $line";
		3165	}
		3166
		3167	@funcs
		3168	};
		3169
		3170	LOG llevInfo, "[ABT] $msg\n";
		3171	LOG llevInfo, "[ABT] $_\n" for @bt;
		3172	--$_log_backtrace;
		3173	};
		3174	} else {
		3175	LOG llevInfo, "[ABT] $msg\n";
		3176	LOG llevInfo, "[ABT] [suppressed]\n";
2605	},	3177	}
2606	);	3178	}
		3179
		3180	# load additional modules
		3181	use cf::pod;
2607		3182
2608	END { cf::emergency_save }	3183	END { cf::emergency_save }
2609		3184
2610	1	3185	1
2611		3186

Diff Legend

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