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

Diff Legend

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