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.133 by root, Thu Jan 4 16:19:32 2007 UTC

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

Diff Legend

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