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.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.230 by root, Mon Apr 2 18:04:46 2007 UTC

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

Diff Legend

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