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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.209 by root, Mon Feb 12 01:25:55 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;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.5 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use BDB ();
		21	use Data::Dumper;
		22	use Digest::MD5;
		23	use Fcntl;
10	use IO::AIO ();	24	use IO::AIO 2.32 ();
11	use YAML::Syck ();	25	use YAML::Syck ();
12	use Time::HiRes;	26	use Time::HiRes;
13	use Event;	27	use Compress::LZF;
		28
		29	Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
		30
14	$Event::Eval = 1; # no idea why this is required, but it is	31	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		34
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	35	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	36	$YAML::Syck::ImplicitUnicode = 1;
18		37
19	use strict;	38	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		39
23	our %COMMAND = ();	40	our %COMMAND = ();
24	our %COMMAND_TIME = ();	41	our %COMMAND_TIME = ();
		42
		43	our @EXTS = (); # list of extension package names
25	our %EXTCMD = ();	44	our %EXTCMD = ();
26		45	our %EXT_CORO = (); # coroutines bound to extensions
27	_init_vars;	46	our %EXT_MAP = (); # pluggable maps
28		47
29	our @EVENT;	48	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	49	our $LIBDIR = datadir . "/ext";
31		50
32	our $TICK = MAX_TIME * 1e-6;	51	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	52	our $TICK_WATCHER;
		53	our $AIO_POLL_WATCHER;
		54	our $WRITE_RUNTIME_WATCHER;
34	our $NEXT_TICK;	55	our $NEXT_TICK;
		56	our $NOW;
		57	our $USE_FSYNC = 1; # use fsync to write maps - default off
		58
		59	our $BDB_POLL_WATCHER;
		60	our $DB_ENV;
35		61
36	our %CFG;	62	our %CFG;
37		63
38	our $UPTIME; $UPTIME ||= time;	64	our $UPTIME; $UPTIME ||= time;
		65	our $RUNTIME;
		66
		67	our %PLAYER; # all users
		68	our %MAP; # all maps
		69	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
		76	# used to convert map paths into valid unix filenames by replacing / by ∕
		77	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		78
		79	binmode STDOUT;
		80	binmode STDERR;
		81
		82	# read virtual server time, if available
		83	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		84	open my $fh, "<", cf::localdir . "/runtime"
		85	or die "unable to read runtime file: $!";
		86	$RUNTIME = <$fh> + 0.;
		87	}
		88
		89	mkdir cf::localdir;
		90	mkdir cf::localdir . "/" . cf::playerdir;
		91	mkdir cf::localdir . "/" . cf::tmpdir;
		92	mkdir cf::localdir . "/" . cf::uniquedir;
		93	mkdir $RANDOM_MAPS;
		94	mkdir $BDB_ENV_DIR;
		95
		96	our $EMERGENCY_POSITION;
		97
		98	sub cf::map::normalise;
39		99
40	#############################################################################	100	#############################################################################
41		101
42	=head2 GLOBAL VARIABLES	102	=head2 GLOBAL VARIABLES
43		103
44	=over 4	104	=over 4
45		105
46	=item $cf::UPTIME	106	=item $cf::UPTIME
47		107
48	The timestamp of the server start (so not actually an uptime).	108	The timestamp of the server start (so not actually an uptime).
		109
		110	=item $cf::RUNTIME
		111
		112	The time this server has run, starts at 0 and is increased by $cf::TICK on
		113	every server tick.
49		114
50	=item $cf::LIBDIR	115	=item $cf::LIBDIR
51		116
52	The perl library directory, where extensions and cf-specific modules can	117	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	118	be found. It will be added to C<@INC> automatically.
54		119
		120	=item $cf::NOW
		121
		122	The time of the last (current) server tick.
		123
55	=item $cf::TICK	124	=item $cf::TICK
56		125
57	The interval between server ticks, in seconds.	126	The interval between server ticks, in seconds.
58		127
59	=item %cf::CFG	128	=item %cf::CFG
60		129
61	Configuration for the server, loaded from C</etc/crossfire/config>, or	130	Configuration for the server, loaded from C</etc/crossfire/config>, or
62	from wherever your confdir points to.	131	from wherever your confdir points to.
		132
		133	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		134
		135	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		136	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		137	processing has been done. Call C<< ->wait >> on them to maximise the
		138	window of cpu time available, or simply to synchronise to the server tick.
63		139
64	=back	140	=back
65		141
66	=cut	142	=cut
67		143
68	BEGIN {	144	BEGIN {
69	*CORE::GLOBAL::warn = sub {	145	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	146	my $msg = join "", @_;
		147	utf8::encode $msg;
		148
71	$msg .= "\n"	149	$msg .= "\n"
72	unless $msg =~ /\n$/;	150	unless $msg =~ /\n$/;
73		151
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	152	LOG llevError, $msg;
76	};	153	};
77	}	154	}
78		155
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	156	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	157	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	161	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85		162
86	# we bless all objects into (empty) derived classes to force a method lookup	163	# we bless all objects into (empty) derived classes to force a method lookup
87	# within the Safe compartment.	164	# within the Safe compartment.
88	for my $pkg (qw(	165	for my $pkg (qw(
89	cf::global	166	cf::global cf::attachable
90	cf::object cf::object::player	167	cf::object cf::object::player
91	cf::client cf::player	168	cf::client cf::player
92	cf::arch cf::living	169	cf::arch cf::living
93	cf::map cf::party cf::region	170	cf::map cf::party cf::region
94	)) {	171	)) {
…		…
98		175
99	$Event::DIED = sub {	176	$Event::DIED = sub {
100	warn "error in event callback: @_";	177	warn "error in event callback: @_";
101	};	178	};
102		179
103	my %ext_pkg;
104	my @exts;
105	my @hook;
106
107	=head2 UTILITY FUNCTIONS	180	=head2 UTILITY FUNCTIONS
108		181
109	=over 4	182	=over 4
110		183
		184	=item dumpval $ref
		185
111	=cut	186	=cut
		187
		188	sub dumpval {
		189	eval {
		190	local $SIG{__DIE__};
		191	my $d;
		192	if (1) {
		193	$d = new Data::Dumper([$_[0]], ["*var"]);
		194	$d->Terse(1);
		195	$d->Indent(2);
		196	$d->Quotekeys(0);
		197	$d->Useqq(1);
		198	#$d->Bless(...);
		199	$d->Seen($_[1]) if @_ > 1;
		200	$d = $d->Dump();
		201	}
		202	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		203	$d
		204	} || "[unable to dump $_[0]: '$@']";
		205	}
112		206
113	use JSON::Syck (); # TODO# replace by JSON::PC once working	207	use JSON::Syck (); # TODO# replace by JSON::PC once working
114		208
115	=item $ref = cf::from_json $json	209	=item $ref = cf::from_json $json
116		210
…		…
132	sub to_json($) {	226	sub to_json($) {
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	227	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134	JSON::Syck::Dump $_[0]	228	JSON::Syck::Dump $_[0]
135	}	229	}
136		230
		231	=item cf::lock_wait $string
		232
		233	Wait until the given lock is available. See cf::lock_acquire.
		234
		235	=item my $lock = cf::lock_acquire $string
		236
		237	Wait until the given lock is available and then acquires it and returns
		238	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		239	for example when the coroutine gets canceled), the lock is automatically
		240	returned.
		241
		242	Lock names should begin with a unique identifier (for example, cf::map::find
		243	uses map_find and cf::map::load uses map_load).
		244
		245	=cut
		246
		247	our %LOCK;
		248
		249	sub lock_wait($) {
		250	my ($key) = @_;
		251
		252	# wait for lock, if any
		253	while ($LOCK{$key}) {
		254	push @{ $LOCK{$key} }, $Coro::current;
		255	Coro::schedule;
		256	}
		257	}
		258
		259	sub lock_acquire($) {
		260	my ($key) = @_;
		261
		262	# wait, to be sure we are not locked
		263	lock_wait $key;
		264
		265	$LOCK{$key} = [];
		266
		267	Coro::guard {
		268	# wake up all waiters, to be on the safe side
		269	$_->ready for @{ delete $LOCK{$key} };
		270	}
		271	}
		272
		273	sub freeze_mainloop {
		274	return unless $TICK_WATCHER->is_active;
		275
		276	my $guard = Coro::guard {
		277	$TICK_WATCHER->start;
		278	$WRITE_RUNTIME_WATCHER->start;
		279	};
		280	$WRITE_RUNTIME_WATCHER->stop;
		281	$TICK_WATCHER->stop;
		282	$guard
		283	}
		284
		285	=item cf::async { BLOCK }
		286
		287	Currently the same as Coro::async_pool, meaning you cannot use
		288	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		289	thing you are allowed to do is call C<prio> on it.
		290
		291	=cut
		292
		293	BEGIN { *async = \&Coro::async_pool }
		294
		295	=item cf::sync_job { BLOCK }
		296
		297	The design of crossfire+ requires that the main coro ($Coro::main) is
		298	always able to handle events or runnable, as crossfire+ is only partly
		299	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		300
		301	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
		303	server will be frozen during this time, so the block should either finish
		304	fast or be very important.
		305
		306	=cut
		307
		308	sub sync_job(&) {
		309	my ($job) = @_;
		310
		311	if ($Coro::current == $Coro::main) {
		312	# this is the main coro, too bad, we have to block
		313	# till the operation succeeds, freezing the server :/
		314
		315	# TODO: use suspend/resume instead
		316	# (but this is cancel-safe)
		317	my $freeze_guard = freeze_mainloop;
		318
		319	my $busy = 1;
		320	my @res;
		321
		322	(async {
		323	@res = eval { $job->() };
		324	warn $@ if $@;
		325	undef $busy;
		326	})->prio (Coro::PRIO_MAX);
		327
		328	while ($busy) {
		329	Coro::cede or Event::one_event;
		330	}
		331
		332	wantarray ? @res : $res[0]
		333	} else {
		334	# we are in another coroutine, how wonderful, everything just works
		335
		336	$job->()
		337	}
		338	}
		339
		340	=item $coro = cf::async_ext { BLOCK }
		341
		342	Like async, but this coro is automatically being canceled when the
		343	extension calling this is being unloaded.
		344
		345	=cut
		346
		347	sub async_ext(&) {
		348	my $cb = shift;
		349
		350	my $coro = &Coro::async ($cb);
		351
		352	$coro->on_destroy (sub {
		353	delete $EXT_CORO{$coro+0};
		354	});
		355	$EXT_CORO{$coro+0} = $coro;
		356
		357	$coro
		358	}
		359
		360	sub write_runtime {
		361	my $runtime = cf::localdir . "/runtime";
		362
		363	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		364	or return;
		365
		366	my $value = $cf::RUNTIME + 90 + 10;
		367	# 10 is the runtime save interval, for a monotonic clock
		368	# 60 allows for the watchdog to kill the server.
		369
		370	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		371	and return;
		372
		373	# always fsync - this file is important
		374	aio_fsync $fh
		375	and return;
		376
		377	close $fh
		378	or return;
		379
		380	aio_rename "$runtime~", $runtime
		381	and return;
		382
		383	1
		384	}
		385
137	=back	386	=back
138		387
139	=cut	388	=cut
140		389
141	#############################################################################	390	#############################################################################
142		391
143	=head2 ATTACHABLE OBJECTS	392	=head2 ATTACHABLE OBJECTS
144		393
145	You can define and attach attachments to each "attachable" object in	394	Many objects in crossfire are so-called attachable objects. That means you can
146	crossfire+ (objects, players, clients, maps and the special "global"	395	attach callbacks/event handlers (a collection of which is called an "attachment")
		396	to it. All such attachable objects support the following methods.
		397
147	class). In the following description, CLASS can be any of C<global>,	398	In the following description, CLASS can be any of C<global>, C<object>
148	C<object> C<player>, C<client> or C<map>.	399	C<player>, C<client> or C<map> (i.e. the attachable objects in
		400	crossfire+).
149		401
150	=over 4	402	=over 4
151		403
		404	=item $attachable->attach ($attachment, key => $value...)
		405
		406	=item $attachable->detach ($attachment)
		407
		408	Attach/detach a pre-registered attachment to a specific object and give it
		409	the specified key/value pairs as arguments.
		410
		411	Example, attach a minesweeper attachment to the given object, making it a
		412	10x10 minesweeper game:
		413
		414	$obj->attach (minesweeper => width => 10, height => 10);
		415
		416	=item $bool = $attachable->attached ($name)
		417
		418	Checks wether the named attachment is currently attached to the object.
		419
		420	=item cf::CLASS->attach ...
		421
		422	=item cf::CLASS->detach ...
		423
		424	Define an anonymous attachment and attach it to all objects of the given
		425	CLASS. See the next function for an explanation of its arguments.
		426
		427	You can attach to global events by using the C<cf::global> class.
		428
		429	Example, log all player logins:
		430
		431	cf::player->attach (
		432	on_login => sub {
		433	my ($pl) = @_;
		434	...
		435	},
		436	);
		437
		438	Example, attach to the jeweler skill:
		439
		440	cf::object->attach (
		441	type => cf::SKILL,
		442	subtype => cf::SK_JEWELER,
		443	on_use_skill => sub {
		444	my ($sk, $ob, $part, $dir, $msg) = @_;
		445	...
		446	},
		447	);
		448
152	=item cf::CLASS::attachment $name, ...	449	=item cf::CLASS::attachment $name, ...
153		450
154	Register an attachment by name through which attachable objects can refer	451	Register an attachment by C<$name> through which attachable objects of the
155	to this attachment.	452	given CLASS can refer to this attachment.
156		453
157	=item $bool = $attachable->attached ($name)	454	Some classes such as crossfire maps and objects can specify attachments
		455	that are attached at load/instantiate time, thus the need for a name.
158		456
159	Checks wether the named attachment is currently attached to the object.
160
161	=item $attachable->attach ($attachment, key => $value...)
162
163	=item $attachable->detach ($attachment)
164
165	Attach/detach a pre-registered attachment either to a specific object
166	(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167	class in a static method call).
168
169	You can attach to global events by using the C<cf::global> class.
170
171	These method calls expect any number of the following handler/hook	457	These calls expect any number of the following handler/hook descriptions:
172	descriptions:
173		458
174	=over 4	459	=over 4
175		460
176	=item prio => $number	461	=item prio => $number
177		462
…		…
203	package and register them. Only handlers for eevents supported by the	488	package and register them. Only handlers for eevents supported by the
204	object/class are recognised.	489	object/class are recognised.
205		490
206	=back	491	=back
207		492
		493	Example, define an attachment called "sockpuppet" that calls the given
		494	event handler when a monster attacks:
		495
		496	cf::object::attachment sockpuppet =>
		497	on_skill_attack => sub {
		498	my ($self, $victim) = @_;
		499	...
		500	}
		501	}
		502
		503	=item $attachable->valid
		504
		505	Just because you have a perl object does not mean that the corresponding
		506	C-level object still exists. If you try to access an object that has no
		507	valid C counterpart anymore you get an exception at runtime. This method
		508	can be used to test for existence of the C object part without causing an
		509	exception.
		510
208	=cut	511	=cut
209		512
210	# the following variables are defined in .xs and must not be re-created	513	# the following variables are defined in .xs and must not be re-created
211	our @CB_GLOBAL = (); # registry for all global events	514	our @CB_GLOBAL = (); # registry for all global events
		515	our @CB_ATTACHABLE = (); # registry for all attachables
212	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	516	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213	our @CB_PLAYER = ();	517	our @CB_PLAYER = ();
214	our @CB_CLIENT = ();	518	our @CB_CLIENT = ();
215	our @CB_TYPE = (); # registry for type (cf-object class) based events	519	our @CB_TYPE = (); # registry for type (cf-object class) based events
216	our @CB_MAP = ();	520	our @CB_MAP = ();
217		521
218	my %attachment;	522	my %attachment;
		523
		524	sub cf::attachable::thawer_merge {
		525	# simply override everything except _meta
		526	local $_[0]{_meta};
		527	%{$_[0]} = %{$_[1]};
		528	}
219		529
220	sub _attach_cb($$$$) {	530	sub _attach_cb($$$$) {
221	my ($registry, $event, $prio, $cb) = @_;	531	my ($registry, $event, $prio, $cb) = @_;
222		532
223	use sort 'stable';	533	use sort 'stable';
…		…
226		536
227	@{$registry->[$event]} = sort	537	@{$registry->[$event]} = sort
228	{ $a->[0] cmp $b->[0] }	538	{ $a->[0] cmp $b->[0] }
229	@{$registry->[$event] || []}, $cb;	539	@{$registry->[$event] || []}, $cb;
230	}	540	}
		541
		542	# hack
		543	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231		544
232	# attach handles attaching event callbacks	545	# attach handles attaching event callbacks
233	# the only thing the caller has to do is pass the correct	546	# the only thing the caller has to do is pass the correct
234	# registry (== where the callback attaches to).	547	# registry (== where the callback attaches to).
235	sub _attach {	548	sub _attach {
…		…
237		550
238	my $object_type;	551	my $object_type;
239	my $prio = 0;	552	my $prio = 0;
240	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	553	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241		554
		555	#TODO: get rid of this hack
		556	if ($attachable_klass{$klass}) {
		557	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		558	}
		559
242	while (@arg) {	560	while (@arg) {
243	my $type = shift @arg;	561	my $type = shift @arg;
244		562
245	if ($type eq "prio") {	563	if ($type eq "prio") {
246	$prio = shift @arg;	564	$prio = shift @arg;
…		…
321	my ($obj, $name) = @_;	639	my ($obj, $name) = @_;
322		640
323	exists $obj->{_attachment}{$name}	641	exists $obj->{_attachment}{$name}
324	}	642	}
325		643
326	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	644	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327	eval "#line " . __LINE__ . " 'cf.pm'	645	eval "#line " . __LINE__ . " 'cf.pm'
328	sub cf::\L$klass\E::_attach_registry {	646	sub cf::\L$klass\E::_attach_registry {
329	(\\\@CB_$klass, KLASS_$klass)	647	(\\\@CB_$klass, KLASS_$klass)
330	}	648	}
331		649
…		…
367	}	685	}
368		686
369	0	687	0
370	}	688	}
371		689
372	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	690	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
373		691
374	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
375
376	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	692	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379		693
380	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382	Generate a global/object/player/map-specific event with the given arguments.	694	Generate an object-specific event with the given arguments.
383		695
384	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	696	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
385	removed in future versions), and there is no public API to access override	697	removed in future versions), and there is no public API to access override
386	results (if you must, access C<@cf::invoke_results> directly).	698	results (if you must, access C<@cf::invoke_results> directly).
387		699
388	=back	700	=back
389		701
390	=cut	702	=cut
391		703
392	#############################################################################	704	#############################################################################
393
394	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396	Attachable objects includes objects, players, clients and maps.
397
398	=over 4
399
400	=item $object->valid
401
402	Just because you have a perl object does not mean that the corresponding
403	C-level object still exists. If you try to access an object that has no
404	valid C counterpart anymore you get an exception at runtime. This method
405	can be used to test for existence of the C object part without causing an
406	exception.
407
408	=back
409
410	=cut
411
412	#############################################################################
413	# object support	705	# object support
414		706
415	sub instantiate {
416	my ($obj, $data) = @_;
417
418	$data = from_json $data;
419
420	for (@$data) {
421	my ($name, $args) = @$_;
422
423	$obj->attach ($name, %{$args || {} });
424	}
425	}
426
427	# basically do the same as instantiate, without calling instantiate
428	sub reattach {	707	sub reattach {
		708	# basically do the same as instantiate, without calling instantiate
429	my ($obj) = @_;	709	my ($obj) = @_;
		710
		711	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		712
430	my $registry = $obj->registry;	713	my $registry = $obj->registry;
431		714
432	@$registry = ();	715	@$registry = ();
433		716
434	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	717	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
443	warn "object uses attachment '$name' that is not available, postponing.\n";	726	warn "object uses attachment '$name' that is not available, postponing.\n";
444	}	727	}
445	}	728	}
446	}	729	}
447		730
448	sub object_freezer_save {	731	cf::attachable->attach (
449	my ($filename, $rdata, $objs) = @_;
450
451	if (length $$rdata) {
452	warn sprintf "saving %s (%d,%d)\n",
453	$filename, length $$rdata, scalar @$objs;
454
455	if (open my $fh, ">:raw", "$filename~") {
456	chmod SAVE_MODE, $fh;
457	syswrite $fh, $$rdata;
458	close $fh;
459
460	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
461	chmod SAVE_MODE, $fh;
462	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
463	close $fh;
464	rename "$filename.pst~", "$filename.pst";
465	} else {
466	unlink "$filename.pst";
467	}
468
469	rename "$filename~", $filename;
470	} else {
471	warn "FATAL: $filename~: $!\n";
472	}
473	} else {
474	unlink $filename;
475	unlink "$filename.pst";
476	}
477	}
478
479	sub object_freezer_as_string {
480	my ($rdata, $objs) = @_;
481
482	use Data::Dumper;
483
484	$$rdata . Dumper $objs
485	}
486
487	sub object_thawer_load {
488	my ($filename) = @_;
489
490	local $/;
491
492	my $av;
493
494	#TODO: use sysread etc.
495	if (open my $data, "<:raw:perlio", $filename) {
496	$data = <$data>;
497	if (open my $pst, "<:raw:perlio", "$filename.pst") {
498	$av = eval { (Storable::thaw <$pst>)->{objs} };
499	}
500	return ($data, $av);
501	}
502
503	()
504	}
505
506	cf::object->attach (
507	prio => -1000000,	732	prio => -1000000,
		733	on_instantiate => sub {
		734	my ($obj, $data) = @_;
		735
		736	$data = from_json $data;
		737
		738	for (@$data) {
		739	my ($name, $args) = @$_;
		740
		741	$obj->attach ($name, %{$args || {} });
		742	}
		743	},
		744	on_reattach => \&reattach,
508	on_clone => sub {	745	on_clone => sub {
509	my ($src, $dst) = @_;	746	my ($src, $dst) = @_;
510		747
511	@{$dst->registry} = @{$src->registry};	748	@{$dst->registry} = @{$src->registry};
512		749
…		…
515	%{$dst->{_attachment}} = %{$src->{_attachment}}	752	%{$dst->{_attachment}} = %{$src->{_attachment}}
516	if exists $src->{_attachment};	753	if exists $src->{_attachment};
517	},	754	},
518	);	755	);
519		756
		757	sub object_freezer_save {
		758	my ($filename, $rdata, $objs) = @_;
		759
		760	sync_job {
		761	if (length $$rdata) {
		762	warn sprintf "saving %s (%d,%d)\n",
		763	$filename, length $$rdata, scalar @$objs;
		764
		765	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		766	chmod SAVE_MODE, $fh;
		767	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		768	aio_fsync $fh if $cf::USE_FSYNC;
		769	close $fh;
		770
		771	if (@$objs) {
		772	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		773	chmod SAVE_MODE, $fh;
		774	my $data = Storable::nfreeze { version => 1, objs => $objs };
		775	aio_write $fh, 0, (length $data), $data, 0;
		776	aio_fsync $fh if $cf::USE_FSYNC;
		777	close $fh;
		778	aio_rename "$filename.pst~", "$filename.pst";
		779	}
		780	} else {
		781	aio_unlink "$filename.pst";
		782	}
		783
		784	aio_rename "$filename~", $filename;
		785	} else {
		786	warn "FATAL: $filename~: $!\n";
		787	}
		788	} else {
		789	aio_unlink $filename;
		790	aio_unlink "$filename.pst";
		791	}
		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	}
		799	}
		800
		801	sub object_freezer_as_string {
		802	my ($rdata, $objs) = @_;
		803
		804	use Data::Dumper;
		805
		806	$$rdata . Dumper $objs
		807	}
		808
		809	sub object_thawer_load {
		810	my ($filename) = @_;
		811
		812	my ($data, $av);
		813
		814	#d#TODO remove .map if file does not exist
		815	aio_stat $filename and $filename =~ s/\.map$//;
		816
		817	(aio_load $filename, $data) >= 0
		818	or return;
		819
		820	unless (aio_stat "$filename.pst") {
		821	(aio_load "$filename.pst", $av) >= 0
		822	or return;
		823	$av = eval { (Storable::thaw $av)->{objs} };
		824	}
		825
		826	warn sprintf "loading %s (%d)\n",
		827	$filename, length $data, scalar @{$av || []};#d#
		828	return ($data, $av);
		829	}
		830
520	#############################################################################	831	#############################################################################
521	# command handling &c	832	# command handling &c
522		833
523	=item cf::register_command $name => \&callback($ob,$args);	834	=item cf::register_command $name => \&callback($ob,$args);
524		835
…		…
546	=cut	857	=cut
547		858
548	sub register_extcmd {	859	sub register_extcmd {
549	my ($name, $cb) = @_;	860	my ($name, $cb) = @_;
550		861
551	my $caller = caller;
552	#warn "registering extcmd '$name' to '$caller'";
553
554	$EXTCMD{$name} = [$cb, $caller];	862	$EXTCMD{$name} = $cb;
555	}	863	}
556		864
557	cf::player->attach (	865	cf::player->attach (
558	on_command => sub {	866	on_command => sub {
559	my ($pl, $name, $params) = @_;	867	my ($pl, $name, $params) = @_;
…		…
572		880
573	my $msg = eval { from_json $buf };	881	my $msg = eval { from_json $buf };
574		882
575	if (ref $msg) {	883	if (ref $msg) {
576	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	884	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
577	if (my %reply = $cb->[0]->($pl, $msg)) {	885	if (my %reply = $cb->($pl, $msg)) {
578	$pl->ext_reply ($msg->{msgid}, %reply);	886	$pl->ext_reply ($msg->{msgid}, %reply);
579	}	887	}
580	}	888	}
581	} else {	889	} else {
582	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	890	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
584		892
585	cf::override;	893	cf::override;
586	},	894	},
587	);	895	);
588		896
589	sub register {
590	my ($base, $pkg) = @_;
591
592	#TODO
593	}
594
595	sub load_extension {	897	sub load_extension {
596	my ($path) = @_;	898	my ($path) = @_;
597		899
598	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	900	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
599	my $base = $1;	901	my $base = $1;
600	my $pkg = $1;	902	my $pkg = $1;
601	$pkg =~ s/[^[:word:]]/_/g;	903	$pkg =~ s/[^[:word:]]/_/g;
602	$pkg = "ext::$pkg";	904	$pkg = "ext::$pkg";
603		905
604	warn "loading '$path' into '$pkg'\n";	906	warn "... loading '$path' into '$pkg'\n";
605		907
606	open my $fh, "<:utf8", $path	908	open my $fh, "<:utf8", $path
607	or die "$path: $!";	909	or die "$path: $!";
608		910
609	my $source =	911	my $source =
610	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8;\n"
611	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
612	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
613	. "\n};\n1";	915	. "\n};\n1";
614		916
615	eval $source	917	unless (eval $source) {
616	or die $@ ? "$path: $@\n"	918	my $msg = $@ ? "$path: $@\n"
617	: "extension disabled.\n";	919	: "extension disabled.\n";
618		920	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
619	push @exts, $pkg;	921	warn $@;
620	$ext_pkg{$base} = $pkg;	922	warn "mandatory extension failed to load, exiting.\n";
621		923	exit 1;
622	# no strict 'refs';	924	}
623	# @{"$pkg\::ISA"} = ext::;	925	die $@;
624
625	register $base, $pkg;
626	}
627
628	sub unload_extension {
629	my ($pkg) = @_;
630
631	warn "removing extension $pkg\n";
632
633	# remove hooks
634	#TODO
635	# for my $idx (0 .. $#PLUGIN_EVENT) {
636	# delete $hook[$idx]{$pkg};
637	# }	926	}
638		927
639	# remove commands	928	push @EXTS, $pkg;
640	for my $name (keys %COMMAND) {
641	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
642
643	if (@cb) {
644	$COMMAND{$name} = \@cb;
645	} else {
646	delete $COMMAND{$name};
647	}
648	}
649
650	# remove extcmds
651	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
652	delete $EXTCMD{$name};
653	}
654
655	if (my $cb = $pkg->can ("unload")) {
656	eval {
657	$cb->($pkg);
658	1
659	} or warn "$pkg unloaded, but with errors: $@";
660	}
661
662	Symbol::delete_package $pkg;
663	}	929	}
664		930
665	sub load_extensions {	931	sub load_extensions {
666	for my $ext (<$LIBDIR/*.ext>) {	932	for my $ext (<$LIBDIR/*.ext>) {
667	next unless -r $ext;	933	next unless -r $ext;
…		…
671	} or warn "$ext not loaded: $@";	937	} or warn "$ext not loaded: $@";
672	}	938	}
673	}	939	}
674		940
675	#############################################################################	941	#############################################################################
676	# load/save/clean perl data associated with a map
677		942
678	*cf::mapsupport::on_clean = sub {	943	=head2 CORE EXTENSIONS
		944
		945	Functions and methods that extend core crossfire objects.
		946
		947	=cut
		948
		949	package cf::player;
		950
		951	use Coro::AIO;
		952
		953	=head3 cf::player
		954
		955	=over 4
		956
		957	=item cf::player::find $login
		958
		959	Returns the given player object, loading it if necessary (might block).
		960
		961	=cut
		962
		963	sub playerdir($) {
		964	cf::localdir
		965	. "/"
		966	. cf::playerdir
		967	. "/"
		968	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		969	}
		970
		971	sub path($) {
		972	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		973
		974	(playerdir $login) . "/$login.pl"
		975	}
		976
		977	sub find_active($) {
		978	$cf::PLAYER{$_[0]}
		979	and $cf::PLAYER{$_[0]}->active
		980	and $cf::PLAYER{$_[0]}
		981	}
		982
		983	sub exists($) {
		984	my ($login) = @_;
		985
		986	$cf::PLAYER{$login}
		987	or cf::sync_job { !aio_stat path $login }
		988	}
		989
		990	sub find($) {
		991	return $cf::PLAYER{$_[0]} || do {
		992	my $login = $_[0];
		993
		994	my $guard = cf::lock_acquire "user_find:$login";
		995
		996	$cf::PLAYER{$_[0]} || do {
		997	my $pl = load_pl path $login
		998	or return;
		999	$cf::PLAYER{$login} = $pl
		1000	}
		1001	}
		1002	}
		1003
		1004	sub save($) {
		1005	my ($pl) = @_;
		1006
		1007	return if $pl->{deny_save};
		1008
		1009	my $path = path $pl;
		1010	my $guard = cf::lock_acquire "user_save:$path";
		1011
		1012	return if $pl->{deny_save};
		1013
		1014	aio_mkdir playerdir $pl, 0770;
		1015	$pl->{last_save} = $cf::RUNTIME;
		1016
		1017	$pl->save_pl ($path);
		1018	Coro::cede;
		1019	}
		1020
		1021	sub new($) {
		1022	my ($login) = @_;
		1023
		1024	my $self = create;
		1025
		1026	$self->ob->name ($login);
		1027	$self->{deny_save} = 1;
		1028
		1029	$cf::PLAYER{$login} = $self;
		1030
		1031	$self
		1032	}
		1033
		1034	=item $pl->quit_character
		1035
		1036	Nukes the player without looking back. If logged in, the connection will
		1037	be destroyed. May block for a long time.
		1038
		1039	=cut
		1040
		1041	sub quit_character {
		1042	my ($pl) = @_;
		1043
		1044	$pl->{deny_save} = 1;
		1045	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1046
		1047	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1048	$pl->deactivate;
		1049	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1050	$pl->ns->destroy if $pl->ns;
		1051
		1052	my $path = playerdir $pl;
		1053	my $temp = "$path~$cf::RUNTIME~deleting~";
		1054	aio_rename $path, $temp;
		1055	delete $cf::PLAYER{$pl->ob->name};
		1056	$pl->destroy;
		1057	IO::AIO::aio_rmtree $temp;
		1058	}
		1059
		1060	=item cf::player::list_logins
		1061
		1062	Returns am arrayref of all valid playernames in the system, can take a
		1063	while and may block, so not sync_job-capable, ever.
		1064
		1065	=cut
		1066
		1067	sub list_logins {
		1068	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1069	or return [];
		1070
		1071	my @logins;
		1072
		1073	for my $login (@$dirs) {
		1074	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1075	aio_read $fh, 0, 512, my $buf, 0 or next;
		1076	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1077
		1078	utf8::decode $login;
		1079	push @logins, $login;
		1080	}
		1081
		1082	\@logins
		1083	}
		1084
		1085	=item $player->maps
		1086
		1087	Returns an arrayref of map paths that are private for this
		1088	player. May block.
		1089
		1090	=cut
		1091
		1092	sub maps($) {
		1093	my ($pl) = @_;
		1094
		1095	$pl = ref $pl ? $pl->ob->name : $pl;
		1096
		1097	my $files = aio_readdir playerdir $pl
		1098	or return;
		1099
		1100	my @paths;
		1101
		1102	for (@$files) {
		1103	utf8::decode $_;
		1104	next if /\.(?:pl|pst)$/;
		1105	next unless /^$PATH_SEP/o;
		1106
		1107	push @paths, cf::map::normalise "~$pl/$_";
		1108	}
		1109
		1110	\@paths
		1111	}
		1112
		1113	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1114
		1115	Sends an ext reply to the player.
		1116
		1117	=cut
		1118
		1119	sub ext_reply($$$%) {
		1120	my ($self, $id, %msg) = @_;
		1121
		1122	$msg{msgid} = $id;
		1123
		1124	$self->send ("ext " . cf::to_json \%msg);
		1125	}
		1126
		1127	package cf;
		1128
		1129	=back
		1130
		1131
		1132	=head3 cf::map
		1133
		1134	=over 4
		1135
		1136	=cut
		1137
		1138	package cf::map;
		1139
		1140	use Fcntl;
		1141	use Coro::AIO;
		1142
		1143	use overload
		1144	'""' => \&as_string,
		1145	fallback => 1;
		1146
		1147	our $MAX_RESET = 3600;
		1148	our $DEFAULT_RESET = 3000;
		1149
		1150	sub generate_random_map {
		1151	my ($self, $rmp) = @_;
		1152	# mit "rum" bekleckern, nicht
		1153	$self->_create_random_map (
		1154	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1155	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1156	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1157	$rmp->{exit_on_final_map},
		1158	$rmp->{xsize}, $rmp->{ysize},
		1159	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1160	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1161	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1162	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1163	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1164	(cf::region::find $rmp->{region}), $rmp->{custom}
		1165	)
		1166	}
		1167
		1168	=item cf::map->register ($regex, $prio)
		1169
		1170	Register a handler for the map path matching the given regex at the
		1171	givne priority (higher is better, built-in handlers have priority 0, the
		1172	default).
		1173
		1174	=cut
		1175
		1176	sub register {
		1177	my (undef, $regex, $prio) = @_;
		1178	my $pkg = caller;
		1179
		1180	no strict;
		1181	push @{"$pkg\::ISA"}, __PACKAGE__;
		1182
		1183	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1184	}
		1185
		1186	# also paths starting with '/'
		1187	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1188
		1189	sub thawer_merge {
		1190	my ($self, $merge) = @_;
		1191
		1192	# we have to keep some variables in memory intact
		1193	local $self->{path};
		1194	local $self->{load_path};
		1195	local $self->{deny_save};
		1196	local $self->{deny_reset};
		1197
		1198	$self->SUPER::thawer_merge ($merge);
		1199	}
		1200
		1201	sub normalise {
		1202	my ($path, $base) = @_;
		1203
		1204	$path = "$path"; # make sure its a string
		1205
		1206	$path =~ s/\.map$//;
		1207
		1208	# map plan:
		1209	#
		1210	# /! non-realised random map exit (special hack!)
		1211	# {... are special paths that are not being touched
		1212	# ?xxx/... are special absolute paths
		1213	# ?random/... random maps
		1214	# /... normal maps
		1215	# ~user/... per-player map of a specific user
		1216
		1217	$path =~ s/$PATH_SEP/\//go;
		1218
		1219	# treat it as relative path if it starts with
		1220	# something that looks reasonable
		1221	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1222	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1223
		1224	$base =~ s{[^/]+/?$}{};
		1225	$path = "$base/$path";
		1226	}
		1227
		1228	for ($path) {
		1229	redo if s{//}{/};
		1230	redo if s{/\.?/}{/};
		1231	redo if s{/[^/]+/\.\./}{/};
		1232	}
		1233
		1234	$path
		1235	}
		1236
		1237	sub new_from_path {
		1238	my (undef, $path, $base) = @_;
		1239
		1240	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1241
		1242	$path = normalise $path, $base;
		1243
		1244	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1245	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1246	my $self = bless cf::map::new, $pkg;
		1247	$self->{path} = $path; $self->path ($path);
		1248	$self->init; # pass $1 etc.
		1249	return $self;
		1250	}
		1251	}
		1252
		1253	Carp::carp "unable to resolve path '$path' (base '$base').";
		1254	()
		1255	}
		1256
		1257	sub init {
		1258	my ($self) = @_;
		1259
		1260	$self
		1261	}
		1262
		1263	sub as_string {
		1264	my ($self) = @_;
		1265
		1266	"$self->{path}"
		1267	}
		1268
		1269	# the displayed name, this is a one way mapping
		1270	sub visible_name {
		1271	&as_string
		1272	}
		1273
		1274	# the original (read-only) location
		1275	sub load_path {
		1276	my ($self) = @_;
		1277
		1278	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1279	}
		1280
		1281	# the temporary/swap location
		1282	sub save_path {
		1283	my ($self) = @_;
		1284
		1285	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1286	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1287	}
		1288
		1289	# the unique path, undef == no special unique path
		1290	sub uniq_path {
		1291	my ($self) = @_;
		1292
		1293	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1294	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1295	}
		1296
		1297	# and all this just because we cannot iterate over
		1298	# all maps in C++...
		1299	sub change_all_map_light {
		1300	my ($change) = @_;
		1301
		1302	$_->change_map_light ($change)
		1303	for grep $_->outdoor, values %cf::MAP;
		1304	}
		1305
		1306	sub unlink_save {
		1307	my ($self) = @_;
		1308
		1309	utf8::encode (my $save = $self->save_path);
		1310	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1311	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	}
		1318
		1319	sub load_header_from($) {
		1320	my ($self, $path) = @_;
		1321
		1322	utf8::encode $path;
		1323	#aio_open $path, O_RDONLY, 0
		1324	# or return;
		1325
		1326	$self->_load_header ($path)
		1327	or return;
		1328
		1329	$self->{load_path} = $path;
		1330
		1331	1
		1332	}
		1333
		1334	sub load_header_orig {
		1335	my ($self) = @_;
		1336
		1337	$self->load_header_from ($self->load_path)
		1338	}
		1339
		1340	sub load_header_temp {
		1341	my ($self) = @_;
		1342
		1343	$self->load_header_from ($self->save_path)
		1344	}
		1345
		1346	sub prepare_temp {
		1347	my ($self) = @_;
		1348
		1349	$self->last_access ((delete $self->{last_access})
		1350	|| $cf::RUNTIME); #d#
		1351	# safety
		1352	$self->{instantiate_time} = $cf::RUNTIME
		1353	if $self->{instantiate_time} > $cf::RUNTIME;
		1354	}
		1355
		1356	sub prepare_orig {
		1357	my ($self) = @_;
		1358
		1359	$self->{load_original} = 1;
		1360	$self->{instantiate_time} = $cf::RUNTIME;
		1361	$self->last_access ($cf::RUNTIME);
		1362	$self->instantiate;
		1363	}
		1364
		1365	sub load_header {
		1366	my ($self) = @_;
		1367
		1368	if ($self->load_header_temp) {
		1369	$self->prepare_temp;
		1370	} else {
		1371	$self->load_header_orig
		1372	or return;
		1373	$self->prepare_orig;
		1374	}
		1375
		1376	1
		1377	}
		1378
		1379	sub find;
		1380	sub find {
		1381	my ($path, $origin) = @_;
		1382
		1383	$path = normalise $path, $origin && $origin->path;
		1384
		1385	cf::lock_wait "map_find:$path";
		1386
		1387	$cf::MAP{$path} || do {
		1388	my $guard = cf::lock_acquire "map_find:$path";
		1389	my $map = new_from_path cf::map $path
		1390	or return;
		1391
		1392	$map->{last_save} = $cf::RUNTIME;
		1393
		1394	$map->load_header
		1395	or return;
		1396
		1397	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1398	# doing this can freeze the server in a sync job, obviously
		1399	#$cf::WAIT_FOR_TICK->wait;
		1400	$map->reset;
		1401	undef $guard;
		1402	return find $path;
		1403	}
		1404
		1405	$cf::MAP{$path} = $map
		1406	}
		1407	}
		1408
		1409	sub pre_load { }
		1410	sub post_load { }
		1411
		1412	sub load {
		1413	my ($self) = @_;
		1414
		1415	local $self->{deny_reset} = 1; # loading can take a long time
		1416
		1417	my $path = $self->{path};
		1418	my $guard = cf::lock_acquire "map_load:$path";
		1419
		1420	return if $self->in_memory != cf::MAP_SWAPPED;
		1421
		1422	$self->in_memory (cf::MAP_LOADING);
		1423
		1424	$self->alloc;
		1425
		1426	$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;
		1452	$self->set_darkness_map;
		1453	$self->difficulty ($self->estimate_difficulty)
		1454	unless $self->difficulty;
		1455	Coro::cede;
		1456	$self->activate;
		1457	}
		1458
		1459	$self->post_load;
		1460
		1461	$self->in_memory (cf::MAP_IN_MEMORY);
		1462	}
		1463
		1464	sub customise_for {
		1465	my ($self, $ob) = @_;
		1466
		1467	return find "~" . $ob->name . "/" . $self->{path}
		1468	if $self->per_player;
		1469
		1470	$self
		1471	}
		1472
		1473	# find and load all maps in the 3x3 area around a map
		1474	sub load_diag {
679	my ($map) = @_;	1475	my ($map) = @_;
680		1476
681	my $path = $map->tmpname;	1477	my @diag; # diagonal neighbours
682	defined $path or return;
683		1478
684	unlink "$path.pst";	1479	for (0 .. 3) {
685	};	1480	my $neigh = $map->tile_path ($_)
		1481	or next;
		1482	$neigh = find $neigh, $map
		1483	or next;
		1484	$neigh->load;
686		1485
687	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1486	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1487	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1488	}
688		1489
689	#############################################################################	1490	for (@diag) {
690	# load/save perl data associated with player->ob objects	1491	my $neigh = find @$_
691		1492	or next;
692	sub all_objects(@) {	1493	$neigh->load;
693	@_, map all_objects ($_->inv), @_	1494	}
694	}	1495	}
695		1496
696	# TODO: compatibility cruft, remove when no longer needed	1497	sub find_sync {
697	cf::player->attach (	1498	my ($path, $origin) = @_;
698	on_load => sub {
699	my ($pl, $path) = @_;
700		1499
701	for my $o (all_objects $pl->ob) {	1500	cf::sync_job { find $path, $origin }
702	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1501	}
703	$o->set_ob_key_value ("_perl_data");
704		1502
705	%$o = %{ Storable::thaw pack "H*", $value };	1503	sub do_load_sync {
		1504	my ($map) = @_;
		1505
		1506	cf::sync_job { $map->load };
		1507	}
		1508
		1509	our %MAP_PREFETCH;
		1510	our $MAP_PREFETCHER = undef;
		1511
		1512	sub find_async {
		1513	my ($path, $origin) = @_;
		1514
		1515	$path = normalise $path, $origin && $origin->{path};
		1516
		1517	if (my $map = $cf::MAP{$path}) {
		1518	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1519	}
		1520
		1521	undef $MAP_PREFETCH{$path};
		1522	$MAP_PREFETCHER ||= cf::async {
		1523	while (%MAP_PREFETCH) {
		1524	for my $path (keys %MAP_PREFETCH) {
		1525	my $map = find $path
		1526	or next;
		1527	$map->load;
		1528
		1529	delete $MAP_PREFETCH{$path};
706	}	1530	}
707	}	1531	}
		1532	undef $MAP_PREFETCHER;
		1533	};
		1534	$MAP_PREFETCHER->prio (6);
		1535
		1536	()
		1537	}
		1538
		1539	sub save {
		1540	my ($self) = @_;
		1541
		1542	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1543
		1544	$self->{last_save} = $cf::RUNTIME;
		1545
		1546	return unless $self->dirty;
		1547
		1548	my $save = $self->save_path; utf8::encode $save;
		1549	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1550
		1551	$self->{load_path} = $save;
		1552
		1553	return if $self->{deny_save};
		1554
		1555	local $self->{last_access} = $self->last_access;#d#
		1556
		1557	cf::async {
		1558	$_->contr->save for $self->players;
		1559	};
		1560
		1561	if ($uniq) {
		1562	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1563	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1564	} else {
		1565	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
708	},	1566	}
709	);	1567	}
710		1568
711	#############################################################################	1569	sub swap_out {
		1570	my ($self) = @_;
712		1571
713	=head2 CORE EXTENSIONS	1572	# save first because save cedes
		1573	$self->save;
714		1574
715	Functions and methods that extend core crossfire objects.	1575	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1576
		1577	return if $self->players;
		1578	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1579	return if $self->{deny_save};
		1580
		1581	$self->clear;
		1582	$self->in_memory (cf::MAP_SWAPPED);
		1583	}
		1584
		1585	sub reset_at {
		1586	my ($self) = @_;
		1587
		1588	# 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};
		1591
		1592	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1593	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1594
		1595	$time + $to
		1596	}
		1597
		1598	sub should_reset {
		1599	my ($self) = @_;
		1600
		1601	$self->reset_at <= $cf::RUNTIME
		1602	}
		1603
		1604	sub reset {
		1605	my ($self) = @_;
		1606
		1607	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1608
		1609	return if $self->players;
		1610	return if $self->isa ("ext::map_per_player");#d#
		1611
		1612	warn "resetting map ", $self->path;#d#
		1613
		1614	delete $cf::MAP{$self->path};
		1615
		1616	$self->in_memory (cf::MAP_SWAPPED);
		1617	$self->clear;
		1618
		1619	$_->clear_links_to ($self) for values %cf::MAP;
		1620
		1621	$self->unlink_save;
		1622	$self->destroy;
		1623	}
		1624
		1625	my $nuke_counter = "aaaa";
		1626
		1627	sub nuke {
		1628	my ($self) = @_;
		1629
		1630	delete $cf::MAP{$self->path};
		1631
		1632	$self->unlink_save;
		1633
		1634	bless $self, "cf::map";
		1635	delete $self->{deny_reset};
		1636	$self->{deny_save} = 1;
		1637	$self->reset_timeout (1);
		1638	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1639
		1640	$cf::MAP{$self->path} = $self;
		1641
		1642	$self->reset; # polite request, might not happen
		1643	}
		1644
		1645	=item cf::map::unique_maps
		1646
		1647	Returns an arrayref of paths of all shared maps that have
		1648	instantiated unique items. May block.
		1649
		1650	=cut
		1651
		1652	sub unique_maps() {
		1653	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1654	or return;
		1655
		1656	my @paths;
		1657
		1658	for (@$files) {
		1659	utf8::decode $_;
		1660	next if /\.pst$/;
		1661	next unless /^$PATH_SEP/o;
		1662
		1663	push @paths, cf::map::normalise $_;
		1664	}
		1665
		1666	\@paths
		1667	}
		1668
		1669	package cf;
		1670
		1671	=back
		1672
		1673	=head3 cf::object
		1674
		1675	=cut
		1676
		1677	package cf::object;
716		1678
717	=over 4	1679	=over 4
718		1680
719	=item cf::player::exists $login	1681	=item $ob->inv_recursive
720		1682
721	Returns true when the given account exists.	1683	Returns the inventory of the object _and_ their inventories, recursively.
722		1684
723	=cut	1685	=cut
724		1686
725	sub cf::player::exists($) {	1687	sub inv_recursive_;
726	cf::player::find $_[0]	1688	sub inv_recursive_ {
727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1689	map { $_, inv_recursive_ $_->inv } @_
728	}	1690	}
		1691
		1692	sub inv_recursive {
		1693	inv_recursive_ inv $_[0]
		1694	}
		1695
		1696	package cf;
		1697
		1698	=back
		1699
		1700	=head3 cf::object::player
		1701
		1702	=over 4
729		1703
730	=item $player_object->reply ($npc, $msg[, $flags])	1704	=item $player_object->reply ($npc, $msg[, $flags])
731		1705
732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1706	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733	can be C<undef>. Does the right thing when the player is currently in a	1707	can be C<undef>. Does the right thing when the player is currently in a
…		…
735		1709
736	=cut	1710	=cut
737		1711
738	# rough implementation of a future "reply" method that works	1712	# rough implementation of a future "reply" method that works
739	# with dialog boxes.	1713	# with dialog boxes.
		1714	#TODO: the first argument must go, split into a $npc->reply_to ( method
740	sub cf::object::player::reply($$$;$) {	1715	sub cf::object::player::reply($$$;$) {
741	my ($self, $npc, $msg, $flags) = @_;	1716	my ($self, $npc, $msg, $flags) = @_;
742		1717
743	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1718	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744		1719
…		…
748	$msg = $npc->name . " says: $msg" if $npc;	1723	$msg = $npc->name . " says: $msg" if $npc;
749	$self->message ($msg, $flags);	1724	$self->message ($msg, $flags);
750	}	1725	}
751	}	1726	}
752		1727
753	=item $player->ext_reply ($msgid, $msgtype, %msg)
754
755	Sends an ext reply to the player.
756
757	=cut
758
759	sub cf::player::ext_reply($$$%) {
760	my ($self, $id, %msg) = @_;
761
762	$msg{msgid} = $id;
763
764	$self->send ("ext " . to_json \%msg);
765	}
766
767	=item $player_object->may ("access")	1728	=item $player_object->may ("access")
768		1729
769	Returns wether the given player is authorized to access resource "access"	1730	Returns wether the given player is authorized to access resource "access"
770	(e.g. "command_wizcast").	1731	(e.g. "command_wizcast").
771		1732
…		…
778	(ref $cf::CFG{"may_$access"}	1739	(ref $cf::CFG{"may_$access"}
779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1740	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780	: $cf::CFG{"may_$access"})	1741	: $cf::CFG{"may_$access"})
781	}	1742	}
782		1743
783	=cut	1744	=item $player_object->enter_link
784		1745
785	#############################################################################	1746	Freezes the player and moves him/her to a special map (C<{link}>).
		1747
		1748	The player should be reasonably safe there for short amounts of time. You
		1749	I<MUST> call C<leave_link> as soon as possible, though.
		1750
		1751	Will never block.
		1752
		1753	=item $player_object->leave_link ($map, $x, $y)
		1754
		1755	Moves the player out of the special C<{link}> map onto the specified
		1756	map. If the map is not valid (or omitted), the player will be moved back
		1757	to the location he/she was before the call to C<enter_link>, or, if that
		1758	fails, to the emergency map position.
		1759
		1760	Might block.
		1761
		1762	=cut
		1763
		1764	sub link_map {
		1765	unless ($LINK_MAP) {
		1766	$LINK_MAP = cf::map::find "{link}"
		1767	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1768	$LINK_MAP->load;
		1769	}
		1770
		1771	$LINK_MAP
		1772	}
		1773
		1774	sub cf::object::player::enter_link {
		1775	my ($self) = @_;
		1776
		1777	$self->deactivate_recursive;
		1778
		1779	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1780
		1781	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1782	if $self->map;
		1783
		1784	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1785	}
		1786
		1787	sub cf::object::player::leave_link {
		1788	my ($self, $map, $x, $y) = @_;
		1789
		1790	my $link_pos = delete $self->{_link_pos};
		1791
		1792	unless ($map) {
		1793	# restore original map position
		1794	($map, $x, $y) = @{ $link_pos || [] };
		1795	$map = cf::map::find $map;
		1796
		1797	unless ($map) {
		1798	($map, $x, $y) = @$EMERGENCY_POSITION;
		1799	$map = cf::map::find $map
		1800	or die "FATAL: cannot load emergency map\n";
		1801	}
		1802	}
		1803
		1804	($x, $y) = (-1, -1)
		1805	unless (defined $x) && (defined $y);
		1806
		1807	# use -1 or undef as default coordinates, not 0, 0
		1808	($x, $y) = ($map->enter_x, $map->enter_y)
		1809	if $x <=0 && $y <= 0;
		1810
		1811	$map->load;
		1812	$map->load_diag;
		1813
		1814	return unless $self->contr->active;
		1815	$self->activate_recursive;
		1816	$self->enter_map ($map, $x, $y);
		1817	}
		1818
		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)
		1852
		1853	=cut
		1854
		1855	sub cf::object::player::goto {
		1856	my ($self, $path, $x, $y) = @_;
		1857
		1858	$self->enter_link;
		1859
		1860	(async {
		1861	my $map = eval {
		1862	my $map = cf::map::find $path;
		1863	$map = $map->customise_for ($self) if $map;
		1864	$map
		1865	} or
		1866	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1867
		1868	$self->leave_link ($map, $x, $y);
		1869	})->prio (1);
		1870	}
		1871
		1872	=item $player_object->enter_exit ($exit_object)
		1873
		1874	=cut
		1875
		1876	sub parse_random_map_params {
		1877	my ($spec) = @_;
		1878
		1879	my $rmp = { # defaults
		1880	xsize => (cf::rndm 15, 40),
		1881	ysize => (cf::rndm 15, 40),
		1882	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1883	#layout => string,
		1884	};
		1885
		1886	for (split /\n/, $spec) {
		1887	my ($k, $v) = split /\s+/, $_, 2;
		1888
		1889	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1890	}
		1891
		1892	$rmp
		1893	}
		1894
		1895	sub prepare_random_map {
		1896	my ($exit) = @_;
		1897
		1898	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1899
		1900	# all this does is basically replace the /! path by
		1901	# a new random map path (?random/...) with a seed
		1902	# that depends on the exit object
		1903
		1904	my $rmp = parse_random_map_params $exit->msg;
		1905
		1906	if ($exit->map) {
		1907	$rmp->{region} = $exit->region->name;
		1908	$rmp->{origin_map} = $exit->map->path;
		1909	$rmp->{origin_x} = $exit->x;
		1910	$rmp->{origin_y} = $exit->y;
		1911	}
		1912
		1913	$rmp->{random_seed} ||= $exit->random_seed;
		1914
		1915	my $data = cf::to_json $rmp;
		1916	my $md5 = Digest::MD5::md5_hex $data;
		1917	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1918
		1919	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1920	aio_write $fh, 0, (length $data), $data, 0;
		1921	undef $fh;
		1922	aio_rename "$meta~", $meta;
		1923
		1924	$exit->slaying ("?random/$md5");
		1925	$exit->msg (undef);
		1926	}
		1927	}
		1928
		1929	sub cf::object::player::enter_exit {
		1930	my ($self, $exit) = @_;
		1931
		1932	return unless $self->type == cf::PLAYER;
		1933
		1934	if ($exit->slaying eq "/!") {
		1935	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1936	cf::sync_job { prepare_random_map $exit };
		1937	}
		1938
		1939	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1940	my $hp = $exit->stats->hp;
		1941	my $sp = $exit->stats->sp;
		1942
		1943	$self->enter_link;
		1944
		1945	(async {
		1946	$self->deactivate_recursive; # just to be sure
		1947	unless (eval {
		1948	$self->goto ($slaying, $hp, $sp);
		1949
		1950	1;
		1951	}) {
		1952	$self->message ("Something went wrong deep within the crossfire server. "
		1953	. "I'll try to bring you back to the map you were before. "
		1954	. "Please report this to the dungeon master!",
		1955	cf::NDI_UNIQUE | cf::NDI_RED);
		1956
		1957	warn "ERROR in enter_exit: $@";
		1958	$self->leave_link;
		1959	}
		1960	})->prio (1);
		1961	}
		1962
		1963	=head3 cf::client
		1964
		1965	=over 4
		1966
		1967	=item $client->send_drawinfo ($text, $flags)
		1968
		1969	Sends a drawinfo packet to the client. Circumvents output buffering so
		1970	should not be used under normal circumstances.
		1971
		1972	=cut
		1973
		1974	sub cf::client::send_drawinfo {
		1975	my ($self, $text, $flags) = @_;
		1976
		1977	utf8::encode $text;
		1978	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1979	}
		1980
		1981
		1982	=item $success = $client->query ($flags, "text", \&cb)
		1983
		1984	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>,
		1986	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1987
		1988	Queries can fail, so check the return code. Or don't, as queries will become
		1989	reliable at some point in the future.
		1990
		1991	=cut
		1992
		1993	sub cf::client::query {
		1994	my ($self, $flags, $text, $cb) = @_;
		1995
		1996	return unless $self->state == ST_PLAYING
		1997	|| $self->state == ST_SETUP
		1998	|| $self->state == ST_CUSTOM;
		1999
		2000	$self->state (ST_CUSTOM);
		2001
		2002	utf8::encode $text;
		2003	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2004
		2005	$self->send_packet ($self->{query_queue}[0][0])
		2006	if @{ $self->{query_queue} } == 1;
		2007	}
		2008
		2009	cf::client->attach (
		2010	on_reply => sub {
		2011	my ($ns, $msg) = @_;
		2012
		2013	# this weird shuffling is so that direct followup queries
		2014	# get handled first
		2015	my $queue = delete $ns->{query_queue}
		2016	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2017
		2018	(shift @$queue)->[1]->($msg);
		2019	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2020
		2021	push @{ $ns->{query_queue} }, @$queue;
		2022
		2023	if (@{ $ns->{query_queue} } == @$queue) {
		2024	if (@$queue) {
		2025	$ns->send_packet ($ns->{query_queue}[0][0]);
		2026	} else {
		2027	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2028	}
		2029	}
		2030	},
		2031	);
		2032
		2033	=item $client->async (\&cb)
		2034
		2035	Create a new coroutine, running the specified callback. The coroutine will
		2036	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2037	or loss of connection).
		2038
		2039	=cut
		2040
		2041	sub cf::client::async {
		2042	my ($self, $cb) = @_;
		2043
		2044	my $coro = &Coro::async ($cb);
		2045
		2046	$coro->on_destroy (sub {
		2047	delete $self->{_coro}{$coro+0};
		2048	});
		2049
		2050	$self->{_coro}{$coro+0} = $coro;
		2051
		2052	$coro
		2053	}
		2054
		2055	cf::client->attach (
		2056	on_destroy => sub {
		2057	my ($ns) = @_;
		2058
		2059	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2060	},
		2061	);
		2062
		2063	=back
		2064
786		2065
787	=head2 SAFE SCRIPTING	2066	=head2 SAFE SCRIPTING
788		2067
789	Functions that provide a safe environment to compile and execute	2068	Functions that provide a safe environment to compile and execute
790	snippets of perl code without them endangering the safety of the server	2069	snippets of perl code without them endangering the safety of the server
…		…
906	The parameter C<$family> should best start with the name of the extension	2185	The parameter C<$family> should best start with the name of the extension
907	using it, it should be unique.	2186	using it, it should be unique.
908		2187
909	=over 4	2188	=over 4
910		2189
911	=item $hashref = cf::db_get $family
912
913	Return a hashref for use by the extension C<$family>, which can be
914	modified. After modifications, you have to call C<cf::db_dirty> or
915	C<cf::db_sync>.
916
917	=item $value = cf::db_get $family => $key	2190	=item $value = cf::db_get $family => $key
918		2191
919	Returns a single value from the database	2192	Returns a single value from the database.
920
921	=item cf::db_put $family => $hashref
922
923	Stores the given family hashref into the database. Updates are delayed, if
924	you want the data to be synced to disk immediately, use C<cf::db_sync>.
925		2193
926	=item cf::db_put $family => $key => $value	2194	=item cf::db_put $family => $key => $value
927		2195
928	Stores the given C<$value> in the family hash. Updates are delayed, if you	2196	Stores the given C<$value> in the family.
929	want the data to be synced to disk immediately, use C<cf::db_sync>.
930
931	=item cf::db_dirty
932
933	Marks the database as dirty, to be updated at a later time.
934
935	=item cf::db_sync
936
937	Immediately write the database to disk I<if it is dirty>.
938		2197
939	=cut	2198	=cut
940		2199
941	our $DB;	2200	our $DB;
942		2201
943	{	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
944	my $path = cf::localdir . "/database.pst";	2216	my $path = cf::localdir . "/database.pst";
		2217	if (stat $path) {
		2218	cf::sync_job {
		2219	my $pst = Storable::retrieve $path;
945		2220
946	sub db_load() {	2221	cf::db_put (board => data => $pst->{board});
947	warn "loading database $path\n";#d# remove later	2222	cf::db_put (guildrules => data => $pst->{guildrules});
948	$DB = stat $path ? Storable::retrieve $path : { };	2223	cf::db_put (rent => balance => $pst->{rent}{balance});
949	}	2224	BDB::db_env_txn_checkpoint $DB_ENV;
950		2225
951	my $pid;	2226	unlink $path;
952
953	sub db_save() {
954	warn "saving database $path\n";#d# remove later
955	waitpid $pid, 0 if $pid;
956	if (0 == ($pid = fork)) {
957	$DB->{_meta}{version} = 1;
958	Storable::nstore $DB, "$path~";
959	rename "$path~", $path;
960	cf::_exit 0 if defined $pid;
961	}	2227	};
962	}
963
964	my $dirty;
965
966	sub db_sync() {
967	db_save if $dirty;
968	undef $dirty;
969	}
970
971	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
972	db_sync;
973	});	2228	}
		2229	}
974		2230
975	sub db_dirty() {
976	$dirty = 1;
977	$idle->start;
978	}
979
980	sub db_get($;$) {	2231	sub db_get($$) {
981	@_ >= 2	2232	my $key = "$_[0]/$_[1]";
982	? $DB->{$_[0]}{$_[1]}
983	: ($DB->{$_[0]} ||= { })
984	}
985		2233
		2234	cf::sync_job {
		2235	BDB::db_get $DB, undef, $key, my $data;
		2236
		2237	$! ? ()
		2238	: Compress::LZF::sthaw $data
		2239	}
		2240	}
		2241
986	sub db_put($$;$) {	2242	sub db_put($$$) {
987	if (@_ >= 3) {	2243	BDB::dbreq_pri 4;
988	$DB->{$_[0]}{$_[1]} = $_[2];	2244	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
989	} else {
990	$DB->{$_[0]} = $_[1];
991	}
992	db_dirty;
993	}
994
995	cf::global->attach (
996	prio => 10000,
997	on_cleanup => sub {
998	db_sync;
999	},
1000	);
1001	}	2245	}
1002		2246
1003	#############################################################################	2247	#############################################################################
1004	# the server's main()	2248	# the server's init and main functions
		2249
		2250	sub load_resources {
		2251	load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2252	or die "unable to load regions file\n";#d#
		2253	}
1005		2254
1006	sub cfg_load {	2255	sub cfg_load {
1007	open my $fh, "<:utf8", cf::confdir . "/config"	2256	open my $fh, "<:utf8", cf::confdir . "/config"
1008	or return;	2257	or return;
1009		2258
1010	local $/;	2259	local $/;
1011	*CFG = YAML::Syck::Load <$fh>;	2260	*CFG = YAML::Syck::Load <$fh>;
		2261
		2262	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2263
		2264	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2265	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2266
		2267	if (exists $CFG{mlockall}) {
		2268	eval {
		2269	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2270	and die "WARNING: m(un)lockall failed: $!\n";
		2271	};
		2272	warn $@ if $@;
		2273	}
		2274	}
		2275
		2276	sub init {
		2277	load_resources;
1012	}	2278	}
1013		2279
1014	sub main {	2280	sub main {
		2281	# we must not ever block the main coroutine
		2282	local $Coro::idle = sub {
		2283	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2284	(async {
		2285	Event::one_event;
		2286	})->prio (Coro::PRIO_MAX);
		2287	};
		2288
1015	cfg_load;	2289	cfg_load;
1016	db_load;
1017	load_extensions;	2290	load_extensions;
		2291
		2292	$TICK_WATCHER->start;
1018	Event::loop;	2293	Event::loop;
1019	}	2294	}
1020		2295
1021	#############################################################################	2296	#############################################################################
1022	# initialisation	2297	# initialisation and cleanup
1023		2298
		2299	# install some emergency cleanup handlers
		2300	BEGIN {
		2301	for my $signal (qw(INT HUP TERM)) {
		2302	Event->signal (
		2303	reentrant => 0,
		2304	data => WF_AUTOCANCEL,
		2305	signal => $signal,
		2306	prio => 0,
		2307	cb => sub {
		2308	cf::cleanup "SIG$signal";
		2309	},
		2310	);
		2311	}
		2312	}
		2313
		2314	sub emergency_save() {
		2315	my $freeze_guard = cf::freeze_mainloop;
		2316
		2317	warn "enter emergency perl save\n";
		2318
		2319	cf::sync_job {
		2320	# use a peculiar iteration method to avoid tripping on perl
		2321	# refcount bugs in for. also avoids problems with players
		2322	# and maps saved/destroyed asynchronously.
		2323	warn "begin emergency player save\n";
		2324	for my $login (keys %cf::PLAYER) {
		2325	my $pl = $cf::PLAYER{$login} or next;
		2326	$pl->valid or next;
		2327	$pl->save;
		2328	}
		2329	warn "end emergency player save\n";
		2330
		2331	warn "begin emergency map save\n";
		2332	for my $path (keys %cf::MAP) {
		2333	my $map = $cf::MAP{$path} or next;
		2334	$map->valid or next;
		2335	$map->save;
		2336	}
		2337	warn "end emergency map save\n";
		2338
		2339	warn "begin emergency database checkpoint\n";
		2340	BDB::db_env_txn_checkpoint $DB_ENV;
		2341	warn "end emergency database checkpoint\n";
		2342	};
		2343
		2344	warn "leave emergency perl save\n";
		2345	}
		2346
1024	sub _perl_reload(&) {	2347	sub reload() {
1025	my ($msg) = @_;	2348	# can/must only be called in main
		2349	if ($Coro::current != $Coro::main) {
		2350	warn "can only reload from main coroutine";
		2351	return;
		2352	}
1026		2353
1027	$msg->("reloading...");	2354	warn "reloading...";
		2355
		2356	warn "cancelling server ticker";
		2357	$TICK_WATCHER->cancel;
		2358
		2359	cf::emergency_save;
1028		2360
1029	eval {	2361	eval {
1030	# cancel all watchers	2362	# if anything goes wrong in here, we should simply crash as we already saved
		2363
		2364	warn "cancelling all WF_AUTOCANCEL watchers";
1031	for (Event::all_watchers) {	2365	for (Event::all_watchers) {
1032	$_->cancel if $_->data & WF_AUTOCANCEL;	2366	$_->cancel if $_->data & WF_AUTOCANCEL;
1033	}	2367	}
1034		2368
1035	# unload all extensions	2369	warn "syncing database to disk";
		2370	BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
		2371
		2372	warn "flushing outstanding aio requests";
1036	for (@exts) {	2373	for (;;) {
1037	$msg->("unloading <$_>");	2374	BDB::flush;
1038	unload_extension $_;	2375	IO::AIO::flush;
		2376	Coro::cede;
		2377	last unless IO::AIO::nreqs || BDB::nreqs;
		2378	warn "iterate...";
		2379	}
		2380
		2381	warn "cancelling all extension coros";
		2382	$_->cancel for values %EXT_CORO;
		2383	%EXT_CORO = ();
		2384
		2385	warn "removing commands";
		2386	%COMMAND = ();
		2387
		2388	warn "removing ext commands";
		2389	%EXTCMD = ();
		2390
		2391	warn "unloading/nuking all extensions";
		2392	for my $pkg (@EXTS) {
		2393	warn "... unloading $pkg";
		2394
		2395	if (my $cb = $pkg->can ("unload")) {
		2396	eval {
		2397	$cb->($pkg);
		2398	1
		2399	} or warn "$pkg unloaded, but with errors: $@";
1039	}	2400	}
1040		2401
		2402	warn "... nuking $pkg";
		2403	Symbol::delete_package $pkg;
		2404	}
		2405
1041	# unload all modules loaded from $LIBDIR	2406	warn "unloading all perl modules loaded from $LIBDIR";
1042	while (my ($k, $v) = each %INC) {	2407	while (my ($k, $v) = each %INC) {
1043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2408	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044		2409
1045	$msg->("removing <$k>");	2410	warn "... unloading $k";
1046	delete $INC{$k};	2411	delete $INC{$k};
1047		2412
1048	$k =~ s/\.pm$//;	2413	$k =~ s/\.pm$//;
1049	$k =~ s/\//::/g;	2414	$k =~ s/\//::/g;
1050		2415
…		…
1053	}	2418	}
1054		2419
1055	Symbol::delete_package $k;	2420	Symbol::delete_package $k;
1056	}	2421	}
1057		2422
1058	# sync database to disk
1059	cf::db_sync;
1060
1061	# get rid of safe::, as good as possible	2423	warn "getting rid of safe::, as good as possible";
1062	Symbol::delete_package "safe::$_"	2424	Symbol::delete_package "safe::$_"
1063	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2425	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064		2426
1065	# remove register_script_function callbacks
1066	# TODO
1067
1068	# unload cf.pm "a bit"	2427	warn "unloading cf.pm \"a bit\"";
1069	delete $INC{"cf.pm"};	2428	delete $INC{"cf.pm"};
1070		2429
1071	# don't, removes xs symbols, too,	2430	# don't, removes xs symbols, too,
1072	# and global variables created in xs	2431	# and global variables created in xs
1073	#Symbol::delete_package __PACKAGE__;	2432	#Symbol::delete_package __PACKAGE__;
1074		2433
1075	# reload cf.pm	2434	warn "unload completed, starting to reload now";
		2435
1076	$msg->("reloading cf.pm");	2436	warn "reloading cf.pm";
1077	require cf;	2437	require cf;
		2438	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078		2439
1079	# load config and database again	2440	warn "loading config and database again";
1080	cf::cfg_load;	2441	cf::cfg_load;
1081	cf::db_load;
1082		2442
1083	# load extensions	2443	warn "loading extensions";
1084	$msg->("load extensions");
1085	cf::load_extensions;	2444	cf::load_extensions;
1086		2445
1087	# reattach attachments to objects	2446	warn "reattaching attachments to objects/players";
1088	$msg->("reattach");
1089	_global_reattach;	2447	_global_reattach;
		2448	warn "reattaching attachments to maps";
		2449	reattach $_ for values %MAP;
		2450
		2451	warn "loading reloadable resources";
		2452	load_resources;
		2453
		2454	warn "restarting server ticker";
		2455
		2456	$TICK_WATCHER->start;
1090	};	2457	};
1091	$msg->($@) if $@;
1092		2458
1093	$msg->("reloaded");	2459	if ($@) {
		2460	warn $@;
		2461	warn "error while reloading, exiting.";
		2462	exit 1;
		2463	}
		2464
		2465	warn "reloaded";
1094	};	2466	};
1095		2467
1096	sub perl_reload() {	2468	our $RELOAD_WATCHER; # used only during reload
1097	_perl_reload {
1098	warn $_[0];
1099	print "$_[0]\n";
1100	};
1101	}
1102		2469
1103	register "<global>", __PACKAGE__;
1104
1105	register_command "perl-reload" => sub {	2470	register_command "reload" => sub {
1106	my ($who, $arg) = @_;	2471	my ($who, $arg) = @_;
1107		2472
1108	if ($who->flag (FLAG_WIZ)) {	2473	if ($who->flag (FLAG_WIZ)) {
1109	_perl_reload {	2474	$who->message ("reloading server.");
1110	warn $_[0];	2475
1111	$who->message ($_[0]);	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	},
1112	};	2487	);
1113	}	2488	}
1114	};	2489	};
1115		2490
1116	unshift @INC, $LIBDIR;	2491	unshift @INC, $LIBDIR;
1117		2492
		2493	my $bug_warning = 0;
		2494
1118	$TICK_WATCHER = Event->timer (	2495	$TICK_WATCHER = Event->timer (
		2496	reentrant => 0,
		2497	parked => 1,
1119	prio => 0,	2498	prio => 0,
1120	at => $NEXT_TICK || 1,	2499	at => $NEXT_TICK || $TICK,
1121	data => WF_AUTOCANCEL,	2500	data => WF_AUTOCANCEL,
1122	cb => sub {	2501	cb => sub {
		2502	if ($Coro::current != $Coro::main) {
		2503	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2504	unless ++$bug_warning > 10;
		2505	return;
		2506	}
		2507
		2508	$NOW = Event::time;
		2509
1123	cf::server_tick; # one server iteration	2510	cf::server_tick; # one server iteration
1124		2511	$RUNTIME += $TICK;
1125	my $NOW = Event::time;
1126	$NEXT_TICK += $TICK;	2512	$NEXT_TICK += $TICK;
1127		2513
		2514	$WAIT_FOR_TICK->broadcast;
		2515	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2516
		2517	Event::sweep;
		2518	Coro::cede_notself;
		2519
		2520	# my $AFTER = Event::time;
		2521	# warn $AFTER - $NOW;#d#
		2522
1128	# if we are delayed by four ticks or more, skip them all	2523	# if we are delayed by four ticks or more, skip them all
1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2524	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130		2525
1131	$TICK_WATCHER->at ($NEXT_TICK);	2526	$TICK_WATCHER->at ($NEXT_TICK);
1132	$TICK_WATCHER->start;	2527	$TICK_WATCHER->start;
1133	},	2528	},
1134	);	2529	);
1135		2530
		2531	{
		2532	BDB::max_poll_time $TICK * 0.1;
		2533	$BDB_POLL_WATCHER = Event->io (
		2534	reentrant => 0,
		2535	fd => BDB::poll_fileno,
		2536	poll => 'r',
		2537	prio => 0,
		2538	data => WF_AUTOCANCEL,
		2539	cb => \&BDB::poll_cb,
		2540	);
		2541	BDB::min_parallel 8;
		2542
		2543	BDB::set_sync_prepare {
		2544	my $status;
		2545	my $current = $Coro::current;
		2546	(
		2547	sub {
		2548	$status = $!;
		2549	$current->ready; undef $current;
		2550	},
		2551	sub {
		2552	Coro::schedule while defined $current;
		2553	$! = $status;
		2554	},
		2555	)
		2556	};
		2557
		2558	unless ($DB_ENV) {
		2559	$DB_ENV = BDB::db_env_create;
		2560
		2561	cf::sync_job {
		2562	eval {
		2563	BDB::db_env_open
		2564	$DB_ENV,
		2565	$BDB_ENV_DIR,
		2566	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2567	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2568	0666;
		2569
		2570	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2571
		2572	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2573	$DB_ENV->set_lk_detect;
		2574	};
		2575
		2576	cf::cleanup "db_env_open(db): $@" if $@;
		2577	};
		2578	}
		2579	}
		2580
		2581	{
		2582	IO::AIO::min_parallel 8;
		2583
		2584	undef $Coro::AIO::WATCHER;
1136	IO::AIO::max_poll_time $TICK * 0.2;	2585	IO::AIO::max_poll_time $TICK * 0.1;
1137		2586	$AIO_POLL_WATCHER = Event->io (
1138	Event->io (fd => IO::AIO::poll_fileno,	2587	reentrant => 0,
		2588	fd => IO::AIO::poll_fileno,
1139	poll => 'r',	2589	poll => 'r',
1140	prio => 5,	2590	prio => 6,
1141	data => WF_AUTOCANCEL,	2591	data => WF_AUTOCANCEL,
1142	cb => \&IO::AIO::poll_cb);	2592	cb => \&IO::AIO::poll_cb,
		2593	);
		2594	}
		2595
		2596	$WRITE_RUNTIME_WATCHER = Event->timer (
		2597	reentrant => 0,
		2598	data => WF_AUTOCANCEL,
		2599	after => 1,
		2600	interval => 10,
		2601	prio => 6, # keep it lowest so it acts like a watchdog
		2602	cb => Coro::unblock_sub {
		2603	write_runtime
		2604	or warn "ERROR: unable to write runtime file: $!";
		2605	},
		2606	);
		2607
		2608	END { cf::emergency_save }
1143		2609
1144	1	2610	1
1145		2611

Diff Legend

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