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.47 by root, Sun Aug 27 13:02:04 2006 UTC vs.
Revision 1.231 by root, Wed Apr 4 00:02:06 2007 UTC

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

Diff Legend

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