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.58 by root, Wed Aug 30 12:08:15 2006 UTC vs.
Revision 1.210 by root, Mon Feb 12 01:32:49 2007 UTC

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

Diff Legend

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