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.86 by root, Thu Dec 14 05:09:32 2006 UTC vs.
Revision 1.229 by root, Sun Apr 1 00:36:34 2007 UTC

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

Diff Legend

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