ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.143 by root, Sun Jan 7 02:39:14 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Digest::MD5;
		21	use Fcntl;
10	use IO::AIO ();	22	use IO::AIO 2.31 ();
11	use YAML::Syck ();	23	use YAML::Syck ();
12	use Time::HiRes;	24	use Time::HiRes;
13	use Event;	25
14	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		27
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
18		30
19	use strict;	31	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		32
21	_init_vars;	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		34
23	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
24	our @EVENT;	39	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	40	our $LIBDIR = datadir . "/ext";
26		41
27	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	43	our $TICK_WATCHER;
29	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
30		46
31	our %CFG;	47	our %CFG;
32		48
33	our $UPTIME; $UPTIME ||= time;	49	our $UPTIME; $UPTIME ||= time;
		50	our $RUNTIME;
		51
		52	our %PLAYER; # all users
		53	our %MAP; # all maps
		54	our $LINK_MAP; # the special {link} map
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO; # coroutines bound to extensions
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
		76	our $EMERGENCY_POSITION;
34		77
35	#############################################################################	78	#############################################################################
36		79
37	=head2 GLOBAL VARIABLES	80	=head2 GLOBAL VARIABLES
38		81
39	=over 4	82	=over 4
40		83
41	=item $cf::UPTIME	84	=item $cf::UPTIME
42		85
43	The timestamp of the server start (so not actually an uptime).	86	The timestamp of the server start (so not actually an uptime).
		87
		88	=item $cf::RUNTIME
		89
		90	The time this server has run, starts at 0 and is increased by $cf::TICK on
		91	every server tick.
44		92
45	=item $cf::LIBDIR	93	=item $cf::LIBDIR
46		94
47	The perl library directory, where extensions and cf-specific modules can	95	The perl library directory, where extensions and cf-specific modules can
48	be found. It will be added to C<@INC> automatically.	96	be found. It will be added to C<@INC> automatically.
		97
		98	=item $cf::NOW
		99
		100	The time of the last (current) server tick.
49		101
50	=item $cf::TICK	102	=item $cf::TICK
51		103
52	The interval between server ticks, in seconds.	104	The interval between server ticks, in seconds.
53		105
…		…
61	=cut	113	=cut
62		114
63	BEGIN {	115	BEGIN {
64	*CORE::GLOBAL::warn = sub {	116	*CORE::GLOBAL::warn = sub {
65	my $msg = join "", @_;	117	my $msg = join "", @_;
		118	utf8::encode $msg;
		119
66	$msg .= "\n"	120	$msg .= "\n"
67	unless $msg =~ /\n$/;	121	unless $msg =~ /\n$/;
68		122
69	print STDERR "cfperl: $msg";
70	LOG llevError, "cfperl: $msg";	123	LOG llevError, "cfperl: $msg";
71	};	124	};
72	}	125	}
73		126
		127	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		128	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		129	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		130	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		131	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
74	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	132	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
75		133
76	# we bless all objects into (empty) derived classes to force a method lookup	134	# we bless all objects into (empty) derived classes to force a method lookup
77	# within the Safe compartment.	135	# within the Safe compartment.
78	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	136	for my $pkg (qw(
		137	cf::global cf::attachable
		138	cf::object cf::object::player
		139	cf::client cf::player
		140	cf::arch cf::living
		141	cf::map cf::party cf::region
		142	)) {
79	no strict 'refs';	143	no strict 'refs';
80	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	144	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
81	}	145	}
82		146
83	$Event::DIED = sub {	147	$Event::DIED = sub {
…		…
85	};	149	};
86		150
87	my %ext_pkg;	151	my %ext_pkg;
88	my @exts;	152	my @exts;
89	my @hook;	153	my @hook;
90	my %command;
91	my %extcmd;
92		154
93	=head2 UTILITY FUNCTIONS	155	=head2 UTILITY FUNCTIONS
94		156
95	=over 4	157	=over 4
96		158
…		…
118	sub to_json($) {	180	sub to_json($) {
119	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	181	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
120	JSON::Syck::Dump $_[0]	182	JSON::Syck::Dump $_[0]
121	}	183	}
122		184
		185	=item cf::lock_wait $string
		186
		187	Wait until the given lock is available. See cf::lock_acquire.
		188
		189	=item my $lock = cf::lock_acquire $string
		190
		191	Wait until the given lock is available and then acquires it and returns
		192	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		193	for example when the coroutine gets canceled), the lock is automatically
		194	returned.
		195
		196	Lock names should begin with a unique identifier (for example, cf::map::find
		197	uses map_find and cf::map::load uses map_load).
		198
		199	=cut
		200
		201	our %LOCK;
		202
		203	sub lock_wait($) {
		204	my ($key) = @_;
		205
		206	# wait for lock, if any
		207	while ($LOCK{$key}) {
		208	push @{ $LOCK{$key} }, $Coro::current;
		209	Coro::schedule;
		210	}
		211	}
		212
		213	sub lock_acquire($) {
		214	my ($key) = @_;
		215
		216	# wait, to be sure we are not locked
		217	lock_wait $key;
		218
		219	$LOCK{$key} = [];
		220
		221	Coro::guard {
		222	# wake up all waiters, to be on the safe side
		223	$_->ready for @{ delete $LOCK{$key} };
		224	}
		225	}
		226
		227	sub freeze_mainloop {
		228	return unless $TICK_WATCHER->is_active;
		229
		230	my $guard = Coro::guard { $TICK_WATCHER->start };
		231	$TICK_WATCHER->stop;
		232	$guard
		233	}
		234
		235	=item cf::async { BLOCK }
		236
		237	Currently the same as Coro::async_pool, meaning you cannot use
		238	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		239	thing you are allowed to do is call C<prio> on it.
		240
		241	=cut
		242
		243	BEGIN { *async = \&Coro::async_pool }
		244
		245	=item cf::sync_job { BLOCK }
		246
		247	The design of crossfire+ requires that the main coro ($Coro::main) is
		248	always able to handle events or runnable, as crossfire+ is only partly
		249	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		250
		251	If it must be done, put the blocking parts into C<sync_job>. This will run
		252	the given BLOCK in another coroutine while waiting for the result. The
		253	server will be frozen during this time, so the block should either finish
		254	fast or be very important.
		255
		256	=cut
		257
		258	sub sync_job(&) {
		259	my ($job) = @_;
		260
		261	if ($Coro::current == $Coro::main) {
		262	# this is the main coro, too bad, we have to block
		263	# till the operation succeeds, freezing the server :/
		264
		265	# TODO: use suspend/resume instead
		266	# (but this is cancel-safe)
		267	my $freeze_guard = freeze_mainloop;
		268
		269	my $busy = 1;
		270	my @res;
		271
		272	(async {
		273	@res = eval { $job->() };
		274	warn $@ if $@;
		275	undef $busy;
		276	})->prio (Coro::PRIO_MAX);
		277
		278	while ($busy) {
		279	Coro::cede or Event::one_event;
		280	}
		281
		282	wantarray ? @res : $res[0]
		283	} else {
		284	# we are in another coroutine, how wonderful, everything just works
		285
		286	$job->()
		287	}
		288	}
		289
		290	=item $coro = cf::async_ext { BLOCK }
		291
		292	Like async, but this coro is automcatially being canceled when the
		293	extension calling this is being unloaded.
		294
		295	=cut
		296
		297	sub async_ext(&) {
		298	my $cb = shift;
		299
		300	my $coro = &Coro::async ($cb);
		301
		302	$coro->on_destroy (sub {
		303	delete $EXT_CORO{$coro+0};
		304	});
		305	$EXT_CORO{$coro+0} = $coro;
		306
		307	$coro
		308	}
		309
		310	sub write_runtime {
		311	my $runtime = cf::localdir . "/runtime";
		312
		313	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		314	or return;
		315
		316	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		317	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		318	and return;
		319
		320	aio_fsync $fh
		321	and return;
		322
		323	close $fh
		324	or return;
		325
		326	aio_rename "$runtime~", $runtime
		327	and return;
		328
		329	1
		330	}
		331
123	=back	332	=back
124		333
125	=cut	334	=cut
126		335
127	#############################################################################	336	#############################################################################
128		337
129	=head2 EVENTS AND OBJECT ATTACHMENTS	338	package cf::path;
		339
		340	sub new {
		341	my ($class, $path, $base) = @_;
		342
		343	$path = $path->as_string if ref $path;
		344
		345	my $self = bless { }, $class;
		346
		347	# {... are special paths that are not touched
		348	# ?xxx/... are special absolute paths
		349	# ?random/... random maps
		350	# /! non-realised random map exit
		351	# /... normal maps
		352	# ~/... per-player maps without a specific player (DO NOT USE)
		353	# ~user/... per-player map of a specific user
		354
		355	if ($path =~ /^{/) {
		356	# fine as it is
		357	} elsif ($path =~ s{^\?random/}{}) {
		358	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		359	$self->{random} = cf::from_json $data;
		360	} else {
		361	if ($path =~ s{^~([^/]+)?}{}) {
		362	$self->{user_rel} = 1;
		363
		364	if (defined $1) {
		365	$self->{user} = $1;
		366	} elsif ($base =~ m{^~([^/]+)/}) {
		367	$self->{user} = $1;
		368	} else {
		369	warn "cannot resolve user-relative path without user <$path,$base>\n";
		370	}
		371	} elsif ($path =~ /^\//) {
		372	# already absolute
		373	} else {
		374	$base =~ s{[^/]+/?$}{};
		375	return $class->new ("$base/$path");
		376	}
		377
		378	for ($path) {
		379	redo if s{/\.?/}{/};
		380	redo if s{/[^/]+/\.\./}{/};
		381	}
		382	}
		383
		384	$self->{path} = $path;
		385
		386	$self
		387	}
		388
		389	# the name / primary key / in-game path
		390	sub as_string {
		391	my ($self) = @_;
		392
		393	$self->{user_rel} ? "~$self->{user}$self->{path}"
		394	: $self->{random} ? "?random/$self->{path}"
		395	: $self->{path}
		396	}
		397
		398	# the displayed name, this is a one way mapping
		399	sub visible_name {
		400	my ($self) = @_;
		401
		402	# if (my $rmp = $self->{random}) {
		403	# # todo: be more intelligent about this
		404	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		405	# } else {
		406	$self->as_string
		407	# }
		408	}
		409
		410	# escape the /'s in the path
		411	sub _escaped_path {
		412	# ∕ is U+2215
		413	(my $path = $_[0]{path}) =~ s/\//∕/g;
		414	$path
		415	}
		416
		417	# the original (read-only) location
		418	sub load_path {
		419	my ($self) = @_;
		420
		421	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		422	}
		423
		424	# the temporary/swap location
		425	sub save_path {
		426	my ($self) = @_;
		427
		428	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		429	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		430	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		431	}
		432
		433	# the unique path, might be eq to save_path
		434	sub uniq_path {
		435	my ($self) = @_;
		436
		437	$self->{user_rel} || $self->{random}
		438	? undef
		439	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		440	}
		441
		442	# return random map parameters, or undef
		443	sub random_map_params {
		444	my ($self) = @_;
		445
		446	$self->{random}
		447	}
		448
		449	# this is somewhat ugly, but style maps do need special treatment
		450	sub is_style_map {
		451	$_[0]{path} =~ m{^/styles/}
		452	}
		453
		454	package cf;
		455
		456	#############################################################################
		457
		458	=head2 ATTACHABLE OBJECTS
		459
		460	Many objects in crossfire are so-called attachable objects. That means you can
		461	attach callbacks/event handlers (a collection of which is called an "attachment")
		462	to it. All such attachable objects support the following methods.
		463
		464	In the following description, CLASS can be any of C<global>, C<object>
		465	C<player>, C<client> or C<map> (i.e. the attachable objects in
		466	crossfire+).
130		467
131	=over 4	468	=over 4
132		469
133	=item $object->attach ($attachment, key => $value...)
134
135	=item $object->detach ($attachment)
136
137	Attach/detach a pre-registered attachment to an object.
138
139	=item $player->attach ($attachment, key => $value...)
140
141	=item $player->detach ($attachment)
142
143	Attach/detach a pre-registered attachment to a player.
144
145	=item $map->attach ($attachment, key => $value...)	470	=item $attachable->attach ($attachment, key => $value...)
146		471
147	=item $map->detach ($attachment)	472	=item $attachable->detach ($attachment)
148		473
149	Attach/detach a pre-registered attachment to a map.	474	Attach/detach a pre-registered attachment to a specific object and give it
		475	the specified key/value pairs as arguments.
150		476
151	=item $bool = $object->attached ($name)	477	Example, attach a minesweeper attachment to the given object, making it a
		478	10x10 minesweeper game:
152		479
153	=item $bool = $player->attached ($name)	480	$obj->attach (minesweeper => width => 10, height => 10);
154		481
155	=item $bool = $map->attached ($name)	482	=item $bool = $attachable->attached ($name)
156		483
157	Checks wether the named attachment is currently attached to the object.	484	Checks wether the named attachment is currently attached to the object.
158		485
159	=item cf::attach_global ...	486	=item cf::CLASS->attach ...
160		487
161	Attach handlers for global events.	488	=item cf::CLASS->detach ...
162		489
163	This and all following C<attach_*>-functions expect any number of the	490	Define an anonymous attachment and attach it to all objects of the given
164	following handler/hook descriptions:	491	CLASS. See the next function for an explanation of its arguments.
		492
		493	You can attach to global events by using the C<cf::global> class.
		494
		495	Example, log all player logins:
		496
		497	cf::player->attach (
		498	on_login => sub {
		499	my ($pl) = @_;
		500	...
		501	},
		502	);
		503
		504	Example, attach to the jeweler skill:
		505
		506	cf::object->attach (
		507	type => cf::SKILL,
		508	subtype => cf::SK_JEWELER,
		509	on_use_skill => sub {
		510	my ($sk, $ob, $part, $dir, $msg) = @_;
		511	...
		512	},
		513	);
		514
		515	=item cf::CLASS::attachment $name, ...
		516
		517	Register an attachment by C<$name> through which attachable objects of the
		518	given CLASS can refer to this attachment.
		519
		520	Some classes such as crossfire maps and objects can specify attachments
		521	that are attached at load/instantiate time, thus the need for a name.
		522
		523	These calls expect any number of the following handler/hook descriptions:
165		524
166	=over 4	525	=over 4
167		526
168	=item prio => $number	527	=item prio => $number
169		528
…		…
171	by another C<prio> setting). Lower priority handlers get executed	530	by another C<prio> setting). Lower priority handlers get executed
172	earlier. The default priority is C<0>, and many built-in handlers are	531	earlier. The default priority is C<0>, and many built-in handlers are
173	registered at priority C<-1000>, so lower priorities should not be used	532	registered at priority C<-1000>, so lower priorities should not be used
174	unless you know what you are doing.	533	unless you know what you are doing.
175		534
		535	=item type => $type
		536
		537	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		538	given type of objects only (the additional parameter C<subtype> can be
		539	used to further limit to the given subtype).
		540
176	=item on_I<event> => \&cb	541	=item on_I<event> => \&cb
177		542
178	Call the given code reference whenever the named event happens (event is	543	Call the given code reference whenever the named event happens (event is
179	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	544	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
180	handlers are recognised generally depends on the type of object these	545	handlers are recognised generally depends on the type of object these
…		…
189	package and register them. Only handlers for eevents supported by the	554	package and register them. Only handlers for eevents supported by the
190	object/class are recognised.	555	object/class are recognised.
191		556
192	=back	557	=back
193		558
194	=item cf::attach_to_type $object_type, $subtype, ...	559	Example, define an attachment called "sockpuppet" that calls the given
		560	event handler when a monster attacks:
195		561
196	Attach handlers for a specific object type (e.g. TRANSPORT) and	562	cf::object::attachment sockpuppet =>
197	subtype. If C<$subtype> is zero or undef, matches all objects of the given	563	on_skill_attack => sub {
198	type.	564	my ($self, $victim) = @_;
199		565	...
200	=item cf::attach_to_objects ...
201
202	Attach handlers to all objects. Do not use this except for debugging or
203	very rare events, as handlers are (obviously) called for I<all> objects in
204	the game.
205
206	=item cf::attach_to_players ...
207
208	Attach handlers to all players.
209
210	=item cf::attach_to_maps ...
211
212	Attach handlers to all maps.
213
214	=item cf:register_attachment $name, ...
215
216	Register an attachment by name through which objects can refer to this
217	attachment.
218
219	=item cf:register_player_attachment $name, ...
220
221	Register an attachment by name through which players can refer to this
222	attachment.
223
224	=item cf:register_map_attachment $name, ...
225
226	Register an attachment by name through which maps can refer to this
227	attachment.
228
229	=cut
230
231	# the following variables are defined in .xs and must not be re-created
232	our @CB_GLOBAL = (); # registry for all global events
233	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
234	our @CB_PLAYER = ();
235	our @CB_TYPE = (); # registry for type (cf-object class) based events
236	our @CB_MAP = ();
237
238	my %attachment;
239
240	sub _attach_cb($\%$$$) {
241	my ($registry, $undo, $event, $prio, $cb) = @_;
242
243	use sort 'stable';
244
245	$cb = [$prio, $cb];
246
247	@{$registry->[$event]} = sort
248	{ $a->[0] cmp $b->[0] }
249	@{$registry->[$event] || []}, $cb;
250
251	push @{$undo->{cb}}, [$event, $cb];
252	}
253
254	# attach handles attaching event callbacks
255	# the only thing the caller has to do is pass the correct
256	# registry (== where the callback attaches to).
257	sub _attach(\@$@) {
258	my ($registry, $klass, @arg) = @_;
259
260	my $prio = 0;
261
262	my %undo = (
263	registry => $registry,
264	cb => [],
265	);
266
267	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
268
269	while (@arg) {
270	my $type = shift @arg;
271
272	if ($type eq "prio") {
273	$prio = shift @arg;
274
275	} elsif ($type eq "package") {
276	my $pkg = shift @arg;
277
278	while (my ($name, $id) = each %cb_id) {
279	if (my $cb = $pkg->can ($name)) {
280	_attach_cb $registry, %undo, $id, $prio, $cb;
281	}
282	}	566	}
283
284	} elsif (exists $cb_id{$type}) {
285	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
286
287	} elsif (ref $type) {
288	warn "attaching objects not supported, ignoring.\n";
289
290	} else {
291	shift @arg;
292	warn "attach argument '$type' not supported, ignoring.\n";
293	}
294	}
295
296	\%undo
297	}
298
299	sub _attach_attachment {
300	my ($obj, $name, %arg) = @_;
301
302	return if exists $obj->{_attachment}{$name};
303
304	my $res;
305
306	if (my $attach = $attachment{$name}) {
307	my $registry = $obj->registry;
308
309	for (@$attach) {
310	my ($klass, @attach) = @$_;
311	$res = _attach @$registry, $klass, @attach;
312	}
313
314	$obj->{$name} = \%arg;
315	} else {
316	warn "object uses attachment '$name' that is not available, postponing.\n";
317	}
318
319	$obj->{_attachment}{$name} = undef;
320
321	$res->{attachment} = $name;
322	$res
323	}
324
325	*cf::object::attach =
326	*cf::player::attach =
327	*cf::map::attach = sub {
328	my ($obj, $name, %arg) = @_;
329
330	_attach_attachment $obj, $name, %arg;
331	};
332
333	# all those should be optimised
334	*cf::object::detach =
335	*cf::player::detach =
336	*cf::map::detach = sub {
337	my ($obj, $name) = @_;
338
339	delete $obj->{_attachment}{$name};
340	reattach ($obj);
341	};
342
343	*cf::object::attached =
344	*cf::player::attached =
345	*cf::map::attached = sub {
346	my ($obj, $name) = @_;
347
348	exists $obj->{_attachment}{$name}
349	};
350
351	sub attach_global {
352	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
353	}
354
355	sub attach_to_type {
356	my $type = shift;
357	my $subtype = shift;
358
359	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
360	}
361
362	sub attach_to_objects {
363	_attach @CB_OBJECT, KLASS_OBJECT, @_
364	}
365
366	sub attach_to_players {
367	_attach @CB_PLAYER, KLASS_PLAYER, @_
368	}
369
370	sub attach_to_maps {
371	_attach @CB_MAP, KLASS_MAP, @_
372	}
373
374	sub register_attachment {
375	my $name = shift;
376
377	$attachment{$name} = [[KLASS_OBJECT, @_]];
378	}
379
380	sub register_player_attachment {
381	my $name = shift;
382
383	$attachment{$name} = [[KLASS_PLAYER, @_]];
384	}
385
386	sub register_map_attachment {
387	my $name = shift;
388
389	$attachment{$name} = [[KLASS_MAP, @_]];
390	}
391
392	our $override;
393	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
394
395	sub override {
396	$override = 1;
397	@invoke_results = ();
398	}
399
400	sub do_invoke {
401	my $event = shift;
402	my $callbacks = shift;
403
404	@invoke_results = ();
405
406	local $override;
407
408	for (@$callbacks) {
409	eval { &{$_->[1]} };
410
411	if ($@) {
412	warn "$@";
413	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
414	override;
415	}
416
417	return 1 if $override;
418	}
419
420	0	567	}
421	}
422		568
423	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	569	=item $attachable->valid
424
425	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
426
427	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
428
429	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
430
431	Generate a global/object/player/map-specific event with the given arguments.
432
433	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
434	removed in future versions), and there is no public API to access override
435	results (if you must, access C<@cf::invoke_results> directly).
436
437	=back
438
439	=cut
440
441	#############################################################################
442
443	=head2 METHODS VALID FOR ALL CORE OBJECTS
444
445	=over 4
446
447	=item $object->valid, $player->valid, $map->valid
448		570
449	Just because you have a perl object does not mean that the corresponding	571	Just because you have a perl object does not mean that the corresponding
450	C-level object still exists. If you try to access an object that has no	572	C-level object still exists. If you try to access an object that has no
451	valid C counterpart anymore you get an exception at runtime. This method	573	valid C counterpart anymore you get an exception at runtime. This method
452	can be used to test for existence of the C object part without causing an	574	can be used to test for existence of the C object part without causing an
453	exception.	575	exception.
454		576
		577	=cut
		578
		579	# the following variables are defined in .xs and must not be re-created
		580	our @CB_GLOBAL = (); # registry for all global events
		581	our @CB_ATTACHABLE = (); # registry for all attachables
		582	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		583	our @CB_PLAYER = ();
		584	our @CB_CLIENT = ();
		585	our @CB_TYPE = (); # registry for type (cf-object class) based events
		586	our @CB_MAP = ();
		587
		588	my %attachment;
		589
		590	sub _attach_cb($$$$) {
		591	my ($registry, $event, $prio, $cb) = @_;
		592
		593	use sort 'stable';
		594
		595	$cb = [$prio, $cb];
		596
		597	@{$registry->[$event]} = sort
		598	{ $a->[0] cmp $b->[0] }
		599	@{$registry->[$event] || []}, $cb;
		600	}
		601
		602	# hack
		603	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		604
		605	# attach handles attaching event callbacks
		606	# the only thing the caller has to do is pass the correct
		607	# registry (== where the callback attaches to).
		608	sub _attach {
		609	my ($registry, $klass, @arg) = @_;
		610
		611	my $object_type;
		612	my $prio = 0;
		613	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		614
		615	#TODO: get rid of this hack
		616	if ($attachable_klass{$klass}) {
		617	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		618	}
		619
		620	while (@arg) {
		621	my $type = shift @arg;
		622
		623	if ($type eq "prio") {
		624	$prio = shift @arg;
		625
		626	} elsif ($type eq "type") {
		627	$object_type = shift @arg;
		628	$registry = $CB_TYPE[$object_type] ||= [];
		629
		630	} elsif ($type eq "subtype") {
		631	defined $object_type or Carp::croak "subtype specified without type";
		632	my $object_subtype = shift @arg;
		633	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		634
		635	} elsif ($type eq "package") {
		636	my $pkg = shift @arg;
		637
		638	while (my ($name, $id) = each %cb_id) {
		639	if (my $cb = $pkg->can ($name)) {
		640	_attach_cb $registry, $id, $prio, $cb;
		641	}
		642	}
		643
		644	} elsif (exists $cb_id{$type}) {
		645	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		646
		647	} elsif (ref $type) {
		648	warn "attaching objects not supported, ignoring.\n";
		649
		650	} else {
		651	shift @arg;
		652	warn "attach argument '$type' not supported, ignoring.\n";
		653	}
		654	}
		655	}
		656
		657	sub _object_attach {
		658	my ($obj, $name, %arg) = @_;
		659
		660	return if exists $obj->{_attachment}{$name};
		661
		662	if (my $attach = $attachment{$name}) {
		663	my $registry = $obj->registry;
		664
		665	for (@$attach) {
		666	my ($klass, @attach) = @$_;
		667	_attach $registry, $klass, @attach;
		668	}
		669
		670	$obj->{$name} = \%arg;
		671	} else {
		672	warn "object uses attachment '$name' that is not available, postponing.\n";
		673	}
		674
		675	$obj->{_attachment}{$name} = undef;
		676	}
		677
		678	sub cf::attachable::attach {
		679	if (ref $_[0]) {
		680	_object_attach @_;
		681	} else {
		682	_attach shift->_attach_registry, @_;
		683	}
		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	};
		697
		698	sub cf::attachable::attached {
		699	my ($obj, $name) = @_;
		700
		701	exists $obj->{_attachment}{$name}
		702	}
		703
		704	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		705	eval "#line " . __LINE__ . " 'cf.pm'
		706	sub cf::\L$klass\E::_attach_registry {
		707	(\\\@CB_$klass, KLASS_$klass)
		708	}
		709
		710	sub cf::\L$klass\E::attachment {
		711	my \$name = shift;
		712
		713	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		714	}
		715	";
		716	die if $@;
		717	}
		718
		719	our $override;
		720	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		721
		722	sub override {
		723	$override = 1;
		724	@invoke_results = ();
		725	}
		726
		727	sub do_invoke {
		728	my $event = shift;
		729	my $callbacks = shift;
		730
		731	@invoke_results = ();
		732
		733	local $override;
		734
		735	for (@$callbacks) {
		736	eval { &{$_->[1]} };
		737
		738	if ($@) {
		739	warn "$@";
		740	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		741	override;
		742	}
		743
		744	return 1 if $override;
		745	}
		746
		747	0
		748	}
		749
		750	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		751
		752	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		753
		754	Generate an object-specific event with the given arguments.
		755
		756	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		757	removed in future versions), and there is no public API to access override
		758	results (if you must, access C<@cf::invoke_results> directly).
		759
455	=back	760	=back
456		761
457	=cut	762	=cut
458
459	*cf::object::valid =
460	*cf::player::valid =
461	*cf::map::valid = \&cf::_valid;
462		763
463	#############################################################################	764	#############################################################################
464	# object support	765	# object support
465		766
466	sub instantiate {
467	my ($obj, $data) = @_;
468
469	$data = from_json $data;
470
471	for (@$data) {
472	my ($name, $args) = @$_;
473
474	$obj->attach ($name, %{$args || {} });
475	}
476	}
477
478	# basically do the same as instantiate, without calling instantiate
479	sub reattach {	767	sub reattach {
		768	# basically do the same as instantiate, without calling instantiate
480	my ($obj) = @_;	769	my ($obj) = @_;
		770
481	my $registry = $obj->registry;	771	my $registry = $obj->registry;
482		772
483	@$registry = ();	773	@$registry = ();
484		774
485	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	775	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
486		776
487	for my $name (keys %{ $obj->{_attachment} || {} }) {	777	for my $name (keys %{ $obj->{_attachment} || {} }) {
488	if (my $attach = $attachment{$name}) {	778	if (my $attach = $attachment{$name}) {
489	for (@$attach) {	779	for (@$attach) {
490	my ($klass, @attach) = @$_;	780	my ($klass, @attach) = @$_;
491	_attach @$registry, $klass, @attach;	781	_attach $registry, $klass, @attach;
492	}	782	}
493	} else {	783	} else {
494	warn "object uses attachment '$name' that is not available, postponing.\n";	784	warn "object uses attachment '$name' that is not available, postponing.\n";
495	}	785	}
496	}	786	}
497	}	787	}
498		788
499	sub object_freezer_save {	789	cf::attachable->attach (
500	my ($filename, $rdata, $objs) = @_;
501
502	if (length $$rdata) {
503	warn sprintf "saving %s (%d,%d)\n",
504	$filename, length $$rdata, scalar @$objs;
505
506	if (open my $fh, ">:raw", "$filename~") {
507	chmod SAVE_MODE, $fh;
508	syswrite $fh, $$rdata;
509	close $fh;
510
511	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
512	chmod SAVE_MODE, $fh;
513	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
514	close $fh;
515	rename "$filename.pst~", "$filename.pst";
516	} else {
517	unlink "$filename.pst";
518	}
519
520	rename "$filename~", $filename;
521	} else {
522	warn "FATAL: $filename~: $!\n";
523	}
524	} else {
525	unlink $filename;
526	unlink "$filename.pst";
527	}
528	}
529
530	sub object_freezer_as_string {
531	my ($rdata, $objs) = @_;
532
533	use Data::Dumper;
534
535	$$rdata . Dumper $objs
536	}
537
538	sub object_thawer_load {
539	my ($filename) = @_;
540
541	local $/;
542
543	my $av;
544
545	#TODO: use sysread etc.
546	if (open my $data, "<:raw:perlio", $filename) {
547	$data = <$data>;
548	if (open my $pst, "<:raw:perlio", "$filename.pst") {
549	$av = eval { (Storable::thaw <$pst>)->{objs} };
550	}
551	return ($data, $av);
552	}
553
554	()
555	}
556
557	attach_to_objects
558	prio => -1000000,	790	prio => -1000000,
		791	on_instantiate => sub {
		792	my ($obj, $data) = @_;
		793
		794	$data = from_json $data;
		795
		796	for (@$data) {
		797	my ($name, $args) = @$_;
		798
		799	$obj->attach ($name, %{$args || {} });
		800	}
		801	},
		802	on_reattach => \&reattach,
559	on_clone => sub {	803	on_clone => sub {
560	my ($src, $dst) = @_;	804	my ($src, $dst) = @_;
561		805
562	@{$dst->registry} = @{$src->registry};	806	@{$dst->registry} = @{$src->registry};
563		807
564	%$dst = %$src;	808	%$dst = %$src;
565		809
566	%{$dst->{_attachment}} = %{$src->{_attachment}}	810	%{$dst->{_attachment}} = %{$src->{_attachment}}
567	if exists $src->{_attachment};	811	if exists $src->{_attachment};
568	},	812	},
569	;	813	);
		814
		815	sub object_freezer_save {
		816	my ($filename, $rdata, $objs) = @_;
		817
		818	sync_job {
		819	if (length $$rdata) {
		820	warn sprintf "saving %s (%d,%d)\n",
		821	$filename, length $$rdata, scalar @$objs;
		822
		823	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		824	chmod SAVE_MODE, $fh;
		825	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		826	aio_fsync $fh;
		827	close $fh;
		828
		829	if (@$objs) {
		830	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		831	chmod SAVE_MODE, $fh;
		832	my $data = Storable::nfreeze { version => 1, objs => $objs };
		833	aio_write $fh, 0, (length $data), $data, 0;
		834	aio_fsync $fh;
		835	close $fh;
		836	aio_rename "$filename.pst~", "$filename.pst";
		837	}
		838	} else {
		839	aio_unlink "$filename.pst";
		840	}
		841
		842	aio_rename "$filename~", $filename;
		843	} else {
		844	warn "FATAL: $filename~: $!\n";
		845	}
		846	} else {
		847	aio_unlink $filename;
		848	aio_unlink "$filename.pst";
		849	}
		850	}
		851	}
		852
		853	sub object_freezer_as_string {
		854	my ($rdata, $objs) = @_;
		855
		856	use Data::Dumper;
		857
		858	$$rdata . Dumper $objs
		859	}
		860
		861	sub object_thawer_load {
		862	my ($filename) = @_;
		863
		864	my ($data, $av);
		865
		866	(aio_load $filename, $data) >= 0
		867	or return;
		868
		869	unless (aio_stat "$filename.pst") {
		870	(aio_load "$filename.pst", $av) >= 0
		871	or return;
		872	$av = eval { (Storable::thaw $av)->{objs} };
		873	}
		874
		875	warn sprintf "loading %s (%d)\n",
		876	$filename, length $data, scalar @{$av || []};#d#
		877	return ($data, $av);
		878	}
570		879
571	#############################################################################	880	#############################################################################
572	# old plug-in events	881	# command handling &c
573		882
574	sub inject_event {	883	=item cf::register_command $name => \&callback($ob,$args);
575	my $extension = shift;
576	my $event_code = shift;
577		884
578	my $cb = $hook[$event_code]{$extension}	885	Register a callback for execution when the client sends the user command
579	or return;	886	$name.
580		887
581	&$cb	888	=cut
582	}
583
584	sub inject_global_event {
585	my $event = shift;
586
587	my $cb = $hook[$event]
588	or return;
589
590	List::Util::max map &$_, values %$cb
591	}
592
593	sub inject_command {
594	my ($name, $obj, $params) = @_;
595
596	for my $cmd (@{ $command{$name} }) {
597	$cmd->[1]->($obj, $params);
598	}
599
600	-1
601	}
602		889
603	sub register_command {	890	sub register_command {
604	my ($name, $time, $cb) = @_;	891	my ($name, $cb) = @_;
605		892
606	my $caller = caller;	893	my $caller = caller;
607	#warn "registering command '$name/$time' to '$caller'";	894	#warn "registering command '$name/$time' to '$caller'";
608		895
609	push @{ $command{$name} }, [$time, $cb, $caller];	896	push @{ $COMMAND{$name} }, [$caller, $cb];
610	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
611	}	897	}
		898
		899	=item cf::register_extcmd $name => \&callback($pl,$packet);
		900
		901	Register a callbackf ro execution when the client sends an extcmd packet.
		902
		903	If the callback returns something, it is sent back as if reply was being
		904	called.
		905
		906	=cut
612		907
613	sub register_extcmd {	908	sub register_extcmd {
614	my ($name, $cb) = @_;	909	my ($name, $cb) = @_;
615		910
616	my $caller = caller;	911	my $caller = caller;
617	#warn "registering extcmd '$name' to '$caller'";	912	#warn "registering extcmd '$name' to '$caller'";
618		913
619	$extcmd{$name} = [$cb, $caller];	914	$EXTCMD{$name} = [$cb, $caller];
620	}	915	}
		916
		917	cf::player->attach (
		918	on_command => sub {
		919	my ($pl, $name, $params) = @_;
		920
		921	my $cb = $COMMAND{$name}
		922	or return;
		923
		924	for my $cmd (@$cb) {
		925	$cmd->[1]->($pl->ob, $params);
		926	}
		927
		928	cf::override;
		929	},
		930	on_extcmd => sub {
		931	my ($pl, $buf) = @_;
		932
		933	my $msg = eval { from_json $buf };
		934
		935	if (ref $msg) {
		936	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		937	if (my %reply = $cb->[0]->($pl, $msg)) {
		938	$pl->ext_reply ($msg->{msgid}, %reply);
		939	}
		940	}
		941	} else {
		942	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		943	}
		944
		945	cf::override;
		946	},
		947	);
621		948
622	sub register {	949	sub register {
623	my ($base, $pkg) = @_;	950	my ($base, $pkg) = @_;
624		951
625	#TODO	952	#TODO
…		…
668	# for my $idx (0 .. $#PLUGIN_EVENT) {	995	# for my $idx (0 .. $#PLUGIN_EVENT) {
669	# delete $hook[$idx]{$pkg};	996	# delete $hook[$idx]{$pkg};
670	# }	997	# }
671		998
672	# remove commands	999	# remove commands
673	for my $name (keys %command) {	1000	for my $name (keys %COMMAND) {
674	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	1001	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
675		1002
676	if (@cb) {	1003	if (@cb) {
677	$command{$name} = \@cb;	1004	$COMMAND{$name} = \@cb;
678	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
679	} else {	1005	} else {
680	delete $command{$name};
681	delete $COMMAND{"$name\000"};	1006	delete $COMMAND{$name};
682	}	1007	}
683	}	1008	}
684		1009
685	# remove extcmds	1010	# remove extcmds
686	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1011	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
687	delete $extcmd{$name};	1012	delete $EXTCMD{$name};
688	}	1013	}
689		1014
690	if (my $cb = $pkg->can ("unload")) {	1015	if (my $cb = $pkg->can ("unload")) {
691	eval {	1016	eval {
692	$cb->($pkg);	1017	$cb->($pkg);
…		…
696		1021
697	Symbol::delete_package $pkg;	1022	Symbol::delete_package $pkg;
698	}	1023	}
699		1024
700	sub load_extensions {	1025	sub load_extensions {
701	my $LIBDIR = maps_directory "perl";
702
703	for my $ext (<$LIBDIR/*.ext>) {	1026	for my $ext (<$LIBDIR/*.ext>) {
704	next unless -r $ext;	1027	next unless -r $ext;
705	eval {	1028	eval {
706	load_extension $ext;	1029	load_extension $ext;
707	1	1030	1
708	} or warn "$ext not loaded: $@";	1031	} or warn "$ext not loaded: $@";
709	}	1032	}
710	}	1033	}
711		1034
712	#############################################################################	1035	#############################################################################
713	# extcmd framework, basically convert ext <msg>
714	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
715
716	attach_to_players
717	on_extcmd => sub {
718	my ($pl, $buf) = @_;
719
720	my $msg = eval { from_json $buf };
721
722	if (ref $msg) {
723	if (my $cb = $extcmd{$msg->{msgtype}}) {
724	if (my %reply = $cb->[0]->($pl, $msg)) {
725	$pl->ext_reply ($msg->{msgid}, %reply);
726	}
727	}
728	} else {
729	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
730	}
731
732	cf::override;
733	},
734	;
735
736	#############################################################################
737	# load/save/clean perl data associated with a map	1036	# load/save/clean perl data associated with a map
738		1037
739	*cf::mapsupport::on_clean = sub {	1038	*cf::mapsupport::on_clean = sub {
740	my ($map) = @_;	1039	my ($map) = @_;
741		1040
…		…
743	defined $path or return;	1042	defined $path or return;
744		1043
745	unlink "$path.pst";	1044	unlink "$path.pst";
746	};	1045	};
747		1046
748	attach_to_maps prio => -10000, package => cf::mapsupport::;	1047	cf::map->attach (prio => -10000, package => cf::mapsupport::);
749		1048
750	#############################################################################	1049	#############################################################################
751	# load/save perl data associated with player->ob objects	1050	# load/save perl data associated with player->ob objects
752		1051
753	sub all_objects(@) {	1052	sub all_objects(@) {
754	@_, map all_objects ($_->inv), @_	1053	@_, map all_objects ($_->inv), @_
755	}	1054	}
756		1055
757	# TODO: compatibility cruft, remove when no longer needed	1056	# TODO: compatibility cruft, remove when no longer needed
758	attach_to_players	1057	cf::player->attach (
759	on_load => sub {	1058	on_load => sub {
760	my ($pl, $path) = @_;	1059	my ($pl, $path) = @_;
761		1060
762	for my $o (all_objects $pl->ob) {	1061	for my $o (all_objects $pl->ob) {
763	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1062	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
765		1064
766	%$o = %{ Storable::thaw pack "H*", $value };	1065	%$o = %{ Storable::thaw pack "H*", $value };
767	}	1066	}
768	}	1067	}
769	},	1068	},
770	;	1069	);
771		1070
772	#############################################################################	1071	#############################################################################
773		1072
774	=head2 CORE EXTENSIONS	1073	=head2 CORE EXTENSIONS
775		1074
776	Functions and methods that extend core crossfire objects.	1075	Functions and methods that extend core crossfire objects.
777		1076
		1077	=cut
		1078
		1079	package cf::player;
		1080
		1081	=head3 cf::player
		1082
778	=over 4	1083	=over 4
779		1084
780	=item cf::player::exists $login	1085	=item cf::player::find $login
781		1086
782	Returns true when the given account exists.	1087	Returns the given player object, loading it if necessary (might block).
783		1088
784	=cut	1089	=cut
785		1090
786	sub cf::player::exists($) {	1091	sub path($) {
787	cf::player::find $_[0]	1092	sprintf "%s/%s/%s/%s.pl",
788	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1093	cf::localdir, cf::playerdir,
		1094	(ref $_[0] ? $_[0]->ob->name : $_[0]) x 2
789	}	1095	}
		1096
		1097	sub find_active($) {
		1098	$cf::PLAYER{$_[0]}
		1099	and $cf::PLAYER{$_[0]}->active
		1100	and $cf::PLAYER{$_[0]}
		1101	}
		1102
		1103	sub exists($) {
		1104	my ($login) = @_;
		1105
		1106	$cf::PLAYER{$login}
		1107	or cf::sync_job { !aio_stat $login }
		1108	}
		1109
		1110	sub find($) {
		1111	return $cf::PLAYER{$_[0]} || do {
		1112	my $login = $_[0];
		1113
		1114	my $guard = cf::lock_acquire "user_find:$login";
		1115
		1116	$cf::PLAYER{$login} ||= (load_pl path $login or return);
		1117	};
		1118	}
		1119
		1120	sub save($) {
		1121	my ($pl) = @_;
		1122
		1123	return if $pl->{deny_save};
		1124
		1125	my $path = path $pl;
		1126	my $guard = cf::lock_acquire "user_save:$path";
		1127
		1128	return if $pl->{deny_save};
		1129	$pl->{last_save} = $cf::RUNTIME;
		1130
		1131	Coro::cede;
		1132	$pl->save_pl ($path);
		1133	Coro::cede;
		1134	}
		1135
		1136	sub new($) {
		1137	my ($login) = @_;
		1138
		1139	my $self = create;
		1140
		1141	$self->ob->name ($login);
		1142	$self->{deny_save} = 1;
		1143
		1144	$cf::PLAYER{$login} = $self;
		1145
		1146	$self
		1147	}
		1148
		1149	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1150
		1151	Sends an ext reply to the player.
		1152
		1153	=cut
		1154
		1155	sub ext_reply($$$%) {
		1156	my ($self, $id, %msg) = @_;
		1157
		1158	$msg{msgid} = $id;
		1159
		1160	$self->send ("ext " . cf::to_json \%msg);
		1161	}
		1162
		1163	package cf;
		1164
		1165	=back
		1166
		1167
		1168	=head3 cf::map
		1169
		1170	=over 4
		1171
		1172	=cut
		1173
		1174	package cf::map;
		1175
		1176	use Fcntl;
		1177	use Coro::AIO;
		1178
		1179	our $MAX_RESET = 3600;
		1180	our $DEFAULT_RESET = 3000;
		1181
		1182	sub generate_random_map {
		1183	my ($path, $rmp) = @_;
		1184
		1185	# mit "rum" bekleckern, nicht
		1186	cf::map::_create_random_map
		1187	$path,
		1188	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1189	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1190	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1191	$rmp->{exit_on_final_map},
		1192	$rmp->{xsize}, $rmp->{ysize},
		1193	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1194	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1195	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1196	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1197	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1198	(cf::region::find $rmp->{region})
		1199	}
		1200
		1201	# and all this just because we cannot iterate over
		1202	# all maps in C++...
		1203	sub change_all_map_light {
		1204	my ($change) = @_;
		1205
		1206	$_->change_map_light ($change)
		1207	for grep $_->outdoor, values %cf::MAP;
		1208	}
		1209
		1210	sub try_load_header($) {
		1211	my ($path) = @_;
		1212
		1213	utf8::encode $path;
		1214	aio_open $path, O_RDONLY, 0
		1215	or return;
		1216
		1217	my $map = cf::map::new
		1218	or return;
		1219
		1220	# for better error messages only, will be overwritten
		1221	$map->path ($path);
		1222
		1223	$map->load_header ($path)
		1224	or return;
		1225
		1226	$map->{load_path} = $path;
		1227
		1228	$map
		1229	}
		1230
		1231	sub find;
		1232	sub find {
		1233	my ($path, $origin) = @_;
		1234
		1235	#warn "find<$path,$origin>\n";#d#
		1236
		1237	$path = new cf::path $path, $origin && $origin->path;
		1238	my $key = $path->as_string;
		1239
		1240	cf::lock_wait "map_find:$key";
		1241
		1242	$cf::MAP{$key} || do {
		1243	my $guard = cf::lock_acquire "map_find:$key";
		1244
		1245	# do it the slow way
		1246	my $map = try_load_header $path->save_path;
		1247
		1248	Coro::cede;
		1249
		1250	if ($map) {
		1251	$map->last_access ((delete $map->{last_access})
		1252	|| $cf::RUNTIME); #d#
		1253	# safety
		1254	$map->{instantiate_time} = $cf::RUNTIME
		1255	if $map->{instantiate_time} > $cf::RUNTIME;
		1256	} else {
		1257	if (my $rmp = $path->random_map_params) {
		1258	$map = generate_random_map $key, $rmp;
		1259	} else {
		1260	$map = try_load_header $path->load_path;
		1261	}
		1262
		1263	$map or return;
		1264
		1265	$map->{load_original} = 1;
		1266	$map->{instantiate_time} = $cf::RUNTIME;
		1267	$map->last_access ($cf::RUNTIME);
		1268	$map->instantiate;
		1269
		1270	# per-player maps become, after loading, normal maps
		1271	$map->per_player (0) if $path->{user_rel};
		1272	}
		1273
		1274	$map->path ($key);
		1275	$map->{path} = $path;
		1276	$map->{last_save} = $cf::RUNTIME;
		1277
		1278	Coro::cede;
		1279
		1280	if ($map->should_reset) {
		1281	$map->reset;
		1282	undef $guard;
		1283	$map = find $path
		1284	or return;
		1285	}
		1286
		1287	$cf::MAP{$key} = $map
		1288	}
		1289	}
		1290
		1291	sub load {
		1292	my ($self) = @_;
		1293
		1294	my $path = $self->{path};
		1295	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1296
		1297	return if $self->in_memory != cf::MAP_SWAPPED;
		1298
		1299	$self->in_memory (cf::MAP_LOADING);
		1300
		1301	$self->alloc;
		1302	$self->load_objects ($self->{load_path}, 1)
		1303	or return;
		1304
		1305	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1306	if delete $self->{load_original};
		1307
		1308	if (my $uniq = $path->uniq_path) {
		1309	utf8::encode $uniq;
		1310	if (aio_open $uniq, O_RDONLY, 0) {
		1311	$self->clear_unique_items;
		1312	$self->load_objects ($uniq, 0);
		1313	}
		1314	}
		1315
		1316	Coro::cede;
		1317
		1318	# now do the right thing for maps
		1319	$self->link_multipart_objects;
		1320
		1321	if ($self->{path}->is_style_map) {
		1322	$self->{deny_save} = 1;
		1323	$self->{deny_reset} = 1;
		1324	} else {
		1325	$self->fix_auto_apply;
		1326	$self->decay_objects;
		1327	$self->update_buttons;
		1328	$self->set_darkness_map;
		1329	$self->difficulty ($self->estimate_difficulty)
		1330	unless $self->difficulty;
		1331	$self->activate;
		1332	}
		1333
		1334	Coro::cede;
		1335
		1336	$self->in_memory (cf::MAP_IN_MEMORY);
		1337	}
		1338
		1339	sub find_sync {
		1340	my ($path, $origin) = @_;
		1341
		1342	cf::sync_job { cf::map::find $path, $origin }
		1343	}
		1344
		1345	sub do_load_sync {
		1346	my ($map) = @_;
		1347
		1348	cf::sync_job { $map->load };
		1349	}
		1350
		1351	sub save {
		1352	my ($self) = @_;
		1353
		1354	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1355
		1356	$self->{last_save} = $cf::RUNTIME;
		1357
		1358	return unless $self->dirty;
		1359
		1360	my $save = $self->{path}->save_path; utf8::encode $save;
		1361	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1362
		1363	$self->{load_path} = $save;
		1364
		1365	return if $self->{deny_save};
		1366
		1367	local $self->{last_access} = $self->last_access;#d#
		1368
		1369	cf::async {
		1370	$_->contr->save for $self->players;
		1371	};
		1372
		1373	if ($uniq) {
		1374	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1375	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1376	} else {
		1377	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1378	}
		1379	}
		1380
		1381	sub swap_out {
		1382	my ($self) = @_;
		1383
		1384	# save first because save cedes
		1385	$self->save;
		1386
		1387	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1388
		1389	return if $self->players;
		1390	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1391	return if $self->{deny_save};
		1392
		1393	$self->clear;
		1394	$self->in_memory (cf::MAP_SWAPPED);
		1395	}
		1396
		1397	sub reset_at {
		1398	my ($self) = @_;
		1399
		1400	# TODO: safety, remove and allow resettable per-player maps
		1401	return 1e99 if $self->{path}{user_rel};
		1402	return 1e99 if $self->{deny_reset};
		1403
		1404	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1405	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1406
		1407	$time + $to
		1408	}
		1409
		1410	sub should_reset {
		1411	my ($self) = @_;
		1412
		1413	$self->reset_at <= $cf::RUNTIME
		1414	}
		1415
		1416	sub unlink_save {
		1417	my ($self) = @_;
		1418
		1419	utf8::encode (my $save = $self->{path}->save_path);
		1420	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1421	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1422	}
		1423
		1424	sub rename {
		1425	my ($self, $new_path) = @_;
		1426
		1427	$self->unlink_save;
		1428
		1429	delete $cf::MAP{$self->path};
		1430	$self->{path} = new cf::path $new_path;
		1431	$self->path ($self->{path}->as_string);
		1432	$cf::MAP{$self->path} = $self;
		1433
		1434	$self->save;
		1435	}
		1436
		1437	sub reset {
		1438	my ($self) = @_;
		1439
		1440	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1441
		1442	return if $self->players;
		1443	return if $self->{path}{user_rel};#d#
		1444
		1445	warn "resetting map ", $self->path;#d#
		1446
		1447	delete $cf::MAP{$self->path};
		1448
		1449	$_->clear_links_to ($self) for values %cf::MAP;
		1450
		1451	$self->unlink_save;
		1452	$self->destroy;
		1453	}
		1454
		1455	my $nuke_counter = "aaaa";
		1456
		1457	sub nuke {
		1458	my ($self) = @_;
		1459
		1460	$self->{deny_save} = 1;
		1461	$self->reset_timeout (1);
		1462	$self->rename ("{nuke}/" . ($nuke_counter++));
		1463	$self->reset; # polite request, might not happen
		1464	}
		1465
		1466	sub customise_for {
		1467	my ($map, $ob) = @_;
		1468
		1469	if ($map->per_player) {
		1470	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
		1471	}
		1472
		1473	$map
		1474	}
		1475
		1476	sub emergency_save {
		1477	my $freeze_guard = cf::freeze_mainloop;
		1478
		1479	warn "enter emergency map save\n";
		1480
		1481	cf::sync_job {
		1482	warn "begin emergency map save\n";
		1483	$_->save for values %cf::MAP;
		1484	};
		1485
		1486	warn "end emergency map save\n";
		1487	}
		1488
		1489	package cf;
		1490
		1491	=back
		1492
		1493
		1494	=head3 cf::object::player
		1495
		1496	=over 4
790		1497
791	=item $player_object->reply ($npc, $msg[, $flags])	1498	=item $player_object->reply ($npc, $msg[, $flags])
792		1499
793	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1500	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
794	can be C<undef>. Does the right thing when the player is currently in a	1501	can be C<undef>. Does the right thing when the player is currently in a
…		…
796		1503
797	=cut	1504	=cut
798		1505
799	# rough implementation of a future "reply" method that works	1506	# rough implementation of a future "reply" method that works
800	# with dialog boxes.	1507	# with dialog boxes.
		1508	#TODO: the first argument must go, split into a $npc->reply_to ( method
801	sub cf::object::player::reply($$$;$) {	1509	sub cf::object::player::reply($$$;$) {
802	my ($self, $npc, $msg, $flags) = @_;	1510	my ($self, $npc, $msg, $flags) = @_;
803		1511
804	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1512	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
805		1513
…		…
809	$msg = $npc->name . " says: $msg" if $npc;	1517	$msg = $npc->name . " says: $msg" if $npc;
810	$self->message ($msg, $flags);	1518	$self->message ($msg, $flags);
811	}	1519	}
812	}	1520	}
813		1521
814	=item $player->ext_reply ($msgid, $msgtype, %msg)
815
816	Sends an ext reply to the player.
817
818	=cut
819
820	sub cf::player::ext_reply($$$%) {
821	my ($self, $id, %msg) = @_;
822
823	$msg{msgid} = $id;
824
825	$self->send ("ext " . to_json \%msg);
826	}
827
828	=item $player_object->may ("access")	1522	=item $player_object->may ("access")
829		1523
830	Returns wether the given player is authorized to access resource "access"	1524	Returns wether the given player is authorized to access resource "access"
831	(e.g. "command_wizcast").	1525	(e.g. "command_wizcast").
832		1526
…		…
839	(ref $cf::CFG{"may_$access"}	1533	(ref $cf::CFG{"may_$access"}
840	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1534	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
841	: $cf::CFG{"may_$access"})	1535	: $cf::CFG{"may_$access"})
842	}	1536	}
843		1537
844	=cut	1538	=item $player_object->enter_link
845		1539
846	#############################################################################	1540	Freezes the player and moves him/her to a special map (C<{link}>).
		1541
		1542	The player should be reaosnably safe there for short amounts of time. You
		1543	I<MUST> call C<leave_link> as soon as possible, though.
		1544
		1545	=item $player_object->leave_link ($map, $x, $y)
		1546
		1547	Moves the player out of the specila link map onto the given map. If the
		1548	map is not valid (or omitted), the player will be moved back to the
		1549	location he/she was before the call to C<enter_link>, or, if that fails,
		1550	to the emergency map position.
		1551
		1552	Might block.
		1553
		1554	=cut
		1555
		1556	sub cf::object::player::enter_link {
		1557	my ($self) = @_;
		1558
		1559	$self->deactivate_recursive;
		1560
		1561	return if $self->map == $LINK_MAP;
		1562
		1563	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1564	if $self->map;
		1565
		1566	$self->enter_map ($LINK_MAP, 20, 20);
		1567	}
		1568
		1569	sub cf::object::player::leave_link {
		1570	my ($self, $map, $x, $y) = @_;
		1571
		1572	my $link_pos = delete $self->{_link_pos};
		1573
		1574	unless ($map) {
		1575	# restore original map position
		1576	($map, $x, $y) = @{ $link_pos || [] };
		1577	$map = cf::map::find $map;
		1578
		1579	unless ($map) {
		1580	($map, $x, $y) = @$EMERGENCY_POSITION;
		1581	$map = cf::map::find $map
		1582	or die "FATAL: cannot load emergency map\n";
		1583	}
		1584	}
		1585
		1586	($x, $y) = (-1, -1)
		1587	unless (defined $x) && (defined $y);
		1588
		1589	# use -1 or undef as default coordinates, not 0, 0
		1590	($x, $y) = ($map->enter_x, $map->enter_y)
		1591	if $x <=0 && $y <= 0;
		1592
		1593	$map->load;
		1594
		1595	return unless $self->contr->active;
		1596	$self->activate_recursive;
		1597	$self->enter_map ($map, $x, $y);
		1598	}
		1599
		1600	cf::player->attach (
		1601	on_logout => sub {
		1602	my ($pl) = @_;
		1603
		1604	# abort map switching before logout
		1605	if ($pl->ob->{_link_pos}) {
		1606	cf::sync_job {
		1607	$pl->ob->leave_link
		1608	};
		1609	}
		1610	},
		1611	on_login => sub {
		1612	my ($pl) = @_;
		1613
		1614	# try to abort aborted map switching on player login :)
		1615	# should happen only on crashes
		1616	if ($pl->ob->{_link_pos}) {
		1617	$pl->ob->enter_link;
		1618	(async {
		1619	# we need this sleep as the login has a concurrent enter_exit running
		1620	# and this sleep increases chances of the player not ending up in scorn
		1621	$pl->ob->reply (undef,
		1622	"There was an internal problem at your last logout, "
		1623	. "the server will try to bring you to your intended destination in a second.",
		1624	cf::NDI_RED);
		1625	Coro::Timer::sleep 1;
		1626	$pl->ob->leave_link;
		1627	})->prio (2);
		1628	}
		1629	},
		1630	);
		1631
		1632	=item $player_object->goto ($path, $x, $y)
		1633
		1634	=cut
		1635
		1636	sub cf::object::player::goto {
		1637	my ($self, $path, $x, $y) = @_;
		1638
		1639	$self->enter_link;
		1640
		1641	(async {
		1642	$path = new cf::path $path;
		1643
		1644	my $map = cf::map::find $path->as_string;
		1645	$map = $map->customise_for ($self) if $map;
		1646
		1647	# warn "entering ", $map->path, " at ($x, $y)\n"
		1648	# if $map;
		1649
		1650	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1651
		1652	$self->leave_link ($map, $x, $y);
		1653	})->prio (1);
		1654	}
		1655
		1656	=item $player_object->enter_exit ($exit_object)
		1657
		1658	=cut
		1659
		1660	sub parse_random_map_params {
		1661	my ($spec) = @_;
		1662
		1663	my $rmp = { # defaults
		1664	xsize => 10,
		1665	ysize => 10,
		1666	};
		1667
		1668	for (split /\n/, $spec) {
		1669	my ($k, $v) = split /\s+/, $_, 2;
		1670
		1671	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1672	}
		1673
		1674	$rmp
		1675	}
		1676
		1677	sub prepare_random_map {
		1678	my ($exit) = @_;
		1679
		1680	# all this does is basically replace the /! path by
		1681	# a new random map path (?random/...) with a seed
		1682	# that depends on the exit object
		1683
		1684	my $rmp = parse_random_map_params $exit->msg;
		1685
		1686	if ($exit->map) {
		1687	$rmp->{region} = $exit->map->region_name;
		1688	$rmp->{origin_map} = $exit->map->path;
		1689	$rmp->{origin_x} = $exit->x;
		1690	$rmp->{origin_y} = $exit->y;
		1691	}
		1692
		1693	$rmp->{random_seed} ||= $exit->random_seed;
		1694
		1695	my $data = cf::to_json $rmp;
		1696	my $md5 = Digest::MD5::md5_hex $data;
		1697
		1698	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1699	aio_write $fh, 0, (length $data), $data, 0;
		1700
		1701	$exit->slaying ("?random/$md5");
		1702	$exit->msg (undef);
		1703	}
		1704	}
		1705
		1706	sub cf::object::player::enter_exit {
		1707	my ($self, $exit) = @_;
		1708
		1709	return unless $self->type == cf::PLAYER;
		1710
		1711	$self->enter_link;
		1712
		1713	(async {
		1714	$self->deactivate_recursive; # just to be sure
		1715	unless (eval {
		1716	prepare_random_map $exit
		1717	if $exit->slaying eq "/!";
		1718
		1719	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1720	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1721
		1722	1;
		1723	}) {
		1724	$self->message ("Something went wrong deep within the crossfire server. "
		1725	. "I'll try to bring you back to the map you were before. "
		1726	. "Please report this to the dungeon master",
		1727	cf::NDI_UNIQUE | cf::NDI_RED);
		1728
		1729	warn "ERROR in enter_exit: $@";
		1730	$self->leave_link;
		1731	}
		1732	})->prio (1);
		1733	}
		1734
		1735	=head3 cf::client
		1736
		1737	=over 4
		1738
		1739	=item $client->send_drawinfo ($text, $flags)
		1740
		1741	Sends a drawinfo packet to the client. Circumvents output buffering so
		1742	should not be used under normal circumstances.
		1743
		1744	=cut
		1745
		1746	sub cf::client::send_drawinfo {
		1747	my ($self, $text, $flags) = @_;
		1748
		1749	utf8::encode $text;
		1750	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1751	}
		1752
		1753
		1754	=item $success = $client->query ($flags, "text", \&cb)
		1755
		1756	Queues a query to the client, calling the given callback with
		1757	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1758	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1759
		1760	Queries can fail, so check the return code. Or don't, as queries will become
		1761	reliable at some point in the future.
		1762
		1763	=cut
		1764
		1765	sub cf::client::query {
		1766	my ($self, $flags, $text, $cb) = @_;
		1767
		1768	return unless $self->state == ST_PLAYING
		1769	|| $self->state == ST_SETUP
		1770	|| $self->state == ST_CUSTOM;
		1771
		1772	$self->state (ST_CUSTOM);
		1773
		1774	utf8::encode $text;
		1775	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1776
		1777	$self->send_packet ($self->{query_queue}[0][0])
		1778	if @{ $self->{query_queue} } == 1;
		1779	}
		1780
		1781	cf::client->attach (
		1782	on_reply => sub {
		1783	my ($ns, $msg) = @_;
		1784
		1785	# this weird shuffling is so that direct followup queries
		1786	# get handled first
		1787	my $queue = delete $ns->{query_queue}
		1788	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1789
		1790	(shift @$queue)->[1]->($msg);
		1791
		1792	push @{ $ns->{query_queue} }, @$queue;
		1793
		1794	if (@{ $ns->{query_queue} } == @$queue) {
		1795	if (@$queue) {
		1796	$ns->send_packet ($ns->{query_queue}[0][0]);
		1797	} else {
		1798	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1799	}
		1800	}
		1801	},
		1802	);
		1803
		1804	=item $client->async (\&cb)
		1805
		1806	Create a new coroutine, running the specified callback. The coroutine will
		1807	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1808	or loss of connection).
		1809
		1810	=cut
		1811
		1812	sub cf::client::async {
		1813	my ($self, $cb) = @_;
		1814
		1815	my $coro = &Coro::async ($cb);
		1816
		1817	$coro->on_destroy (sub {
		1818	delete $self->{_coro}{$coro+0};
		1819	});
		1820
		1821	$self->{_coro}{$coro+0} = $coro;
		1822
		1823	$coro
		1824	}
		1825
		1826	cf::client->attach (
		1827	on_destroy => sub {
		1828	my ($ns) = @_;
		1829
		1830	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1831	},
		1832	);
		1833
		1834	=back
		1835
847		1836
848	=head2 SAFE SCRIPTING	1837	=head2 SAFE SCRIPTING
849		1838
850	Functions that provide a safe environment to compile and execute	1839	Functions that provide a safe environment to compile and execute
851	snippets of perl code without them endangering the safety of the server	1840	snippets of perl code without them endangering the safety of the server
…		…
866		1855
867	=pod	1856	=pod
868		1857
869	The following fucntions and emthods are available within a safe environment:	1858	The following fucntions and emthods are available within a safe environment:
870		1859
871	cf::object contr pay_amount pay_player	1860	cf::object contr pay_amount pay_player map
872	cf::object::player player	1861	cf::object::player player
873	cf::player peaceful	1862	cf::player peaceful
		1863	cf::map trigger
874		1864
875	=cut	1865	=cut
876		1866
877	for (	1867	for (
878	["cf::object" => qw(contr pay_amount pay_player)],	1868	["cf::object" => qw(contr pay_amount pay_player map)],
879	["cf::object::player" => qw(player)],	1869	["cf::object::player" => qw(player)],
880	["cf::player" => qw(peaceful)],	1870	["cf::player" => qw(peaceful)],
		1871	["cf::map" => qw(trigger)],
881	) {	1872	) {
882	no strict 'refs';	1873	no strict 'refs';
883	my ($pkg, @funs) = @$_;	1874	my ($pkg, @funs) = @$_;
884	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1875	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
885	for @funs;	1876	for @funs;
…		…
1001		1992
1002	{	1993	{
1003	my $path = cf::localdir . "/database.pst";	1994	my $path = cf::localdir . "/database.pst";
1004		1995
1005	sub db_load() {	1996	sub db_load() {
1006	warn "loading database $path\n";#d# remove later
1007	$DB = stat $path ? Storable::retrieve $path : { };	1997	$DB = stat $path ? Storable::retrieve $path : { };
1008	}	1998	}
1009		1999
1010	my $pid;	2000	my $pid;
1011		2001
1012	sub db_save() {	2002	sub db_save() {
1013	warn "saving database $path\n";#d# remove later
1014	waitpid $pid, 0 if $pid;	2003	waitpid $pid, 0 if $pid;
1015	if (0 == ($pid = fork)) {	2004	if (0 == ($pid = fork)) {
1016	$DB->{_meta}{version} = 1;	2005	$DB->{_meta}{version} = 1;
1017	Storable::nstore $DB, "$path~";	2006	Storable::nstore $DB, "$path~";
1018	rename "$path~", $path;	2007	rename "$path~", $path;
…		…
1025	sub db_sync() {	2014	sub db_sync() {
1026	db_save if $dirty;	2015	db_save if $dirty;
1027	undef $dirty;	2016	undef $dirty;
1028	}	2017	}
1029		2018
1030	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	2019	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1031	db_sync;	2020	db_sync;
1032	});	2021	});
1033		2022
1034	sub db_dirty() {	2023	sub db_dirty() {
1035	$dirty = 1;	2024	$dirty = 1;
…		…
1049	$DB->{$_[0]} = $_[1];	2038	$DB->{$_[0]} = $_[1];
1050	}	2039	}
1051	db_dirty;	2040	db_dirty;
1052	}	2041	}
1053		2042
1054	attach_global	2043	cf::global->attach (
1055	prio => 10000,	2044	prio => 10000,
1056	on_cleanup => sub {	2045	on_cleanup => sub {
1057	db_sync;	2046	db_sync;
1058	},	2047	},
1059	;	2048	);
1060	}	2049	}
1061		2050
1062	#############################################################################	2051	#############################################################################
1063	# the server's main()	2052	# the server's main()
1064		2053
…		…
1066	open my $fh, "<:utf8", cf::confdir . "/config"	2055	open my $fh, "<:utf8", cf::confdir . "/config"
1067	or return;	2056	or return;
1068		2057
1069	local $/;	2058	local $/;
1070	*CFG = YAML::Syck::Load <$fh>;	2059	*CFG = YAML::Syck::Load <$fh>;
		2060
		2061	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2062
		2063	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2064	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2065
		2066	if (exists $CFG{mlockall}) {
		2067	eval {
		2068	$CFG{mlockall} ? &mlockall : &munlockall
		2069	and die "WARNING: m(un)lockall failed: $!\n";
		2070	};
		2071	warn $@ if $@;
		2072	}
1071	}	2073	}
1072		2074
1073	sub main {	2075	sub main {
		2076	# we must not ever block the main coroutine
		2077	local $Coro::idle = sub {
		2078	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2079	async { Event::one_event };
		2080	};
		2081
1074	cfg_load;	2082	cfg_load;
1075	db_load;	2083	db_load;
1076	load_extensions;	2084	load_extensions;
1077	Event::loop;	2085	Event::loop;
1078	}	2086	}
1079		2087
1080	#############################################################################	2088	#############################################################################
1081	# initialisation	2089	# initialisation
1082		2090
1083	sub _perl_reload(&) {	2091	sub reload() {
1084	my ($msg) = @_;	2092	# can/must only be called in main
		2093	if ($Coro::current != $Coro::main) {
		2094	warn "can only reload from main coroutine\n";
		2095	return;
		2096	}
1085		2097
1086	$msg->("reloading...");	2098	warn "reloading...";
		2099
		2100	my $guard = freeze_mainloop;
		2101	cf::emergency_save;
1087		2102
1088	eval {	2103	eval {
		2104	# if anything goes wrong in here, we should simply crash as we already saved
		2105
1089	# cancel all watchers	2106	# cancel all watchers
1090	$_->cancel for Event::all_watchers;	2107	for (Event::all_watchers) {
		2108	$_->cancel if $_->data & WF_AUTOCANCEL;
		2109	}
		2110
		2111	# cancel all extension coros
		2112	$_->cancel for values %EXT_CORO;
		2113	%EXT_CORO = ();
1091		2114
1092	# unload all extensions	2115	# unload all extensions
1093	for (@exts) {	2116	for (@exts) {
1094	$msg->("unloading <$_>");	2117	warn "unloading <$_>";
1095	unload_extension $_;	2118	unload_extension $_;
1096	}	2119	}
1097		2120
1098	# unload all modules loaded from $LIBDIR	2121	# unload all modules loaded from $LIBDIR
1099	while (my ($k, $v) = each %INC) {	2122	while (my ($k, $v) = each %INC) {
1100	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2123	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101		2124
1102	$msg->("removing <$k>");	2125	warn "removing <$k>";
1103	delete $INC{$k};	2126	delete $INC{$k};
1104		2127
1105	$k =~ s/\.pm$//;	2128	$k =~ s/\.pm$//;
1106	$k =~ s/\//::/g;	2129	$k =~ s/\//::/g;
1107		2130
…		…
1112	Symbol::delete_package $k;	2135	Symbol::delete_package $k;
1113	}	2136	}
1114		2137
1115	# sync database to disk	2138	# sync database to disk
1116	cf::db_sync;	2139	cf::db_sync;
		2140	IO::AIO::flush;
1117		2141
1118	# get rid of safe::, as good as possible	2142	# get rid of safe::, as good as possible
1119	Symbol::delete_package "safe::$_"	2143	Symbol::delete_package "safe::$_"
1120	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2144	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121		2145
1122	# remove register_script_function callbacks	2146	# remove register_script_function callbacks
1123	# TODO	2147	# TODO
1124		2148
1125	# unload cf.pm "a bit"	2149	# unload cf.pm "a bit"
…		…
1128	# don't, removes xs symbols, too,	2152	# don't, removes xs symbols, too,
1129	# and global variables created in xs	2153	# and global variables created in xs
1130	#Symbol::delete_package __PACKAGE__;	2154	#Symbol::delete_package __PACKAGE__;
1131		2155
1132	# reload cf.pm	2156	# reload cf.pm
1133	$msg->("reloading cf.pm");	2157	warn "reloading cf.pm";
1134	require cf;	2158	require cf;
		2159	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		2160
1136	# load config and database again	2161	# load config and database again
1137	cf::cfg_load;	2162	cf::cfg_load;
1138	cf::db_load;	2163	cf::db_load;
1139		2164
1140	# load extensions	2165	# load extensions
1141	$msg->("load extensions");	2166	warn "load extensions";
1142	cf::load_extensions;	2167	cf::load_extensions;
1143		2168
1144	# reattach attachments to objects	2169	# reattach attachments to objects
1145	$msg->("reattach");	2170	warn "reattach";
1146	_global_reattach;	2171	_global_reattach;
1147	};	2172	};
1148	$msg->($@) if $@;
1149		2173
1150	$msg->("reloaded");	2174	if ($@) {
		2175	warn $@;
		2176	warn "error while reloading, exiting.";
		2177	exit 1;
		2178	}
		2179
		2180	warn "reloaded successfully";
1151	};	2181	};
1152		2182
1153	sub perl_reload() {	2183	#############################################################################
1154	_perl_reload {
1155	warn $_[0];
1156	print "$_[0]\n";
1157	};
1158	}
1159		2184
		2185	unless ($LINK_MAP) {
		2186	$LINK_MAP = cf::map::new;
		2187
		2188	$LINK_MAP->width (41);
		2189	$LINK_MAP->height (41);
		2190	$LINK_MAP->alloc;
		2191	$LINK_MAP->path ("{link}");
		2192	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2193	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2194
		2195	# dirty hack because... archetypes are not yet loaded
		2196	Event->timer (
		2197	after => 10,
		2198	cb => sub {
		2199	$_[0]->w->cancel;
		2200
		2201	# provide some exits "home"
		2202	my $exit = cf::object::new "exit";
		2203
		2204	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2205	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2206	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2207
		2208	$LINK_MAP->insert ($exit->clone, 19, 19);
		2209	$LINK_MAP->insert ($exit->clone, 19, 20);
		2210	$LINK_MAP->insert ($exit->clone, 19, 21);
		2211	$LINK_MAP->insert ($exit->clone, 20, 19);
		2212	$LINK_MAP->insert ($exit->clone, 20, 21);
		2213	$LINK_MAP->insert ($exit->clone, 21, 19);
		2214	$LINK_MAP->insert ($exit->clone, 21, 20);
		2215	$LINK_MAP->insert ($exit->clone, 21, 21);
		2216
		2217	$exit->destroy;
		2218	});
		2219
		2220	$LINK_MAP->{deny_save} = 1;
		2221	$LINK_MAP->{deny_reset} = 1;
		2222
		2223	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2224	}
		2225
		2226	register "<global>", __PACKAGE__;
		2227
1160	register_command "perl-reload", 0, sub {	2228	register_command "reload" => sub {
1161	my ($who, $arg) = @_;	2229	my ($who, $arg) = @_;
1162		2230
1163	if ($who->flag (FLAG_WIZ)) {	2231	if ($who->flag (FLAG_WIZ)) {
1164	_perl_reload {	2232	$who->message ("start of reload.");
1165	warn $_[0];	2233	reload;
1166	$who->message ($_[0]);	2234	$who->message ("end of reload.");
1167	};
1168	}	2235	}
1169	};	2236	};
1170		2237
1171	register "<global>", __PACKAGE__;
1172
1173	unshift @INC, $LIBDIR;	2238	unshift @INC, $LIBDIR;
1174		2239
1175	$TICK_WATCHER = Event->timer (	2240	$TICK_WATCHER = Event->timer (
		2241	reentrant => 0,
1176	prio => 1,	2242	prio => 0,
1177	async => 1,
1178	at => $NEXT_TICK || 1,	2243	at => $NEXT_TICK || $TICK,
		2244	data => WF_AUTOCANCEL,
1179	cb => sub {	2245	cb => sub {
1180	cf::server_tick; # one server iteration	2246	cf::server_tick; # one server iteration
1181		2247	$RUNTIME += $TICK;
1182	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	2248	$NEXT_TICK += $TICK;
1184		2249
1185	# if we are delayed by four ticks or more, skip them all	2250	# if we are delayed by four ticks or more, skip them all
1186	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2251	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1187		2252
1188	$TICK_WATCHER->at ($NEXT_TICK);	2253	$TICK_WATCHER->at ($NEXT_TICK);
1189	$TICK_WATCHER->start;	2254	$TICK_WATCHER->start;
1190	},	2255	},
1191	);	2256	);
1192		2257
1193	IO::AIO::max_poll_time $TICK * 0.2;	2258	IO::AIO::max_poll_time $TICK * 0.2;
1194		2259
		2260	Event->io (
1195	Event->io (fd => IO::AIO::poll_fileno,	2261	fd => IO::AIO::poll_fileno,
1196	poll => 'r',	2262	poll => 'r',
1197	prio => 5,	2263	prio => 5,
		2264	data => WF_AUTOCANCEL,
1198	cb => \&IO::AIO::poll_cb);	2265	cb => \&IO::AIO::poll_cb,
		2266	);
		2267
		2268	Event->timer (
		2269	data => WF_AUTOCANCEL,
		2270	after => 0,
		2271	interval => 10,
		2272	cb => sub {
		2273	(Coro::unblock_sub {
		2274	write_runtime
		2275	or warn "ERROR: unable to write runtime file: $!";
		2276	})->();
		2277	},
		2278	);
		2279
		2280	END { cf::emergency_save }
1199		2281
1200	1	2282	1
1201		2283

Diff Legend

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