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

Diff Legend

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