ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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