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.60 by root, Thu Aug 31 06:23:19 2006 UTC vs.
Revision 1.211 by root, Tue Feb 13 16:23:32 2007 UTC

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

Diff Legend

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