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.69 by root, Mon Sep 18 01:10:35 2006 UTC vs.
Revision 1.221 by pippijn, Fri Mar 2 13:32:52 2007 UTC

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

Diff Legend

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