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.36 by root, Thu Aug 24 14:04:29 2006 UTC vs.
Revision 1.165 by root, Fri Jan 12 22:09:22 2007 UTC

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

Diff Legend

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