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.143 by root, Sun Jan 7 02:39:14 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Digest::MD5;
		21	use Fcntl;
10	use IO::AIO ();	22	use IO::AIO 2.31 ();
11	use YAML::Syck ();	23	use YAML::Syck ();
12	use Time::HiRes;	24	use Time::HiRes;
13	use Event;	25
14	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		27
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
18		30
19	use strict;	31	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		32
21	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, "cfperl: $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';
…		…
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 path($) {
726	cf::player::find $_[0]	1092	sprintf "%s/%s/%s/%s.pl",
727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1093	cf::localdir, cf::playerdir,
		1094	(ref $_[0] ? $_[0]->ob->name : $_[0]) x 2
728	}	1095	}
		1096
		1097	sub find_active($) {
		1098	$cf::PLAYER{$_[0]}
		1099	and $cf::PLAYER{$_[0]}->active
		1100	and $cf::PLAYER{$_[0]}
		1101	}
		1102
		1103	sub exists($) {
		1104	my ($login) = @_;
		1105
		1106	$cf::PLAYER{$login}
		1107	or cf::sync_job { !aio_stat $login }
		1108	}
		1109
		1110	sub find($) {
		1111	return $cf::PLAYER{$_[0]} || do {
		1112	my $login = $_[0];
		1113
		1114	my $guard = cf::lock_acquire "user_find:$login";
		1115
		1116	$cf::PLAYER{$login} ||= (load_pl path $login or return);
		1117	};
		1118	}
		1119
		1120	sub save($) {
		1121	my ($pl) = @_;
		1122
		1123	return if $pl->{deny_save};
		1124
		1125	my $path = path $pl;
		1126	my $guard = cf::lock_acquire "user_save:$path";
		1127
		1128	return if $pl->{deny_save};
		1129	$pl->{last_save} = $cf::RUNTIME;
		1130
		1131	Coro::cede;
		1132	$pl->save_pl ($path);
		1133	Coro::cede;
		1134	}
		1135
		1136	sub new($) {
		1137	my ($login) = @_;
		1138
		1139	my $self = create;
		1140
		1141	$self->ob->name ($login);
		1142	$self->{deny_save} = 1;
		1143
		1144	$cf::PLAYER{$login} = $self;
		1145
		1146	$self
		1147	}
		1148
		1149	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1150
		1151	Sends an ext reply to the player.
		1152
		1153	=cut
		1154
		1155	sub ext_reply($$$%) {
		1156	my ($self, $id, %msg) = @_;
		1157
		1158	$msg{msgid} = $id;
		1159
		1160	$self->send ("ext " . cf::to_json \%msg);
		1161	}
		1162
		1163	package cf;
		1164
		1165	=back
		1166
		1167
		1168	=head3 cf::map
		1169
		1170	=over 4
		1171
		1172	=cut
		1173
		1174	package cf::map;
		1175
		1176	use Fcntl;
		1177	use Coro::AIO;
		1178
		1179	our $MAX_RESET = 3600;
		1180	our $DEFAULT_RESET = 3000;
		1181
		1182	sub generate_random_map {
		1183	my ($path, $rmp) = @_;
		1184
		1185	# mit "rum" bekleckern, nicht
		1186	cf::map::_create_random_map
		1187	$path,
		1188	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1189	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1190	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1191	$rmp->{exit_on_final_map},
		1192	$rmp->{xsize}, $rmp->{ysize},
		1193	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1194	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1195	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1196	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1197	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1198	(cf::region::find $rmp->{region})
		1199	}
		1200
		1201	# and all this just because we cannot iterate over
		1202	# all maps in C++...
		1203	sub change_all_map_light {
		1204	my ($change) = @_;
		1205
		1206	$_->change_map_light ($change)
		1207	for grep $_->outdoor, values %cf::MAP;
		1208	}
		1209
		1210	sub try_load_header($) {
		1211	my ($path) = @_;
		1212
		1213	utf8::encode $path;
		1214	aio_open $path, O_RDONLY, 0
		1215	or return;
		1216
		1217	my $map = cf::map::new
		1218	or return;
		1219
		1220	# for better error messages only, will be overwritten
		1221	$map->path ($path);
		1222
		1223	$map->load_header ($path)
		1224	or return;
		1225
		1226	$map->{load_path} = $path;
		1227
		1228	$map
		1229	}
		1230
		1231	sub find;
		1232	sub find {
		1233	my ($path, $origin) = @_;
		1234
		1235	#warn "find<$path,$origin>\n";#d#
		1236
		1237	$path = new cf::path $path, $origin && $origin->path;
		1238	my $key = $path->as_string;
		1239
		1240	cf::lock_wait "map_find:$key";
		1241
		1242	$cf::MAP{$key} || do {
		1243	my $guard = cf::lock_acquire "map_find:$key";
		1244
		1245	# do it the slow way
		1246	my $map = try_load_header $path->save_path;
		1247
		1248	Coro::cede;
		1249
		1250	if ($map) {
		1251	$map->last_access ((delete $map->{last_access})
		1252	|| $cf::RUNTIME); #d#
		1253	# safety
		1254	$map->{instantiate_time} = $cf::RUNTIME
		1255	if $map->{instantiate_time} > $cf::RUNTIME;
		1256	} else {
		1257	if (my $rmp = $path->random_map_params) {
		1258	$map = generate_random_map $key, $rmp;
		1259	} else {
		1260	$map = try_load_header $path->load_path;
		1261	}
		1262
		1263	$map or return;
		1264
		1265	$map->{load_original} = 1;
		1266	$map->{instantiate_time} = $cf::RUNTIME;
		1267	$map->last_access ($cf::RUNTIME);
		1268	$map->instantiate;
		1269
		1270	# per-player maps become, after loading, normal maps
		1271	$map->per_player (0) if $path->{user_rel};
		1272	}
		1273
		1274	$map->path ($key);
		1275	$map->{path} = $path;
		1276	$map->{last_save} = $cf::RUNTIME;
		1277
		1278	Coro::cede;
		1279
		1280	if ($map->should_reset) {
		1281	$map->reset;
		1282	undef $guard;
		1283	$map = find $path
		1284	or return;
		1285	}
		1286
		1287	$cf::MAP{$key} = $map
		1288	}
		1289	}
		1290
		1291	sub load {
		1292	my ($self) = @_;
		1293
		1294	my $path = $self->{path};
		1295	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1296
		1297	return if $self->in_memory != cf::MAP_SWAPPED;
		1298
		1299	$self->in_memory (cf::MAP_LOADING);
		1300
		1301	$self->alloc;
		1302	$self->load_objects ($self->{load_path}, 1)
		1303	or return;
		1304
		1305	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1306	if delete $self->{load_original};
		1307
		1308	if (my $uniq = $path->uniq_path) {
		1309	utf8::encode $uniq;
		1310	if (aio_open $uniq, O_RDONLY, 0) {
		1311	$self->clear_unique_items;
		1312	$self->load_objects ($uniq, 0);
		1313	}
		1314	}
		1315
		1316	Coro::cede;
		1317
		1318	# now do the right thing for maps
		1319	$self->link_multipart_objects;
		1320
		1321	if ($self->{path}->is_style_map) {
		1322	$self->{deny_save} = 1;
		1323	$self->{deny_reset} = 1;
		1324	} else {
		1325	$self->fix_auto_apply;
		1326	$self->decay_objects;
		1327	$self->update_buttons;
		1328	$self->set_darkness_map;
		1329	$self->difficulty ($self->estimate_difficulty)
		1330	unless $self->difficulty;
		1331	$self->activate;
		1332	}
		1333
		1334	Coro::cede;
		1335
		1336	$self->in_memory (cf::MAP_IN_MEMORY);
		1337	}
		1338
		1339	sub find_sync {
		1340	my ($path, $origin) = @_;
		1341
		1342	cf::sync_job { cf::map::find $path, $origin }
		1343	}
		1344
		1345	sub do_load_sync {
		1346	my ($map) = @_;
		1347
		1348	cf::sync_job { $map->load };
		1349	}
		1350
		1351	sub save {
		1352	my ($self) = @_;
		1353
		1354	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1355
		1356	$self->{last_save} = $cf::RUNTIME;
		1357
		1358	return unless $self->dirty;
		1359
		1360	my $save = $self->{path}->save_path; utf8::encode $save;
		1361	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1362
		1363	$self->{load_path} = $save;
		1364
		1365	return if $self->{deny_save};
		1366
		1367	local $self->{last_access} = $self->last_access;#d#
		1368
		1369	cf::async {
		1370	$_->contr->save for $self->players;
		1371	};
		1372
		1373	if ($uniq) {
		1374	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1375	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1376	} else {
		1377	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1378	}
		1379	}
		1380
		1381	sub swap_out {
		1382	my ($self) = @_;
		1383
		1384	# save first because save cedes
		1385	$self->save;
		1386
		1387	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1388
		1389	return if $self->players;
		1390	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1391	return if $self->{deny_save};
		1392
		1393	$self->clear;
		1394	$self->in_memory (cf::MAP_SWAPPED);
		1395	}
		1396
		1397	sub reset_at {
		1398	my ($self) = @_;
		1399
		1400	# TODO: safety, remove and allow resettable per-player maps
		1401	return 1e99 if $self->{path}{user_rel};
		1402	return 1e99 if $self->{deny_reset};
		1403
		1404	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1405	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1406
		1407	$time + $to
		1408	}
		1409
		1410	sub should_reset {
		1411	my ($self) = @_;
		1412
		1413	$self->reset_at <= $cf::RUNTIME
		1414	}
		1415
		1416	sub unlink_save {
		1417	my ($self) = @_;
		1418
		1419	utf8::encode (my $save = $self->{path}->save_path);
		1420	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1421	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1422	}
		1423
		1424	sub rename {
		1425	my ($self, $new_path) = @_;
		1426
		1427	$self->unlink_save;
		1428
		1429	delete $cf::MAP{$self->path};
		1430	$self->{path} = new cf::path $new_path;
		1431	$self->path ($self->{path}->as_string);
		1432	$cf::MAP{$self->path} = $self;
		1433
		1434	$self->save;
		1435	}
		1436
		1437	sub reset {
		1438	my ($self) = @_;
		1439
		1440	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1441
		1442	return if $self->players;
		1443	return if $self->{path}{user_rel};#d#
		1444
		1445	warn "resetting map ", $self->path;#d#
		1446
		1447	delete $cf::MAP{$self->path};
		1448
		1449	$_->clear_links_to ($self) for values %cf::MAP;
		1450
		1451	$self->unlink_save;
		1452	$self->destroy;
		1453	}
		1454
		1455	my $nuke_counter = "aaaa";
		1456
		1457	sub nuke {
		1458	my ($self) = @_;
		1459
		1460	$self->{deny_save} = 1;
		1461	$self->reset_timeout (1);
		1462	$self->rename ("{nuke}/" . ($nuke_counter++));
		1463	$self->reset; # polite request, might not happen
		1464	}
		1465
		1466	sub customise_for {
		1467	my ($map, $ob) = @_;
		1468
		1469	if ($map->per_player) {
		1470	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
		1471	}
		1472
		1473	$map
		1474	}
		1475
		1476	sub emergency_save {
		1477	my $freeze_guard = cf::freeze_mainloop;
		1478
		1479	warn "enter emergency map save\n";
		1480
		1481	cf::sync_job {
		1482	warn "begin emergency map save\n";
		1483	$_->save for values %cf::MAP;
		1484	};
		1485
		1486	warn "end emergency map save\n";
		1487	}
		1488
		1489	package cf;
		1490
		1491	=back
		1492
		1493
		1494	=head3 cf::object::player
		1495
		1496	=over 4
729		1497
730	=item $player_object->reply ($npc, $msg[, $flags])	1498	=item $player_object->reply ($npc, $msg[, $flags])
731		1499
732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1500	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733	can be C<undef>. Does the right thing when the player is currently in a	1501	can be C<undef>. Does the right thing when the player is currently in a
…		…
735		1503
736	=cut	1504	=cut
737		1505
738	# rough implementation of a future "reply" method that works	1506	# rough implementation of a future "reply" method that works
739	# with dialog boxes.	1507	# with dialog boxes.
		1508	#TODO: the first argument must go, split into a $npc->reply_to ( method
740	sub cf::object::player::reply($$$;$) {	1509	sub cf::object::player::reply($$$;$) {
741	my ($self, $npc, $msg, $flags) = @_;	1510	my ($self, $npc, $msg, $flags) = @_;
742		1511
743	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1512	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744		1513
…		…
748	$msg = $npc->name . " says: $msg" if $npc;	1517	$msg = $npc->name . " says: $msg" if $npc;
749	$self->message ($msg, $flags);	1518	$self->message ($msg, $flags);
750	}	1519	}
751	}	1520	}
752		1521
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")	1522	=item $player_object->may ("access")
768		1523
769	Returns wether the given player is authorized to access resource "access"	1524	Returns wether the given player is authorized to access resource "access"
770	(e.g. "command_wizcast").	1525	(e.g. "command_wizcast").
771		1526
…		…
778	(ref $cf::CFG{"may_$access"}	1533	(ref $cf::CFG{"may_$access"}
779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1534	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780	: $cf::CFG{"may_$access"})	1535	: $cf::CFG{"may_$access"})
781	}	1536	}
782		1537
783	=cut	1538	=item $player_object->enter_link
784		1539
785	#############################################################################	1540	Freezes the player and moves him/her to a special map (C<{link}>).
		1541
		1542	The player should be reaosnably safe there for short amounts of time. You
		1543	I<MUST> call C<leave_link> as soon as possible, though.
		1544
		1545	=item $player_object->leave_link ($map, $x, $y)
		1546
		1547	Moves the player out of the specila link map onto the given map. If the
		1548	map is not valid (or omitted), the player will be moved back to the
		1549	location he/she was before the call to C<enter_link>, or, if that fails,
		1550	to the emergency map position.
		1551
		1552	Might block.
		1553
		1554	=cut
		1555
		1556	sub cf::object::player::enter_link {
		1557	my ($self) = @_;
		1558
		1559	$self->deactivate_recursive;
		1560
		1561	return if $self->map == $LINK_MAP;
		1562
		1563	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1564	if $self->map;
		1565
		1566	$self->enter_map ($LINK_MAP, 20, 20);
		1567	}
		1568
		1569	sub cf::object::player::leave_link {
		1570	my ($self, $map, $x, $y) = @_;
		1571
		1572	my $link_pos = delete $self->{_link_pos};
		1573
		1574	unless ($map) {
		1575	# restore original map position
		1576	($map, $x, $y) = @{ $link_pos || [] };
		1577	$map = cf::map::find $map;
		1578
		1579	unless ($map) {
		1580	($map, $x, $y) = @$EMERGENCY_POSITION;
		1581	$map = cf::map::find $map
		1582	or die "FATAL: cannot load emergency map\n";
		1583	}
		1584	}
		1585
		1586	($x, $y) = (-1, -1)
		1587	unless (defined $x) && (defined $y);
		1588
		1589	# use -1 or undef as default coordinates, not 0, 0
		1590	($x, $y) = ($map->enter_x, $map->enter_y)
		1591	if $x <=0 && $y <= 0;
		1592
		1593	$map->load;
		1594
		1595	return unless $self->contr->active;
		1596	$self->activate_recursive;
		1597	$self->enter_map ($map, $x, $y);
		1598	}
		1599
		1600	cf::player->attach (
		1601	on_logout => sub {
		1602	my ($pl) = @_;
		1603
		1604	# abort map switching before logout
		1605	if ($pl->ob->{_link_pos}) {
		1606	cf::sync_job {
		1607	$pl->ob->leave_link
		1608	};
		1609	}
		1610	},
		1611	on_login => sub {
		1612	my ($pl) = @_;
		1613
		1614	# try to abort aborted map switching on player login :)
		1615	# should happen only on crashes
		1616	if ($pl->ob->{_link_pos}) {
		1617	$pl->ob->enter_link;
		1618	(async {
		1619	# we need this sleep as the login has a concurrent enter_exit running
		1620	# and this sleep increases chances of the player not ending up in scorn
		1621	$pl->ob->reply (undef,
		1622	"There was an internal problem at your last logout, "
		1623	. "the server will try to bring you to your intended destination in a second.",
		1624	cf::NDI_RED);
		1625	Coro::Timer::sleep 1;
		1626	$pl->ob->leave_link;
		1627	})->prio (2);
		1628	}
		1629	},
		1630	);
		1631
		1632	=item $player_object->goto ($path, $x, $y)
		1633
		1634	=cut
		1635
		1636	sub cf::object::player::goto {
		1637	my ($self, $path, $x, $y) = @_;
		1638
		1639	$self->enter_link;
		1640
		1641	(async {
		1642	$path = new cf::path $path;
		1643
		1644	my $map = cf::map::find $path->as_string;
		1645	$map = $map->customise_for ($self) if $map;
		1646
		1647	# warn "entering ", $map->path, " at ($x, $y)\n"
		1648	# if $map;
		1649
		1650	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1651
		1652	$self->leave_link ($map, $x, $y);
		1653	})->prio (1);
		1654	}
		1655
		1656	=item $player_object->enter_exit ($exit_object)
		1657
		1658	=cut
		1659
		1660	sub parse_random_map_params {
		1661	my ($spec) = @_;
		1662
		1663	my $rmp = { # defaults
		1664	xsize => 10,
		1665	ysize => 10,
		1666	};
		1667
		1668	for (split /\n/, $spec) {
		1669	my ($k, $v) = split /\s+/, $_, 2;
		1670
		1671	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1672	}
		1673
		1674	$rmp
		1675	}
		1676
		1677	sub prepare_random_map {
		1678	my ($exit) = @_;
		1679
		1680	# all this does is basically replace the /! path by
		1681	# a new random map path (?random/...) with a seed
		1682	# that depends on the exit object
		1683
		1684	my $rmp = parse_random_map_params $exit->msg;
		1685
		1686	if ($exit->map) {
		1687	$rmp->{region} = $exit->map->region_name;
		1688	$rmp->{origin_map} = $exit->map->path;
		1689	$rmp->{origin_x} = $exit->x;
		1690	$rmp->{origin_y} = $exit->y;
		1691	}
		1692
		1693	$rmp->{random_seed} ||= $exit->random_seed;
		1694
		1695	my $data = cf::to_json $rmp;
		1696	my $md5 = Digest::MD5::md5_hex $data;
		1697
		1698	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1699	aio_write $fh, 0, (length $data), $data, 0;
		1700
		1701	$exit->slaying ("?random/$md5");
		1702	$exit->msg (undef);
		1703	}
		1704	}
		1705
		1706	sub cf::object::player::enter_exit {
		1707	my ($self, $exit) = @_;
		1708
		1709	return unless $self->type == cf::PLAYER;
		1710
		1711	$self->enter_link;
		1712
		1713	(async {
		1714	$self->deactivate_recursive; # just to be sure
		1715	unless (eval {
		1716	prepare_random_map $exit
		1717	if $exit->slaying eq "/!";
		1718
		1719	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1720	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1721
		1722	1;
		1723	}) {
		1724	$self->message ("Something went wrong deep within the crossfire server. "
		1725	. "I'll try to bring you back to the map you were before. "
		1726	. "Please report this to the dungeon master",
		1727	cf::NDI_UNIQUE | cf::NDI_RED);
		1728
		1729	warn "ERROR in enter_exit: $@";
		1730	$self->leave_link;
		1731	}
		1732	})->prio (1);
		1733	}
		1734
		1735	=head3 cf::client
		1736
		1737	=over 4
		1738
		1739	=item $client->send_drawinfo ($text, $flags)
		1740
		1741	Sends a drawinfo packet to the client. Circumvents output buffering so
		1742	should not be used under normal circumstances.
		1743
		1744	=cut
		1745
		1746	sub cf::client::send_drawinfo {
		1747	my ($self, $text, $flags) = @_;
		1748
		1749	utf8::encode $text;
		1750	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1751	}
		1752
		1753
		1754	=item $success = $client->query ($flags, "text", \&cb)
		1755
		1756	Queues a query to the client, calling the given callback with
		1757	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1758	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1759
		1760	Queries can fail, so check the return code. Or don't, as queries will become
		1761	reliable at some point in the future.
		1762
		1763	=cut
		1764
		1765	sub cf::client::query {
		1766	my ($self, $flags, $text, $cb) = @_;
		1767
		1768	return unless $self->state == ST_PLAYING
		1769	|| $self->state == ST_SETUP
		1770	|| $self->state == ST_CUSTOM;
		1771
		1772	$self->state (ST_CUSTOM);
		1773
		1774	utf8::encode $text;
		1775	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1776
		1777	$self->send_packet ($self->{query_queue}[0][0])
		1778	if @{ $self->{query_queue} } == 1;
		1779	}
		1780
		1781	cf::client->attach (
		1782	on_reply => sub {
		1783	my ($ns, $msg) = @_;
		1784
		1785	# this weird shuffling is so that direct followup queries
		1786	# get handled first
		1787	my $queue = delete $ns->{query_queue}
		1788	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1789
		1790	(shift @$queue)->[1]->($msg);
		1791
		1792	push @{ $ns->{query_queue} }, @$queue;
		1793
		1794	if (@{ $ns->{query_queue} } == @$queue) {
		1795	if (@$queue) {
		1796	$ns->send_packet ($ns->{query_queue}[0][0]);
		1797	} else {
		1798	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1799	}
		1800	}
		1801	},
		1802	);
		1803
		1804	=item $client->async (\&cb)
		1805
		1806	Create a new coroutine, running the specified callback. The coroutine will
		1807	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1808	or loss of connection).
		1809
		1810	=cut
		1811
		1812	sub cf::client::async {
		1813	my ($self, $cb) = @_;
		1814
		1815	my $coro = &Coro::async ($cb);
		1816
		1817	$coro->on_destroy (sub {
		1818	delete $self->{_coro}{$coro+0};
		1819	});
		1820
		1821	$self->{_coro}{$coro+0} = $coro;
		1822
		1823	$coro
		1824	}
		1825
		1826	cf::client->attach (
		1827	on_destroy => sub {
		1828	my ($ns) = @_;
		1829
		1830	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1831	},
		1832	);
		1833
		1834	=back
		1835
786		1836
787	=head2 SAFE SCRIPTING	1837	=head2 SAFE SCRIPTING
788		1838
789	Functions that provide a safe environment to compile and execute	1839	Functions that provide a safe environment to compile and execute
790	snippets of perl code without them endangering the safety of the server	1840	snippets of perl code without them endangering the safety of the server
…		…
942		1992
943	{	1993	{
944	my $path = cf::localdir . "/database.pst";	1994	my $path = cf::localdir . "/database.pst";
945		1995
946	sub db_load() {	1996	sub db_load() {
947	warn "loading database $path\n";#d# remove later
948	$DB = stat $path ? Storable::retrieve $path : { };	1997	$DB = stat $path ? Storable::retrieve $path : { };
949	}	1998	}
950		1999
951	my $pid;	2000	my $pid;
952		2001
953	sub db_save() {	2002	sub db_save() {
954	warn "saving database $path\n";#d# remove later
955	waitpid $pid, 0 if $pid;	2003	waitpid $pid, 0 if $pid;
956	if (0 == ($pid = fork)) {	2004	if (0 == ($pid = fork)) {
957	$DB->{_meta}{version} = 1;	2005	$DB->{_meta}{version} = 1;
958	Storable::nstore $DB, "$path~";	2006	Storable::nstore $DB, "$path~";
959	rename "$path~", $path;	2007	rename "$path~", $path;
…		…
1007	open my $fh, "<:utf8", cf::confdir . "/config"	2055	open my $fh, "<:utf8", cf::confdir . "/config"
1008	or return;	2056	or return;
1009		2057
1010	local $/;	2058	local $/;
1011	*CFG = YAML::Syck::Load <$fh>;	2059	*CFG = YAML::Syck::Load <$fh>;
		2060
		2061	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2062
		2063	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2064	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2065
		2066	if (exists $CFG{mlockall}) {
		2067	eval {
		2068	$CFG{mlockall} ? &mlockall : &munlockall
		2069	and die "WARNING: m(un)lockall failed: $!\n";
		2070	};
		2071	warn $@ if $@;
		2072	}
1012	}	2073	}
1013		2074
1014	sub main {	2075	sub main {
		2076	# we must not ever block the main coroutine
		2077	local $Coro::idle = sub {
		2078	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2079	async { Event::one_event };
		2080	};
		2081
1015	cfg_load;	2082	cfg_load;
1016	db_load;	2083	db_load;
1017	load_extensions;	2084	load_extensions;
1018	Event::loop;	2085	Event::loop;
1019	}	2086	}
1020		2087
1021	#############################################################################	2088	#############################################################################
1022	# initialisation	2089	# initialisation
1023		2090
1024	sub _perl_reload(&) {	2091	sub reload() {
1025	my ($msg) = @_;	2092	# can/must only be called in main
		2093	if ($Coro::current != $Coro::main) {
		2094	warn "can only reload from main coroutine\n";
		2095	return;
		2096	}
1026		2097
1027	$msg->("reloading...");	2098	warn "reloading...";
		2099
		2100	my $guard = freeze_mainloop;
		2101	cf::emergency_save;
1028		2102
1029	eval {	2103	eval {
		2104	# if anything goes wrong in here, we should simply crash as we already saved
		2105
1030	# cancel all watchers	2106	# cancel all watchers
1031	for (Event::all_watchers) {	2107	for (Event::all_watchers) {
1032	$_->cancel if $_->data & WF_AUTOCANCEL;	2108	$_->cancel if $_->data & WF_AUTOCANCEL;
1033	}	2109	}
1034		2110
		2111	# cancel all extension coros
		2112	$_->cancel for values %EXT_CORO;
		2113	%EXT_CORO = ();
		2114
1035	# unload all extensions	2115	# unload all extensions
1036	for (@exts) {	2116	for (@exts) {
1037	$msg->("unloading <$_>");	2117	warn "unloading <$_>";
1038	unload_extension $_;	2118	unload_extension $_;
1039	}	2119	}
1040		2120
1041	# unload all modules loaded from $LIBDIR	2121	# unload all modules loaded from $LIBDIR
1042	while (my ($k, $v) = each %INC) {	2122	while (my ($k, $v) = each %INC) {
1043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2123	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044		2124
1045	$msg->("removing <$k>");	2125	warn "removing <$k>";
1046	delete $INC{$k};	2126	delete $INC{$k};
1047		2127
1048	$k =~ s/\.pm$//;	2128	$k =~ s/\.pm$//;
1049	$k =~ s/\//::/g;	2129	$k =~ s/\//::/g;
1050		2130
…		…
1055	Symbol::delete_package $k;	2135	Symbol::delete_package $k;
1056	}	2136	}
1057		2137
1058	# sync database to disk	2138	# sync database to disk
1059	cf::db_sync;	2139	cf::db_sync;
		2140	IO::AIO::flush;
1060		2141
1061	# get rid of safe::, as good as possible	2142	# get rid of safe::, as good as possible
1062	Symbol::delete_package "safe::$_"	2143	Symbol::delete_package "safe::$_"
1063	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2144	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064		2145
1065	# remove register_script_function callbacks	2146	# remove register_script_function callbacks
1066	# TODO	2147	# TODO
1067		2148
1068	# unload cf.pm "a bit"	2149	# unload cf.pm "a bit"
…		…
1071	# don't, removes xs symbols, too,	2152	# don't, removes xs symbols, too,
1072	# and global variables created in xs	2153	# and global variables created in xs
1073	#Symbol::delete_package __PACKAGE__;	2154	#Symbol::delete_package __PACKAGE__;
1074		2155
1075	# reload cf.pm	2156	# reload cf.pm
1076	$msg->("reloading cf.pm");	2157	warn "reloading cf.pm";
1077	require cf;	2158	require cf;
		2159	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078		2160
1079	# load config and database again	2161	# load config and database again
1080	cf::cfg_load;	2162	cf::cfg_load;
1081	cf::db_load;	2163	cf::db_load;
1082		2164
1083	# load extensions	2165	# load extensions
1084	$msg->("load extensions");	2166	warn "load extensions";
1085	cf::load_extensions;	2167	cf::load_extensions;
1086		2168
1087	# reattach attachments to objects	2169	# reattach attachments to objects
1088	$msg->("reattach");	2170	warn "reattach";
1089	_global_reattach;	2171	_global_reattach;
1090	};	2172	};
1091	$msg->($@) if $@;
1092		2173
1093	$msg->("reloaded");	2174	if ($@) {
		2175	warn $@;
		2176	warn "error while reloading, exiting.";
		2177	exit 1;
		2178	}
		2179
		2180	warn "reloaded successfully";
1094	};	2181	};
1095		2182
1096	sub perl_reload() {	2183	#############################################################################
1097	_perl_reload {	2184
1098	warn $_[0];	2185	unless ($LINK_MAP) {
1099	print "$_[0]\n";	2186	$LINK_MAP = cf::map::new;
1100	};	2187
		2188	$LINK_MAP->width (41);
		2189	$LINK_MAP->height (41);
		2190	$LINK_MAP->alloc;
		2191	$LINK_MAP->path ("{link}");
		2192	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2193	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2194
		2195	# dirty hack because... archetypes are not yet loaded
		2196	Event->timer (
		2197	after => 10,
		2198	cb => sub {
		2199	$_[0]->w->cancel;
		2200
		2201	# provide some exits "home"
		2202	my $exit = cf::object::new "exit";
		2203
		2204	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2205	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2206	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2207
		2208	$LINK_MAP->insert ($exit->clone, 19, 19);
		2209	$LINK_MAP->insert ($exit->clone, 19, 20);
		2210	$LINK_MAP->insert ($exit->clone, 19, 21);
		2211	$LINK_MAP->insert ($exit->clone, 20, 19);
		2212	$LINK_MAP->insert ($exit->clone, 20, 21);
		2213	$LINK_MAP->insert ($exit->clone, 21, 19);
		2214	$LINK_MAP->insert ($exit->clone, 21, 20);
		2215	$LINK_MAP->insert ($exit->clone, 21, 21);
		2216
		2217	$exit->destroy;
		2218	});
		2219
		2220	$LINK_MAP->{deny_save} = 1;
		2221	$LINK_MAP->{deny_reset} = 1;
		2222
		2223	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1101	}	2224	}
1102		2225
1103	register "<global>", __PACKAGE__;	2226	register "<global>", __PACKAGE__;
1104		2227
1105	register_command "perl-reload" => sub {	2228	register_command "reload" => sub {
1106	my ($who, $arg) = @_;	2229	my ($who, $arg) = @_;
1107		2230
1108	if ($who->flag (FLAG_WIZ)) {	2231	if ($who->flag (FLAG_WIZ)) {
1109	_perl_reload {	2232	$who->message ("start of reload.");
1110	warn $_[0];	2233	reload;
1111	$who->message ($_[0]);	2234	$who->message ("end of reload.");
1112	};
1113	}	2235	}
1114	};	2236	};
1115		2237
1116	unshift @INC, $LIBDIR;	2238	unshift @INC, $LIBDIR;
1117		2239
1118	$TICK_WATCHER = Event->timer (	2240	$TICK_WATCHER = Event->timer (
		2241	reentrant => 0,
1119	prio => 0,	2242	prio => 0,
1120	at => $NEXT_TICK || 1,	2243	at => $NEXT_TICK || $TICK,
1121	data => WF_AUTOCANCEL,	2244	data => WF_AUTOCANCEL,
1122	cb => sub {	2245	cb => sub {
1123	cf::server_tick; # one server iteration	2246	cf::server_tick; # one server iteration
1124		2247	$RUNTIME += $TICK;
1125	my $NOW = Event::time;
1126	$NEXT_TICK += $TICK;	2248	$NEXT_TICK += $TICK;
1127		2249
1128	# if we are delayed by four ticks or more, skip them all	2250	# if we are delayed by four ticks or more, skip them all
1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2251	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130		2252
1131	$TICK_WATCHER->at ($NEXT_TICK);	2253	$TICK_WATCHER->at ($NEXT_TICK);
1132	$TICK_WATCHER->start;	2254	$TICK_WATCHER->start;
1133	},	2255	},
1134	);	2256	);
1135		2257
1136	IO::AIO::max_poll_time $TICK * 0.2;	2258	IO::AIO::max_poll_time $TICK * 0.2;
1137		2259
		2260	Event->io (
1138	Event->io (fd => IO::AIO::poll_fileno,	2261	fd => IO::AIO::poll_fileno,
1139	poll => 'r',	2262	poll => 'r',
1140	prio => 5,	2263	prio => 5,
1141	data => WF_AUTOCANCEL,	2264	data => WF_AUTOCANCEL,
1142	cb => \&IO::AIO::poll_cb);	2265	cb => \&IO::AIO::poll_cb,
		2266	);
		2267
		2268	Event->timer (
		2269	data => WF_AUTOCANCEL,
		2270	after => 0,
		2271	interval => 10,
		2272	cb => sub {
		2273	(Coro::unblock_sub {
		2274	write_runtime
		2275	or warn "ERROR: unable to write runtime file: $!";
		2276	})->();
		2277	},
		2278	);
		2279
		2280	END { cf::emergency_save }
1143		2281
1144	1	2282	1
1145		2283

Diff Legend

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