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.23 by root, Wed Jul 19 22:19:19 2006 UTC vs.
Revision 1.188 by root, Sat Jan 20 23:30:16 2007 UTC

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

Diff Legend

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