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

Diff Legend

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