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

Diff Legend

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