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

Diff Legend

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