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.28 by root, Sun Jul 30 17:42:14 2006 UTC vs.
Revision 1.149 by root, Mon Jan 8 14:11:05 2007 UTC

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

Diff Legend

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