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.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.127 by root, Wed Jan 3 00:05:26 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
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	128	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
…		…
84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85		134
86	# 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
87	# within the Safe compartment.	136	# within the Safe compartment.
88	for my $pkg (qw(	137	for my $pkg (qw(
89	cf::global	138	cf::global cf::attachable
90	cf::object cf::object::player	139	cf::object cf::object::player
91	cf::client cf::player	140	cf::client cf::player
92	cf::arch cf::living	141	cf::arch cf::living
93	cf::map cf::party cf::region	142	cf::map cf::party cf::region
94	)) {	143	)) {
…		…
132	sub to_json($) {	181	sub to_json($) {
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134	JSON::Syck::Dump $_[0]	183	JSON::Syck::Dump $_[0]
135	}	184	}
136		185
		186	=item my $guard = cf::guard { BLOCK }
		187
		188	Run the given callback when the guard object gets destroyed (useful for
		189	coroutine cancellations).
		190
		191	You can call C<< ->cancel >> on the guard object to stop the block from
		192	being executed.
		193
		194	=cut
		195
		196	sub guard(&) {
		197	bless \(my $cb = $_[0]), cf::guard::;
		198	}
		199
		200	sub cf::guard::cancel {
		201	${$_[0]} = sub { };
		202	}
		203
		204	sub cf::guard::DESTROY {
		205	${$_[0]}->();
		206	}
		207
		208	=item cf::lock_wait $string
		209
		210	Wait until the given lock is available. See cf::lock_acquire.
		211
		212	=item my $lock = cf::lock_acquire $string
		213
		214	Wait until the given lock is available and then acquires it and returns
		215	a guard object. If the guard object gets destroyed (goes out of scope,
		216	for example when the coroutine gets canceled), the lock is automatically
		217	returned.
		218
		219	Lock names should begin with a unique identifier (for example, find_map
		220	uses map_find and load_map uses map_load).
		221
		222	=cut
		223
		224	our %LOCK;
		225
		226	sub lock_wait($) {
		227	my ($key) = @_;
		228
		229	# wait for lock, if any
		230	while ($LOCK{$key}) {
		231	push @{ $LOCK{$key} }, $Coro::current;
		232	Coro::schedule;
		233	}
		234	}
		235
		236	sub lock_acquire($) {
		237	my ($key) = @_;
		238
		239	# wait, to be sure we are not locked
		240	lock_wait $key;
		241
		242	$LOCK{$key} = [];
		243
		244	cf::guard {
		245	# wake up all waiters, to be on the safe side
		246	$_->ready for @{ delete $LOCK{$key} };
		247	}
		248	}
		249
		250	=item cf::async { BLOCK }
		251
		252	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
		253	error instead of exiting the server in case of a problem.
		254
		255	=cut
		256
		257	sub async(&) {
		258	my ($cb) = @_;
		259
		260	Coro::async {
		261	eval { $cb->() };
		262	warn $@ if $@;
		263	}
		264	}
		265
		266	=item cf::sync_job { BLOCK }
		267
		268	The design of crossfire+ requires that the main coro ($Coro::main) is
		269	always able to handle events or runnable, as crossfire+ is only partly
		270	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		271
		272	If it must be done, put the blocking parts into C<sync_job>. This will run
		273	the given BLOCK in another coroutine while waiting for the result. The
		274	server will be frozen during this time, so the block should either finish
		275	fast or be very important.
		276
		277	=cut
		278
		279	sub sync_job(&) {
		280	my ($job) = @_;
		281
		282	if ($Coro::current == $Coro::main) {
		283	# this is the main coro, too bad, we have to block
		284	# till the operation succeeds, freezing the server :/
		285
		286	# TODO: use suspend/resume instead
		287	# (but this is cancel-safe)
		288	local $FREEZE = 1;
		289
		290	my $busy = 1;
		291	my @res;
		292
		293	(Coro::async {
		294	@res = eval { $job->() };
		295	warn $@ if $@;
		296	undef $busy;
		297	})->prio (Coro::PRIO_MAX);
		298
		299	while ($busy) {
		300	Coro::cede_notself;
		301	Event::one_event unless Coro::nready;
		302	}
		303
		304	wantarray ? @res : $res[0]
		305	} else {
		306	# we are in another coroutine, how wonderful, everything just works
		307
		308	$job->()
		309	}
		310	}
		311
		312	=item $coro = cf::coro { BLOCK }
		313
		314	Creates and returns a new coro. This coro is automcatially being canceled
		315	when the extension calling this is being unloaded.
		316
		317	=cut
		318
		319	sub coro(&) {
		320	my $cb = shift;
		321
		322	my $coro = &cf::async ($cb);
		323
		324	$coro->on_destroy (sub {
		325	delete $EXT_CORO{$coro+0};
		326	});
		327	$EXT_CORO{$coro+0} = $coro;
		328
		329	$coro
		330	}
		331
		332	sub write_runtime {
		333	my $runtime = cf::localdir . "/runtime";
		334
		335	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		336	or return;
		337
		338	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		339	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		340	and return;
		341
		342	aio_fsync $fh
		343	and return;
		344
		345	close $fh
		346	or return;
		347
		348	aio_rename "$runtime~", $runtime
		349	and return;
		350
		351	1
		352	}
		353
137	=back	354	=back
138		355
139	=cut	356	=cut
140		357
141	#############################################################################	358	#############################################################################
142		359
		360	package cf::path;
		361
		362	sub new {
		363	my ($class, $path, $base) = @_;
		364
		365	$path = $path->as_string if ref $path;
		366
		367	my $self = bless { }, $class;
		368
		369	# {... are special paths that are not touched
		370	# ?xxx/... are special absolute paths
		371	# ?random/... random maps
		372	# /! non-realised random map exit
		373	# /... normal maps
		374	# ~/... per-player maps without a specific player (DO NOT USE)
		375	# ~user/... per-player map of a specific user
		376
		377	if ($path =~ /^{/) {
		378	# fine as it is
		379	} elsif ($path =~ s{^\?random/}{}) {
		380	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		381	$self->{random} = cf::from_json $data;
		382	} else {
		383	if ($path =~ s{^~([^/]+)?}{}) {
		384	$self->{user_rel} = 1;
		385
		386	if (defined $1) {
		387	$self->{user} = $1;
		388	} elsif ($base =~ m{^~([^/]+)/}) {
		389	$self->{user} = $1;
		390	} else {
		391	warn "cannot resolve user-relative path without user <$path,$base>\n";
		392	}
		393	} elsif ($path =~ /^\//) {
		394	# already absolute
		395	} else {
		396	$base =~ s{[^/]+/?$}{};
		397	return $class->new ("$base/$path");
		398	}
		399
		400	for ($path) {
		401	redo if s{/\.?/}{/};
		402	redo if s{/[^/]+/\.\./}{/};
		403	}
		404	}
		405
		406	$self->{path} = $path;
		407
		408	$self
		409	}
		410
		411	# the name / primary key / in-game path
		412	sub as_string {
		413	my ($self) = @_;
		414
		415	$self->{user_rel} ? "~$self->{user}$self->{path}"
		416	: $self->{random} ? "?random/$self->{path}"
		417	: $self->{path}
		418	}
		419
		420	# the displayed name, this is a one way mapping
		421	sub visible_name {
		422	my ($self) = @_;
		423
		424	# if (my $rmp = $self->{random}) {
		425	# # todo: be more intelligent about this
		426	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		427	# } else {
		428	$self->as_string
		429	# }
		430	}
		431
		432	# escape the /'s in the path
		433	sub _escaped_path {
		434	# ∕ is U+2215
		435	(my $path = $_[0]{path}) =~ s/\//∕/g;
		436	$path
		437	}
		438
		439	# the original (read-only) location
		440	sub load_path {
		441	my ($self) = @_;
		442
		443	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		444	}
		445
		446	# the temporary/swap location
		447	sub save_path {
		448	my ($self) = @_;
		449
		450	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		451	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		452	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		453	}
		454
		455	# the unique path, might be eq to save_path
		456	sub uniq_path {
		457	my ($self) = @_;
		458
		459	$self->{user_rel} || $self->{random}
		460	? undef
		461	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		462	}
		463
		464	# return random map parameters, or undef
		465	sub random_map_params {
		466	my ($self) = @_;
		467
		468	$self->{random}
		469	}
		470
		471	# this is somewhat ugly, but style maps do need special treatment
		472	sub is_style_map {
		473	$_[0]{path} =~ m{^/styles/}
		474	}
		475
		476	package cf;
		477
		478	#############################################################################
		479
143	=head2 ATTACHABLE OBJECTS	480	=head2 ATTACHABLE OBJECTS
144		481
145	You can define and attach attachments to each "attachable" object in	482	Many objects in crossfire are so-called attachable objects. That means you can
146	crossfire+ (objects, players, clients, maps and the special "global"	483	attach callbacks/event handlers (a collection of which is called an "attachment")
		484	to it. All such attachable objects support the following methods.
		485
147	class). In the following description, CLASS can be any of C<global>,	486	In the following description, CLASS can be any of C<global>, C<object>
148	C<object> C<player>, C<client> or C<map>.	487	C<player>, C<client> or C<map> (i.e. the attachable objects in
		488	crossfire+).
149		489
150	=over 4	490	=over 4
151		491
		492	=item $attachable->attach ($attachment, key => $value...)
		493
		494	=item $attachable->detach ($attachment)
		495
		496	Attach/detach a pre-registered attachment to a specific object and give it
		497	the specified key/value pairs as arguments.
		498
		499	Example, attach a minesweeper attachment to the given object, making it a
		500	10x10 minesweeper game:
		501
		502	$obj->attach (minesweeper => width => 10, height => 10);
		503
		504	=item $bool = $attachable->attached ($name)
		505
		506	Checks wether the named attachment is currently attached to the object.
		507
		508	=item cf::CLASS->attach ...
		509
		510	=item cf::CLASS->detach ...
		511
		512	Define an anonymous attachment and attach it to all objects of the given
		513	CLASS. See the next function for an explanation of its arguments.
		514
		515	You can attach to global events by using the C<cf::global> class.
		516
		517	Example, log all player logins:
		518
		519	cf::player->attach (
		520	on_login => sub {
		521	my ($pl) = @_;
		522	...
		523	},
		524	);
		525
		526	Example, attach to the jeweler skill:
		527
		528	cf::object->attach (
		529	type => cf::SKILL,
		530	subtype => cf::SK_JEWELER,
		531	on_use_skill => sub {
		532	my ($sk, $ob, $part, $dir, $msg) = @_;
		533	...
		534	},
		535	);
		536
152	=item cf::CLASS::attachment $name, ...	537	=item cf::CLASS::attachment $name, ...
153		538
154	Register an attachment by name through which attachable objects can refer	539	Register an attachment by C<$name> through which attachable objects of the
155	to this attachment.	540	given CLASS can refer to this attachment.
156		541
157	=item $bool = $attachable->attached ($name)	542	Some classes such as crossfire maps and objects can specify attachments
		543	that are attached at load/instantiate time, thus the need for a name.
158		544
159	Checks wether the named attachment is currently attached to the object.
160
161	=item $attachable->attach ($attachment, key => $value...)
162
163	=item $attachable->detach ($attachment)
164
165	Attach/detach a pre-registered attachment either to a specific object
166	(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167	class in a static method call).
168
169	You can attach to global events by using the C<cf::global> class.
170
171	These method calls expect any number of the following handler/hook	545	These calls expect any number of the following handler/hook descriptions:
172	descriptions:
173		546
174	=over 4	547	=over 4
175		548
176	=item prio => $number	549	=item prio => $number
177		550
…		…
203	package and register them. Only handlers for eevents supported by the	576	package and register them. Only handlers for eevents supported by the
204	object/class are recognised.	577	object/class are recognised.
205		578
206	=back	579	=back
207		580
		581	Example, define an attachment called "sockpuppet" that calls the given
		582	event handler when a monster attacks:
		583
		584	cf::object::attachment sockpuppet =>
		585	on_skill_attack => sub {
		586	my ($self, $victim) = @_;
		587	...
		588	}
		589	}
		590
		591	=item $attachable->valid
		592
		593	Just because you have a perl object does not mean that the corresponding
		594	C-level object still exists. If you try to access an object that has no
		595	valid C counterpart anymore you get an exception at runtime. This method
		596	can be used to test for existence of the C object part without causing an
		597	exception.
		598
208	=cut	599	=cut
209		600
210	# the following variables are defined in .xs and must not be re-created	601	# the following variables are defined in .xs and must not be re-created
211	our @CB_GLOBAL = (); # registry for all global events	602	our @CB_GLOBAL = (); # registry for all global events
		603	our @CB_ATTACHABLE = (); # registry for all attachables
212	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	604	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213	our @CB_PLAYER = ();	605	our @CB_PLAYER = ();
214	our @CB_CLIENT = ();	606	our @CB_CLIENT = ();
215	our @CB_TYPE = (); # registry for type (cf-object class) based events	607	our @CB_TYPE = (); # registry for type (cf-object class) based events
216	our @CB_MAP = ();	608	our @CB_MAP = ();
217		609
218	my %attachment;	610	my %attachment;
219		611
220	sub _attach_cb($$$$) {	612	sub _attach_cb($$$$) {
221	my ($registry, $event, $prio, $cb) = @_;	613	my ($registry, $event, $prio, $cb) = @_;
…		…
226		618
227	@{$registry->[$event]} = sort	619	@{$registry->[$event]} = sort
228	{ $a->[0] cmp $b->[0] }	620	{ $a->[0] cmp $b->[0] }
229	@{$registry->[$event] || []}, $cb;	621	@{$registry->[$event] || []}, $cb;
230	}	622	}
		623
		624	# hack
		625	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231		626
232	# attach handles attaching event callbacks	627	# attach handles attaching event callbacks
233	# the only thing the caller has to do is pass the correct	628	# the only thing the caller has to do is pass the correct
234	# registry (== where the callback attaches to).	629	# registry (== where the callback attaches to).
235	sub _attach {	630	sub _attach {
…		…
237		632
238	my $object_type;	633	my $object_type;
239	my $prio = 0;	634	my $prio = 0;
240	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	635	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241		636
		637	#TODO: get rid of this hack
		638	if ($attachable_klass{$klass}) {
		639	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		640	}
		641
242	while (@arg) {	642	while (@arg) {
243	my $type = shift @arg;	643	my $type = shift @arg;
244		644
245	if ($type eq "prio") {	645	if ($type eq "prio") {
246	$prio = shift @arg;	646	$prio = shift @arg;
…		…
321	my ($obj, $name) = @_;	721	my ($obj, $name) = @_;
322		722
323	exists $obj->{_attachment}{$name}	723	exists $obj->{_attachment}{$name}
324	}	724	}
325		725
326	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	726	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327	eval "#line " . __LINE__ . " 'cf.pm'	727	eval "#line " . __LINE__ . " 'cf.pm'
328	sub cf::\L$klass\E::_attach_registry {	728	sub cf::\L$klass\E::_attach_registry {
329	(\\\@CB_$klass, KLASS_$klass)	729	(\\\@CB_$klass, KLASS_$klass)
330	}	730	}
331		731
…		…
367	}	767	}
368		768
369	0	769	0
370	}	770	}
371		771
372	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	772	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
373		773
374	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
375
376	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	774	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379		775
380	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382	Generate a global/object/player/map-specific event with the given arguments.	776	Generate an object-specific event with the given arguments.
383		777
384	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	778	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
385	removed in future versions), and there is no public API to access override	779	removed in future versions), and there is no public API to access override
386	results (if you must, access C<@cf::invoke_results> directly).	780	results (if you must, access C<@cf::invoke_results> directly).
387		781
388	=back	782	=back
389		783
390	=cut	784	=cut
391		785
392	#############################################################################	786	#############################################################################
393
394	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396	Attachable objects includes objects, players, clients and maps.
397
398	=over 4
399
400	=item $object->valid
401
402	Just because you have a perl object does not mean that the corresponding
403	C-level object still exists. If you try to access an object that has no
404	valid C counterpart anymore you get an exception at runtime. This method
405	can be used to test for existence of the C object part without causing an
406	exception.
407
408	=back
409
410	=cut
411
412	#############################################################################
413	# object support	787	# object support
414		788
415	sub instantiate {
416	my ($obj, $data) = @_;
417
418	$data = from_json $data;
419
420	for (@$data) {
421	my ($name, $args) = @$_;
422
423	$obj->attach ($name, %{$args || {} });
424	}
425	}
426
427	# basically do the same as instantiate, without calling instantiate
428	sub reattach {	789	sub reattach {
		790	# basically do the same as instantiate, without calling instantiate
429	my ($obj) = @_;	791	my ($obj) = @_;
		792
430	my $registry = $obj->registry;	793	my $registry = $obj->registry;
431		794
432	@$registry = ();	795	@$registry = ();
433		796
434	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	797	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
443	warn "object uses attachment '$name' that is not available, postponing.\n";	806	warn "object uses attachment '$name' that is not available, postponing.\n";
444	}	807	}
445	}	808	}
446	}	809	}
447		810
448	sub object_freezer_save {	811	cf::attachable->attach (
449	my ($filename, $rdata, $objs) = @_;
450
451	if (length $$rdata) {
452	warn sprintf "saving %s (%d,%d)\n",
453	$filename, length $$rdata, scalar @$objs;
454
455	if (open my $fh, ">:raw", "$filename~") {
456	chmod SAVE_MODE, $fh;
457	syswrite $fh, $$rdata;
458	close $fh;
459
460	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
461	chmod SAVE_MODE, $fh;
462	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
463	close $fh;
464	rename "$filename.pst~", "$filename.pst";
465	} else {
466	unlink "$filename.pst";
467	}
468
469	rename "$filename~", $filename;
470	} else {
471	warn "FATAL: $filename~: $!\n";
472	}
473	} else {
474	unlink $filename;
475	unlink "$filename.pst";
476	}
477	}
478
479	sub object_freezer_as_string {
480	my ($rdata, $objs) = @_;
481
482	use Data::Dumper;
483
484	$$rdata . Dumper $objs
485	}
486
487	sub object_thawer_load {
488	my ($filename) = @_;
489
490	local $/;
491
492	my $av;
493
494	#TODO: use sysread etc.
495	if (open my $data, "<:raw:perlio", $filename) {
496	$data = <$data>;
497	if (open my $pst, "<:raw:perlio", "$filename.pst") {
498	$av = eval { (Storable::thaw <$pst>)->{objs} };
499	}
500	return ($data, $av);
501	}
502
503	()
504	}
505
506	cf::object->attach (
507	prio => -1000000,	812	prio => -1000000,
		813	on_instantiate => sub {
		814	my ($obj, $data) = @_;
		815
		816	$data = from_json $data;
		817
		818	for (@$data) {
		819	my ($name, $args) = @$_;
		820
		821	$obj->attach ($name, %{$args || {} });
		822	}
		823	},
		824	on_reattach => \&reattach,
508	on_clone => sub {	825	on_clone => sub {
509	my ($src, $dst) = @_;	826	my ($src, $dst) = @_;
510		827
511	@{$dst->registry} = @{$src->registry};	828	@{$dst->registry} = @{$src->registry};
512		829
…		…
514		831
515	%{$dst->{_attachment}} = %{$src->{_attachment}}	832	%{$dst->{_attachment}} = %{$src->{_attachment}}
516	if exists $src->{_attachment};	833	if exists $src->{_attachment};
517	},	834	},
518	);	835	);
		836
		837	sub object_freezer_save {
		838	my ($filename, $rdata, $objs) = @_;
		839
		840	sync_job {
		841	if (length $$rdata) {
		842	warn sprintf "saving %s (%d,%d)\n",
		843	$filename, length $$rdata, scalar @$objs;
		844
		845	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		846	chmod SAVE_MODE, $fh;
		847	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		848	aio_fsync $fh;
		849	close $fh;
		850
		851	if (@$objs) {
		852	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		853	chmod SAVE_MODE, $fh;
		854	my $data = Storable::nfreeze { version => 1, objs => $objs };
		855	aio_write $fh, 0, (length $data), $data, 0;
		856	aio_fsync $fh;
		857	close $fh;
		858	aio_rename "$filename.pst~", "$filename.pst";
		859	}
		860	} else {
		861	aio_unlink "$filename.pst";
		862	}
		863
		864	aio_rename "$filename~", $filename;
		865	} else {
		866	warn "FATAL: $filename~: $!\n";
		867	}
		868	} else {
		869	aio_unlink $filename;
		870	aio_unlink "$filename.pst";
		871	}
		872	}
		873	}
		874
		875	sub object_freezer_as_string {
		876	my ($rdata, $objs) = @_;
		877
		878	use Data::Dumper;
		879
		880	$$rdata . Dumper $objs
		881	}
		882
		883	sub object_thawer_load {
		884	my ($filename) = @_;
		885
		886	my ($data, $av);
		887
		888	(aio_load $filename, $data) >= 0
		889	or return;
		890
		891	unless (aio_stat "$filename.pst") {
		892	(aio_load "$filename.pst", $av) >= 0
		893	or return;
		894	$av = eval { (Storable::thaw $av)->{objs} };
		895	}
		896
		897	warn sprintf "loading %s (%d)\n",
		898	$filename, length $data, scalar @{$av || []};#d#
		899	return ($data, $av);
		900	}
519		901
520	#############################################################################	902	#############################################################################
521	# command handling &c	903	# command handling &c
522		904
523	=item cf::register_command $name => \&callback($ob,$args);	905	=item cf::register_command $name => \&callback($ob,$args);
…		…
712		1094
713	=head2 CORE EXTENSIONS	1095	=head2 CORE EXTENSIONS
714		1096
715	Functions and methods that extend core crossfire objects.	1097	Functions and methods that extend core crossfire objects.
716		1098
		1099	=head3 cf::player
		1100
717	=over 4	1101	=over 4
718		1102
719	=item cf::player::exists $login	1103	=item cf::player::exists $login
720		1104
721	Returns true when the given account exists.	1105	Returns true when the given account exists.
…		…
725	sub cf::player::exists($) {	1109	sub cf::player::exists($) {
726	cf::player::find $_[0]	1110	cf::player::find $_[0]
727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1111	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
728	}	1112	}
729		1113
		1114	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1115
		1116	Sends an ext reply to the player.
		1117
		1118	=cut
		1119
		1120	sub cf::player::ext_reply($$$%) {
		1121	my ($self, $id, %msg) = @_;
		1122
		1123	$msg{msgid} = $id;
		1124
		1125	$self->send ("ext " . to_json \%msg);
		1126	}
		1127
		1128	=back
		1129
		1130
		1131	=head3 cf::map
		1132
		1133	=over 4
		1134
		1135	=cut
		1136
		1137	package cf::map;
		1138
		1139	use Fcntl;
		1140	use Coro::AIO;
		1141
		1142	our $MAX_RESET = 7200;
		1143	our $DEFAULT_RESET = 3600;
		1144
		1145	sub generate_random_map {
		1146	my ($path, $rmp) = @_;
		1147
		1148	# mit "rum" bekleckern, nicht
		1149	cf::map::_create_random_map
		1150	$path,
		1151	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1152	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1153	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1154	$rmp->{exit_on_final_map},
		1155	$rmp->{xsize}, $rmp->{ysize},
		1156	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1157	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1158	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1159	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1160	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1161	(cf::region::find $rmp->{region})
		1162	}
		1163
		1164	# and all this just because we cannot iterate over
		1165	# all maps in C++...
		1166	sub change_all_map_light {
		1167	my ($change) = @_;
		1168
		1169	$_->change_map_light ($change)
		1170	for grep $_->outdoor, values %cf::MAP;
		1171	}
		1172
		1173	sub try_load_header($) {
		1174	my ($path) = @_;
		1175
		1176	utf8::encode $path;
		1177	aio_open $path, O_RDONLY, 0
		1178	or return;
		1179
		1180	my $map = cf::map::new
		1181	or return;
		1182
		1183	$map->load_header ($path)
		1184	or return;
		1185
		1186	$map->{load_path} = $path;
		1187
		1188	$map
		1189	}
		1190
		1191	sub find_map;
		1192	sub find_map {
		1193	my ($path, $origin) = @_;
		1194
		1195	#warn "find_map<$path,$origin>\n";#d#
		1196
		1197	$path = new cf::path $path, $origin && $origin->path;
		1198	my $key = $path->as_string;
		1199
		1200	cf::lock_wait "map_find:$key";
		1201
		1202	$cf::MAP{$key} || do {
		1203	my $guard = cf::lock_acquire "map_find:$key";
		1204
		1205	# do it the slow way
		1206	my $map = try_load_header $path->save_path;
		1207
		1208	if ($map) {
		1209	# safety
		1210	$map->{instantiate_time} = $cf::RUNTIME
		1211	if $map->{instantiate_time} > $cf::RUNTIME;
		1212	} else {
		1213	if (my $rmp = $path->random_map_params) {
		1214	$map = generate_random_map $key, $rmp;
		1215	} else {
		1216	$map = try_load_header $path->load_path;
		1217	}
		1218
		1219	$map or return;
		1220
		1221	$map->{load_original} = 1;
		1222	$map->{instantiate_time} = $cf::RUNTIME;
		1223	$map->instantiate;
		1224
		1225	# per-player maps become, after loading, normal maps
		1226	$map->per_player (0) if $path->{user_rel};
		1227	}
		1228
		1229	$map->path ($key);
		1230	$map->{path} = $path;
		1231	$map->{last_save} = $cf::RUNTIME;
		1232	$map->last_access ($cf::RUNTIME);
		1233
		1234	if ($map->should_reset) {
		1235	$map->reset;
		1236	undef $guard;
		1237	$map = find_map $path
		1238	or return;
		1239	}
		1240
		1241	$cf::MAP{$key} = $map
		1242	}
		1243	}
		1244
		1245	sub load {
		1246	my ($self) = @_;
		1247
		1248	my $path = $self->{path};
		1249	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1250
		1251	return if $self->in_memory != cf::MAP_SWAPPED;
		1252
		1253	$self->in_memory (cf::MAP_LOADING);
		1254
		1255	$self->alloc;
		1256	$self->load_objects ($self->{load_path}, 1)
		1257	or return;
		1258
		1259	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1260	if delete $self->{load_original};
		1261
		1262	if (my $uniq = $path->uniq_path) {
		1263	utf8::encode $uniq;
		1264	if (aio_open $uniq, O_RDONLY, 0) {
		1265	$self->clear_unique_items;
		1266	$self->load_objects ($uniq, 0);
		1267	}
		1268	}
		1269
		1270	# now do the right thing for maps
		1271	$self->link_multipart_objects;
		1272
		1273	if ($self->{path}->is_style_map) {
		1274	$self->{deny_save} = 1;
		1275	$self->{deny_reset} = 1;
		1276	} else {
		1277	$self->fix_auto_apply;
		1278	$self->decay_objects;
		1279	$self->update_buttons;
		1280	$self->set_darkness_map;
		1281	$self->difficulty ($self->estimate_difficulty)
		1282	unless $self->difficulty;
		1283	$self->activate;
		1284	}
		1285
		1286	$self->in_memory (cf::MAP_IN_MEMORY);
		1287	}
		1288
		1289	sub load_map_sync {
		1290	my ($path, $origin) = @_;
		1291
		1292	#warn "load_map_sync<$path, $origin>\n";#d#
		1293
		1294	cf::sync_job {
		1295	my $map = cf::map::find_map $path, $origin
		1296	or return;
		1297	$map->load;
		1298	$map
		1299	}
		1300	}
		1301
		1302	sub save {
		1303	my ($self) = @_;
		1304
		1305	$self->{last_save} = $cf::RUNTIME;
		1306
		1307	return unless $self->dirty;
		1308
		1309	my $save = $self->{path}->save_path; utf8::encode $save;
		1310	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1311
		1312	$self->{load_path} = $save;
		1313
		1314	return if $self->{deny_save};
		1315
		1316	if ($uniq) {
		1317	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1318	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1319	} else {
		1320	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1321	}
		1322	}
		1323
		1324	sub swap_out {
		1325	my ($self) = @_;
		1326
		1327	return if $self->players;
		1328	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1329	return if $self->{deny_save};
		1330
		1331	$self->save;
		1332	$self->clear;
		1333	$self->in_memory (cf::MAP_SWAPPED);
		1334	}
		1335
		1336	sub reset_at {
		1337	my ($self) = @_;
		1338
		1339	# TODO: safety, remove and allow resettable per-player maps
		1340	return 1e99 if $self->{path}{user_rel};
		1341	return 1e99 if $self->{deny_reset};
		1342
		1343	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1344	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1345
		1346	$time + $to
		1347	}
		1348
		1349	sub should_reset {
		1350	my ($self) = @_;
		1351
		1352	$self->reset_at <= $cf::RUNTIME
		1353	}
		1354
		1355	sub unlink_save {
		1356	my ($self) = @_;
		1357
		1358	utf8::encode (my $save = $self->{path}->save_path);
		1359	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1360	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1361	}
		1362
		1363	sub rename {
		1364	my ($self, $new_path) = @_;
		1365
		1366	$self->unlink_save;
		1367
		1368	delete $cf::MAP{$self->path};
		1369	$self->{path} = new cf::path $new_path;
		1370	$self->path ($self->{path}->as_string);
		1371	$cf::MAP{$self->path} = $self;
		1372
		1373	$self->save;
		1374	}
		1375
		1376	sub reset {
		1377	my ($self) = @_;
		1378
		1379	return if $self->players;
		1380	return if $self->{path}{user_rel};#d#
		1381
		1382	warn "resetting map ", $self->path;#d#
		1383
		1384	delete $cf::MAP{$self->path};
		1385
		1386	$_->clear_links_to ($self) for values %cf::MAP;
		1387
		1388	$self->unlink_save;
		1389	$self->destroy;
		1390	}
		1391
		1392	my $nuke_counter = "aaaa";
		1393
		1394	sub nuke {
		1395	my ($self) = @_;
		1396
		1397	$self->{deny_save} = 1;
		1398	$self->reset_timeout (1);
		1399	$self->rename ("{nuke}/" . ($nuke_counter++));
		1400	$self->reset; # polite request, might not happen
		1401	}
		1402
		1403	sub customise_for {
		1404	my ($map, $ob) = @_;
		1405
		1406	if ($map->per_player) {
		1407	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
		1408	}
		1409
		1410	$map
		1411	}
		1412
		1413	sub emergency_save {
		1414	local $cf::FREEZE = 1;
		1415
		1416	warn "enter emergency map save\n";
		1417
		1418	cf::sync_job {
		1419	warn "begin emergency map save\n";
		1420	$_->save for values %cf::MAP;
		1421	};
		1422
		1423	warn "end emergency map save\n";
		1424	}
		1425
		1426	package cf;
		1427
		1428	=back
		1429
		1430
		1431	=head3 cf::object::player
		1432
		1433	=over 4
		1434
730	=item $player_object->reply ($npc, $msg[, $flags])	1435	=item $player_object->reply ($npc, $msg[, $flags])
731		1436
732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1437	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733	can be C<undef>. Does the right thing when the player is currently in a	1438	can be C<undef>. Does the right thing when the player is currently in a
734	dialogue with the given NPC character.	1439	dialogue with the given NPC character.
735		1440
736	=cut	1441	=cut
737		1442
738	# rough implementation of a future "reply" method that works	1443	# rough implementation of a future "reply" method that works
739	# with dialog boxes.	1444	# with dialog boxes.
		1445	#TODO: the first argument must go, split into a $npc->reply_to ( method
740	sub cf::object::player::reply($$$;$) {	1446	sub cf::object::player::reply($$$;$) {
741	my ($self, $npc, $msg, $flags) = @_;	1447	my ($self, $npc, $msg, $flags) = @_;
742		1448
743	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1449	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744		1450
…		…
748	$msg = $npc->name . " says: $msg" if $npc;	1454	$msg = $npc->name . " says: $msg" if $npc;
749	$self->message ($msg, $flags);	1455	$self->message ($msg, $flags);
750	}	1456	}
751	}	1457	}
752		1458
753	=item $player->ext_reply ($msgid, $msgtype, %msg)
754
755	Sends an ext reply to the player.
756
757	=cut
758
759	sub cf::player::ext_reply($$$%) {
760	my ($self, $id, %msg) = @_;
761
762	$msg{msgid} = $id;
763
764	$self->send ("ext " . to_json \%msg);
765	}
766
767	=item $player_object->may ("access")	1459	=item $player_object->may ("access")
768		1460
769	Returns wether the given player is authorized to access resource "access"	1461	Returns wether the given player is authorized to access resource "access"
770	(e.g. "command_wizcast").	1462	(e.g. "command_wizcast").
771		1463
…		…
778	(ref $cf::CFG{"may_$access"}	1470	(ref $cf::CFG{"may_$access"}
779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1471	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780	: $cf::CFG{"may_$access"})	1472	: $cf::CFG{"may_$access"})
781	}	1473	}
782		1474
783	=cut	1475	=item $player_object->enter_link
784		1476
785	#############################################################################	1477	Freezes the player and moves him/her to a special map (C<{link}>).
		1478
		1479	The player should be reaosnably safe there for short amounts of time. You
		1480	I<MUST> call C<leave_link> as soon as possible, though.
		1481
		1482	=item $player_object->leave_link ($map, $x, $y)
		1483
		1484	Moves the player out of the specila link map onto the given map. If the
		1485	map is not valid (or omitted), the player will be moved back to the
		1486	location he/she was before the call to C<enter_link>, or, if that fails,
		1487	to the emergency map position.
		1488
		1489	Might block.
		1490
		1491	=cut
		1492
		1493	sub cf::object::player::enter_link {
		1494	my ($self) = @_;
		1495
		1496	$self->deactivate_recursive;
		1497
		1498	return if $self->map == $LINK_MAP;
		1499
		1500	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1501	if $self->map;
		1502
		1503	$self->enter_map ($LINK_MAP, 20, 20);
		1504	}
		1505
		1506	sub cf::object::player::leave_link {
		1507	my ($self, $map, $x, $y) = @_;
		1508
		1509	my $link_pos = delete $self->{_link_pos};
		1510
		1511	unless ($map) {
		1512	# restore original map position
		1513	($map, $x, $y) = @{ $link_pos || [] };
		1514	$map = cf::map::find_map $map;
		1515
		1516	unless ($map) {
		1517	($map, $x, $y) = @$EMERGENCY_POSITION;
		1518	$map = cf::map::find_map $map
		1519	or die "FATAL: cannot load emergency map\n";
		1520	}
		1521	}
		1522
		1523	($x, $y) = (-1, -1)
		1524	unless (defined $x) && (defined $y);
		1525
		1526	# use -1 or undef as default coordinates, not 0, 0
		1527	($x, $y) = ($map->enter_x, $map->enter_y)
		1528	if $x <=0 && $y <= 0;
		1529
		1530	$map->load;
		1531
		1532	$self->activate_recursive;
		1533	$self->enter_map ($map, $x, $y);
		1534	}
		1535
		1536	cf::player->attach (
		1537	on_logout => sub {
		1538	my ($pl) = @_;
		1539
		1540	# abort map switching before logout
		1541	if ($pl->ob->{_link_pos}) {
		1542	cf::sync_job {
		1543	$pl->ob->leave_link
		1544	};
		1545	}
		1546	},
		1547	on_login => sub {
		1548	my ($pl) = @_;
		1549
		1550	# try to abort aborted map switching on player login :)
		1551	# should happen only on crashes
		1552	if ($pl->ob->{_link_pos}) {
		1553	$pl->ob->enter_link;
		1554	cf::async {
		1555	# we need this sleep as the login has a concurrent enter_exit running
		1556	# and this sleep increases chances of the player not ending up in scorn
		1557	Coro::Timer::sleep 1;
		1558	$pl->ob->leave_link;
		1559	};
		1560	}
		1561	},
		1562	);
		1563
		1564	=item $player_object->goto_map ($path, $x, $y)
		1565
		1566	=cut
		1567
		1568	sub cf::object::player::goto_map {
		1569	my ($self, $path, $x, $y) = @_;
		1570
		1571	$self->enter_link;
		1572
		1573	(cf::async {
		1574	$path = new cf::path $path;
		1575
		1576	my $map = cf::map::find_map $path->as_string;
		1577	$map = $map->customise_for ($self) if $map;
		1578
		1579	# warn "entering ", $map->path, " at ($x, $y)\n"
		1580	# if $map;
		1581
		1582	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1583
		1584	$self->leave_link ($map, $x, $y);
		1585	})->prio (1);
		1586	}
		1587
		1588	=item $player_object->enter_exit ($exit_object)
		1589
		1590	=cut
		1591
		1592	sub parse_random_map_params {
		1593	my ($spec) = @_;
		1594
		1595	my $rmp = { # defaults
		1596	xsize => 10,
		1597	ysize => 10,
		1598	};
		1599
		1600	for (split /\n/, $spec) {
		1601	my ($k, $v) = split /\s+/, $_, 2;
		1602
		1603	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1604	}
		1605
		1606	$rmp
		1607	}
		1608
		1609	sub prepare_random_map {
		1610	my ($exit) = @_;
		1611
		1612	# all this does is basically replace the /! path by
		1613	# a new random map path (?random/...) with a seed
		1614	# that depends on the exit object
		1615
		1616	my $rmp = parse_random_map_params $exit->msg;
		1617
		1618	if ($exit->map) {
		1619	$rmp->{region} = $exit->map->region_name;
		1620	$rmp->{origin_map} = $exit->map->path;
		1621	$rmp->{origin_x} = $exit->x;
		1622	$rmp->{origin_y} = $exit->y;
		1623	}
		1624
		1625	$rmp->{random_seed} ||= $exit->random_seed;
		1626
		1627	my $data = cf::to_json $rmp;
		1628	my $md5 = Digest::MD5::md5_hex $data;
		1629
		1630	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1631	aio_write $fh, 0, (length $data), $data, 0;
		1632
		1633	$exit->slaying ("?random/$md5");
		1634	$exit->msg (undef);
		1635	}
		1636	}
		1637
		1638	sub cf::object::player::enter_exit {
		1639	my ($self, $exit) = @_;
		1640
		1641	return unless $self->type == cf::PLAYER;
		1642
		1643	$self->enter_link;
		1644
		1645	(cf::async {
		1646	unless (eval {
		1647	prepare_random_map $exit
		1648	if $exit->slaying eq "/!";
		1649
		1650	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1651	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1652
		1653	1;
		1654	}) {
		1655	$self->message ("Something went wrong deep within the crossfire server. "
		1656	. "I'll try to bring you back to the map you were before. "
		1657	. "Please report this to the dungeon master",
		1658	cf::NDI_UNIQUE | cf::NDI_RED);
		1659
		1660	warn "ERROR in enter_exit: $@";
		1661	$self->leave_link;
		1662	}
		1663	})->prio (1);
		1664	}
		1665
		1666	=head3 cf::client
		1667
		1668	=over 4
		1669
		1670	=item $client->send_drawinfo ($text, $flags)
		1671
		1672	Sends a drawinfo packet to the client. Circumvents output buffering so
		1673	should not be used under normal circumstances.
		1674
		1675	=cut
		1676
		1677	sub cf::client::send_drawinfo {
		1678	my ($self, $text, $flags) = @_;
		1679
		1680	utf8::encode $text;
		1681	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1682	}
		1683
		1684
		1685	=item $success = $client->query ($flags, "text", \&cb)
		1686
		1687	Queues a query to the client, calling the given callback with
		1688	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1689	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1690
		1691	Queries can fail, so check the return code. Or don't, as queries will become
		1692	reliable at some point in the future.
		1693
		1694	=cut
		1695
		1696	sub cf::client::query {
		1697	my ($self, $flags, $text, $cb) = @_;
		1698
		1699	return unless $self->state == ST_PLAYING
		1700	|| $self->state == ST_SETUP
		1701	|| $self->state == ST_CUSTOM;
		1702
		1703	$self->state (ST_CUSTOM);
		1704
		1705	utf8::encode $text;
		1706	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1707
		1708	$self->send_packet ($self->{query_queue}[0][0])
		1709	if @{ $self->{query_queue} } == 1;
		1710	}
		1711
		1712	cf::client->attach (
		1713	on_reply => sub {
		1714	my ($ns, $msg) = @_;
		1715
		1716	# this weird shuffling is so that direct followup queries
		1717	# get handled first
		1718	my $queue = delete $ns->{query_queue};
		1719
		1720	(shift @$queue)->[1]->($msg);
		1721
		1722	push @{ $ns->{query_queue} }, @$queue;
		1723
		1724	if (@{ $ns->{query_queue} } == @$queue) {
		1725	if (@$queue) {
		1726	$ns->send_packet ($ns->{query_queue}[0][0]);
		1727	} else {
		1728	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1729	}
		1730	}
		1731	},
		1732	);
		1733
		1734	=item $client->coro (\&cb)
		1735
		1736	Create a new coroutine, running the specified callback. The coroutine will
		1737	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1738	or loss of connection).
		1739
		1740	=cut
		1741
		1742	sub cf::client::coro {
		1743	my ($self, $cb) = @_;
		1744
		1745	my $coro = &cf::async ($cb);
		1746
		1747	$coro->on_destroy (sub {
		1748	delete $self->{_coro}{$coro+0};
		1749	});
		1750
		1751	$self->{_coro}{$coro+0} = $coro;
		1752
		1753	$coro
		1754	}
		1755
		1756	cf::client->attach (
		1757	on_destroy => sub {
		1758	my ($ns) = @_;
		1759
		1760	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1761	},
		1762	);
		1763
		1764	=back
		1765
786		1766
787	=head2 SAFE SCRIPTING	1767	=head2 SAFE SCRIPTING
788		1768
789	Functions that provide a safe environment to compile and execute	1769	Functions that provide a safe environment to compile and execute
790	snippets of perl code without them endangering the safety of the server	1770	snippets of perl code without them endangering the safety of the server
…		…
942		1922
943	{	1923	{
944	my $path = cf::localdir . "/database.pst";	1924	my $path = cf::localdir . "/database.pst";
945		1925
946	sub db_load() {	1926	sub db_load() {
947	warn "loading database $path\n";#d# remove later
948	$DB = stat $path ? Storable::retrieve $path : { };	1927	$DB = stat $path ? Storable::retrieve $path : { };
949	}	1928	}
950		1929
951	my $pid;	1930	my $pid;
952		1931
953	sub db_save() {	1932	sub db_save() {
954	warn "saving database $path\n";#d# remove later
955	waitpid $pid, 0 if $pid;	1933	waitpid $pid, 0 if $pid;
956	if (0 == ($pid = fork)) {	1934	if (0 == ($pid = fork)) {
957	$DB->{_meta}{version} = 1;	1935	$DB->{_meta}{version} = 1;
958	Storable::nstore $DB, "$path~";	1936	Storable::nstore $DB, "$path~";
959	rename "$path~", $path;	1937	rename "$path~", $path;
…		…
1010	local $/;	1988	local $/;
1011	*CFG = YAML::Syck::Load <$fh>;	1989	*CFG = YAML::Syck::Load <$fh>;
1012	}	1990	}
1013		1991
1014	sub main {	1992	sub main {
		1993	# we must not ever block the main coroutine
		1994	local $Coro::idle = sub {
		1995	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		1996	(Coro::unblock_sub {
		1997	Event::one_event;
		1998	})->();
		1999	};
		2000
1015	cfg_load;	2001	cfg_load;
1016	db_load;	2002	db_load;
1017	load_extensions;	2003	load_extensions;
1018	Event::loop;	2004	Event::loop;
1019	}	2005	}
1020		2006
1021	#############################################################################	2007	#############################################################################
1022	# initialisation	2008	# initialisation
1023		2009
1024	sub _perl_reload(&) {	2010	sub reload() {
1025	my ($msg) = @_;	2011	# can/must only be called in main
		2012	if ($Coro::current != $Coro::main) {
		2013	warn "can only reload from main coroutine\n";
		2014	return;
		2015	}
1026		2016
1027	$msg->("reloading...");	2017	warn "reloading...";
		2018
		2019	local $FREEZE = 1;
		2020	cf::emergency_save;
1028		2021
1029	eval {	2022	eval {
		2023	# if anything goes wrong in here, we should simply crash as we already saved
		2024
1030	# cancel all watchers	2025	# cancel all watchers
1031	for (Event::all_watchers) {	2026	for (Event::all_watchers) {
1032	$_->cancel if $_->data & WF_AUTOCANCEL;	2027	$_->cancel if $_->data & WF_AUTOCANCEL;
1033	}	2028	}
1034		2029
		2030	# cancel all extension coros
		2031	$_->cancel for values %EXT_CORO;
		2032	%EXT_CORO = ();
		2033
1035	# unload all extensions	2034	# unload all extensions
1036	for (@exts) {	2035	for (@exts) {
1037	$msg->("unloading <$_>");	2036	warn "unloading <$_>";
1038	unload_extension $_;	2037	unload_extension $_;
1039	}	2038	}
1040		2039
1041	# unload all modules loaded from $LIBDIR	2040	# unload all modules loaded from $LIBDIR
1042	while (my ($k, $v) = each %INC) {	2041	while (my ($k, $v) = each %INC) {
1043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2042	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044		2043
1045	$msg->("removing <$k>");	2044	warn "removing <$k>";
1046	delete $INC{$k};	2045	delete $INC{$k};
1047		2046
1048	$k =~ s/\.pm$//;	2047	$k =~ s/\.pm$//;
1049	$k =~ s/\//::/g;	2048	$k =~ s/\//::/g;
1050		2049
…		…
1055	Symbol::delete_package $k;	2054	Symbol::delete_package $k;
1056	}	2055	}
1057		2056
1058	# sync database to disk	2057	# sync database to disk
1059	cf::db_sync;	2058	cf::db_sync;
		2059	IO::AIO::flush;
1060		2060
1061	# get rid of safe::, as good as possible	2061	# get rid of safe::, as good as possible
1062	Symbol::delete_package "safe::$_"	2062	Symbol::delete_package "safe::$_"
1063	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2063	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064		2064
1065	# remove register_script_function callbacks	2065	# remove register_script_function callbacks
1066	# TODO	2066	# TODO
1067		2067
1068	# unload cf.pm "a bit"	2068	# unload cf.pm "a bit"
…		…
1071	# don't, removes xs symbols, too,	2071	# don't, removes xs symbols, too,
1072	# and global variables created in xs	2072	# and global variables created in xs
1073	#Symbol::delete_package __PACKAGE__;	2073	#Symbol::delete_package __PACKAGE__;
1074		2074
1075	# reload cf.pm	2075	# reload cf.pm
1076	$msg->("reloading cf.pm");	2076	warn "reloading cf.pm";
1077	require cf;	2077	require cf;
		2078	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078		2079
1079	# load config and database again	2080	# load config and database again
1080	cf::cfg_load;	2081	cf::cfg_load;
1081	cf::db_load;	2082	cf::db_load;
1082		2083
1083	# load extensions	2084	# load extensions
1084	$msg->("load extensions");	2085	warn "load extensions";
1085	cf::load_extensions;	2086	cf::load_extensions;
1086		2087
1087	# reattach attachments to objects	2088	# reattach attachments to objects
1088	$msg->("reattach");	2089	warn "reattach";
1089	_global_reattach;	2090	_global_reattach;
1090	};	2091	};
1091	$msg->($@) if $@;
1092		2092
1093	$msg->("reloaded");	2093	if ($@) {
		2094	warn $@;
		2095	warn "error while reloading, exiting.";
		2096	exit 1;
		2097	}
		2098
		2099	warn "reloaded successfully";
1094	};	2100	};
1095		2101
1096	sub perl_reload() {	2102	#############################################################################
1097	_perl_reload {	2103
1098	warn $_[0];	2104	unless ($LINK_MAP) {
1099	print "$_[0]\n";	2105	$LINK_MAP = cf::map::new;
1100	};	2106
		2107	$LINK_MAP->width (41);
		2108	$LINK_MAP->height (41);
		2109	$LINK_MAP->alloc;
		2110	$LINK_MAP->path ("{link}");
		2111	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2112	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2113
		2114	# dirty hack because... archetypes are not yet loaded
		2115	Event->timer (
		2116	after => 2,
		2117	cb => sub {
		2118	$_[0]->w->cancel;
		2119
		2120	# provide some exits "home"
		2121	my $exit = cf::object::new "exit";
		2122
		2123	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2124	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2125	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2126
		2127	$LINK_MAP->insert ($exit->clone, 19, 19);
		2128	$LINK_MAP->insert ($exit->clone, 19, 20);
		2129	$LINK_MAP->insert ($exit->clone, 19, 21);
		2130	$LINK_MAP->insert ($exit->clone, 20, 19);
		2131	$LINK_MAP->insert ($exit->clone, 20, 21);
		2132	$LINK_MAP->insert ($exit->clone, 21, 19);
		2133	$LINK_MAP->insert ($exit->clone, 21, 20);
		2134	$LINK_MAP->insert ($exit->clone, 21, 21);
		2135
		2136	$exit->destroy;
		2137	});
		2138
		2139	$LINK_MAP->{deny_save} = 1;
		2140	$LINK_MAP->{deny_reset} = 1;
		2141
		2142	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1101	}	2143	}
1102		2144
1103	register "<global>", __PACKAGE__;	2145	register "<global>", __PACKAGE__;
1104		2146
1105	register_command "perl-reload" => sub {	2147	register_command "reload" => sub {
1106	my ($who, $arg) = @_;	2148	my ($who, $arg) = @_;
1107		2149
1108	if ($who->flag (FLAG_WIZ)) {	2150	if ($who->flag (FLAG_WIZ)) {
1109	_perl_reload {	2151	$who->message ("start of reload.");
1110	warn $_[0];	2152	reload;
1111	$who->message ($_[0]);	2153	$who->message ("end of reload.");
1112	};
1113	}	2154	}
1114	};	2155	};
1115		2156
1116	unshift @INC, $LIBDIR;	2157	unshift @INC, $LIBDIR;
1117		2158
1118	$TICK_WATCHER = Event->timer (	2159	$TICK_WATCHER = Event->timer (
		2160	reentrant => 0,
1119	prio => 0,	2161	prio => 0,
1120	at => $NEXT_TICK || 1,	2162	at => $NEXT_TICK || $TICK,
1121	data => WF_AUTOCANCEL,	2163	data => WF_AUTOCANCEL,
1122	cb => sub {	2164	cb => sub {
		2165	unless ($FREEZE) {
1123	cf::server_tick; # one server iteration	2166	cf::server_tick; # one server iteration
		2167	$RUNTIME += $TICK;
		2168	}
1124		2169
1125	my $NOW = Event::time;
1126	$NEXT_TICK += $TICK;	2170	$NEXT_TICK += $TICK;
1127		2171
1128	# if we are delayed by four ticks or more, skip them all	2172	# if we are delayed by four ticks or more, skip them all
1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2173	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130		2174
1131	$TICK_WATCHER->at ($NEXT_TICK);	2175	$TICK_WATCHER->at ($NEXT_TICK);
1132	$TICK_WATCHER->start;	2176	$TICK_WATCHER->start;
1133	},	2177	},
1134	);	2178	);
1135		2179
1136	IO::AIO::max_poll_time $TICK * 0.2;	2180	IO::AIO::max_poll_time $TICK * 0.2;
1137		2181
		2182	Event->io (
1138	Event->io (fd => IO::AIO::poll_fileno,	2183	fd => IO::AIO::poll_fileno,
1139	poll => 'r',	2184	poll => 'r',
1140	prio => 5,	2185	prio => 5,
1141	data => WF_AUTOCANCEL,	2186	data => WF_AUTOCANCEL,
1142	cb => \&IO::AIO::poll_cb);	2187	cb => \&IO::AIO::poll_cb,
		2188	);
		2189
		2190	Event->timer (
		2191	data => WF_AUTOCANCEL,
		2192	after => 0,
		2193	interval => 10,
		2194	cb => sub {
		2195	(Coro::unblock_sub {
		2196	write_runtime
		2197	or warn "ERROR: unable to write runtime file: $!";
		2198	})->();
		2199	},
		2200	);
		2201
		2202	END { cf::emergency_save }
1143		2203
1144	1	2204	1
1145		2205

Diff Legend

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