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

Diff Legend

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