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.111 by root, Mon Jan 1 12:28:47 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 (2); # run main coroutine ("the server") with very high priority
20		32
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		34
23	our %COMMAND = ();	35	our %COMMAND = ();
24	our %COMMAND_TIME = ();	36	our %COMMAND_TIME = ();
25	our %EXTCMD = ();	37	our %EXTCMD = ();
26		38
27	_init_vars;
28
29	our @EVENT;	39	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	40	our $LIBDIR = datadir . "/ext";
31		41
32	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	43	our $TICK_WATCHER;
34	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
35		46
36	our %CFG;	47	our %CFG;
37		48
38	our $UPTIME; $UPTIME ||= time;	49	our $UPTIME; $UPTIME ||= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		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
		77	our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];
39		78
40	#############################################################################	79	#############################################################################
41		80
42	=head2 GLOBAL VARIABLES	81	=head2 GLOBAL VARIABLES
43		82
44	=over 4	83	=over 4
45		84
46	=item $cf::UPTIME	85	=item $cf::UPTIME
47		86
48	The timestamp of the server start (so not actually an uptime).	87	The timestamp of the server start (so not actually an uptime).
		88
		89	=item $cf::RUNTIME
		90
		91	The time this server has run, starts at 0 and is increased by $cf::TICK on
		92	every server tick.
49		93
50	=item $cf::LIBDIR	94	=item $cf::LIBDIR
51		95
52	The perl library directory, where extensions and cf-specific modules can	96	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	97	be found. It will be added to C<@INC> automatically.
		98
		99	=item $cf::NOW
		100
		101	The time of the last (current) server tick.
54		102
55	=item $cf::TICK	103	=item $cf::TICK
56		104
57	The interval between server ticks, in seconds.	105	The interval between server ticks, in seconds.
58		106
…		…
66	=cut	114	=cut
67		115
68	BEGIN {	116	BEGIN {
69	*CORE::GLOBAL::warn = sub {	117	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	118	my $msg = join "", @_;
		119	utf8::encode $msg;
		120
71	$msg .= "\n"	121	$msg .= "\n"
72	unless $msg =~ /\n$/;	122	unless $msg =~ /\n$/;
73		123
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	124	LOG llevError, "cfperl: $msg";
76	};	125	};
77	}	126	}
78		127
		128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		129	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		130	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		131	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		132	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
79	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80		134
81	# we bless all objects into (empty) derived classes to force a method lookup	135	# we bless all objects into (empty) derived classes to force a method lookup
82	# within the Safe compartment.	136	# within the Safe compartment.
83	for my $pkg (qw(	137	for my $pkg (qw(
		138	cf::global cf::attachable
84	cf::object cf::object::player	139	cf::object cf::object::player
85	cf::client cf::player	140	cf::client cf::player
86	cf::arch cf::living	141	cf::arch cf::living
87	cf::map cf::party cf::region	142	cf::map cf::party cf::region
88	)) {	143	)) {
…		…
126	sub to_json($) {	181	sub to_json($) {
127	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128	JSON::Syck::Dump $_[0]	183	JSON::Syck::Dump $_[0]
129	}	184	}
130		185
		186	=item cf::sync_job { BLOCK }
		187
		188	The design of crossfire+ requires that the main coro ($Coro::main) is
		189	always able to handle events or runnable, as crossfire+ is only partly
		190	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		191
		192	If it must be done, put the blocking parts into C<sync_job>. This will run
		193	the given BLOCK in another coroutine while waiting for the result. The
		194	server will be frozen during this time, so the block should either finish
		195	fast or be very important.
		196
		197	=cut
		198
		199	sub sync_job(&) {
		200	my ($job) = @_;
		201
		202	my $busy = 1;
		203	my @res;
		204
		205	my $coro = Coro::async {
		206	@res = eval { $job->() };
		207	warn $@ if $@;
		208	undef $busy;
		209	};
		210
		211	if ($Coro::current == $Coro::main) {
		212	# TODO: use suspend/resume instead
		213	local $FREEZE = 1;
		214	$coro->prio (Coro::PRIO_MAX);
		215	while ($busy) {
		216	Coro::cede_notself;
		217	Event::one_event unless Coro::nready;
		218	}
		219	} else {
		220	$coro->join;
		221	}
		222
		223	wantarray ? @res : $res[0]
		224	}
		225
		226	=item $coro = cf::coro { BLOCK }
		227
		228	Creates and returns a new coro. This coro is automcatially being canceled
		229	when the extension calling this is being unloaded.
		230
		231	=cut
		232
		233	sub coro(&) {
		234	my $cb = shift;
		235
		236	my $coro; $coro = async {
		237	eval {
		238	$cb->();
		239	};
		240	warn $@ if $@;
		241	};
		242
		243	$coro->on_destroy (sub {
		244	delete $EXT_CORO{$coro+0};
		245	});
		246	$EXT_CORO{$coro+0} = $coro;
		247
		248	$coro
		249	}
		250
		251	sub write_runtime {
		252	my $runtime = cf::localdir . "/runtime";
		253
		254	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		255	or return;
		256
		257	my $value = $cf::RUNTIME;
		258	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		259	and return;
		260
		261	aio_fsync $fh
		262	and return;
		263
		264	close $fh
		265	or return;
		266
		267	aio_rename "$runtime~", $runtime
		268	and return;
		269
		270	1
		271	}
		272
131	=back	273	=back
132		274
133	=cut	275	=cut
134		276
135	#############################################################################	277	#############################################################################
136		278
137	=head2 EVENTS AND OBJECT ATTACHMENTS	279	package cf::path;
		280
		281	sub new {
		282	my ($class, $path, $base) = @_;
		283
		284	$path = $path->as_string if ref $path;
		285
		286	my $self = bless { }, $class;
		287
		288	if ($path =~ s{^\?random/}{}) {
		289	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		290	$self->{random} = cf::from_json $data;
		291	} else {
		292	if ($path =~ s{^~([^/]+)?}{}) {
		293	$self->{user_rel} = 1;
		294
		295	if (defined $1) {
		296	$self->{user} = $1;
		297	} elsif ($base =~ m{^~([^/]+)/}) {
		298	$self->{user} = $1;
		299	} else {
		300	warn "cannot resolve user-relative path without user <$path,$base>\n";
		301	}
		302	} elsif ($path =~ /^\//) {
		303	# already absolute
		304	} else {
		305	$base =~ s{[^/]+/?$}{};
		306	return $class->new ("$base/$path");
		307	}
		308
		309	for ($path) {
		310	redo if s{/\.?/}{/};
		311	redo if s{/[^/]+/\.\./}{/};
		312	}
		313	}
		314
		315	$self->{path} = $path;
		316
		317	$self
		318	}
		319
		320	# the name / primary key / in-game path
		321	sub as_string {
		322	my ($self) = @_;
		323
		324	$self->{user_rel} ? "~$self->{user}$self->{path}"
		325	: $self->{random} ? "?random/$self->{path}"
		326	: $self->{path}
		327	}
		328
		329	# the displayed name, this is a one way mapping
		330	sub visible_name {
		331	my ($self) = @_;
		332
		333	# if (my $rmp = $self->{random}) {
		334	# # todo: be more intelligent about this
		335	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		336	# } else {
		337	$self->as_string
		338	# }
		339	}
		340
		341	# escape the /'s in the path
		342	sub _escaped_path {
		343	# ∕ is U+2215
		344	(my $path = $_[0]{path}) =~ s/\//∕/g;
		345	$path
		346	}
		347
		348	# the original (read-only) location
		349	sub load_path {
		350	my ($self) = @_;
		351
		352	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		353	}
		354
		355	# the temporary/swap location
		356	sub save_path {
		357	my ($self) = @_;
		358
		359	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		360	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		361	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		362	}
		363
		364	# the unique path, might be eq to save_path
		365	sub uniq_path {
		366	my ($self) = @_;
		367
		368	$self->{user_rel} || $self->{random}
		369	? undef
		370	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		371	}
		372
		373	# return random map parameters, or undef
		374	sub random_map_params {
		375	my ($self) = @_;
		376
		377	$self->{random}
		378	}
		379
		380	# this is somewhat ugly, but style maps do need special treatment
		381	sub is_style_map {
		382	$_[0]{path} =~ m{^/styles/}
		383	}
		384
		385	package cf;
		386
		387	#############################################################################
		388
		389	=head2 ATTACHABLE OBJECTS
		390
		391	Many objects in crossfire are so-called attachable objects. That means you can
		392	attach callbacks/event handlers (a collection of which is called an "attachment")
		393	to it. All such attachable objects support the following methods.
		394
		395	In the following description, CLASS can be any of C<global>, C<object>
		396	C<player>, C<client> or C<map> (i.e. the attachable objects in
		397	crossfire+).
138		398
139	=over 4	399	=over 4
140		400
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...)	401	=item $attachable->attach ($attachment, key => $value...)
160		402
161	=item $client->detach ($attachment)	403	=item $attachable->detach ($attachment)
162		404
163	Attach/detach a pre-registered attachment to a map.	405	Attach/detach a pre-registered attachment to a specific object and give it
		406	the specified key/value pairs as arguments.
164		407
165	=item $bool = $object->attached ($name)	408	Example, attach a minesweeper attachment to the given object, making it a
		409	10x10 minesweeper game:
166		410
167	=item $bool = $player->attached ($name)	411	$obj->attach (minesweeper => width => 10, height => 10);
168		412
169	=item $bool = $client->attached ($name)	413	=item $bool = $attachable->attached ($name)
170
171	=item $bool = $map->attached ($name)
172		414
173	Checks wether the named attachment is currently attached to the object.	415	Checks wether the named attachment is currently attached to the object.
174		416
175	=item cf::attach_global ...	417	=item cf::CLASS->attach ...
176		418
177	Attach handlers for global events.	419	=item cf::CLASS->detach ...
178		420
179	This and all following C<attach_*>-functions expect any number of the	421	Define an anonymous attachment and attach it to all objects of the given
180	following handler/hook descriptions:	422	CLASS. See the next function for an explanation of its arguments.
		423
		424	You can attach to global events by using the C<cf::global> class.
		425
		426	Example, log all player logins:
		427
		428	cf::player->attach (
		429	on_login => sub {
		430	my ($pl) = @_;
		431	...
		432	},
		433	);
		434
		435	Example, attach to the jeweler skill:
		436
		437	cf::object->attach (
		438	type => cf::SKILL,
		439	subtype => cf::SK_JEWELER,
		440	on_use_skill => sub {
		441	my ($sk, $ob, $part, $dir, $msg) = @_;
		442	...
		443	},
		444	);
		445
		446	=item cf::CLASS::attachment $name, ...
		447
		448	Register an attachment by C<$name> through which attachable objects of the
		449	given CLASS can refer to this attachment.
		450
		451	Some classes such as crossfire maps and objects can specify attachments
		452	that are attached at load/instantiate time, thus the need for a name.
		453
		454	These calls expect any number of the following handler/hook descriptions:
181		455
182	=over 4	456	=over 4
183		457
184	=item prio => $number	458	=item prio => $number
185		459
…		…
187	by another C<prio> setting). Lower priority handlers get executed	461	by another C<prio> setting). Lower priority handlers get executed
188	earlier. The default priority is C<0>, and many built-in handlers are	462	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	463	registered at priority C<-1000>, so lower priorities should not be used
190	unless you know what you are doing.	464	unless you know what you are doing.
191		465
		466	=item type => $type
		467
		468	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		469	given type of objects only (the additional parameter C<subtype> can be
		470	used to further limit to the given subtype).
		471
192	=item on_I<event> => \&cb	472	=item on_I<event> => \&cb
193		473
194	Call the given code reference whenever the named event happens (event is	474	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	475	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	476	handlers are recognised generally depends on the type of object these
…		…
205	package and register them. Only handlers for eevents supported by the	485	package and register them. Only handlers for eevents supported by the
206	object/class are recognised.	486	object/class are recognised.
207		487
208	=back	488	=back
209		489
210	=item cf::attach_to_type $object_type, $subtype, ...	490	Example, define an attachment called "sockpuppet" that calls the given
		491	event handler when a monster attacks:
211		492
212	Attach handlers for a specific object type (e.g. TRANSPORT) and	493	cf::object::attachment sockpuppet =>
213	subtype. If C<$subtype> is zero or undef, matches all objects of the given	494	on_skill_attack => sub {
214	type.	495	my ($self, $victim) = @_;
215		496	...
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	}	497	}
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	498	}
455	}
456		499
457	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	500	=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		501
485	Just because you have a perl object does not mean that the corresponding	502	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	503	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	504	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	505	can be used to test for existence of the C object part without causing an
489	exception.	506	exception.
490		507
		508	=cut
		509
		510	# the following variables are defined in .xs and must not be re-created
		511	our @CB_GLOBAL = (); # registry for all global events
		512	our @CB_ATTACHABLE = (); # registry for all attachables
		513	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		514	our @CB_PLAYER = ();
		515	our @CB_CLIENT = ();
		516	our @CB_TYPE = (); # registry for type (cf-object class) based events
		517	our @CB_MAP = ();
		518
		519	my %attachment;
		520
		521	sub _attach_cb($$$$) {
		522	my ($registry, $event, $prio, $cb) = @_;
		523
		524	use sort 'stable';
		525
		526	$cb = [$prio, $cb];
		527
		528	@{$registry->[$event]} = sort
		529	{ $a->[0] cmp $b->[0] }
		530	@{$registry->[$event] || []}, $cb;
		531	}
		532
		533	# hack
		534	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		535
		536	# attach handles attaching event callbacks
		537	# the only thing the caller has to do is pass the correct
		538	# registry (== where the callback attaches to).
		539	sub _attach {
		540	my ($registry, $klass, @arg) = @_;
		541
		542	my $object_type;
		543	my $prio = 0;
		544	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		545
		546	#TODO: get rid of this hack
		547	if ($attachable_klass{$klass}) {
		548	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		549	}
		550
		551	while (@arg) {
		552	my $type = shift @arg;
		553
		554	if ($type eq "prio") {
		555	$prio = shift @arg;
		556
		557	} elsif ($type eq "type") {
		558	$object_type = shift @arg;
		559	$registry = $CB_TYPE[$object_type] ||= [];
		560
		561	} elsif ($type eq "subtype") {
		562	defined $object_type or Carp::croak "subtype specified without type";
		563	my $object_subtype = shift @arg;
		564	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		565
		566	} elsif ($type eq "package") {
		567	my $pkg = shift @arg;
		568
		569	while (my ($name, $id) = each %cb_id) {
		570	if (my $cb = $pkg->can ($name)) {
		571	_attach_cb $registry, $id, $prio, $cb;
		572	}
		573	}
		574
		575	} elsif (exists $cb_id{$type}) {
		576	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		577
		578	} elsif (ref $type) {
		579	warn "attaching objects not supported, ignoring.\n";
		580
		581	} else {
		582	shift @arg;
		583	warn "attach argument '$type' not supported, ignoring.\n";
		584	}
		585	}
		586	}
		587
		588	sub _object_attach {
		589	my ($obj, $name, %arg) = @_;
		590
		591	return if exists $obj->{_attachment}{$name};
		592
		593	if (my $attach = $attachment{$name}) {
		594	my $registry = $obj->registry;
		595
		596	for (@$attach) {
		597	my ($klass, @attach) = @$_;
		598	_attach $registry, $klass, @attach;
		599	}
		600
		601	$obj->{$name} = \%arg;
		602	} else {
		603	warn "object uses attachment '$name' that is not available, postponing.\n";
		604	}
		605
		606	$obj->{_attachment}{$name} = undef;
		607	}
		608
		609	sub cf::attachable::attach {
		610	if (ref $_[0]) {
		611	_object_attach @_;
		612	} else {
		613	_attach shift->_attach_registry, @_;
		614	}
		615	};
		616
		617	# all those should be optimised
		618	sub cf::attachable::detach {
		619	my ($obj, $name) = @_;
		620
		621	if (ref $obj) {
		622	delete $obj->{_attachment}{$name};
		623	reattach ($obj);
		624	} else {
		625	Carp::croak "cannot, currently, detach class attachments";
		626	}
		627	};
		628
		629	sub cf::attachable::attached {
		630	my ($obj, $name) = @_;
		631
		632	exists $obj->{_attachment}{$name}
		633	}
		634
		635	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		636	eval "#line " . __LINE__ . " 'cf.pm'
		637	sub cf::\L$klass\E::_attach_registry {
		638	(\\\@CB_$klass, KLASS_$klass)
		639	}
		640
		641	sub cf::\L$klass\E::attachment {
		642	my \$name = shift;
		643
		644	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		645	}
		646	";
		647	die if $@;
		648	}
		649
		650	our $override;
		651	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		652
		653	sub override {
		654	$override = 1;
		655	@invoke_results = ();
		656	}
		657
		658	sub do_invoke {
		659	my $event = shift;
		660	my $callbacks = shift;
		661
		662	@invoke_results = ();
		663
		664	local $override;
		665
		666	for (@$callbacks) {
		667	eval { &{$_->[1]} };
		668
		669	if ($@) {
		670	warn "$@";
		671	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		672	override;
		673	}
		674
		675	return 1 if $override;
		676	}
		677
		678	0
		679	}
		680
		681	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		682
		683	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		684
		685	Generate an object-specific event with the given arguments.
		686
		687	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		688	removed in future versions), and there is no public API to access override
		689	results (if you must, access C<@cf::invoke_results> directly).
		690
491	=back	691	=back
492		692
493	=cut	693	=cut
494
495	*cf::object::valid =
496	*cf::player::valid =
497	*cf::client::valid =
498	*cf::map::valid = \&cf::_valid;
499		694
500	#############################################################################	695	#############################################################################
501	# object support	696	# object support
502		697
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 {	698	sub reattach {
		699	# basically do the same as instantiate, without calling instantiate
517	my ($obj) = @_;	700	my ($obj) = @_;
		701
518	my $registry = $obj->registry;	702	my $registry = $obj->registry;
519		703
520	@$registry = ();	704	@$registry = ();
521		705
522	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	706	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
523		707
524	for my $name (keys %{ $obj->{_attachment} || {} }) {	708	for my $name (keys %{ $obj->{_attachment} || {} }) {
525	if (my $attach = $attachment{$name}) {	709	if (my $attach = $attachment{$name}) {
526	for (@$attach) {	710	for (@$attach) {
527	my ($klass, @attach) = @$_;	711	my ($klass, @attach) = @$_;
528	_attach @$registry, $klass, @attach;	712	_attach $registry, $klass, @attach;
529	}	713	}
530	} else {	714	} else {
531	warn "object uses attachment '$name' that is not available, postponing.\n";	715	warn "object uses attachment '$name' that is not available, postponing.\n";
532	}	716	}
533	}	717	}
534	}	718	}
535		719
536	sub object_freezer_save {	720	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,	721	prio => -1000000,
		722	on_instantiate => sub {
		723	my ($obj, $data) = @_;
		724
		725	$data = from_json $data;
		726
		727	for (@$data) {
		728	my ($name, $args) = @$_;
		729
		730	$obj->attach ($name, %{$args || {} });
		731	}
		732	},
		733	on_reattach => \&reattach,
596	on_clone => sub {	734	on_clone => sub {
597	my ($src, $dst) = @_;	735	my ($src, $dst) = @_;
598		736
599	@{$dst->registry} = @{$src->registry};	737	@{$dst->registry} = @{$src->registry};
600		738
601	%$dst = %$src;	739	%$dst = %$src;
602		740
603	%{$dst->{_attachment}} = %{$src->{_attachment}}	741	%{$dst->{_attachment}} = %{$src->{_attachment}}
604	if exists $src->{_attachment};	742	if exists $src->{_attachment};
605	},	743	},
606	;	744	);
		745
		746	sub object_freezer_save {
		747	my ($filename, $rdata, $objs) = @_;
		748
		749	sync_job {
		750	if (length $$rdata) {
		751	warn sprintf "saving %s (%d,%d)\n",
		752	$filename, length $$rdata, scalar @$objs;
		753
		754	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		755	chmod SAVE_MODE, $fh;
		756	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		757	aio_fsync $fh;
		758	close $fh;
		759
		760	if (@$objs) {
		761	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		762	chmod SAVE_MODE, $fh;
		763	my $data = Storable::nfreeze { version => 1, objs => $objs };
		764	aio_write $fh, 0, (length $data), $data, 0;
		765	aio_fsync $fh;
		766	close $fh;
		767	aio_rename "$filename.pst~", "$filename.pst";
		768	}
		769	} else {
		770	aio_unlink "$filename.pst";
		771	}
		772
		773	aio_rename "$filename~", $filename;
		774	} else {
		775	warn "FATAL: $filename~: $!\n";
		776	}
		777	} else {
		778	aio_unlink $filename;
		779	aio_unlink "$filename.pst";
		780	}
		781	}
		782	}
		783
		784	sub object_freezer_as_string {
		785	my ($rdata, $objs) = @_;
		786
		787	use Data::Dumper;
		788
		789	$$rdata . Dumper $objs
		790	}
		791
		792	sub object_thawer_load {
		793	my ($filename) = @_;
		794
		795	my ($data, $av);
		796
		797	(aio_load $filename, $data) >= 0
		798	or return;
		799
		800	unless (aio_stat "$filename.pst") {
		801	(aio_load "$filename.pst", $av) >= 0
		802	or return;
		803	$av = eval { (Storable::thaw <$av>)->{objs} };
		804	}
		805
		806	return ($data, $av);
		807	}
607		808
608	#############################################################################	809	#############################################################################
609	# command handling &c	810	# command handling &c
610		811
611	=item cf::register_command $name => \&callback($ob,$args);	812	=item cf::register_command $name => \&callback($ob,$args);
…		…
640	#warn "registering extcmd '$name' to '$caller'";	841	#warn "registering extcmd '$name' to '$caller'";
641		842
642	$EXTCMD{$name} = [$cb, $caller];	843	$EXTCMD{$name} = [$cb, $caller];
643	}	844	}
644		845
645	attach_to_players	846	cf::player->attach (
646	on_command => sub {	847	on_command => sub {
647	my ($pl, $name, $params) = @_;	848	my ($pl, $name, $params) = @_;
648		849
649	my $cb = $COMMAND{$name}	850	my $cb = $COMMAND{$name}
650	or return;	851	or return;
…		…
670	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	871	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
671	}	872	}
672		873
673	cf::override;	874	cf::override;
674	},	875	},
675	;	876	);
676		877
677	sub register {	878	sub register {
678	my ($base, $pkg) = @_;	879	my ($base, $pkg) = @_;
679		880
680	#TODO	881	#TODO
…		…
770	defined $path or return;	971	defined $path or return;
771		972
772	unlink "$path.pst";	973	unlink "$path.pst";
773	};	974	};
774		975
775	attach_to_maps prio => -10000, package => cf::mapsupport::;	976	cf::map->attach (prio => -10000, package => cf::mapsupport::);
776		977
777	#############################################################################	978	#############################################################################
778	# load/save perl data associated with player->ob objects	979	# load/save perl data associated with player->ob objects
779		980
780	sub all_objects(@) {	981	sub all_objects(@) {
781	@_, map all_objects ($_->inv), @_	982	@_, map all_objects ($_->inv), @_
782	}	983	}
783		984
784	# TODO: compatibility cruft, remove when no longer needed	985	# TODO: compatibility cruft, remove when no longer needed
785	attach_to_players	986	cf::player->attach (
786	on_load => sub {	987	on_load => sub {
787	my ($pl, $path) = @_;	988	my ($pl, $path) = @_;
788		989
789	for my $o (all_objects $pl->ob) {	990	for my $o (all_objects $pl->ob) {
790	if (my $value = $o->get_ob_key_value ("_perl_data")) {	991	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
792		993
793	%$o = %{ Storable::thaw pack "H*", $value };	994	%$o = %{ Storable::thaw pack "H*", $value };
794	}	995	}
795	}	996	}
796	},	997	},
797	;	998	);
798		999
799	#############################################################################	1000	#############################################################################
800		1001
801	=head2 CORE EXTENSIONS	1002	=head2 CORE EXTENSIONS
802		1003
803	Functions and methods that extend core crossfire objects.	1004	Functions and methods that extend core crossfire objects.
		1005
		1006	=head3 cf::player
804		1007
805	=over 4	1008	=over 4
806		1009
807	=item cf::player::exists $login	1010	=item cf::player::exists $login
808		1011
…		…
813	sub cf::player::exists($) {	1016	sub cf::player::exists($) {
814	cf::player::find $_[0]	1017	cf::player::find $_[0]
815	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1018	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
816	}	1019	}
817		1020
		1021	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1022
		1023	Sends an ext reply to the player.
		1024
		1025	=cut
		1026
		1027	sub cf::player::ext_reply($$$%) {
		1028	my ($self, $id, %msg) = @_;
		1029
		1030	$msg{msgid} = $id;
		1031
		1032	$self->send ("ext " . to_json \%msg);
		1033	}
		1034
		1035	=back
		1036
		1037
		1038	=head3 cf::map
		1039
		1040	=over 4
		1041
		1042	=cut
		1043
		1044	package cf::map;
		1045
		1046	use Fcntl;
		1047	use Coro::AIO;
		1048
		1049	our $MAX_RESET = 7200;
		1050	our $DEFAULT_RESET = 3600;
		1051	$MAX_RESET = 10;#d#
		1052	$DEFAULT_RESET = 10;#d#
		1053
		1054	sub generate_random_map {
		1055	my ($path, $rmp) = @_;
		1056
		1057	# mit "rum" bekleckern, nicht
		1058	cf::map::_create_random_map
		1059	$path,
		1060	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1061	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1062	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1063	$rmp->{exit_on_final_map},
		1064	$rmp->{xsize}, $rmp->{ysize},
		1065	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1066	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1067	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1068	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1069	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1070	(cf::region::find $rmp->{region})
		1071	}
		1072
		1073	# and all this just because we cannot iterate over
		1074	# all maps in C++...
		1075	sub change_all_map_light {
		1076	my ($change) = @_;
		1077
		1078	$_->change_map_light ($change) for values %cf::MAP;
		1079	}
		1080
		1081	sub try_load_header($) {
		1082	my ($path) = @_;
		1083
		1084	utf8::encode $path;
		1085	aio_open $path, O_RDONLY, 0
		1086	or return;
		1087
		1088	my $map = cf::map::new
		1089	or return;
		1090
		1091	$map->load_header ($path)
		1092	or return;
		1093
		1094	$map->{load_path} = $path;
		1095	use Data::Dumper; warn Dumper $map;#d#
		1096
		1097	$map
		1098	}
		1099
		1100	sub find_map {
		1101	my ($path, $origin) = @_;
		1102
		1103	#warn "find_map<$path,$origin>\n";#d#
		1104
		1105	$path = ref $path ? $path : new cf::path $path, $origin && $origin->path;
		1106	my $key = $path->as_string;
		1107
		1108	$cf::MAP{$key} || do {
		1109	# do it the slow way
		1110	my $map = try_load_header $path->save_path;
		1111
		1112	if ($map) {
		1113	# safety
		1114	$map->{instantiate_time} = $cf::RUNTIME
		1115	if $map->{instantiate_time} > $cf::RUNTIME;
		1116	} else {
		1117	if (my $rmp = $path->random_map_params) {
		1118	$map = generate_random_map $key, $rmp;
		1119	} else {
		1120	$map = try_load_header $path->load_path;
		1121	}
		1122
		1123	$map or return;
		1124
		1125	$map->{load_original} = 1;
		1126	$map->{instantiate_time} = $cf::RUNTIME;
		1127	$map->instantiate;
		1128
		1129	# per-player maps become, after loading, normal maps
		1130	$map->per_player (0) if $path->{user_rel};
		1131	}
		1132
		1133	$map->path ($key);
		1134	$map->{path} = $path;
		1135	$map->last_access ($cf::RUNTIME);
		1136
		1137	$map->reset if $map->should_reset;
		1138
		1139	$cf::MAP{$key} = $map
		1140	}
		1141	}
		1142
		1143	sub load {
		1144	my ($self) = @_;
		1145
		1146	return if $self->in_memory != cf::MAP_SWAPPED;
		1147
		1148	$self->in_memory (cf::MAP_LOADING);
		1149
		1150	my $path = $self->{path};
		1151
		1152	$self->alloc;
		1153	$self->load_objects ($self->{load_path}, 1)
		1154	or return;
		1155
		1156	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) if delete $self->{load_original};
		1157
		1158	if (my $uniq = $path->uniq_path) {
		1159	utf8::encode $uniq;
		1160	if (aio_open $uniq, O_RDONLY, 0) {
		1161	$self->clear_unique_items;
		1162	$self->load_objects ($uniq, 0);
		1163	}
		1164	}
		1165
		1166	# now do the right thing for maps
		1167	$self->link_multipart_objects;
		1168
		1169	if ($self->{path}->is_style_map) {
		1170	$self->{deny_save} = 1;
		1171	$self->{deny_reset} = 1;
		1172	} else {
		1173	$self->fix_auto_apply;
		1174	$self->decay_objects;
		1175	$self->update_buttons;
		1176	$self->set_darkness_map;
		1177	$self->difficulty ($self->estimate_difficulty)
		1178	unless $self->difficulty;
		1179	$self->activate;
		1180	}
		1181
		1182	$self->in_memory (cf::MAP_IN_MEMORY);
		1183	}
		1184
		1185	sub load_map_sync {
		1186	my ($path, $origin) = @_;
		1187
		1188	#warn "load_map_sync<$path, $origin>\n";#d#
		1189
		1190	cf::sync_job {
		1191	my $map = cf::map::find_map $path, $origin
		1192	or return;
		1193	$map->load;
		1194	$map
		1195	}
		1196	}
		1197
		1198	sub save {
		1199	my ($self) = @_;
		1200
		1201	my $save = $self->{path}->save_path; utf8::encode $save;
		1202	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1203
		1204	$self->{last_save} = $cf::RUNTIME;
		1205
		1206	return unless $self->dirty;
		1207
		1208	$self->{load_path} = $save;
		1209
		1210	return if $self->{deny_save};
		1211
		1212	warn "saving map ", $self->path;
		1213
		1214	if ($uniq) {
		1215	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1216	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1217	} else {
		1218	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1219	}
		1220	}
		1221
		1222	sub swap_out {
		1223	my ($self) = @_;
		1224
		1225	return if $self->players;
		1226	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1227	return if $self->{deny_save};
		1228
		1229	$self->save;
		1230	$self->clear;
		1231	$self->in_memory (cf::MAP_SWAPPED);
		1232	}
		1233
		1234	sub should_reset {
		1235	my ($map) = @_;
		1236
		1237	# TODO: safety, remove and allow resettable per-player maps
		1238	return if $map->{path}{user_rel};#d#
		1239	return if $map->{deny_reset};
		1240	#return unless $map->reset_timeout;
		1241
		1242	my $time = $map->fixed_resettime ? $map->{instantiate_time} : $map->last_access;
		1243	my $to = $map->reset_timeout || $DEFAULT_RESET;
		1244	$to = $MAX_RESET if $to > $MAX_RESET;
		1245
		1246	$time + $to < $cf::RUNTIME
		1247	}
		1248
		1249	sub unlink_save {
		1250	my ($self) = @_;
		1251
		1252	utf8::encode (my $save = $self->{path}->save_path);
		1253	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1254	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1255	}
		1256
		1257	sub reset {
		1258	my ($self) = @_;
		1259
		1260	return if $self->players;
		1261	return if $self->{path}{user_rel};#d#
		1262
		1263	warn "resetting map ", $self->path;#d#
		1264
		1265	delete $cf::MAP{$self->path};
		1266
		1267	$_->clear_links_to ($self) for values %cf::MAP;
		1268
		1269	$self->unlink_save;
		1270	$self->destroy;
		1271	}
		1272
		1273	sub customise_for {
		1274	my ($map, $ob) = @_;
		1275
		1276	if ($map->per_player) {
		1277	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
		1278	}
		1279
		1280	$map
		1281	}
		1282
		1283	sub emergency_save {
		1284	local $cf::FREEZE = 1;
		1285
		1286	warn "enter emergency map save\n";
		1287
		1288	cf::sync_job {
		1289	warn "begin emergency map save\n";
		1290	$_->save for values %cf::MAP;
		1291	};
		1292
		1293	warn "end emergency map save\n";
		1294	}
		1295
		1296	package cf;
		1297
		1298	=back
		1299
		1300
		1301	=head3 cf::object::player
		1302
		1303	=over 4
		1304
818	=item $player_object->reply ($npc, $msg[, $flags])	1305	=item $player_object->reply ($npc, $msg[, $flags])
819		1306
820	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1307	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	1308	can be C<undef>. Does the right thing when the player is currently in a
822	dialogue with the given NPC character.	1309	dialogue with the given NPC character.
823		1310
824	=cut	1311	=cut
825		1312
826	# rough implementation of a future "reply" method that works	1313	# rough implementation of a future "reply" method that works
827	# with dialog boxes.	1314	# with dialog boxes.
		1315	#TODO: the first argument must go, split into a $npc->reply_to ( method
828	sub cf::object::player::reply($$$;$) {	1316	sub cf::object::player::reply($$$;$) {
829	my ($self, $npc, $msg, $flags) = @_;	1317	my ($self, $npc, $msg, $flags) = @_;
830		1318
831	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1319	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
832		1320
…		…
836	$msg = $npc->name . " says: $msg" if $npc;	1324	$msg = $npc->name . " says: $msg" if $npc;
837	$self->message ($msg, $flags);	1325	$self->message ($msg, $flags);
838	}	1326	}
839	}	1327	}
840		1328
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")	1329	=item $player_object->may ("access")
856		1330
857	Returns wether the given player is authorized to access resource "access"	1331	Returns wether the given player is authorized to access resource "access"
858	(e.g. "command_wizcast").	1332	(e.g. "command_wizcast").
859		1333
…		…
866	(ref $cf::CFG{"may_$access"}	1340	(ref $cf::CFG{"may_$access"}
867	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1341	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
868	: $cf::CFG{"may_$access"})	1342	: $cf::CFG{"may_$access"})
869	}	1343	}
870		1344
871	=cut	1345	sub cf::object::player::enter_link {
		1346	my ($self) = @_;
872		1347
873	#############################################################################	1348	return if $self->map == $LINK_MAP;
		1349
		1350	$self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
		1351	if $self->map;
		1352
		1353	$self->enter_map ($LINK_MAP, 20, 20);
		1354	$self->deactivate_recursive;
		1355	}
		1356
		1357	sub cf::object::player::leave_link {
		1358	my ($self, $map, $x, $y) = @_;
		1359
		1360	my $link_pos = delete $self->{_link_pos};
		1361
		1362	unless ($map) {
		1363	$self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1364
		1365	# restore original map position
		1366	($map, $x, $y) = @{ $link_pos || [] };
		1367	$map = cf::map::find_map $map;
		1368
		1369	unless ($map) {
		1370	($map, $x, $y) = @$EMERGENCY_POSITION;
		1371	$map = cf::map::find_map $map
		1372	or die "FATAL: cannot load emergency map\n";
		1373	}
		1374	}
		1375
		1376	($x, $y) = (-1, -1)
		1377	unless (defined $x) && (defined $y);
		1378
		1379	# use -1 or undef as default coordinates, not 0, 0
		1380	($x, $y) = ($map->enter_x, $map->enter_y)
		1381	if $x <=0 && $y <= 0;
		1382
		1383	$map->load;
		1384
		1385	$self->activate_recursive;
		1386	$self->enter_map ($map, $x, $y);
		1387	}
		1388
		1389	=item $player_object->goto_map ($map, $x, $y)
		1390
		1391	=cut
		1392
		1393	sub cf::object::player::goto_map {
		1394	my ($self, $path, $x, $y) = @_;
		1395
		1396	$self->enter_link;
		1397
		1398	(Coro::async {
		1399	$path = new cf::path $path;
		1400
		1401	my $map = cf::map::find_map $path->as_string;
		1402	$map = $map->customise_for ($self) if $map;
		1403
		1404	warn "entering ", $map->path, " at ($x, $y)\n"
		1405	if $map;
		1406
		1407	$self->leave_link ($map, $x, $y);
		1408	})->prio (1);
		1409	}
		1410
		1411	=item $player_object->enter_exit ($exit_object)
		1412
		1413	=cut
		1414
		1415	sub parse_random_map_params {
		1416	my ($spec) = @_;
		1417
		1418	my $rmp = { # defaults
		1419	xsize => 10,
		1420	ysize => 10,
		1421	};
		1422
		1423	for (split /\n/, $spec) {
		1424	my ($k, $v) = split /\s+/, $_, 2;
		1425
		1426	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1427	}
		1428
		1429	$rmp
		1430	}
		1431
		1432	sub prepare_random_map {
		1433	my ($exit) = @_;
		1434
		1435	# all this does is basically replace the /! path by
		1436	# a new random map path (?random/...) with a seed
		1437	# that depends on the exit object
		1438
		1439	my $rmp = parse_random_map_params $exit->msg;
		1440
		1441	if ($exit->map) {
		1442	$rmp->{region} = $exit->map->region_name;
		1443	$rmp->{origin_map} = $exit->map->path;
		1444	$rmp->{origin_x} = $exit->x;
		1445	$rmp->{origin_y} = $exit->y;
		1446	}
		1447
		1448	$rmp->{random_seed} ||= $exit->random_seed;
		1449
		1450	my $data = cf::to_json $rmp;
		1451	my $md5 = Digest::MD5::md5_hex $data;
		1452
		1453	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1454	aio_write $fh, 0, (length $data), $data, 0;
		1455
		1456	$exit->slaying ("?random/$md5");
		1457	$exit->msg (undef);
		1458	}
		1459	}
		1460
		1461	sub cf::object::player::enter_exit {
		1462	my ($self, $exit) = @_;
		1463
		1464	return unless $self->type == cf::PLAYER;
		1465
		1466	$self->enter_link;
		1467
		1468	(Coro::async {
		1469	unless (eval {
		1470
		1471	prepare_random_map $exit
		1472	if $exit->slaying eq "/!";
		1473
		1474	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1475	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1476
		1477	1;
		1478	}) {
		1479	$self->message ("Something went wrong deep within the crossfire server. "
		1480	. "I'll try to bring you back to the map you were before. "
		1481	. "Please report this to the dungeon master",
		1482	cf::NDI_UNIQUE | cf::NDI_RED);
		1483
		1484	warn "ERROR in enter_exit: $@";
		1485	$self->leave_link;
		1486	}
		1487	})->prio (1);
		1488	}
		1489
		1490	=head3 cf::client
		1491
		1492	=over 4
		1493
		1494	=item $client->send_drawinfo ($text, $flags)
		1495
		1496	Sends a drawinfo packet to the client. Circumvents output buffering so
		1497	should not be used under normal circumstances.
		1498
		1499	=cut
		1500
		1501	sub cf::client::send_drawinfo {
		1502	my ($self, $text, $flags) = @_;
		1503
		1504	utf8::encode $text;
		1505	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1506	}
		1507
		1508
		1509	=item $success = $client->query ($flags, "text", \&cb)
		1510
		1511	Queues a query to the client, calling the given callback with
		1512	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1513	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1514
		1515	Queries can fail, so check the return code. Or don't, as queries will become
		1516	reliable at some point in the future.
		1517
		1518	=cut
		1519
		1520	sub cf::client::query {
		1521	my ($self, $flags, $text, $cb) = @_;
		1522
		1523	return unless $self->state == ST_PLAYING
		1524	|| $self->state == ST_SETUP
		1525	|| $self->state == ST_CUSTOM;
		1526
		1527	$self->state (ST_CUSTOM);
		1528
		1529	utf8::encode $text;
		1530	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1531
		1532	$self->send_packet ($self->{query_queue}[0][0])
		1533	if @{ $self->{query_queue} } == 1;
		1534	}
		1535
		1536	cf::client->attach (
		1537	on_reply => sub {
		1538	my ($ns, $msg) = @_;
		1539
		1540	# this weird shuffling is so that direct followup queries
		1541	# get handled first
		1542	my $queue = delete $ns->{query_queue};
		1543
		1544	(shift @$queue)->[1]->($msg);
		1545
		1546	push @{ $ns->{query_queue} }, @$queue;
		1547
		1548	if (@{ $ns->{query_queue} } == @$queue) {
		1549	if (@$queue) {
		1550	$ns->send_packet ($ns->{query_queue}[0][0]);
		1551	} else {
		1552	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1553	}
		1554	}
		1555	},
		1556	);
		1557
		1558	=item $client->coro (\&cb)
		1559
		1560	Create a new coroutine, running the specified callback. The coroutine will
		1561	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1562	or loss of connection).
		1563
		1564	=cut
		1565
		1566	sub cf::client::coro {
		1567	my ($self, $cb) = @_;
		1568
		1569	my $coro; $coro = async {
		1570	eval {
		1571	$cb->();
		1572	};
		1573	warn $@ if $@;
		1574	};
		1575
		1576	$coro->on_destroy (sub {
		1577	delete $self->{_coro}{$coro+0};
		1578	});
		1579
		1580	$self->{_coro}{$coro+0} = $coro;
		1581
		1582	$coro
		1583	}
		1584
		1585	cf::client->attach (
		1586	on_destroy => sub {
		1587	my ($ns) = @_;
		1588
		1589	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1590	},
		1591	);
		1592
		1593	=back
		1594
874		1595
875	=head2 SAFE SCRIPTING	1596	=head2 SAFE SCRIPTING
876		1597
877	Functions that provide a safe environment to compile and execute	1598	Functions that provide a safe environment to compile and execute
878	snippets of perl code without them endangering the safety of the server	1599	snippets of perl code without them endangering the safety of the server
…		…
1078	$DB->{$_[0]} = $_[1];	1799	$DB->{$_[0]} = $_[1];
1079	}	1800	}
1080	db_dirty;	1801	db_dirty;
1081	}	1802	}
1082		1803
1083	attach_global	1804	cf::global->attach (
1084	prio => 10000,	1805	prio => 10000,
1085	on_cleanup => sub {	1806	on_cleanup => sub {
1086	db_sync;	1807	db_sync;
1087	},	1808	},
1088	;	1809	);
1089	}	1810	}
1090		1811
1091	#############################################################################	1812	#############################################################################
1092	# the server's main()	1813	# the server's main()
1093		1814
…		…
1098	local $/;	1819	local $/;
1099	*CFG = YAML::Syck::Load <$fh>;	1820	*CFG = YAML::Syck::Load <$fh>;
1100	}	1821	}
1101		1822
1102	sub main {	1823	sub main {
		1824	# we must not ever block the main coroutine
		1825	local $Coro::idle = sub {
		1826	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1827	(Coro::unblock_sub {
		1828	Event::one_event;
		1829	})->();
		1830	};
		1831
1103	cfg_load;	1832	cfg_load;
1104	db_load;	1833	db_load;
1105	load_extensions;	1834	load_extensions;
1106	Event::loop;	1835	Event::loop;
1107	}	1836	}
1108		1837
1109	#############################################################################	1838	#############################################################################
1110	# initialisation	1839	# initialisation
1111		1840
1112	sub _perl_reload(&) {	1841	sub reload() {
1113	my ($msg) = @_;	1842	# can/must only be called in main
		1843	if ($Coro::current != $Coro::main) {
		1844	warn "can only reload from main coroutine\n";
		1845	return;
		1846	}
1114		1847
1115	$msg->("reloading...");	1848	warn "reloading...";
		1849
		1850	local $FREEZE = 1;
		1851	cf::emergency_save;
1116		1852
1117	eval {	1853	eval {
		1854	# if anything goes wrong in here, we should simply crash as we already saved
		1855
1118	# cancel all watchers	1856	# cancel all watchers
1119	for (Event::all_watchers) {	1857	for (Event::all_watchers) {
1120	$_->cancel if $_->data & WF_AUTOCANCEL;	1858	$_->cancel if $_->data & WF_AUTOCANCEL;
1121	}	1859	}
1122		1860
		1861	# cancel all extension coros
		1862	$_->cancel for values %EXT_CORO;
		1863	%EXT_CORO = ();
		1864
1123	# unload all extensions	1865	# unload all extensions
1124	for (@exts) {	1866	for (@exts) {
1125	$msg->("unloading <$_>");	1867	warn "unloading <$_>";
1126	unload_extension $_;	1868	unload_extension $_;
1127	}	1869	}
1128		1870
1129	# unload all modules loaded from $LIBDIR	1871	# unload all modules loaded from $LIBDIR
1130	while (my ($k, $v) = each %INC) {	1872	while (my ($k, $v) = each %INC) {
1131	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1873	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1132		1874
1133	$msg->("removing <$k>");	1875	warn "removing <$k>";
1134	delete $INC{$k};	1876	delete $INC{$k};
1135		1877
1136	$k =~ s/\.pm$//;	1878	$k =~ s/\.pm$//;
1137	$k =~ s/\//::/g;	1879	$k =~ s/\//::/g;
1138		1880
…		…
1143	Symbol::delete_package $k;	1885	Symbol::delete_package $k;
1144	}	1886	}
1145		1887
1146	# sync database to disk	1888	# sync database to disk
1147	cf::db_sync;	1889	cf::db_sync;
		1890	IO::AIO::flush;
1148		1891
1149	# get rid of safe::, as good as possible	1892	# get rid of safe::, as good as possible
1150	Symbol::delete_package "safe::$_"	1893	Symbol::delete_package "safe::$_"
1151	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1894	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1152		1895
1153	# remove register_script_function callbacks	1896	# remove register_script_function callbacks
1154	# TODO	1897	# TODO
1155		1898
1156	# unload cf.pm "a bit"	1899	# unload cf.pm "a bit"
…		…
1159	# don't, removes xs symbols, too,	1902	# don't, removes xs symbols, too,
1160	# and global variables created in xs	1903	# and global variables created in xs
1161	#Symbol::delete_package __PACKAGE__;	1904	#Symbol::delete_package __PACKAGE__;
1162		1905
1163	# reload cf.pm	1906	# reload cf.pm
1164	$msg->("reloading cf.pm");	1907	warn "reloading cf.pm";
1165	require cf;	1908	require cf;
		1909	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1166		1910
1167	# load config and database again	1911	# load config and database again
1168	cf::cfg_load;	1912	cf::cfg_load;
1169	cf::db_load;	1913	cf::db_load;
1170		1914
1171	# load extensions	1915	# load extensions
1172	$msg->("load extensions");	1916	warn "load extensions";
1173	cf::load_extensions;	1917	cf::load_extensions;
1174		1918
1175	# reattach attachments to objects	1919	# reattach attachments to objects
1176	$msg->("reattach");	1920	warn "reattach";
1177	_global_reattach;	1921	_global_reattach;
1178	};	1922	};
1179	$msg->($@) if $@;
1180		1923
1181	$msg->("reloaded");	1924	if ($@) {
		1925	warn $@;
		1926	warn "error while reloading, exiting.";
		1927	exit 1;
		1928	}
		1929
		1930	warn "reloaded successfully";
1182	};	1931	};
1183		1932
1184	sub perl_reload() {	1933	#############################################################################
1185	_perl_reload {	1934
1186	warn $_[0];	1935	unless ($LINK_MAP) {
1187	print "$_[0]\n";	1936	$LINK_MAP = cf::map::new;
1188	};	1937
		1938	$LINK_MAP->width (41);
		1939	$LINK_MAP->height (41);
		1940	$LINK_MAP->alloc;
		1941	$LINK_MAP->path ("{link}");
		1942	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		1943	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		1944
		1945	# dirty hack because... archetypes are not yet loaded
		1946	Event->timer (
		1947	after => 2,
		1948	cb => sub {
		1949	$_[0]->w->cancel;
		1950
		1951	# provide some exits "home"
		1952	my $exit = cf::object::new "exit";
		1953
		1954	$exit->slaying ($EMERGENCY_POSITION->[0]);
		1955	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		1956	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		1957
		1958	$LINK_MAP->insert ($exit->clone, 19, 19);
		1959	$LINK_MAP->insert ($exit->clone, 19, 20);
		1960	$LINK_MAP->insert ($exit->clone, 19, 21);
		1961	$LINK_MAP->insert ($exit->clone, 20, 19);
		1962	$LINK_MAP->insert ($exit->clone, 20, 21);
		1963	$LINK_MAP->insert ($exit->clone, 21, 19);
		1964	$LINK_MAP->insert ($exit->clone, 21, 20);
		1965	$LINK_MAP->insert ($exit->clone, 21, 21);
		1966
		1967	$exit->destroy;
		1968	});
		1969
		1970	$LINK_MAP->{deny_save} = 1;
		1971	$LINK_MAP->{deny_reset} = 1;
		1972
		1973	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1189	}	1974	}
1190		1975
1191	register "<global>", __PACKAGE__;	1976	register "<global>", __PACKAGE__;
1192		1977
1193	register_command "perl-reload" => sub {	1978	register_command "reload" => sub {
1194	my ($who, $arg) = @_;	1979	my ($who, $arg) = @_;
1195		1980
1196	if ($who->flag (FLAG_WIZ)) {	1981	if ($who->flag (FLAG_WIZ)) {
1197	_perl_reload {	1982	$who->message ("start of reload.");
1198	warn $_[0];	1983	reload;
1199	$who->message ($_[0]);	1984	$who->message ("end of reload.");
1200	};
1201	}	1985	}
1202	};	1986	};
1203		1987
1204	unshift @INC, $LIBDIR;	1988	unshift @INC, $LIBDIR;
1205		1989
1206	$TICK_WATCHER = Event->timer (	1990	$TICK_WATCHER = Event->timer (
		1991	reentrant => 0,
1207	prio => 0,	1992	prio => 0,
1208	at => $NEXT_TICK || 1,	1993	at => $NEXT_TICK || $TICK,
1209	data => WF_AUTOCANCEL,	1994	data => WF_AUTOCANCEL,
1210	cb => sub {	1995	cb => sub {
		1996	unless ($FREEZE) {
1211	cf::server_tick; # one server iteration	1997	cf::server_tick; # one server iteration
		1998	$RUNTIME += $TICK;
		1999	}
1212		2000
1213	my $NOW = Event::time;
1214	$NEXT_TICK += $TICK;	2001	$NEXT_TICK += $TICK;
1215		2002
1216	# if we are delayed by four ticks or more, skip them all	2003	# if we are delayed by four ticks or more, skip them all
1217	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2004	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1218		2005
1219	$TICK_WATCHER->at ($NEXT_TICK);	2006	$TICK_WATCHER->at ($NEXT_TICK);
1220	$TICK_WATCHER->start;	2007	$TICK_WATCHER->start;
1221	},	2008	},
1222	);	2009	);
1223		2010
1224	IO::AIO::max_poll_time $TICK * 0.2;	2011	IO::AIO::max_poll_time $TICK * 0.2;
1225		2012
		2013	Event->io (
1226	Event->io (fd => IO::AIO::poll_fileno,	2014	fd => IO::AIO::poll_fileno,
1227	poll => 'r',	2015	poll => 'r',
1228	prio => 5,	2016	prio => 5,
1229	data => WF_AUTOCANCEL,	2017	data => WF_AUTOCANCEL,
1230	cb => \&IO::AIO::poll_cb);	2018	cb => \&IO::AIO::poll_cb,
		2019	);
		2020
		2021	Event->timer (
		2022	data => WF_AUTOCANCEL,
		2023	after => 0,
		2024	interval => 10,
		2025	cb => sub {
		2026	(Coro::unblock_sub {
		2027	write_runtime
		2028	or warn "ERROR: unable to write runtime file: $!";
		2029	})->();
		2030	},
		2031	);
1231		2032
1232	1	2033	1
1233		2034

Diff Legend

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