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

Diff Legend

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