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

Diff Legend

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