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

Diff Legend

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