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

Diff Legend

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