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.51 by root, Mon Aug 28 14:05:24 2006 UTC vs.
Revision 1.232 by root, Wed Apr 4 02:07:19 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 cf::living)) {	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, key => $value...)	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, key => $value...)	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, key => $value...) # 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, %arg) = @_;	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	}	611	}
261		612
262	$obj->{$name} = \%arg;	613	$obj->{$name} = \%arg;
263	} else {	614	} else {
264	warn "object uses attachment '$name' that is not available, postponing.\n";	615	warn "object uses attachment '$name' that is not available, postponing.\n";
265	}	616	}
266		617
267	$obj->{_attachment}{$name} = undef;	618	$obj->{_attachment}{$name} = undef;
268
269	$res->{attachment} = $name;
270	$res
271	}	619	}
272		620
273	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 {
274	my ($obj, $name, %arg) = @_;	631	my ($obj, $name) = @_;
275		632
276	_attach_attachment $obj, $name, %arg;	633	if (ref $obj) {
277	}	634	delete $obj->{_attachment}{$name};
		635	reattach ($obj);
		636	} else {
		637	Carp::croak "cannot, currently, detach class attachments";
		638	}
		639	};
278		640
279	sub cf::player::attach {	641	sub cf::attachable::attached {
280	my ($obj, $name, %arg) = @_;	642	my ($obj, $name) = @_;
281		643
282	_attach_attachment KLASS_PLAYER, $obj, $name, %arg;	644	exists $obj->{_attachment}{$name}
283	}	645	}
284		646
285	sub cf::map::attach {	647	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
286	my ($obj, $name, %arg) = @_;	648	eval "#line " . __LINE__ . " 'cf.pm'
		649	sub cf::\L$klass\E::_attach_registry {
		650	(\\\@CB_$klass, KLASS_$klass)
		651	}
287		652
288	_attach_attachment KLASS_MAP, $obj, $name, %arg;	653	sub cf::\L$klass\E::attachment {
289	}
290
291	sub attach_global {
292	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
293	}
294
295	sub attach_to_type {
296	my $type = shift;
297	my $subtype = shift;
298
299	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300	}
301
302	sub attach_to_objects {
303	_attach @CB_OBJECT, KLASS_OBJECT, @_
304	}
305
306	sub attach_to_players {
307	_attach @CB_PLAYER, KLASS_PLAYER, @_
308	}
309
310	sub attach_to_maps {
311	_attach @CB_MAP, KLASS_MAP, @_
312	}
313
314	sub register_attachment {
315	my $name = shift;	654	my \$name = shift;
316		655
317	$attachment{$name} = [[KLASS_OBJECT, @_]];	656	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		657	}
		658	";
		659	die if $@;
318	}	660	}
319		661
320	our $override;	662	our $override;
321	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?
322		664
…		…
336	for (@$callbacks) {	678	for (@$callbacks) {
337	eval { &{$_->[1]} };	679	eval { &{$_->[1]} };
338		680
339	if ($@) {	681	if ($@) {
340	warn "$@";	682	warn "$@";
341	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	683	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342	override;	684	override;
343	}	685	}
344		686
345	return 1 if $override;	687	return 1 if $override;
346	}	688	}
347		689
348	0	690	0
349	}	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
350		706
351	#############################################################################	707	#############################################################################
352	# object support	708	# object support
353		709
354	sub instantiate {
355	my ($obj, $data) = @_;
356
357	$data = from_json $data;
358
359	for (@$data) {
360	my ($name, $args) = @$_;
361
362	$obj->attach ($name, %{$args || {} });
363	}
364	}
365
366	# basically do the same as instantiate, without calling instantiate
367	sub reattach {	710	sub reattach {
		711	# basically do the same as instantiate, without calling instantiate
368	my ($obj) = @_;	712	my ($obj) = @_;
		713
		714	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		715
369	my $registry = $obj->registry;	716	my $registry = $obj->registry;
370		717
371	@$registry = ();	718	@$registry = ();
372		719
373	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	720	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
374		721
375	for my $name (keys %{ $obj->{_attachment} || {} }) {	722	for my $name (keys %{ $obj->{_attachment} || {} }) {
376	if (my $attach = $attachment{$name}) {	723	if (my $attach = $attachment{$name}) {
377	for (@$attach) {	724	for (@$attach) {
378	my ($klass, @attach) = @$_;	725	my ($klass, @attach) = @$_;
379	_attach @$registry, $klass, @attach;	726	_attach $registry, $klass, @attach;
380	}	727	}
381	} else {	728	} else {
382	warn "object uses attachment '$name' that is not available, postponing.\n";	729	warn "object uses attachment '$name' that is not available, postponing.\n";
383	}	730	}
384	}	731	}
385	}	732	}
386		733
387	sub object_freezer_save {	734	cf::attachable->attach (
388	my ($filename, $objs) = @_;
389
390	if (@$objs) {
391	open my $fh, ">:raw", "$filename.pst~";
392	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
393	close $fh;
394	chmod SAVE_MODE, "$filename.pst~";
395	rename "$filename.pst~", "$filename.pst";
396	} else {
397	unlink "$filename.pst";
398	}
399
400	chmod SAVE_MODE, "$filename~";
401	rename "$filename~", $filename;
402	}
403
404	sub object_thawer_load {
405	my ($filename) = @_;
406
407	open my $fh, "<:raw:perlio", "$filename.pst"
408	or return;
409
410	eval { local $/; (Storable::thaw <$fh>)->{objs} }
411	}
412
413	attach_to_objects
414	prio => -1000000,	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,
415	on_clone => sub {	748	on_clone => sub {
416	my ($src, $dst) = @_;	749	my ($src, $dst) = @_;
417		750
418	@{$dst->registry} = @{$src->registry};	751	@{$dst->registry} = @{$src->registry};
419		752
420	%$dst = %$src;	753	%$dst = %$src;
421		754
422	%{$dst->{_attachment}} = %{$src->{_attachment}}	755	%{$dst->{_attachment}} = %{$src->{_attachment}}
423	if exists $src->{_attachment};	756	if exists $src->{_attachment};
424	},	757	},
425	;	758	);
		759
		760	sub object_freezer_save {
		761	my ($filename, $rdata, $objs) = @_;
		762
		763	sync_job {
		764	if (length $$rdata) {
		765	warn sprintf "saving %s (%d,%d)\n",
		766	$filename, length $$rdata, scalar @$objs;
		767
		768	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		769	chmod SAVE_MODE, $fh;
		770	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		771	aio_fsync $fh if $cf::USE_FSYNC;
		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
		787	aio_rename "$filename~", $filename;
		788	} else {
		789	warn "FATAL: $filename~: $!\n";
		790	}
		791	} else {
		792	aio_unlink $filename;
		793	aio_unlink "$filename.pst";
		794	}
		795	}
		796	}
		797
		798	sub object_freezer_as_string {
		799	my ($rdata, $objs) = @_;
		800
		801	use Data::Dumper;
		802
		803	$$rdata . Dumper $objs
		804	}
		805
		806	sub object_thawer_load {
		807	my ($filename) = @_;
		808
		809	my ($data, $av);
		810
		811	(aio_load $filename, $data) >= 0
		812	or return;
		813
		814	unless (aio_stat "$filename.pst") {
		815	(aio_load "$filename.pst", $av) >= 0
		816	or return;
		817	$av = eval { (Storable::thaw $av)->{objs} };
		818	}
		819
		820	warn sprintf "loading %s (%d)\n",
		821	$filename, length $data, scalar @{$av || []};#d#
		822	return ($data, $av);
		823	}
426		824
427	#############################################################################	825	#############################################################################
428	# old plug-in events	826	# command handling &c
429		827
430	sub inject_event {	828	=item cf::register_command $name => \&callback($ob,$args);
431	my $extension = shift;
432	my $event_code = shift;
433		829
434	my $cb = $hook[$event_code]{$extension}	830	Register a callback for execution when the client sends the user command
435	or return;	831	$name.
436		832
437	&$cb	833	=cut
438	}
439
440	sub inject_global_event {
441	my $event = shift;
442
443	my $cb = $hook[$event]
444	or return;
445
446	List::Util::max map &$_, values %$cb
447	}
448
449	sub inject_command {
450	my ($name, $obj, $params) = @_;
451
452	for my $cmd (@{ $command{$name} }) {
453	$cmd->[1]->($obj, $params);
454	}
455
456	-1
457	}
458		834
459	sub register_command {	835	sub register_command {
460	my ($name, $time, $cb) = @_;	836	my ($name, $cb) = @_;
461		837
462	my $caller = caller;	838	my $caller = caller;
463	#warn "registering command '$name/$time' to '$caller'";	839	#warn "registering command '$name/$time' to '$caller'";
464		840
465	push @{ $command{$name} }, [$time, $cb, $caller];	841	push @{ $COMMAND{$name} }, [$caller, $cb];
466	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
467	}	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
468		852
469	sub register_extcmd {	853	sub register_extcmd {
470	my ($name, $cb) = @_;	854	my ($name, $cb) = @_;
471		855
472	my $caller = caller;	856	$EXTCMD{$name} = $cb;
473	#warn "registering extcmd '$name' to '$caller'";
474
475	$extcmd{$name} = [$cb, $caller];
476	}	857	}
477		858
478	sub register {	859	cf::player->attach (
479	my ($base, $pkg) = @_;	860	on_command => sub {
		861	my ($pl, $name, $params) = @_;
480		862
481	#TODO	863	my $cb = $COMMAND{$name}
482	}	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	);
483		890
484	sub load_extension {	891	sub load_extension {
485	my ($path) = @_;	892	my ($path) = @_;
486		893
487	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	894	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
488	my $base = $1;	895	my $base = $1;
489	my $pkg = $1;	896	my $pkg = $1;
490	$pkg =~ s/[^[:word:]]/_/g;	897	$pkg =~ s/[^[:word:]]/_/g;
491	$pkg = "ext::$pkg";	898	$pkg = "ext::$pkg";
492		899
493	warn "loading '$path' into '$pkg'\n";	900	warn "... loading '$path' into '$pkg'\n";
494		901
495	open my $fh, "<:utf8", $path	902	open my $fh, "<:utf8", $path
496	or die "$path: $!";	903	or die "$path: $!";
497		904
498	my $source =	905	my $source =
499	"package $pkg; use strict; use utf8;\n"	906	"package $pkg; use strict; use utf8;\n"
500	. "#line 1 \"$path\"\n{\n"	907	. "#line 1 \"$path\"\n{\n"
501	. (do { local $/; <$fh> })	908	. (do { local $/; <$fh> })
502	. "\n};\n1";	909	. "\n};\n1";
503		910
504	eval $source	911	unless (eval $source) {
505	or die "$path: $@";	912	my $msg = $@ ? "$path: $@\n"
506		913	: "extension disabled.\n";
507	push @exts, $pkg;	914	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
508	$ext_pkg{$base} = $pkg;	915	warn $@;
509		916	warn "mandatory extension failed to load, exiting.\n";
510	# no strict 'refs';	917	exit 1;
511	# @{"$pkg\::ISA"} = ext::;	918	}
512		919	die $@;
513	register $base, $pkg;
514	}
515
516	sub unload_extension {
517	my ($pkg) = @_;
518
519	warn "removing extension $pkg\n";
520
521	# remove hooks
522	#TODO
523	# for my $idx (0 .. $#PLUGIN_EVENT) {
524	# delete $hook[$idx]{$pkg};
525	# }	920	}
526		921
527	# remove commands	922	push @EXTS, $pkg;
528	for my $name (keys %command) {
529	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
530
531	if (@cb) {
532	$command{$name} = \@cb;
533	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
534	} else {
535	delete $command{$name};
536	delete $COMMAND{"$name\000"};
537	}
538	}
539
540	# remove extcmds
541	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
542	delete $extcmd{$name};
543	}
544
545	if (my $cb = $pkg->can ("unload")) {
546	eval {
547	$cb->($pkg);
548	1
549	} or warn "$pkg unloaded, but with errors: $@";
550	}
551
552	Symbol::delete_package $pkg;
553	}	923	}
554		924
555	sub load_extensions {	925	sub load_extensions {
556	my $LIBDIR = maps_directory "perl";
557
558	for my $ext (<$LIBDIR/*.ext>) {	926	for my $ext (<$LIBDIR/*.ext>) {
559	next unless -r $ext;	927	next unless -r $ext;
560	eval {	928	eval {
561	load_extension $ext;	929	load_extension $ext;
562	1	930	1
563	} or warn "$ext not loaded: $@";	931	} or warn "$ext not loaded: $@";
564	}	932	}
565	}	933	}
566		934
567	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	$self->ns->ext_event ($type, %msg);
		1153	}
		1154
		1155	package cf;
		1156
		1157	=back
		1158
		1159
		1160	=head3 cf::map
		1161
		1162	=over 4
		1163
		1164	=cut
		1165
		1166	package cf::map;
		1167
		1168	use Fcntl;
		1169	use Coro::AIO;
		1170
		1171	use overload
		1172	'""' => \&as_string,
		1173	fallback => 1;
		1174
		1175	our $MAX_RESET = 3600;
		1176	our $DEFAULT_RESET = 3000;
		1177
		1178	sub generate_random_map {
		1179	my ($self, $rmp) = @_;
		1180	# mit "rum" bekleckern, nicht
		1181	$self->_create_random_map (
		1182	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1183	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1184	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1185	$rmp->{exit_on_final_map},
		1186	$rmp->{xsize}, $rmp->{ysize},
		1187	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1188	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1189	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1190	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1191	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1192	(cf::region::find $rmp->{region}), $rmp->{custom}
		1193	)
		1194	}
		1195
		1196	=item cf::map->register ($regex, $prio)
		1197
		1198	Register a handler for the map path matching the given regex at the
		1199	givne priority (higher is better, built-in handlers have priority 0, the
		1200	default).
		1201
		1202	=cut
		1203
		1204	sub register {
		1205	my (undef, $regex, $prio) = @_;
		1206	my $pkg = caller;
		1207
		1208	no strict;
		1209	push @{"$pkg\::ISA"}, __PACKAGE__;
		1210
		1211	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1212	}
		1213
		1214	# also paths starting with '/'
		1215	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1216
		1217	sub thawer_merge {
		1218	my ($self, $merge) = @_;
		1219
		1220	# we have to keep some variables in memory intact
		1221	local $self->{path};
		1222	local $self->{load_path};
		1223	local $self->{deny_save};
		1224	local $self->{deny_reset};
		1225
		1226	$self->SUPER::thawer_merge ($merge);
		1227	}
		1228
		1229	sub normalise {
		1230	my ($path, $base) = @_;
		1231
		1232	$path = "$path"; # make sure its a string
		1233
		1234	$path =~ s/\.map$//;
		1235
		1236	# map plan:
		1237	#
		1238	# /! non-realised random map exit (special hack!)
		1239	# {... are special paths that are not being touched
		1240	# ?xxx/... are special absolute paths
		1241	# ?random/... random maps
		1242	# /... normal maps
		1243	# ~user/... per-player map of a specific user
		1244
		1245	$path =~ s/$PATH_SEP/\//go;
		1246
		1247	# treat it as relative path if it starts with
		1248	# something that looks reasonable
		1249	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1250	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1251
		1252	$base =~ s{[^/]+/?$}{};
		1253	$path = "$base/$path";
		1254	}
		1255
		1256	for ($path) {
		1257	redo if s{//}{/};
		1258	redo if s{/\.?/}{/};
		1259	redo if s{/[^/]+/\.\./}{/};
		1260	}
		1261
		1262	$path
		1263	}
		1264
		1265	sub new_from_path {
		1266	my (undef, $path, $base) = @_;
		1267
		1268	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1269
		1270	$path = normalise $path, $base;
		1271
		1272	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1273	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1274	my $self = bless cf::map::new, $pkg;
		1275	$self->{path} = $path; $self->path ($path);
		1276	$self->init; # pass $1 etc.
		1277	return $self;
		1278	}
		1279	}
		1280
		1281	Carp::carp "unable to resolve path '$path' (base '$base').";
		1282	()
		1283	}
		1284
		1285	sub init {
		1286	my ($self) = @_;
		1287
		1288	$self
		1289	}
		1290
		1291	sub as_string {
		1292	my ($self) = @_;
		1293
		1294	"$self->{path}"
		1295	}
		1296
		1297	# the displayed name, this is a one way mapping
		1298	sub visible_name {
		1299	&as_string
		1300	}
		1301
		1302	# the original (read-only) location
		1303	sub load_path {
		1304	my ($self) = @_;
		1305
		1306	sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
		1307	}
		1308
		1309	# the temporary/swap location
		1310	sub save_path {
		1311	my ($self) = @_;
		1312
		1313	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1314	sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
		1315	}
		1316
		1317	# the unique path, undef == no special unique path
		1318	sub uniq_path {
		1319	my ($self) = @_;
		1320
		1321	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1322	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1323	}
		1324
		1325	# and all this just because we cannot iterate over
		1326	# all maps in C++...
		1327	sub change_all_map_light {
		1328	my ($change) = @_;
		1329
		1330	$_->change_map_light ($change)
		1331	for grep $_->outdoor, values %cf::MAP;
		1332	}
		1333
		1334	sub unlink_save {
		1335	my ($self) = @_;
		1336
		1337	utf8::encode (my $save = $self->save_path);
		1338	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1339	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1340	}
		1341
		1342	sub load_header_from($) {
		1343	my ($self, $path) = @_;
		1344
		1345	utf8::encode $path;
		1346	#aio_open $path, O_RDONLY, 0
		1347	# or return;
		1348
		1349	$self->_load_header ($path)
		1350	or return;
		1351
		1352	$self->{load_path} = $path;
		1353
		1354	1
		1355	}
		1356
		1357	sub load_header_orig {
		1358	my ($self) = @_;
		1359
		1360	$self->load_header_from ($self->load_path)
		1361	}
		1362
		1363	sub load_header_temp {
		1364	my ($self) = @_;
		1365
		1366	$self->load_header_from ($self->save_path)
		1367	}
		1368
		1369	sub prepare_temp {
		1370	my ($self) = @_;
		1371
		1372	$self->last_access ((delete $self->{last_access})
		1373	|| $cf::RUNTIME); #d#
		1374	# safety
		1375	$self->{instantiate_time} = $cf::RUNTIME
		1376	if $self->{instantiate_time} > $cf::RUNTIME;
		1377	}
		1378
		1379	sub prepare_orig {
		1380	my ($self) = @_;
		1381
		1382	$self->{load_original} = 1;
		1383	$self->{instantiate_time} = $cf::RUNTIME;
		1384	$self->last_access ($cf::RUNTIME);
		1385	$self->instantiate;
		1386	}
		1387
		1388	sub load_header {
		1389	my ($self) = @_;
		1390
		1391	if ($self->load_header_temp) {
		1392	$self->prepare_temp;
		1393	} else {
		1394	$self->load_header_orig
		1395	or return;
		1396	$self->prepare_orig;
		1397	}
		1398
		1399	1
		1400	}
		1401
		1402	sub find;
		1403	sub find {
		1404	my ($path, $origin) = @_;
		1405
		1406	$path = normalise $path, $origin && $origin->path;
		1407
		1408	cf::lock_wait "map_find:$path";
		1409
		1410	$cf::MAP{$path} || do {
		1411	my $guard = cf::lock_acquire "map_find:$path";
		1412	my $map = new_from_path cf::map $path
		1413	or return;
		1414
		1415	$map->{last_save} = $cf::RUNTIME;
		1416
		1417	$map->load_header
		1418	or return;
		1419
		1420	if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
		1421	# doing this can freeze the server in a sync job, obviously
		1422	#$cf::WAIT_FOR_TICK->wait;
		1423	$map->reset;
		1424	undef $guard;
		1425	return find $path;
		1426	}
		1427
		1428	$cf::MAP{$path} = $map
		1429	}
		1430	}
		1431
		1432	sub pre_load { }
		1433	sub post_load { }
		1434
		1435	sub load {
		1436	my ($self) = @_;
		1437
		1438	local $self->{deny_reset} = 1; # loading can take a long time
		1439
		1440	my $path = $self->{path};
		1441	my $guard = cf::lock_acquire "map_load:$path";
		1442
		1443	return if $self->in_memory != cf::MAP_SWAPPED;
		1444
		1445	$self->in_memory (cf::MAP_LOADING);
		1446
		1447	$self->alloc;
		1448
		1449	$self->pre_load;
		1450
		1451	$self->_load_objects ($self->{load_path}, 1)
		1452	or return;
		1453
		1454	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1455	if delete $self->{load_original};
		1456
		1457	if (my $uniq = $self->uniq_path) {
		1458	utf8::encode $uniq;
		1459	if (aio_open $uniq, O_RDONLY, 0) {
		1460	$self->clear_unique_items;
		1461	$self->_load_objects ($uniq, 0);
		1462	}
		1463	}
		1464
		1465	Coro::cede;
		1466
		1467	# now do the right thing for maps
		1468	$self->link_multipart_objects;
		1469
		1470	unless ($self->{deny_activate}) {
		1471	$self->decay_objects;
		1472	$self->fix_auto_apply;
		1473	$self->update_buttons;
		1474	Coro::cede;
		1475	$self->set_darkness_map;
		1476	$self->difficulty ($self->estimate_difficulty)
		1477	unless $self->difficulty;
		1478	Coro::cede;
		1479	$self->activate;
		1480	}
		1481
		1482	$self->post_load;
		1483
		1484	$self->in_memory (cf::MAP_IN_MEMORY);
		1485	}
		1486
		1487	sub customise_for {
		1488	my ($self, $ob) = @_;
		1489
		1490	return find "~" . $ob->name . "/" . $self->{path}
		1491	if $self->per_player;
		1492
		1493	$self
		1494	}
		1495
		1496	# find and load all maps in the 3x3 area around a map
		1497	sub load_diag {
568	my ($msg) = @_;	1498	my ($map) = @_;
569		1499
570	$msg->("reloading...");	1500	my @diag; # diagonal neighbours
571		1501
572	eval {	1502	for (0 .. 3) {
573	# 1. cancel all watchers	1503	my $neigh = $map->tile_path ($_)
574	$_->cancel for Event::all_watchers;	1504	or next;
		1505	$neigh = find $neigh, $map
		1506	or next;
		1507	$neigh->load;
575		1508
576	# 2. unload all extensions	1509	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
577	for (@exts) {	1510	[$neigh->tile_path (($_ + 1) % 4), $neigh];
578	$msg->("unloading <$_>");	1511	}
579	unload_extension $_;
580	}
581		1512
582	# 3. unload all modules loaded from $LIBDIR	1513	for (@diag) {
583	while (my ($k, $v) = each %INC) {	1514	my $neigh = find @$_
584	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1515	or next;
		1516	$neigh->load;
		1517	}
		1518	}
585		1519
586	$msg->("removing <$k>");	1520	sub find_sync {
587	delete $INC{$k};	1521	my ($path, $origin) = @_;
588		1522
589	$k =~ s/\.pm$//;	1523	cf::sync_job { find $path, $origin }
590	$k =~ s/\//::/g;	1524	}
591		1525
592	if (my $cb = $k->can ("unload_module")) {	1526	sub do_load_sync {
593	$cb->();	1527	my ($map) = @_;
		1528
		1529	cf::sync_job { $map->load };
		1530	}
		1531
		1532	our %MAP_PREFETCH;
		1533	our $MAP_PREFETCHER = undef;
		1534
		1535	sub find_async {
		1536	my ($path, $origin) = @_;
		1537
		1538	$path = normalise $path, $origin && $origin->{path};
		1539
		1540	if (my $map = $cf::MAP{$path}) {
		1541	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1542	}
		1543
		1544	undef $MAP_PREFETCH{$path};
		1545	$MAP_PREFETCHER ||= cf::async {
		1546	while (%MAP_PREFETCH) {
		1547	for my $path (keys %MAP_PREFETCH) {
		1548	my $map = find $path
		1549	or next;
		1550	$map->load;
		1551
		1552	delete $MAP_PREFETCH{$path};
594	}	1553	}
595
596	Symbol::delete_package $k;
597	}
598
599	# 4. get rid of safe::, as good as possible
600	Symbol::delete_package "safe::$_"
601	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
602
603	# 5. remove register_script_function callbacks
604	# TODO
605		1554	}
606	# 6. unload cf.pm "a bit"	1555	undef $MAP_PREFETCHER;
607	delete $INC{"cf.pm"};
608
609	# don't, removes xs symbols, too,
610	# and global variables created in xs
611	#Symbol::delete_package __PACKAGE__;
612
613	# 7. reload cf.pm
614	$msg->("reloading cf.pm");
615	require cf;
616	};	1556	};
617	$msg->($@) if $@;	1557	$MAP_PREFETCHER->prio (6);
618		1558
619	$msg->("reloaded");	1559	()
620	};	1560	}
621		1561
622	sub perl_reload() {	1562	sub save {
623	_perl_reload {	1563	my ($self) = @_;
624	warn $_[0];	1564
625	print "$_[0]\n";	1565	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1566
		1567	$self->{last_save} = $cf::RUNTIME;
		1568
		1569	return unless $self->dirty;
		1570
		1571	my $save = $self->save_path; utf8::encode $save;
		1572	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1573
		1574	$self->{load_path} = $save;
		1575
		1576	return if $self->{deny_save};
		1577
		1578	local $self->{last_access} = $self->last_access;#d#
		1579
		1580	cf::async {
		1581	$_->contr->save for $self->players;
626	};	1582	};
627	}
628		1583
629	register_command "perl-reload", 0, sub {	1584	if ($uniq) {
630	my ($who, $arg) = @_;	1585	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
631		1586	$self->_save_objects ($uniq, cf::IO_UNIQUES);
632	if ($who->flag (FLAG_WIZ)) {
633	_perl_reload {
634	warn $_[0];
635	$who->message ($_[0]);
636	};
637	}
638	};
639
640	#############################################################################
641	# extcmd framework, basically convert ext <msg>
642	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
643
644	attach_to_players
645	on_extcmd => sub {
646	my ($pl, $buf) = @_;
647
648	my $msg = eval { from_json $buf };
649
650	if (ref $msg) {
651	if (my $cb = $extcmd{$msg->{msgtype}}) {
652	if (my %reply = $cb->[0]->($pl, $msg)) {
653	$pl->ext_reply ($msg->{msgid}, %reply);
654	}
655	}
656	} else {	1587	} else {
657	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	1588	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
658	}
659
660	cf::override;
661	},	1589	}
662	;	1590	}
663		1591
664	#############################################################################	1592	sub swap_out {
665	# load/save/clean perl data associated with a map
666
667	*cf::mapsupport::on_clean = sub {
668	my ($map) = @_;	1593	my ($self) = @_;
669		1594
670	my $path = $map->tmpname;	1595	# save first because save cedes
671	defined $path or return;	1596	$self->save;
672		1597
673	unlink "$path.pst";	1598	my $lock = cf::lock_acquire "map_data:" . $self->path;
674	};
675		1599
676	# old style persistent data, TODO: remove #d#	1600	return if $self->players;
677	*cf::mapsupport::on_swapin =	1601	return if $self->in_memory != cf::MAP_IN_MEMORY;
678	*cf::mapsupport::on_load = sub {	1602	return if $self->{deny_save};
		1603
		1604	$self->clear;
		1605	$self->in_memory (cf::MAP_SWAPPED);
		1606	}
		1607
		1608	sub reset_at {
679	my ($map) = @_;	1609	my ($self) = @_;
680		1610
681	my $path = $map->tmpname;	1611	# TODO: safety, remove and allow resettable per-player maps
682	$path = $map->path unless defined $path;	1612	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1613	return 1e99 if $self->{deny_reset};
683		1614
684	open my $fh, "<:raw", "$path.cfperl"	1615	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
685	or return; # no perl data	1616	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
686		1617
687	my $data = Storable::thaw do { local $/; <$fh> };	1618	$time + $to
688
689	$data->{version} <= 1
690	or return; # too new
691
692	$map->_set_obs ($data->{obs});
693	$map->invoke (EVENT_MAP_UPGRADE);
694	};
695
696	attach_to_maps prio => -10000, package => cf::mapsupport::;
697
698	#############################################################################
699	# load/save perl data associated with player->ob objects
700
701	sub all_objects(@) {
702	@_, map all_objects ($_->inv), @_
703	}	1619	}
704		1620
705	attach_to_players	1621	sub should_reset {
706	on_load => sub {	1622	my ($self) = @_;
707	my ($pl, $path) = @_;
708		1623
709	for my $o (all_objects $pl->ob) {	1624	$self->reset_at <= $cf::RUNTIME
710	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1625	}
711	$o->set_ob_key_value ("_perl_data");
712		1626
713	%$o = %{ Storable::thaw pack "H*", $value };	1627	sub reset {
714	}	1628	my ($self) = @_;
715	}	1629
		1630	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1631
		1632	return if $self->players;
		1633	return if $self->isa ("ext::map_per_player");#d#
		1634
		1635	warn "resetting map ", $self->path;#d#
		1636
		1637	$self->in_memory (cf::MAP_SWAPPED);
		1638
		1639	# need to save uniques path
		1640	unless ($self->{deny_save}) {
		1641	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1642
		1643	$self->_save_objects ($uniq, cf::IO_UNIQUES)
		1644	if $uniq;
716	},	1645	}
717	;
718		1646
719	#############################################################################	1647	delete $cf::MAP{$self->path};
720	# core extensions - in perl
721		1648
722	=item cf::player::exists $login	1649	$self->clear;
723		1650
724	Returns true when the given account exists.	1651	$_->clear_links_to ($self) for values %cf::MAP;
725		1652
726	=cut	1653	$self->unlink_save;
727		1654	$self->destroy;
728	sub cf::player::exists($) {
729	cf::player::find $_[0]
730	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
731	}	1655	}
732		1656
		1657	my $nuke_counter = "aaaa";
		1658
		1659	sub nuke {
		1660	my ($self) = @_;
		1661
		1662	delete $cf::MAP{$self->path};
		1663
		1664	$self->unlink_save;
		1665
		1666	bless $self, "cf::map";
		1667	delete $self->{deny_reset};
		1668	$self->{deny_save} = 1;
		1669	$self->reset_timeout (1);
		1670	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1671
		1672	$cf::MAP{$self->path} = $self;
		1673
		1674	$self->reset; # polite request, might not happen
		1675	}
		1676
		1677	=item cf::map::unique_maps
		1678
		1679	Returns an arrayref of paths of all shared maps that have
		1680	instantiated unique items. May block.
		1681
		1682	=cut
		1683
		1684	sub unique_maps() {
		1685	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1686	or return;
		1687
		1688	my @paths;
		1689
		1690	for (@$files) {
		1691	utf8::decode $_;
		1692	next if /\.pst$/;
		1693	next unless /^$PATH_SEP/o;
		1694
		1695	push @paths, cf::map::normalise $_;
		1696	}
		1697
		1698	\@paths
		1699	}
		1700
		1701	package cf;
		1702
		1703	=back
		1704
		1705	=head3 cf::object
		1706
		1707	=cut
		1708
		1709	package cf::object;
		1710
		1711	=over 4
		1712
		1713	=item $ob->inv_recursive
		1714
		1715	Returns the inventory of the object _and_ their inventories, recursively.
		1716
		1717	=cut
		1718
		1719	sub inv_recursive_;
		1720	sub inv_recursive_ {
		1721	map { $_, inv_recursive_ $_->inv } @_
		1722	}
		1723
		1724	sub inv_recursive {
		1725	inv_recursive_ inv $_[0]
		1726	}
		1727
		1728	package cf;
		1729
		1730	=back
		1731
		1732	=head3 cf::object::player
		1733
		1734	=over 4
		1735
733	=item $player->reply ($npc, $msg[, $flags])	1736	=item $player_object->reply ($npc, $msg[, $flags])
734		1737
735	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1738	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
736	can be C<undef>. Does the right thing when the player is currently in a	1739	can be C<undef>. Does the right thing when the player is currently in a
737	dialogue with the given NPC character.	1740	dialogue with the given NPC character.
738		1741
739	=cut	1742	=cut
740		1743
741	# rough implementation of a future "reply" method that works	1744	# rough implementation of a future "reply" method that works
742	# with dialog boxes.	1745	# with dialog boxes.
		1746	#TODO: the first argument must go, split into a $npc->reply_to ( method
743	sub cf::object::player::reply($$$;$) {	1747	sub cf::object::player::reply($$$;$) {
744	my ($self, $npc, $msg, $flags) = @_;	1748	my ($self, $npc, $msg, $flags) = @_;
745		1749
746	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1750	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
747		1751
…		…
751	$msg = $npc->name . " says: $msg" if $npc;	1755	$msg = $npc->name . " says: $msg" if $npc;
752	$self->message ($msg, $flags);	1756	$self->message ($msg, $flags);
753	}	1757	}
754	}	1758	}
755		1759
756	=item $player->ext_reply ($msgid, $msgtype, %msg)	1760	=item $player_object->may ("access")
757		1761
758	Sends an ext reply to the player.	1762	Returns wether the given player is authorized to access resource "access"
		1763	(e.g. "command_wizcast").
759		1764
760	=cut	1765	=cut
761		1766
762	sub cf::player::ext_reply($$$%) {	1767	sub cf::object::player::may {
		1768	my ($self, $access) = @_;
		1769
		1770	$self->flag (cf::FLAG_WIZ) ||
		1771	(ref $cf::CFG{"may_$access"}
		1772	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1773	: $cf::CFG{"may_$access"})
		1774	}
		1775
		1776	=item $player_object->enter_link
		1777
		1778	Freezes the player and moves him/her to a special map (C<{link}>).
		1779
		1780	The player should be reasonably safe there for short amounts of time. You
		1781	I<MUST> call C<leave_link> as soon as possible, though.
		1782
		1783	Will never block.
		1784
		1785	=item $player_object->leave_link ($map, $x, $y)
		1786
		1787	Moves the player out of the special C<{link}> map onto the specified
		1788	map. If the map is not valid (or omitted), the player will be moved back
		1789	to the location he/she was before the call to C<enter_link>, or, if that
		1790	fails, to the emergency map position.
		1791
		1792	Might block.
		1793
		1794	=cut
		1795
		1796	sub link_map {
		1797	unless ($LINK_MAP) {
		1798	$LINK_MAP = cf::map::find "{link}"
		1799	or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
		1800	$LINK_MAP->load;
		1801	}
		1802
		1803	$LINK_MAP
		1804	}
		1805
		1806	sub cf::object::player::enter_link {
		1807	my ($self) = @_;
		1808
		1809	$self->deactivate_recursive;
		1810
		1811	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1812
		1813	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1814	if $self->map;
		1815
		1816	$self->enter_map ($LINK_MAP || link_map, 10, 10);
		1817	}
		1818
		1819	sub cf::object::player::leave_link {
		1820	my ($self, $map, $x, $y) = @_;
		1821
		1822	my $link_pos = delete $self->{_link_pos};
		1823
		1824	unless ($map) {
		1825	# restore original map position
		1826	($map, $x, $y) = @{ $link_pos || [] };
		1827	$map = cf::map::find $map;
		1828
		1829	unless ($map) {
		1830	($map, $x, $y) = @$EMERGENCY_POSITION;
		1831	$map = cf::map::find $map
		1832	or die "FATAL: cannot load emergency map\n";
		1833	}
		1834	}
		1835
		1836	($x, $y) = (-1, -1)
		1837	unless (defined $x) && (defined $y);
		1838
		1839	# use -1 or undef as default coordinates, not 0, 0
		1840	($x, $y) = ($map->enter_x, $map->enter_y)
		1841	if $x <=0 && $y <= 0;
		1842
		1843	$map->load;
		1844	$map->load_diag;
		1845
		1846	return unless $self->contr->active;
		1847	$self->activate_recursive;
		1848
		1849	local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
		1850	$self->enter_map ($map, $x, $y);
		1851	}
		1852
		1853	cf::player->attach (
		1854	on_logout => sub {
		1855	my ($pl) = @_;
		1856
		1857	# abort map switching before logout
		1858	if ($pl->ob->{_link_pos}) {
		1859	cf::sync_job {
		1860	$pl->ob->leave_link
		1861	};
		1862	}
		1863	},
		1864	on_login => sub {
		1865	my ($pl) = @_;
		1866
		1867	# try to abort aborted map switching on player login :)
		1868	# should happen only on crashes
		1869	if ($pl->ob->{_link_pos}) {
		1870	$pl->ob->enter_link;
		1871	(async {
		1872	$pl->ob->reply (undef,
		1873	"There was an internal problem at your last logout, "
		1874	. "the server will try to bring you to your intended destination in a second.",
		1875	cf::NDI_RED);
		1876	# we need this sleep as the login has a concurrent enter_exit running
		1877	# and this sleep increases chances of the player not ending up in scorn
		1878	Coro::Timer::sleep 1;
		1879	$pl->ob->leave_link;
		1880	})->prio (2);
		1881	}
		1882	},
		1883	);
		1884
		1885	=item $player_object->goto ($path, $x, $y)
		1886
		1887	=cut
		1888
		1889	sub cf::object::player::goto {
		1890	my ($self, $path, $x, $y) = @_;
		1891
		1892	$self->enter_link;
		1893
		1894	(async {
		1895	my $map = eval {
		1896	my $map = cf::map::find $path;
		1897	$map = $map->customise_for ($self) if $map;
		1898	$map
		1899	} or
		1900	$self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1901
		1902	$self->leave_link ($map, $x, $y);
		1903	})->prio (1);
		1904	}
		1905
		1906	=item $player_object->enter_exit ($exit_object)
		1907
		1908	=cut
		1909
		1910	sub parse_random_map_params {
		1911	my ($spec) = @_;
		1912
		1913	my $rmp = { # defaults
		1914	xsize => (cf::rndm 15, 40),
		1915	ysize => (cf::rndm 15, 40),
		1916	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1917	#layout => string,
		1918	};
		1919
		1920	for (split /\n/, $spec) {
		1921	my ($k, $v) = split /\s+/, $_, 2;
		1922
		1923	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1924	}
		1925
		1926	$rmp
		1927	}
		1928
		1929	sub prepare_random_map {
		1930	my ($exit) = @_;
		1931
		1932	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1933
		1934	# all this does is basically replace the /! path by
		1935	# a new random map path (?random/...) with a seed
		1936	# that depends on the exit object
		1937
		1938	my $rmp = parse_random_map_params $exit->msg;
		1939
		1940	if ($exit->map) {
		1941	$rmp->{region} = $exit->region->name;
		1942	$rmp->{origin_map} = $exit->map->path;
		1943	$rmp->{origin_x} = $exit->x;
		1944	$rmp->{origin_y} = $exit->y;
		1945	}
		1946
		1947	$rmp->{random_seed} ||= $exit->random_seed;
		1948
		1949	my $data = cf::to_json $rmp;
		1950	my $md5 = Digest::MD5::md5_hex $data;
		1951	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1952
		1953	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1954	aio_write $fh, 0, (length $data), $data, 0;
		1955	undef $fh;
		1956	aio_rename "$meta~", $meta;
		1957
		1958	$exit->slaying ("?random/$md5");
		1959	$exit->msg (undef);
		1960	}
		1961	}
		1962
		1963	sub cf::object::player::enter_exit {
		1964	my ($self, $exit) = @_;
		1965
		1966	return unless $self->type == cf::PLAYER;
		1967
		1968	if ($exit->slaying eq "/!") {
		1969	#TODO: this should de-fi-ni-te-ly not be a sync-job
		1970	cf::sync_job { prepare_random_map $exit };
		1971	}
		1972
		1973	my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
		1974	my $hp = $exit->stats->hp;
		1975	my $sp = $exit->stats->sp;
		1976
		1977	$self->enter_link;
		1978
		1979	(async {
		1980	$self->deactivate_recursive; # just to be sure
		1981	unless (eval {
		1982	$self->goto ($slaying, $hp, $sp);
		1983
		1984	1;
		1985	}) {
		1986	$self->message ("Something went wrong deep within the crossfire server. "
		1987	. "I'll try to bring you back to the map you were before. "
		1988	. "Please report this to the dungeon master!",
		1989	cf::NDI_UNIQUE | cf::NDI_RED);
		1990
		1991	warn "ERROR in enter_exit: $@";
		1992	$self->leave_link;
		1993	}
		1994	})->prio (1);
		1995	}
		1996
		1997	=head3 cf::client
		1998
		1999	=over 4
		2000
		2001	=item $client->send_drawinfo ($text, $flags)
		2002
		2003	Sends a drawinfo packet to the client. Circumvents output buffering so
		2004	should not be used under normal circumstances.
		2005
		2006	=cut
		2007
		2008	sub cf::client::send_drawinfo {
		2009	my ($self, $text, $flags) = @_;
		2010
		2011	utf8::encode $text;
		2012	$self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
		2013	}
		2014
		2015	=item $client->ext_event ($type, %msg)
		2016
		2017	Sends an exti event to the client.
		2018
		2019	=cut
		2020
		2021	sub cf::client::ext_event($$%) {
763	my ($self, $id, %msg) = @_;	2022	my ($self, $type, %msg) = @_;
764		2023
765	$msg{msgid} = $id;	2024	$msg{msgtype} = "event_$type";
766
767	$self->send ("ext " . to_json \%msg);	2025	$self->send_packet ("ext " . cf::to_json \%msg);
768	}	2026	}
769		2027
770	#############################################################################	2028	=item $success = $client->query ($flags, "text", \&cb)
771	# map scripting support	2029
		2030	Queues a query to the client, calling the given callback with
		2031	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		2032	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		2033
		2034	Queries can fail, so check the return code. Or don't, as queries will become
		2035	reliable at some point in the future.
		2036
		2037	=cut
		2038
		2039	sub cf::client::query {
		2040	my ($self, $flags, $text, $cb) = @_;
		2041
		2042	return unless $self->state == ST_PLAYING
		2043	|| $self->state == ST_SETUP
		2044	|| $self->state == ST_CUSTOM;
		2045
		2046	$self->state (ST_CUSTOM);
		2047
		2048	utf8::encode $text;
		2049	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		2050
		2051	$self->send_packet ($self->{query_queue}[0][0])
		2052	if @{ $self->{query_queue} } == 1;
		2053	}
		2054
		2055	cf::client->attach (
		2056	on_reply => sub {
		2057	my ($ns, $msg) = @_;
		2058
		2059	# this weird shuffling is so that direct followup queries
		2060	# get handled first
		2061	my $queue = delete $ns->{query_queue}
		2062	or return; # be conservative, not sure how that can happen, but we saw a crash here
		2063
		2064	(shift @$queue)->[1]->($msg);
		2065	return unless $ns->valid; # temporary(?) workaround for callback destroying socket
		2066
		2067	push @{ $ns->{query_queue} }, @$queue;
		2068
		2069	if (@{ $ns->{query_queue} } == @$queue) {
		2070	if (@$queue) {
		2071	$ns->send_packet ($ns->{query_queue}[0][0]);
		2072	} else {
		2073	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		2074	}
		2075	}
		2076	},
		2077	);
		2078
		2079	=item $client->async (\&cb)
		2080
		2081	Create a new coroutine, running the specified callback. The coroutine will
		2082	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2083	or loss of connection).
		2084
		2085	=cut
		2086
		2087	sub cf::client::async {
		2088	my ($self, $cb) = @_;
		2089
		2090	my $coro = &Coro::async ($cb);
		2091
		2092	$coro->on_destroy (sub {
		2093	delete $self->{_coro}{$coro+0};
		2094	});
		2095
		2096	$self->{_coro}{$coro+0} = $coro;
		2097
		2098	$coro
		2099	}
		2100
		2101	cf::client->attach (
		2102	on_destroy => sub {
		2103	my ($ns) = @_;
		2104
		2105	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2106	},
		2107	);
		2108
		2109	=back
		2110
		2111
		2112	=head2 SAFE SCRIPTING
		2113
		2114	Functions that provide a safe environment to compile and execute
		2115	snippets of perl code without them endangering the safety of the server
		2116	itself. Looping constructs, I/O operators and other built-in functionality
		2117	is not available in the safe scripting environment, and the number of
		2118	functions and methods that can be called is greatly reduced.
		2119
		2120	=cut
772		2121
773	our $safe = new Safe "safe";	2122	our $safe = new Safe "safe";
774	our $safe_hole = new Safe::Hole;	2123	our $safe_hole = new Safe::Hole;
775		2124
776	$SIG{FPE} = 'IGNORE';	2125	$SIG{FPE} = 'IGNORE';
777		2126
778	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	2127	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
779		2128
780	# here we export the classes and methods available to script code	2129	# here we export the classes and methods available to script code
781		2130
		2131	=pod
		2132
		2133	The following functions and methods are available within a safe environment:
		2134
		2135	cf::object contr pay_amount pay_player map
		2136	cf::object::player player
		2137	cf::player peaceful
		2138	cf::map trigger
		2139
		2140	=cut
		2141
782	for (	2142	for (
783	["cf::object" => qw(contr pay_amount pay_player)],	2143	["cf::object" => qw(contr pay_amount pay_player map)],
784	["cf::object::player" => qw(player)],	2144	["cf::object::player" => qw(player)],
785	["cf::player" => qw(peaceful)],	2145	["cf::player" => qw(peaceful)],
		2146	["cf::map" => qw(trigger)],
786	) {	2147	) {
787	no strict 'refs';	2148	no strict 'refs';
788	my ($pkg, @funs) = @$_;	2149	my ($pkg, @funs) = @$_;
789	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2150	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
790	for @funs;	2151	for @funs;
791	}	2152	}
		2153
		2154	=over 4
		2155
		2156	=item @retval = safe_eval $code, [var => value, ...]
		2157
		2158	Compiled and executes the given perl code snippet. additional var/value
		2159	pairs result in temporary local (my) scalar variables of the given name
		2160	that are available in the code snippet. Example:
		2161
		2162	my $five = safe_eval '$first + $second', first => 1, second => 4;
		2163
		2164	=cut
792		2165
793	sub safe_eval($;@) {	2166	sub safe_eval($;@) {
794	my ($code, %vars) = @_;	2167	my ($code, %vars) = @_;
795		2168
796	my $qcode = $code;	2169	my $qcode = $code;
…		…
819	}	2192	}
820		2193
821	wantarray ? @res : $res[0]	2194	wantarray ? @res : $res[0]
822	}	2195	}
823		2196
		2197	=item cf::register_script_function $function => $cb
		2198
		2199	Register a function that can be called from within map/npc scripts. The
		2200	function should be reasonably secure and should be put into a package name
		2201	like the extension.
		2202
		2203	Example: register a function that gets called whenever a map script calls
		2204	C<rent::overview>, as used by the C<rent> extension.
		2205
		2206	cf::register_script_function "rent::overview" => sub {
		2207	...
		2208	};
		2209
		2210	=cut
		2211
824	sub register_script_function {	2212	sub register_script_function {
825	my ($fun, $cb) = @_;	2213	my ($fun, $cb) = @_;
826		2214
827	no strict 'refs';	2215	no strict 'refs';
828	*{"safe::$fun"} = $safe_hole->wrap ($cb);	2216	*{"safe::$fun"} = $safe_hole->wrap ($cb);
829	}	2217	}
830		2218
		2219	=back
		2220
		2221	=cut
		2222
831	#############################################################################	2223	#############################################################################
832	# the server's main()	2224
		2225	=head2 EXTENSION DATABASE SUPPORT
		2226
		2227	Crossfire maintains a very simple database for extension use. It can
		2228	currently store anything that can be serialised using Storable, which
		2229	excludes objects.
		2230
		2231	The parameter C<$family> should best start with the name of the extension
		2232	using it, it should be unique.
		2233
		2234	=over 4
		2235
		2236	=item $value = cf::db_get $family => $key
		2237
		2238	Returns a single value from the database.
		2239
		2240	=item cf::db_put $family => $key => $value
		2241
		2242	Stores the given C<$value> in the family.
		2243
		2244	=cut
		2245
		2246	our $DB;
		2247
		2248	sub db_init {
		2249	unless ($DB) {
		2250	$DB = BDB::db_create $DB_ENV;
		2251
		2252	cf::sync_job {
		2253	eval {
		2254	$DB->set_flags (BDB::CHKSUM);
		2255
		2256	BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
		2257	BDB::CREATE | BDB::AUTO_COMMIT, 0666;
		2258	cf::cleanup "db_open(db): $!" if $!;
		2259	};
		2260	cf::cleanup "db_open(db): $@" if $@;
		2261	};
		2262
		2263	my $path = cf::localdir . "/database.pst";
		2264	if (stat $path) {
		2265	cf::sync_job {
		2266	my $pst = Storable::retrieve $path;
		2267
		2268	cf::db_put (board => data => $pst->{board});
		2269	cf::db_put (guildrules => data => $pst->{guildrules});
		2270	cf::db_put (rent => balance => $pst->{rent}{balance});
		2271	BDB::db_env_txn_checkpoint $DB_ENV;
		2272
		2273	unlink $path;
		2274	};
		2275	}
		2276	}
		2277	}
		2278
		2279	sub db_get($$) {
		2280	my $key = "$_[0]/$_[1]";
		2281
		2282	cf::sync_job {
		2283	BDB::db_get $DB, undef, $key, my $data;
		2284
		2285	$! ? ()
		2286	: Compress::LZF::sthaw $data
		2287	}
		2288	}
		2289
		2290	sub db_put($$$) {
		2291	BDB::dbreq_pri 4;
		2292	BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
		2293	}
		2294
		2295	#############################################################################
		2296	# the server's init and main functions
		2297
		2298	sub load_facedata {
		2299	my $path = sprintf "%s/facedata", cf::datadir;
		2300
		2301	warn "loading facedata from $path\n";
		2302
		2303	my $faces;
		2304	0 < aio_load $path, $faces
		2305	or die "$path: $!";
		2306
		2307	Coro::cede;
		2308	$faces = Storable::thaw $faces;
		2309	Coro::cede;
		2310
		2311	my $meta = delete $faces->{""};
		2312	$meta->{version} == 1
		2313	or cf::cleanup "$path: version mismatch, cannot proceed.";
		2314
		2315	while (my ($face, $info) = each %$faces) {
		2316	my $idx = (cf::face::find $face) || cf::face::alloc $face;
		2317	cf::face::set $idx, $info->{visibility}, $info->{magicmap};
		2318	cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
		2319	cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
		2320	Coro::cede;
		2321	}
		2322
		2323	while (my ($face, $info) = each %$faces) {
		2324	next unless $info->{smooth};
		2325	my $idx = cf::face::find $face
		2326	or next;
		2327	if (my $smooth = cf::face::find $info->{smooth}) {
		2328	cf::face::set_smooth $idx, $smooth;
		2329	} else {
		2330	warn "smooth face '$info->{smooth}' not found for face '$face'";
		2331	}
		2332	Coro::cede;
		2333	}
		2334
		2335	1
		2336	}
		2337
		2338	sub reload_resources {
		2339	load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
		2340	or die "unable to load regions file\n";#d#
		2341	load_facedata
		2342	or die "unable to load facedata\n";#d#
		2343	}
		2344
		2345	sub init {
		2346	reload_resources;
		2347	}
		2348
		2349	sub cfg_load {
		2350	open my $fh, "<:utf8", cf::confdir . "/config"
		2351	or return;
		2352
		2353	local $/;
		2354	*CFG = YAML::Syck::Load <$fh>;
		2355
		2356	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2357
		2358	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2359	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2360
		2361	if (exists $CFG{mlockall}) {
		2362	eval {
		2363	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2364	and die "WARNING: m(un)lockall failed: $!\n";
		2365	};
		2366	warn $@ if $@;
		2367	}
		2368	}
833		2369
834	sub main {	2370	sub main {
		2371	# we must not ever block the main coroutine
		2372	local $Coro::idle = sub {
		2373	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2374	(async {
		2375	Event::one_event;
		2376	})->prio (Coro::PRIO_MAX);
		2377	};
		2378
		2379	cfg_load;
		2380	db_init;
		2381	load_extensions;
		2382
		2383	$TICK_WATCHER->start;
835	Event::loop;	2384	Event::loop;
836	}	2385	}
837		2386
838	#############################################################################	2387	#############################################################################
839	# initialisation	2388	# initialisation and cleanup
840		2389
841	register "<global>", __PACKAGE__;	2390	# install some emergency cleanup handlers
		2391	BEGIN {
		2392	for my $signal (qw(INT HUP TERM)) {
		2393	Event->signal (
		2394	reentrant => 0,
		2395	data => WF_AUTOCANCEL,
		2396	signal => $signal,
		2397	prio => 0,
		2398	cb => sub {
		2399	cf::cleanup "SIG$signal";
		2400	},
		2401	);
		2402	}
		2403	}
		2404
		2405	sub emergency_save() {
		2406	my $freeze_guard = cf::freeze_mainloop;
		2407
		2408	warn "enter emergency perl save\n";
		2409
		2410	cf::sync_job {
		2411	# use a peculiar iteration method to avoid tripping on perl
		2412	# refcount bugs in for. also avoids problems with players
		2413	# and maps saved/destroyed asynchronously.
		2414	warn "begin emergency player save\n";
		2415	for my $login (keys %cf::PLAYER) {
		2416	my $pl = $cf::PLAYER{$login} or next;
		2417	$pl->valid or next;
		2418	$pl->save;
		2419	}
		2420	warn "end emergency player save\n";
		2421
		2422	warn "begin emergency map save\n";
		2423	for my $path (keys %cf::MAP) {
		2424	my $map = $cf::MAP{$path} or next;
		2425	$map->valid or next;
		2426	$map->save;
		2427	}
		2428	warn "end emergency map save\n";
		2429
		2430	warn "begin emergency database checkpoint\n";
		2431	BDB::db_env_txn_checkpoint $DB_ENV;
		2432	warn "end emergency database checkpoint\n";
		2433	};
		2434
		2435	warn "leave emergency perl save\n";
		2436	}
		2437
		2438	sub post_cleanup {
		2439	my ($make_core) = @_;
		2440
		2441	warn Carp::longmess "post_cleanup backtrace"
		2442	if $make_core;
		2443	}
		2444
		2445	sub reload() {
		2446	# can/must only be called in main
		2447	if ($Coro::current != $Coro::main) {
		2448	warn "can only reload from main coroutine";
		2449	return;
		2450	}
		2451
		2452	warn "reloading...";
		2453
		2454	warn "entering sync_job";
		2455
		2456	cf::sync_job {
		2457	cf::write_runtime; # external watchdog should not bark
		2458	cf::emergency_save;
		2459	cf::write_runtime; # external watchdog should not bark
		2460
		2461	warn "syncing database to disk";
		2462	BDB::db_env_txn_checkpoint $DB_ENV;
		2463
		2464	# if anything goes wrong in here, we should simply crash as we already saved
		2465
		2466	warn "cancelling all WF_AUTOCANCEL watchers";
		2467	for (Event::all_watchers) {
		2468	$_->cancel if $_->data & WF_AUTOCANCEL;
		2469	}
		2470
		2471	warn "flushing outstanding aio requests";
		2472	for (;;) {
		2473	BDB::flush;
		2474	IO::AIO::flush;
		2475	Coro::cede;
		2476	last unless IO::AIO::nreqs || BDB::nreqs;
		2477	warn "iterate...";
		2478	}
		2479
		2480	++$RELOAD;
		2481
		2482	warn "cancelling all extension coros";
		2483	$_->cancel for values %EXT_CORO;
		2484	%EXT_CORO = ();
		2485
		2486	warn "removing commands";
		2487	%COMMAND = ();
		2488
		2489	warn "removing ext commands";
		2490	%EXTCMD = ();
		2491
		2492	warn "unloading/nuking all extensions";
		2493	for my $pkg (@EXTS) {
		2494	warn "... unloading $pkg";
		2495
		2496	if (my $cb = $pkg->can ("unload")) {
		2497	eval {
		2498	$cb->($pkg);
		2499	1
		2500	} or warn "$pkg unloaded, but with errors: $@";
		2501	}
		2502
		2503	warn "... nuking $pkg";
		2504	Symbol::delete_package $pkg;
		2505	}
		2506
		2507	warn "unloading all perl modules loaded from $LIBDIR";
		2508	while (my ($k, $v) = each %INC) {
		2509	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2510
		2511	warn "... unloading $k";
		2512	delete $INC{$k};
		2513
		2514	$k =~ s/\.pm$//;
		2515	$k =~ s/\//::/g;
		2516
		2517	if (my $cb = $k->can ("unload_module")) {
		2518	$cb->();
		2519	}
		2520
		2521	Symbol::delete_package $k;
		2522	}
		2523
		2524	warn "getting rid of safe::, as good as possible";
		2525	Symbol::delete_package "safe::$_"
		2526	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2527
		2528	warn "unloading cf.pm \"a bit\"";
		2529	delete $INC{"cf.pm"};
		2530
		2531	# don't, removes xs symbols, too,
		2532	# and global variables created in xs
		2533	#Symbol::delete_package __PACKAGE__;
		2534
		2535	warn "unload completed, starting to reload now";
		2536
		2537	warn "reloading cf.pm";
		2538	require cf;
		2539	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2540
		2541	warn "loading config and database again";
		2542	cf::cfg_load;
		2543
		2544	warn "loading extensions";
		2545	cf::load_extensions;
		2546
		2547	warn "reattaching attachments to objects/players";
		2548	_global_reattach; # objects, sockets
		2549	warn "reattaching attachments to maps";
		2550	reattach $_ for values %MAP;
		2551	warn "reattaching attachments to players";
		2552	reattach $_ for values %PLAYER;
		2553
		2554	warn "loading reloadable resources";
		2555	reload_resources;
		2556
		2557	warn "leaving sync_job";
		2558
		2559	1
		2560	} or do {
		2561	warn $@;
		2562	warn "error while reloading, exiting.";
		2563	exit 1;
		2564	};
		2565
		2566	warn "reloaded";
		2567	};
		2568
		2569	our $RELOAD_WATCHER; # used only during reload
		2570
		2571	register_command "reload" => sub {
		2572	my ($who, $arg) = @_;
		2573
		2574	if ($who->flag (FLAG_WIZ)) {
		2575	$who->message ("reloading server.");
		2576
		2577	# doing reload synchronously and two reloads happen back-to-back,
		2578	# coro crashes during coro_state_free->destroy here.
		2579
		2580	$RELOAD_WATCHER ||= Event->timer (
		2581	reentrant => 0,
		2582	after => 0,
		2583	data => WF_AUTOCANCEL,
		2584	cb => sub {
		2585	reload;
		2586	undef $RELOAD_WATCHER;
		2587	},
		2588	);
		2589	}
		2590	};
842		2591
843	unshift @INC, $LIBDIR;	2592	unshift @INC, $LIBDIR;
844		2593
845	load_extensions;	2594	my $bug_warning = 0;
846		2595
847	$TICK_WATCHER = Event->timer (	2596	$TICK_WATCHER = Event->timer (
		2597	reentrant => 0,
		2598	parked => 1,
848	prio => 1,	2599	prio => 0,
849	at => $NEXT_TICK || 1,	2600	at => $NEXT_TICK || $TICK,
		2601	data => WF_AUTOCANCEL,
850	cb => sub {	2602	cb => sub {
		2603	if ($Coro::current != $Coro::main) {
		2604	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2605	unless ++$bug_warning > 10;
		2606	return;
		2607	}
		2608
		2609	$NOW = Event::time;
		2610
851	cf::server_tick; # one server iteration	2611	cf::server_tick; # one server iteration
852		2612	$RUNTIME += $TICK;
853	my $NOW = Event::time;
854	$NEXT_TICK += $TICK;	2613	$NEXT_TICK += $TICK;
855		2614
		2615	if ($NOW >= $NEXT_RUNTIME_WRITE) {
		2616	$NEXT_RUNTIME_WRITE = $NOW + 10;
		2617	Coro::async_pool {
		2618	write_runtime
		2619	or warn "ERROR: unable to write runtime file: $!";
		2620	};
		2621	}
		2622
		2623	$WAIT_FOR_TICK->broadcast;
		2624	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2625
		2626	# my $AFTER = Event::time;
		2627	# warn $AFTER - $NOW;#d#
		2628
856	# if we are delayed by four ticks, skip them all	2629	# if we are delayed by four ticks or more, skip them all
857	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2630	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
858		2631
859	$TICK_WATCHER->at ($NEXT_TICK);	2632	$TICK_WATCHER->at ($NEXT_TICK);
860	$TICK_WATCHER->start;	2633	$TICK_WATCHER->start;
861	},	2634	},
862	);	2635	);
863		2636
864	_reload_2;	2637	{
		2638	BDB::max_poll_time $TICK * 0.1;
		2639	$BDB_POLL_WATCHER = Event->io (
		2640	reentrant => 0,
		2641	fd => BDB::poll_fileno,
		2642	poll => 'r',
		2643	prio => 0,
		2644	data => WF_AUTOCANCEL,
		2645	cb => \&BDB::poll_cb,
		2646	);
		2647	BDB::min_parallel 8;
		2648
		2649	BDB::set_sync_prepare {
		2650	my $status;
		2651	my $current = $Coro::current;
		2652	(
		2653	sub {
		2654	$status = $!;
		2655	$current->ready; undef $current;
		2656	},
		2657	sub {
		2658	Coro::schedule while defined $current;
		2659	$! = $status;
		2660	},
		2661	)
		2662	};
		2663
		2664	unless ($DB_ENV) {
		2665	$DB_ENV = BDB::db_env_create;
		2666
		2667	cf::sync_job {
		2668	eval {
		2669	BDB::db_env_open
		2670	$DB_ENV,
		2671	$BDB_ENV_DIR,
		2672	BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
		2673	| BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
		2674	0666;
		2675
		2676	cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
		2677
		2678	$DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
		2679	$DB_ENV->set_lk_detect;
		2680	};
		2681
		2682	cf::cleanup "db_env_open(db): $@" if $@;
		2683	};
		2684	}
		2685	}
		2686
		2687	{
		2688	IO::AIO::min_parallel 8;
		2689
		2690	undef $Coro::AIO::WATCHER;
		2691	IO::AIO::max_poll_time $TICK * 0.1;
		2692	$AIO_POLL_WATCHER = Event->io (
		2693	reentrant => 0,
		2694	data => WF_AUTOCANCEL,
		2695	fd => IO::AIO::poll_fileno,
		2696	poll => 'r',
		2697	prio => 6,
		2698	cb => \&IO::AIO::poll_cb,
		2699	);
		2700	}
		2701
		2702	END { cf::emergency_save }
865		2703
866	1	2704	1
867		2705

Diff Legend

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