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

Diff Legend

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