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

Diff Legend

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