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

Diff Legend

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