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.83 by root, Mon Dec 11 01:30:41 2006 UTC vs.
Revision 1.157 by root, Wed Jan 10 01:16:54 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 Data::Dumper;
		21	use Digest::MD5;
		22	use Fcntl;
10	use IO::AIO ();	23	use IO::AIO 2.32 ();
11	use YAML::Syck ();	24	use YAML::Syck ();
12	use Time::HiRes;	25	use Time::HiRes;
13	use Event;	26
14	$Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		28
		29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		30
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	32	$YAML::Syck::ImplicitUnicode = 1;
18		33
19	use strict;	34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		35
21	_init_vars;
22
23	our %COMMAND = ();	36	our %COMMAND = ();
		37	our %COMMAND_TIME = ();
		38	our %EXTCMD = ();
		39
24	our @EVENT;	40	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	41	our $LIBDIR = datadir . "/ext";
26		42
27	our $TICK = MAX_TIME * 1e-6;	43	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	44	our $TICK_WATCHER;
29	our $NEXT_TICK;	45	our $NEXT_TICK;
		46	our $NOW;
30		47
31	our %CFG;	48	our %CFG;
32		49
33	our $uptime;#d#	50	our $UPTIME; $UPTIME ||= time;
34	our $UPTIME;	51	our $RUNTIME;
35	$UPTIME ||= $uptime;#d#	52
36	$UPTIME ||= time;	53	our %PLAYER; # all users
		54	our %MAP; # all maps
		55	our $LINK_MAP; # the special {link} map
		56	our $RANDOM_MAPS = cf::localdir . "/random";
		57	our %EXT_CORO; # coroutines bound to extensions
		58
		59	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		60	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		61
		62	binmode STDOUT;
		63	binmode STDERR;
		64
		65	# read virtual server time, if available
		66	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		67	open my $fh, "<", cf::localdir . "/runtime"
		68	or die "unable to read runtime file: $!";
		69	$RUNTIME = <$fh> + 0.;
		70	}
		71
		72	mkdir cf::localdir;
		73	mkdir cf::localdir . "/" . cf::playerdir;
		74	mkdir cf::localdir . "/" . cf::tmpdir;
		75	mkdir cf::localdir . "/" . cf::uniquedir;
		76	mkdir $RANDOM_MAPS;
		77
		78	# a special map that is always available
		79	our $LINK_MAP;
		80	our $EMERGENCY_POSITION;
37		81
38	#############################################################################	82	#############################################################################
39		83
40	=head2 GLOBAL VARIABLES	84	=head2 GLOBAL VARIABLES
41		85
42	=over 4	86	=over 4
43		87
44	=item $cf::UPTIME	88	=item $cf::UPTIME
45		89
46	The timestamp of the server start (so not actually an uptime).	90	The timestamp of the server start (so not actually an uptime).
		91
		92	=item $cf::RUNTIME
		93
		94	The time this server has run, starts at 0 and is increased by $cf::TICK on
		95	every server tick.
47		96
48	=item $cf::LIBDIR	97	=item $cf::LIBDIR
49		98
50	The perl library directory, where extensions and cf-specific modules can	99	The perl library directory, where extensions and cf-specific modules can
51	be found. It will be added to C<@INC> automatically.	100	be found. It will be added to C<@INC> automatically.
52		101
		102	=item $cf::NOW
		103
		104	The time of the last (current) server tick.
		105
53	=item $cf::TICK	106	=item $cf::TICK
54		107
55	The interval between server ticks, in seconds.	108	The interval between server ticks, in seconds.
56		109
57	=item %cf::CFG	110	=item %cf::CFG
58		111
59	Configuration for the server, loaded from C</etc/crossfire/config>, or	112	Configuration for the server, loaded from C</etc/crossfire/config>, or
60	from wherever your confdir points to.	113	from wherever your confdir points to.
		114
		115	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		116
		117	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		118	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		119	processing has been done. Call C<< ->wait >> on them to maximise the
		120	window of cpu time available, or simply to synchronise to the server tick.
61		121
62	=back	122	=back
63		123
64	=cut	124	=cut
65		125
66	BEGIN {	126	BEGIN {
67	*CORE::GLOBAL::warn = sub {	127	*CORE::GLOBAL::warn = sub {
68	my $msg = join "", @_;	128	my $msg = join "", @_;
		129	utf8::encode $msg;
		130
69	$msg .= "\n"	131	$msg .= "\n"
70	unless $msg =~ /\n$/;	132	unless $msg =~ /\n$/;
71		133
72	print STDERR "cfperl: $msg";
73	LOG llevError, "cfperl: $msg";	134	LOG llevError, $msg;
74	};	135	};
75	}	136	}
76		137
		138	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		139	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		140	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		141	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		142	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
77	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	143	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
78		144
79	# we bless all objects into (empty) derived classes to force a method lookup	145	# we bless all objects into (empty) derived classes to force a method lookup
80	# within the Safe compartment.	146	# within the Safe compartment.
81	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	147	for my $pkg (qw(
		148	cf::global cf::attachable
		149	cf::object cf::object::player
		150	cf::client cf::player
		151	cf::arch cf::living
		152	cf::map cf::party cf::region
		153	)) {
82	no strict 'refs';	154	no strict 'refs';
83	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	155	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	156	}
85		157
86	$Event::DIED = sub {	158	$Event::DIED = sub {
…		…
88	};	160	};
89		161
90	my %ext_pkg;	162	my %ext_pkg;
91	my @exts;	163	my @exts;
92	my @hook;	164	my @hook;
93	my %command;
94	my %extcmd;
95		165
96	=head2 UTILITY FUNCTIONS	166	=head2 UTILITY FUNCTIONS
97		167
98	=over 4	168	=over 4
99		169
		170	=item dumpval $ref
		171
100	=cut	172	=cut
		173
		174	sub dumpval {
		175	eval {
		176	local $SIG{__DIE__};
		177	my $d;
		178	if (1) {
		179	$d = new Data::Dumper([$_[0]], ["*var"]);
		180	$d->Terse(1);
		181	$d->Indent(2);
		182	$d->Quotekeys(0);
		183	$d->Useqq(1);
		184	#$d->Bless(...);
		185	$d->Seen($_[1]) if @_ > 1;
		186	$d = $d->Dump();
		187	}
		188	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		189	$d
		190	} || "[unable to dump $_[0]: '$@']";
		191	}
101		192
102	use JSON::Syck (); # TODO# replace by JSON::PC once working	193	use JSON::Syck (); # TODO# replace by JSON::PC once working
103		194
104	=item $ref = cf::from_json $json	195	=item $ref = cf::from_json $json
105		196
…		…
121	sub to_json($) {	212	sub to_json($) {
122	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	213	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
123	JSON::Syck::Dump $_[0]	214	JSON::Syck::Dump $_[0]
124	}	215	}
125		216
		217	=item cf::lock_wait $string
		218
		219	Wait until the given lock is available. See cf::lock_acquire.
		220
		221	=item my $lock = cf::lock_acquire $string
		222
		223	Wait until the given lock is available and then acquires it and returns
		224	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		225	for example when the coroutine gets canceled), the lock is automatically
		226	returned.
		227
		228	Lock names should begin with a unique identifier (for example, cf::map::find
		229	uses map_find and cf::map::load uses map_load).
		230
		231	=cut
		232
		233	our %LOCK;
		234
		235	sub lock_wait($) {
		236	my ($key) = @_;
		237
		238	# wait for lock, if any
		239	while ($LOCK{$key}) {
		240	push @{ $LOCK{$key} }, $Coro::current;
		241	Coro::schedule;
		242	}
		243	}
		244
		245	sub lock_acquire($) {
		246	my ($key) = @_;
		247
		248	# wait, to be sure we are not locked
		249	lock_wait $key;
		250
		251	$LOCK{$key} = [];
		252
		253	Coro::guard {
		254	# wake up all waiters, to be on the safe side
		255	$_->ready for @{ delete $LOCK{$key} };
		256	}
		257	}
		258
		259	sub freeze_mainloop {
		260	return unless $TICK_WATCHER->is_active;
		261
		262	my $guard = Coro::guard { $TICK_WATCHER->start };
		263	$TICK_WATCHER->stop;
		264	$guard
		265	}
		266
		267	=item cf::async { BLOCK }
		268
		269	Currently the same as Coro::async_pool, meaning you cannot use
		270	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		271	thing you are allowed to do is call C<prio> on it.
		272
		273	=cut
		274
		275	BEGIN { *async = \&Coro::async_pool }
		276
		277	=item cf::sync_job { BLOCK }
		278
		279	The design of crossfire+ requires that the main coro ($Coro::main) is
		280	always able to handle events or runnable, as crossfire+ is only partly
		281	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		282
		283	If it must be done, put the blocking parts into C<sync_job>. This will run
		284	the given BLOCK in another coroutine while waiting for the result. The
		285	server will be frozen during this time, so the block should either finish
		286	fast or be very important.
		287
		288	=cut
		289
		290	sub sync_job(&) {
		291	my ($job) = @_;
		292
		293	if ($Coro::current == $Coro::main) {
		294	# this is the main coro, too bad, we have to block
		295	# till the operation succeeds, freezing the server :/
		296
		297	# TODO: use suspend/resume instead
		298	# (but this is cancel-safe)
		299	my $freeze_guard = freeze_mainloop;
		300
		301	my $busy = 1;
		302	my @res;
		303
		304	(async {
		305	@res = eval { $job->() };
		306	warn $@ if $@;
		307	undef $busy;
		308	})->prio (Coro::PRIO_MAX);
		309
		310	while ($busy) {
		311	Coro::cede or Event::one_event;
		312	}
		313
		314	wantarray ? @res : $res[0]
		315	} else {
		316	# we are in another coroutine, how wonderful, everything just works
		317
		318	$job->()
		319	}
		320	}
		321
		322	=item $coro = cf::async_ext { BLOCK }
		323
		324	Like async, but this coro is automcatially being canceled when the
		325	extension calling this is being unloaded.
		326
		327	=cut
		328
		329	sub async_ext(&) {
		330	my $cb = shift;
		331
		332	my $coro = &Coro::async ($cb);
		333
		334	$coro->on_destroy (sub {
		335	delete $EXT_CORO{$coro+0};
		336	});
		337	$EXT_CORO{$coro+0} = $coro;
		338
		339	$coro
		340	}
		341
		342	sub write_runtime {
		343	my $runtime = cf::localdir . "/runtime";
		344
		345	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		346	or return;
		347
		348	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		349	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		350	and return;
		351
		352	aio_fsync $fh
		353	and return;
		354
		355	close $fh
		356	or return;
		357
		358	aio_rename "$runtime~", $runtime
		359	and return;
		360
		361	1
		362	}
		363
126	=back	364	=back
127		365
128	=cut	366	=cut
129		367
130	#############################################################################	368	#############################################################################
131		369
132	=head2 EVENTS AND OBJECT ATTACHMENTS	370	package cf::path;
		371
		372	# used to convert map paths into valid unix filenames by repalcing / by ∕
		373	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		374
		375	sub new {
		376	my ($class, $path, $base) = @_;
		377
		378	$path = $path->as_string if ref $path;
		379
		380	my $self = bless { }, $class;
		381
		382	# {... are special paths that are not touched
		383	# ?xxx/... are special absolute paths
		384	# ?random/... random maps
		385	# /! non-realised random map exit
		386	# /... normal maps
		387	# ~/... per-player maps without a specific player (DO NOT USE)
		388	# ~user/... per-player map of a specific user
		389
		390	if ($path =~ /^{/) {
		391	# fine as it is
		392	} elsif ($path =~ s{^\?random/}{}) {
		393	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		394	$self->{random} = cf::from_json $data;
		395	} else {
		396	if ($path =~ s{^~([^/]+)?}{}) {
		397	$self->{user_rel} = 1;
		398
		399	if (defined $1) {
		400	$self->{user} = $1;
		401	} elsif ($base =~ m{^~([^/]+)/}) {
		402	$self->{user} = $1;
		403	} else {
		404	warn "cannot resolve user-relative path without user <$path,$base>\n";
		405	}
		406	} elsif ($path =~ /^\//) {
		407	# already absolute
		408	} else {
		409	$base =~ s{[^/]+/?$}{};
		410	return $class->new ("$base/$path");
		411	}
		412
		413	for ($path) {
		414	redo if s{/\.?/}{/};
		415	redo if s{/[^/]+/\.\./}{/};
		416	}
		417	}
		418
		419	$self->{path} = $path;
		420
		421	$self
		422	}
		423
		424	# the name / primary key / in-game path
		425	sub as_string {
		426	my ($self) = @_;
		427
		428	$self->{user_rel} ? "~$self->{user}$self->{path}"
		429	: $self->{random} ? "?random/$self->{path}"
		430	: $self->{path}
		431	}
		432
		433	# the displayed name, this is a one way mapping
		434	sub visible_name {
		435	my ($self) = @_;
		436
		437	# if (my $rmp = $self->{random}) {
		438	# # todo: be more intelligent about this
		439	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		440	# } else {
		441	$self->as_string
		442	# }
		443	}
		444
		445	# escape the /'s in the path
		446	sub _escaped_path {
		447	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		448	$path
		449	}
		450
		451	# the original (read-only) location
		452	sub load_path {
		453	my ($self) = @_;
		454
		455	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		456	}
		457
		458	# the temporary/swap location
		459	sub save_path {
		460	my ($self) = @_;
		461
		462	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		463	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		464	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		465	}
		466
		467	# the unique path, might be eq to save_path
		468	sub uniq_path {
		469	my ($self) = @_;
		470
		471	$self->{user_rel} || $self->{random}
		472	? undef
		473	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		474	}
		475
		476	# return random map parameters, or undef
		477	sub random_map_params {
		478	my ($self) = @_;
		479
		480	$self->{random}
		481	}
		482
		483	# this is somewhat ugly, but style maps do need special treatment
		484	sub is_style_map {
		485	$_[0]{path} =~ m{^/styles/}
		486	}
		487
		488	package cf;
		489
		490	#############################################################################
		491
		492	=head2 ATTACHABLE OBJECTS
		493
		494	Many objects in crossfire are so-called attachable objects. That means you can
		495	attach callbacks/event handlers (a collection of which is called an "attachment")
		496	to it. All such attachable objects support the following methods.
		497
		498	In the following description, CLASS can be any of C<global>, C<object>
		499	C<player>, C<client> or C<map> (i.e. the attachable objects in
		500	crossfire+).
133		501
134	=over 4	502	=over 4
135		503
136	=item $object->attach ($attachment, key => $value...)
137
138	=item $object->detach ($attachment)
139
140	Attach/detach a pre-registered attachment to an object.
141
142	=item $player->attach ($attachment, key => $value...)
143
144	=item $player->detach ($attachment)
145
146	Attach/detach a pre-registered attachment to a player.
147
148	=item $map->attach ($attachment, key => $value...)	504	=item $attachable->attach ($attachment, key => $value...)
149		505
150	=item $map->detach ($attachment)	506	=item $attachable->detach ($attachment)
151		507
152	Attach/detach a pre-registered attachment to a map.	508	Attach/detach a pre-registered attachment to a specific object and give it
		509	the specified key/value pairs as arguments.
153		510
154	=item $bool = $object->attached ($name)	511	Example, attach a minesweeper attachment to the given object, making it a
		512	10x10 minesweeper game:
155		513
156	=item $bool = $player->attached ($name)	514	$obj->attach (minesweeper => width => 10, height => 10);
157		515
158	=item $bool = $map->attached ($name)	516	=item $bool = $attachable->attached ($name)
159		517
160	Checks wether the named attachment is currently attached to the object.	518	Checks wether the named attachment is currently attached to the object.
161		519
162	=item cf::attach_global ...	520	=item cf::CLASS->attach ...
163		521
164	Attach handlers for global events.	522	=item cf::CLASS->detach ...
165		523
166	This and all following C<attach_*>-functions expect any number of the	524	Define an anonymous attachment and attach it to all objects of the given
167	following handler/hook descriptions:	525	CLASS. See the next function for an explanation of its arguments.
		526
		527	You can attach to global events by using the C<cf::global> class.
		528
		529	Example, log all player logins:
		530
		531	cf::player->attach (
		532	on_login => sub {
		533	my ($pl) = @_;
		534	...
		535	},
		536	);
		537
		538	Example, attach to the jeweler skill:
		539
		540	cf::object->attach (
		541	type => cf::SKILL,
		542	subtype => cf::SK_JEWELER,
		543	on_use_skill => sub {
		544	my ($sk, $ob, $part, $dir, $msg) = @_;
		545	...
		546	},
		547	);
		548
		549	=item cf::CLASS::attachment $name, ...
		550
		551	Register an attachment by C<$name> through which attachable objects of the
		552	given CLASS can refer to this attachment.
		553
		554	Some classes such as crossfire maps and objects can specify attachments
		555	that are attached at load/instantiate time, thus the need for a name.
		556
		557	These calls expect any number of the following handler/hook descriptions:
168		558
169	=over 4	559	=over 4
170		560
171	=item prio => $number	561	=item prio => $number
172		562
…		…
174	by another C<prio> setting). Lower priority handlers get executed	564	by another C<prio> setting). Lower priority handlers get executed
175	earlier. The default priority is C<0>, and many built-in handlers are	565	earlier. The default priority is C<0>, and many built-in handlers are
176	registered at priority C<-1000>, so lower priorities should not be used	566	registered at priority C<-1000>, so lower priorities should not be used
177	unless you know what you are doing.	567	unless you know what you are doing.
178		568
		569	=item type => $type
		570
		571	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		572	given type of objects only (the additional parameter C<subtype> can be
		573	used to further limit to the given subtype).
		574
179	=item on_I<event> => \&cb	575	=item on_I<event> => \&cb
180		576
181	Call the given code reference whenever the named event happens (event is	577	Call the given code reference whenever the named event happens (event is
182	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	578	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
183	handlers are recognised generally depends on the type of object these	579	handlers are recognised generally depends on the type of object these
…		…
192	package and register them. Only handlers for eevents supported by the	588	package and register them. Only handlers for eevents supported by the
193	object/class are recognised.	589	object/class are recognised.
194		590
195	=back	591	=back
196		592
197	=item cf::attach_to_type $object_type, $subtype, ...	593	Example, define an attachment called "sockpuppet" that calls the given
		594	event handler when a monster attacks:
198		595
199	Attach handlers for a specific object type (e.g. TRANSPORT) and	596	cf::object::attachment sockpuppet =>
200	subtype. If C<$subtype> is zero or undef, matches all objects of the given	597	on_skill_attack => sub {
201	type.	598	my ($self, $victim) = @_;
202		599	...
203	=item cf::attach_to_objects ...
204
205	Attach handlers to all objects. Do not use this except for debugging or
206	very rare events, as handlers are (obviously) called for I<all> objects in
207	the game.
208
209	=item cf::attach_to_players ...
210
211	Attach handlers to all players.
212
213	=item cf::attach_to_maps ...
214
215	Attach handlers to all maps.
216
217	=item cf:register_attachment $name, ...
218
219	Register an attachment by name through which objects can refer to this
220	attachment.
221
222	=item cf:register_player_attachment $name, ...
223
224	Register an attachment by name through which players can refer to this
225	attachment.
226
227	=item cf:register_map_attachment $name, ...
228
229	Register an attachment by name through which maps can refer to this
230	attachment.
231
232	=cut
233
234	# the following variables are defined in .xs and must not be re-created
235	our @CB_GLOBAL = (); # registry for all global events
236	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
237	our @CB_PLAYER = ();
238	our @CB_TYPE = (); # registry for type (cf-object class) based events
239	our @CB_MAP = ();
240
241	my %attachment;
242
243	sub _attach_cb($\%$$$) {
244	my ($registry, $undo, $event, $prio, $cb) = @_;
245
246	use sort 'stable';
247
248	$cb = [$prio, $cb];
249
250	@{$registry->[$event]} = sort
251	{ $a->[0] cmp $b->[0] }
252	@{$registry->[$event] || []}, $cb;
253
254	push @{$undo->{cb}}, [$event, $cb];
255	}
256
257	# attach handles attaching event callbacks
258	# the only thing the caller has to do is pass the correct
259	# registry (== where the callback attaches to).
260	sub _attach(\@$@) {
261	my ($registry, $klass, @arg) = @_;
262
263	my $prio = 0;
264
265	my %undo = (
266	registry => $registry,
267	cb => [],
268	);
269
270	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
271
272	while (@arg) {
273	my $type = shift @arg;
274
275	if ($type eq "prio") {
276	$prio = shift @arg;
277
278	} elsif ($type eq "package") {
279	my $pkg = shift @arg;
280
281	while (my ($name, $id) = each %cb_id) {
282	if (my $cb = $pkg->can ($name)) {
283	_attach_cb $registry, %undo, $id, $prio, $cb;
284	}
285	}	600	}
286
287	} elsif (exists $cb_id{$type}) {
288	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
289
290	} elsif (ref $type) {
291	warn "attaching objects not supported, ignoring.\n";
292
293	} else {
294	shift @arg;
295	warn "attach argument '$type' not supported, ignoring.\n";
296	}
297	}
298
299	\%undo
300	}
301
302	sub _attach_attachment {
303	my ($obj, $name, %arg) = @_;
304
305	return if exists $obj->{_attachment}{$name};
306
307	my $res;
308
309	if (my $attach = $attachment{$name}) {
310	my $registry = $obj->registry;
311
312	for (@$attach) {
313	my ($klass, @attach) = @$_;
314	$res = _attach @$registry, $klass, @attach;
315	}
316
317	$obj->{$name} = \%arg;
318	} else {
319	warn "object uses attachment '$name' that is not available, postponing.\n";
320	}
321
322	$obj->{_attachment}{$name} = undef;
323
324	$res->{attachment} = $name;
325	$res
326	}
327
328	*cf::object::attach =
329	*cf::player::attach =
330	*cf::map::attach = sub {
331	my ($obj, $name, %arg) = @_;
332
333	_attach_attachment $obj, $name, %arg;
334	};
335
336	# all those should be optimised
337	*cf::object::detach =
338	*cf::player::detach =
339	*cf::map::detach = sub {
340	my ($obj, $name) = @_;
341
342	delete $obj->{_attachment}{$name};
343	reattach ($obj);
344	};
345
346	*cf::object::attached =
347	*cf::player::attached =
348	*cf::map::attached = sub {
349	my ($obj, $name) = @_;
350
351	exists $obj->{_attachment}{$name}
352	};
353
354	sub attach_global {
355	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
356	}
357
358	sub attach_to_type {
359	my $type = shift;
360	my $subtype = shift;
361
362	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
363	}
364
365	sub attach_to_objects {
366	_attach @CB_OBJECT, KLASS_OBJECT, @_
367	}
368
369	sub attach_to_players {
370	_attach @CB_PLAYER, KLASS_PLAYER, @_
371	}
372
373	sub attach_to_maps {
374	_attach @CB_MAP, KLASS_MAP, @_
375	}
376
377	sub register_attachment {
378	my $name = shift;
379
380	$attachment{$name} = [[KLASS_OBJECT, @_]];
381	}
382
383	sub register_player_attachment {
384	my $name = shift;
385
386	$attachment{$name} = [[KLASS_PLAYER, @_]];
387	}
388
389	sub register_map_attachment {
390	my $name = shift;
391
392	$attachment{$name} = [[KLASS_MAP, @_]];
393	}
394
395	our $override;
396	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
397
398	sub override {
399	$override = 1;
400	@invoke_results = ();
401	}
402
403	sub do_invoke {
404	my $event = shift;
405	my $callbacks = shift;
406
407	@invoke_results = ();
408
409	local $override;
410
411	for (@$callbacks) {
412	eval { &{$_->[1]} };
413
414	if ($@) {
415	warn "$@";
416	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
417	override;
418	}
419
420	return 1 if $override;
421	}
422
423	0	601	}
424	}
425		602
426	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	603	=item $attachable->valid
427
428	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
429
430	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
431
432	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
433
434	Generate a global/object/player/map-specific event with the given arguments.
435
436	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
437	removed in future versions), and there is no public API to access override
438	results (if you must, access C<@cf::invoke_results> directly).
439
440	=back
441
442	=cut
443
444	#############################################################################
445
446	=head2 METHODS VALID FOR ALL CORE OBJECTS
447
448	=over 4
449
450	=item $object->valid, $player->valid, $map->valid
451		604
452	Just because you have a perl object does not mean that the corresponding	605	Just because you have a perl object does not mean that the corresponding
453	C-level object still exists. If you try to access an object that has no	606	C-level object still exists. If you try to access an object that has no
454	valid C counterpart anymore you get an exception at runtime. This method	607	valid C counterpart anymore you get an exception at runtime. This method
455	can be used to test for existence of the C object part without causing an	608	can be used to test for existence of the C object part without causing an
456	exception.	609	exception.
457		610
		611	=cut
		612
		613	# the following variables are defined in .xs and must not be re-created
		614	our @CB_GLOBAL = (); # registry for all global events
		615	our @CB_ATTACHABLE = (); # registry for all attachables
		616	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		617	our @CB_PLAYER = ();
		618	our @CB_CLIENT = ();
		619	our @CB_TYPE = (); # registry for type (cf-object class) based events
		620	our @CB_MAP = ();
		621
		622	my %attachment;
		623
		624	sub _attach_cb($$$$) {
		625	my ($registry, $event, $prio, $cb) = @_;
		626
		627	use sort 'stable';
		628
		629	$cb = [$prio, $cb];
		630
		631	@{$registry->[$event]} = sort
		632	{ $a->[0] cmp $b->[0] }
		633	@{$registry->[$event] || []}, $cb;
		634	}
		635
		636	# hack
		637	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		638
		639	# attach handles attaching event callbacks
		640	# the only thing the caller has to do is pass the correct
		641	# registry (== where the callback attaches to).
		642	sub _attach {
		643	my ($registry, $klass, @arg) = @_;
		644
		645	my $object_type;
		646	my $prio = 0;
		647	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		648
		649	#TODO: get rid of this hack
		650	if ($attachable_klass{$klass}) {
		651	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		652	}
		653
		654	while (@arg) {
		655	my $type = shift @arg;
		656
		657	if ($type eq "prio") {
		658	$prio = shift @arg;
		659
		660	} elsif ($type eq "type") {
		661	$object_type = shift @arg;
		662	$registry = $CB_TYPE[$object_type] ||= [];
		663
		664	} elsif ($type eq "subtype") {
		665	defined $object_type or Carp::croak "subtype specified without type";
		666	my $object_subtype = shift @arg;
		667	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		668
		669	} elsif ($type eq "package") {
		670	my $pkg = shift @arg;
		671
		672	while (my ($name, $id) = each %cb_id) {
		673	if (my $cb = $pkg->can ($name)) {
		674	_attach_cb $registry, $id, $prio, $cb;
		675	}
		676	}
		677
		678	} elsif (exists $cb_id{$type}) {
		679	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		680
		681	} elsif (ref $type) {
		682	warn "attaching objects not supported, ignoring.\n";
		683
		684	} else {
		685	shift @arg;
		686	warn "attach argument '$type' not supported, ignoring.\n";
		687	}
		688	}
		689	}
		690
		691	sub _object_attach {
		692	my ($obj, $name, %arg) = @_;
		693
		694	return if exists $obj->{_attachment}{$name};
		695
		696	if (my $attach = $attachment{$name}) {
		697	my $registry = $obj->registry;
		698
		699	for (@$attach) {
		700	my ($klass, @attach) = @$_;
		701	_attach $registry, $klass, @attach;
		702	}
		703
		704	$obj->{$name} = \%arg;
		705	} else {
		706	warn "object uses attachment '$name' that is not available, postponing.\n";
		707	}
		708
		709	$obj->{_attachment}{$name} = undef;
		710	}
		711
		712	sub cf::attachable::attach {
		713	if (ref $_[0]) {
		714	_object_attach @_;
		715	} else {
		716	_attach shift->_attach_registry, @_;
		717	}
		718	};
		719
		720	# all those should be optimised
		721	sub cf::attachable::detach {
		722	my ($obj, $name) = @_;
		723
		724	if (ref $obj) {
		725	delete $obj->{_attachment}{$name};
		726	reattach ($obj);
		727	} else {
		728	Carp::croak "cannot, currently, detach class attachments";
		729	}
		730	};
		731
		732	sub cf::attachable::attached {
		733	my ($obj, $name) = @_;
		734
		735	exists $obj->{_attachment}{$name}
		736	}
		737
		738	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		739	eval "#line " . __LINE__ . " 'cf.pm'
		740	sub cf::\L$klass\E::_attach_registry {
		741	(\\\@CB_$klass, KLASS_$klass)
		742	}
		743
		744	sub cf::\L$klass\E::attachment {
		745	my \$name = shift;
		746
		747	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		748	}
		749	";
		750	die if $@;
		751	}
		752
		753	our $override;
		754	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		755
		756	sub override {
		757	$override = 1;
		758	@invoke_results = ();
		759	}
		760
		761	sub do_invoke {
		762	my $event = shift;
		763	my $callbacks = shift;
		764
		765	@invoke_results = ();
		766
		767	local $override;
		768
		769	for (@$callbacks) {
		770	eval { &{$_->[1]} };
		771
		772	if ($@) {
		773	warn "$@";
		774	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		775	override;
		776	}
		777
		778	return 1 if $override;
		779	}
		780
		781	0
		782	}
		783
		784	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		785
		786	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		787
		788	Generate an object-specific event with the given arguments.
		789
		790	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		791	removed in future versions), and there is no public API to access override
		792	results (if you must, access C<@cf::invoke_results> directly).
		793
458	=back	794	=back
459		795
460	=cut	796	=cut
461
462	*cf::object::valid =
463	*cf::player::valid =
464	*cf::map::valid = \&cf::_valid;
465		797
466	#############################################################################	798	#############################################################################
467	# object support	799	# object support
468		800
469	sub instantiate {
470	my ($obj, $data) = @_;
471
472	$data = from_json $data;
473
474	for (@$data) {
475	my ($name, $args) = @$_;
476
477	$obj->attach ($name, %{$args || {} });
478	}
479	}
480
481	# basically do the same as instantiate, without calling instantiate
482	sub reattach {	801	sub reattach {
		802	# basically do the same as instantiate, without calling instantiate
483	my ($obj) = @_;	803	my ($obj) = @_;
		804
484	my $registry = $obj->registry;	805	my $registry = $obj->registry;
485		806
486	@$registry = ();	807	@$registry = ();
487		808
488	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	809	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
489		810
490	for my $name (keys %{ $obj->{_attachment} || {} }) {	811	for my $name (keys %{ $obj->{_attachment} || {} }) {
491	if (my $attach = $attachment{$name}) {	812	if (my $attach = $attachment{$name}) {
492	for (@$attach) {	813	for (@$attach) {
493	my ($klass, @attach) = @$_;	814	my ($klass, @attach) = @$_;
494	_attach @$registry, $klass, @attach;	815	_attach $registry, $klass, @attach;
495	}	816	}
496	} else {	817	} else {
497	warn "object uses attachment '$name' that is not available, postponing.\n";	818	warn "object uses attachment '$name' that is not available, postponing.\n";
498	}	819	}
499	}	820	}
500	}	821	}
501		822
502	sub object_freezer_save {	823	cf::attachable->attach (
503	my ($filename, $rdata, $objs) = @_;
504
505	if (length $$rdata) {
506	warn sprintf "saving %s (%d,%d)\n",
507	$filename, length $$rdata, scalar @$objs;
508
509	if (open my $fh, ">:raw", "$filename~") {
510	chmod SAVE_MODE, $fh;
511	syswrite $fh, $$rdata;
512	close $fh;
513
514	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
515	chmod SAVE_MODE, $fh;
516	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
517	close $fh;
518	rename "$filename.pst~", "$filename.pst";
519	} else {
520	unlink "$filename.pst";
521	}
522
523	rename "$filename~", $filename;
524	} else {
525	warn "FATAL: $filename~: $!\n";
526	}
527	} else {
528	unlink $filename;
529	unlink "$filename.pst";
530	}
531	}
532
533	sub object_freezer_as_string {
534	my ($rdata, $objs) = @_;
535
536	use Data::Dumper;
537
538	$$rdata . Dumper $objs
539	}
540
541	sub object_thawer_load {
542	my ($filename) = @_;
543
544	local $/;
545
546	my $av;
547
548	#TODO: use sysread etc.
549	if (open my $data, "<:raw:perlio", $filename) {
550	$data = <$data>;
551	if (open my $pst, "<:raw:perlio", "$filename.pst") {
552	$av = eval { (Storable::thaw <$pst>)->{objs} };
553	}
554	return ($data, $av);
555	}
556
557	()
558	}
559
560	attach_to_objects
561	prio => -1000000,	824	prio => -1000000,
		825	on_instantiate => sub {
		826	my ($obj, $data) = @_;
		827
		828	$data = from_json $data;
		829
		830	for (@$data) {
		831	my ($name, $args) = @$_;
		832
		833	$obj->attach ($name, %{$args || {} });
		834	}
		835	},
		836	on_reattach => \&reattach,
562	on_clone => sub {	837	on_clone => sub {
563	my ($src, $dst) = @_;	838	my ($src, $dst) = @_;
564		839
565	@{$dst->registry} = @{$src->registry};	840	@{$dst->registry} = @{$src->registry};
566		841
567	%$dst = %$src;	842	%$dst = %$src;
568		843
569	%{$dst->{_attachment}} = %{$src->{_attachment}}	844	%{$dst->{_attachment}} = %{$src->{_attachment}}
570	if exists $src->{_attachment};	845	if exists $src->{_attachment};
571	},	846	},
572	;	847	);
		848
		849	sub object_freezer_save {
		850	my ($filename, $rdata, $objs) = @_;
		851
		852	sync_job {
		853	if (length $$rdata) {
		854	warn sprintf "saving %s (%d,%d)\n",
		855	$filename, length $$rdata, scalar @$objs;
		856
		857	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		858	chmod SAVE_MODE, $fh;
		859	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		860	aio_fsync $fh;
		861	close $fh;
		862
		863	if (@$objs) {
		864	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		865	chmod SAVE_MODE, $fh;
		866	my $data = Storable::nfreeze { version => 1, objs => $objs };
		867	aio_write $fh, 0, (length $data), $data, 0;
		868	aio_fsync $fh;
		869	close $fh;
		870	aio_rename "$filename.pst~", "$filename.pst";
		871	}
		872	} else {
		873	aio_unlink "$filename.pst";
		874	}
		875
		876	aio_rename "$filename~", $filename;
		877	} else {
		878	warn "FATAL: $filename~: $!\n";
		879	}
		880	} else {
		881	aio_unlink $filename;
		882	aio_unlink "$filename.pst";
		883	}
		884	}
		885	}
		886
		887	sub object_freezer_as_string {
		888	my ($rdata, $objs) = @_;
		889
		890	use Data::Dumper;
		891
		892	$$rdata . Dumper $objs
		893	}
		894
		895	sub object_thawer_load {
		896	my ($filename) = @_;
		897
		898	my ($data, $av);
		899
		900	(aio_load $filename, $data) >= 0
		901	or return;
		902
		903	unless (aio_stat "$filename.pst") {
		904	(aio_load "$filename.pst", $av) >= 0
		905	or return;
		906	$av = eval { (Storable::thaw $av)->{objs} };
		907	}
		908
		909	warn sprintf "loading %s (%d)\n",
		910	$filename, length $data, scalar @{$av || []};#d#
		911	return ($data, $av);
		912	}
573		913
574	#############################################################################	914	#############################################################################
575	# old plug-in events	915	# command handling &c
576		916
577	sub inject_event {	917	=item cf::register_command $name => \&callback($ob,$args);
578	my $extension = shift;
579	my $event_code = shift;
580		918
581	my $cb = $hook[$event_code]{$extension}	919	Register a callback for execution when the client sends the user command
582	or return;	920	$name.
583		921
584	&$cb	922	=cut
585	}
586
587	sub inject_global_event {
588	my $event = shift;
589
590	my $cb = $hook[$event]
591	or return;
592
593	List::Util::max map &$_, values %$cb
594	}
595
596	sub inject_command {
597	my ($name, $obj, $params) = @_;
598
599	for my $cmd (@{ $command{$name} }) {
600	$cmd->[1]->($obj, $params);
601	}
602
603	-1
604	}
605		923
606	sub register_command {	924	sub register_command {
607	my ($name, $time, $cb) = @_;	925	my ($name, $cb) = @_;
608		926
609	my $caller = caller;	927	my $caller = caller;
610	#warn "registering command '$name/$time' to '$caller'";	928	#warn "registering command '$name/$time' to '$caller'";
611		929
612	push @{ $command{$name} }, [$time, $cb, $caller];	930	push @{ $COMMAND{$name} }, [$caller, $cb];
613	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
614	}	931	}
		932
		933	=item cf::register_extcmd $name => \&callback($pl,$packet);
		934
		935	Register a callbackf ro execution when the client sends an extcmd packet.
		936
		937	If the callback returns something, it is sent back as if reply was being
		938	called.
		939
		940	=cut
615		941
616	sub register_extcmd {	942	sub register_extcmd {
617	my ($name, $cb) = @_;	943	my ($name, $cb) = @_;
618		944
619	my $caller = caller;	945	my $caller = caller;
620	#warn "registering extcmd '$name' to '$caller'";	946	#warn "registering extcmd '$name' to '$caller'";
621		947
622	$extcmd{$name} = [$cb, $caller];	948	$EXTCMD{$name} = [$cb, $caller];
623	}	949	}
		950
		951	cf::player->attach (
		952	on_command => sub {
		953	my ($pl, $name, $params) = @_;
		954
		955	my $cb = $COMMAND{$name}
		956	or return;
		957
		958	for my $cmd (@$cb) {
		959	$cmd->[1]->($pl->ob, $params);
		960	}
		961
		962	cf::override;
		963	},
		964	on_extcmd => sub {
		965	my ($pl, $buf) = @_;
		966
		967	my $msg = eval { from_json $buf };
		968
		969	if (ref $msg) {
		970	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		971	if (my %reply = $cb->[0]->($pl, $msg)) {
		972	$pl->ext_reply ($msg->{msgid}, %reply);
		973	}
		974	}
		975	} else {
		976	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		977	}
		978
		979	cf::override;
		980	},
		981	);
624		982
625	sub register {	983	sub register {
626	my ($base, $pkg) = @_;	984	my ($base, $pkg) = @_;
627		985
628	#TODO	986	#TODO
…		…
671	# for my $idx (0 .. $#PLUGIN_EVENT) {	1029	# for my $idx (0 .. $#PLUGIN_EVENT) {
672	# delete $hook[$idx]{$pkg};	1030	# delete $hook[$idx]{$pkg};
673	# }	1031	# }
674		1032
675	# remove commands	1033	# remove commands
676	for my $name (keys %command) {	1034	for my $name (keys %COMMAND) {
677	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	1035	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
678		1036
679	if (@cb) {	1037	if (@cb) {
680	$command{$name} = \@cb;	1038	$COMMAND{$name} = \@cb;
681	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
682	} else {	1039	} else {
683	delete $command{$name};
684	delete $COMMAND{"$name\000"};	1040	delete $COMMAND{$name};
685	}	1041	}
686	}	1042	}
687		1043
688	# remove extcmds	1044	# remove extcmds
689	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1045	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
690	delete $extcmd{$name};	1046	delete $EXTCMD{$name};
691	}	1047	}
692		1048
693	if (my $cb = $pkg->can ("unload")) {	1049	if (my $cb = $pkg->can ("unload")) {
694	eval {	1050	eval {
695	$cb->($pkg);	1051	$cb->($pkg);
…		…
699		1055
700	Symbol::delete_package $pkg;	1056	Symbol::delete_package $pkg;
701	}	1057	}
702		1058
703	sub load_extensions {	1059	sub load_extensions {
704	my $LIBDIR = maps_directory "perl";
705
706	for my $ext (<$LIBDIR/*.ext>) {	1060	for my $ext (<$LIBDIR/*.ext>) {
707	next unless -r $ext;	1061	next unless -r $ext;
708	eval {	1062	eval {
709	load_extension $ext;	1063	load_extension $ext;
710	1	1064	1
711	} or warn "$ext not loaded: $@";	1065	} or warn "$ext not loaded: $@";
712	}	1066	}
713	}	1067	}
714		1068
715	#############################################################################	1069	#############################################################################
716	# extcmd framework, basically convert ext <msg>
717	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
718
719	attach_to_players
720	on_extcmd => sub {
721	my ($pl, $buf) = @_;
722
723	my $msg = eval { from_json $buf };
724
725	if (ref $msg) {
726	if (my $cb = $extcmd{$msg->{msgtype}}) {
727	if (my %reply = $cb->[0]->($pl, $msg)) {
728	$pl->ext_reply ($msg->{msgid}, %reply);
729	}
730	}
731	} else {
732	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
733	}
734
735	cf::override;
736	},
737	;
738
739	#############################################################################
740	# load/save/clean perl data associated with a map	1070	# load/save/clean perl data associated with a map
741		1071
742	*cf::mapsupport::on_clean = sub {	1072	*cf::mapsupport::on_clean = sub {
743	my ($map) = @_;	1073	my ($map) = @_;
744		1074
…		…
746	defined $path or return;	1076	defined $path or return;
747		1077
748	unlink "$path.pst";	1078	unlink "$path.pst";
749	};	1079	};
750		1080
751	attach_to_maps prio => -10000, package => cf::mapsupport::;	1081	cf::map->attach (prio => -10000, package => cf::mapsupport::);
752		1082
753	#############################################################################	1083	#############################################################################
754	# load/save perl data associated with player->ob objects
755		1084
756	sub all_objects(@) {	1085	=head2 CORE EXTENSIONS
757	@_, map all_objects ($_->inv), @_
758	}
759		1086
760	# TODO: compatibility cruft, remove when no longer needed	1087	Functions and methods that extend core crossfire objects.
761	attach_to_players	1088
762	on_load => sub {	1089	=cut
		1090
		1091	package cf::player;
		1092
		1093	use Coro::AIO;
		1094
		1095	=head3 cf::player
		1096
		1097	=over 4
		1098
		1099	=item cf::player::find $login
		1100
		1101	Returns the given player object, loading it if necessary (might block).
		1102
		1103	=cut
		1104
		1105	sub playerdir($) {
		1106	cf::localdir
		1107	. "/"
		1108	. cf::playerdir
		1109	. "/"
		1110	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1111	}
		1112
		1113	sub path($) {
		1114	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1115
		1116	(playerdir $login) . "/$login.pl"
		1117	}
		1118
		1119	sub find_active($) {
		1120	$cf::PLAYER{$_[0]}
		1121	and $cf::PLAYER{$_[0]}->active
		1122	and $cf::PLAYER{$_[0]}
		1123	}
		1124
		1125	sub exists($) {
		1126	my ($login) = @_;
		1127
		1128	$cf::PLAYER{$login}
		1129	or cf::sync_job { !aio_stat $login }
		1130	}
		1131
		1132	sub find($) {
		1133	return $cf::PLAYER{$_[0]} || do {
		1134	my $login = $_[0];
		1135
		1136	my $guard = cf::lock_acquire "user_find:$login";
		1137
		1138	$cf::PLAYER{$_[0]} || do {
		1139	my $pl = load_pl path $login
		1140	or return;
		1141	$cf::PLAYER{$login} = $pl
		1142	}
		1143	}
		1144	}
		1145
		1146	sub save($) {
		1147	my ($pl) = @_;
		1148
		1149	return if $pl->{deny_save};
		1150
		1151	my $path = path $pl;
		1152	my $guard = cf::lock_acquire "user_save:$path";
		1153
		1154	return if $pl->{deny_save};
		1155
		1156	aio_mkdir playerdir $pl, 0770;
		1157	$pl->{last_save} = $cf::RUNTIME;
		1158
		1159	$pl->save_pl ($path);
		1160	Coro::cede;
		1161	}
		1162
		1163	sub new($) {
		1164	my ($login) = @_;
		1165
		1166	my $self = create;
		1167
		1168	$self->ob->name ($login);
		1169	$self->{deny_save} = 1;
		1170
		1171	$cf::PLAYER{$login} = $self;
		1172
		1173	$self
		1174	}
		1175
		1176	=item $pl->quit_character
		1177
		1178	Nukes the player without looking back. If logged in, the connection will
		1179	be destroyed. May block for a long time.
		1180
		1181	=cut
		1182
		1183	sub quit_character {
		1184	my ($pl) = @_;
		1185
		1186	$pl->{deny_save} = 1;
		1187	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1188
		1189	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1190	$pl->deactivate;
		1191	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1192	$pl->ns->destroy if $pl->ns;
		1193
		1194	my $path = playerdir $pl;
		1195	my $temp = "$path~$cf::RUNTIME~deleting~";
		1196	aio_rename $path, $temp;
		1197	delete $cf::PLAYER{$pl->ob->name};
		1198	$pl->destroy;
		1199	IO::AIO::aio_rmtree $temp;
		1200	}
		1201
		1202	=item cf::player::list_logins
		1203
		1204	Returns am arrayref of all valid playernames in the system, can take a
		1205	while and may block, so not sync_job-capable, ever.
		1206
		1207	=cut
		1208
		1209	sub list_logins {
		1210	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1211	or return [];
		1212
		1213	my @logins;
		1214
		1215	for my $login (@$dirs) {
		1216	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1217	aio_read $fh, 0, 512, my $buf, 0 or next;
		1218	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1219
		1220	utf8::decode $login;
		1221	push @logins, $login;
		1222	}
		1223
		1224	\@logins
		1225	}
		1226
		1227	=item $player->maps
		1228
		1229	Returns an arrayref of cf::path's of all maps that are private for this
		1230	player. May block.
		1231
		1232	=cut
		1233
		1234	sub maps($) {
		1235	my ($pl) = @_;
		1236
		1237	my $files = aio_readdir playerdir $pl
		1238	or return;
		1239
		1240	my @paths;
		1241
		1242	for (@$files) {
		1243	utf8::decode $_;
		1244	next if /\.(?:pl|pst)$/;
		1245	next unless /^$PATH_SEP/;
		1246
		1247	s/$PATH_SEP/\//g;
		1248	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
		1249	}
		1250
		1251	\@paths
		1252	}
		1253
		1254	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1255
		1256	Sends an ext reply to the player.
		1257
		1258	=cut
		1259
		1260	sub ext_reply($$$%) {
		1261	my ($self, $id, %msg) = @_;
		1262
		1263	$msg{msgid} = $id;
		1264
		1265	$self->send ("ext " . cf::to_json \%msg);
		1266	}
		1267
		1268	package cf;
		1269
		1270	=back
		1271
		1272
		1273	=head3 cf::map
		1274
		1275	=over 4
		1276
		1277	=cut
		1278
		1279	package cf::map;
		1280
		1281	use Fcntl;
		1282	use Coro::AIO;
		1283
		1284	our $MAX_RESET = 3600;
		1285	our $DEFAULT_RESET = 3000;
		1286
		1287	sub generate_random_map {
		1288	my ($path, $rmp) = @_;
		1289
		1290	# mit "rum" bekleckern, nicht
		1291	cf::map::_create_random_map
		1292	$path,
		1293	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1294	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1295	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1296	$rmp->{exit_on_final_map},
		1297	$rmp->{xsize}, $rmp->{ysize},
		1298	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1299	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1300	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1301	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1302	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1303	(cf::region::find $rmp->{region})
		1304	}
		1305
		1306	# and all this just because we cannot iterate over
		1307	# all maps in C++...
		1308	sub change_all_map_light {
		1309	my ($change) = @_;
		1310
		1311	$_->change_map_light ($change)
		1312	for grep $_->outdoor, values %cf::MAP;
		1313	}
		1314
		1315	sub try_load_header($) {
763	my ($pl, $path) = @_;	1316	my ($path) = @_;
764		1317
765	for my $o (all_objects $pl->ob) {	1318	utf8::encode $path;
766	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1319	aio_open $path, O_RDONLY, 0
767	$o->set_ob_key_value ("_perl_data");	1320	or return;
768		1321
769	%$o = %{ Storable::thaw pack "H*", $value };	1322	my $map = cf::map::new
		1323	or return;
		1324
		1325	# for better error messages only, will be overwritten
		1326	$map->path ($path);
		1327
		1328	$map->load_header ($path)
		1329	or return;
		1330
		1331	$map->{load_path} = $path;
		1332
		1333	$map
		1334	}
		1335
		1336	sub find;
		1337	sub find {
		1338	my ($path, $origin) = @_;
		1339
		1340	#warn "find<$path,$origin>\n";#d#
		1341
		1342	$path = new cf::path $path, $origin && $origin->path;
		1343	my $key = $path->as_string;
		1344
		1345	cf::lock_wait "map_find:$key";
		1346
		1347	$cf::MAP{$key} || do {
		1348	my $guard = cf::lock_acquire "map_find:$key";
		1349
		1350	# do it the slow way
		1351	my $map = try_load_header $path->save_path;
		1352
		1353	Coro::cede;
		1354
		1355	if ($map) {
		1356	$map->last_access ((delete $map->{last_access})
		1357	|| $cf::RUNTIME); #d#
		1358	# safety
		1359	$map->{instantiate_time} = $cf::RUNTIME
		1360	if $map->{instantiate_time} > $cf::RUNTIME;
		1361	} else {
		1362	if (my $rmp = $path->random_map_params) {
		1363	$map = generate_random_map $key, $rmp;
		1364	} else {
		1365	$map = try_load_header $path->load_path;
770	}	1366	}
		1367
		1368	$map or return;
		1369
		1370	$map->{load_original} = 1;
		1371	$map->{instantiate_time} = $cf::RUNTIME;
		1372	$map->last_access ($cf::RUNTIME);
		1373	$map->instantiate;
		1374
		1375	# per-player maps become, after loading, normal maps
		1376	$map->per_player (0) if $path->{user_rel};
771	}	1377	}
		1378
		1379	$map->path ($key);
		1380	$map->{path} = $path;
		1381	$map->{last_save} = $cf::RUNTIME;
		1382
		1383	Coro::cede;
		1384
		1385	if ($map->should_reset) {
		1386	$map->reset;
		1387	undef $guard;
		1388	$map = find $path
		1389	or return;
		1390	}
		1391
		1392	$cf::MAP{$key} = $map
772	},	1393	}
773	;	1394	}
774		1395
775	#############################################################################	1396	sub load {
		1397	my ($self) = @_;
776		1398
777	=head2 CORE EXTENSIONS	1399	my $path = $self->{path};
		1400	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
778		1401
779	Functions and methods that extend core crossfire objects.	1402	return if $self->in_memory != cf::MAP_SWAPPED;
		1403
		1404	$self->in_memory (cf::MAP_LOADING);
		1405
		1406	$self->alloc;
		1407	$self->load_objects ($self->{load_path}, 1)
		1408	or return;
		1409
		1410	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1411	if delete $self->{load_original};
		1412
		1413	if (my $uniq = $path->uniq_path) {
		1414	utf8::encode $uniq;
		1415	if (aio_open $uniq, O_RDONLY, 0) {
		1416	$self->clear_unique_items;
		1417	$self->load_objects ($uniq, 0);
		1418	}
		1419	}
		1420
		1421	Coro::cede;
		1422
		1423	# now do the right thing for maps
		1424	$self->link_multipart_objects;
		1425
		1426	if ($self->{path}->is_style_map) {
		1427	$self->{deny_save} = 1;
		1428	$self->{deny_reset} = 1;
		1429	} else {
		1430	$self->fix_auto_apply;
		1431	$self->decay_objects;
		1432	$self->update_buttons;
		1433	$self->set_darkness_map;
		1434	$self->difficulty ($self->estimate_difficulty)
		1435	unless $self->difficulty;
		1436	$self->activate;
		1437	}
		1438
		1439	Coro::cede;
		1440
		1441	$self->in_memory (cf::MAP_IN_MEMORY);
		1442	}
		1443
		1444	# find and load all maps in the 3x3 area around a map
		1445	sub load_diag {
		1446	my ($map) = @_;
		1447
		1448	my @diag; # diagonal neighbours
		1449
		1450	for (0 .. 3) {
		1451	my $neigh = $map->tile_path ($_)
		1452	or next;
		1453	$neigh = find $neigh, $map
		1454	or next;
		1455	$neigh->load;
		1456
		1457	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1458	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1459	}
		1460
		1461	for (@diag) {
		1462	my $neigh = find @$_
		1463	or next;
		1464	$neigh->load;
		1465	}
		1466	}
		1467
		1468	sub find_sync {
		1469	my ($path, $origin) = @_;
		1470
		1471	cf::sync_job { find $path, $origin }
		1472	}
		1473
		1474	sub do_load_sync {
		1475	my ($map) = @_;
		1476
		1477	cf::sync_job { $map->load };
		1478	}
		1479
		1480	our %MAP_PREFETCH;
		1481	our $MAP_PREFETCHER = Coro::async {
		1482	while () {
		1483	while (%MAP_PREFETCH) {
		1484	my $key = each %MAP_PREFETCH
		1485	or next;
		1486	my $path = delete $MAP_PREFETCH{$key};
		1487
		1488	my $map = find $path
		1489	or next;
		1490	$map->load;
		1491	}
		1492	Coro::schedule;
		1493	}
		1494	};
		1495
		1496	sub find_async {
		1497	my ($path, $origin) = @_;
		1498
		1499	$path = new cf::path $path, $origin && $origin->path;
		1500	my $key = $path->as_string;
		1501
		1502	if (my $map = $cf::MAP{$key}) {
		1503	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1504	}
		1505
		1506	$MAP_PREFETCH{$key} = $path;
		1507	$MAP_PREFETCHER->ready;
		1508
		1509	()
		1510	}
		1511
		1512	sub save {
		1513	my ($self) = @_;
		1514
		1515	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1516
		1517	$self->{last_save} = $cf::RUNTIME;
		1518
		1519	return unless $self->dirty;
		1520
		1521	my $save = $self->{path}->save_path; utf8::encode $save;
		1522	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1523
		1524	$self->{load_path} = $save;
		1525
		1526	return if $self->{deny_save};
		1527
		1528	local $self->{last_access} = $self->last_access;#d#
		1529
		1530	cf::async {
		1531	$_->contr->save for $self->players;
		1532	};
		1533
		1534	if ($uniq) {
		1535	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1536	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1537	} else {
		1538	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1539	}
		1540	}
		1541
		1542	sub swap_out {
		1543	my ($self) = @_;
		1544
		1545	# save first because save cedes
		1546	$self->save;
		1547
		1548	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1549
		1550	return if $self->players;
		1551	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1552	return if $self->{deny_save};
		1553
		1554	$self->clear;
		1555	$self->in_memory (cf::MAP_SWAPPED);
		1556	}
		1557
		1558	sub reset_at {
		1559	my ($self) = @_;
		1560
		1561	# TODO: safety, remove and allow resettable per-player maps
		1562	return 1e99 if $self->{path}{user_rel};
		1563	return 1e99 if $self->{deny_reset};
		1564
		1565	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1566	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1567
		1568	$time + $to
		1569	}
		1570
		1571	sub should_reset {
		1572	my ($self) = @_;
		1573
		1574	$self->reset_at <= $cf::RUNTIME
		1575	}
		1576
		1577	sub unlink_save {
		1578	my ($self) = @_;
		1579
		1580	utf8::encode (my $save = $self->{path}->save_path);
		1581	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1582	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1583	}
		1584
		1585	sub rename {
		1586	my ($self, $new_path) = @_;
		1587
		1588	$self->unlink_save;
		1589
		1590	delete $cf::MAP{$self->path};
		1591	$self->{path} = new cf::path $new_path;
		1592	$self->path ($self->{path}->as_string);
		1593	$cf::MAP{$self->path} = $self;
		1594
		1595	$self->save;
		1596	}
		1597
		1598	sub reset {
		1599	my ($self) = @_;
		1600
		1601	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1602
		1603	return if $self->players;
		1604	return if $self->{path}{user_rel};#d#
		1605
		1606	warn "resetting map ", $self->path;#d#
		1607
		1608	delete $cf::MAP{$self->path};
		1609
		1610	$_->clear_links_to ($self) for values %cf::MAP;
		1611
		1612	$self->unlink_save;
		1613	$self->destroy;
		1614	}
		1615
		1616	my $nuke_counter = "aaaa";
		1617
		1618	sub nuke {
		1619	my ($self) = @_;
		1620
		1621	$self->{deny_save} = 1;
		1622	$self->reset_timeout (1);
		1623	$self->rename ("{nuke}/" . ($nuke_counter++));
		1624	$self->reset; # polite request, might not happen
		1625	}
		1626
		1627	sub customise_for {
		1628	my ($map, $ob) = @_;
		1629
		1630	if ($map->per_player) {
		1631	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
		1632	}
		1633
		1634	$map
		1635	}
		1636
		1637	package cf;
		1638
		1639	=back
		1640
		1641	=head3 cf::object
		1642
		1643	=cut
		1644
		1645	package cf::object;
780		1646
781	=over 4	1647	=over 4
782		1648
783	=item cf::player::exists $login	1649	=item $ob->inv_recursive
784		1650
785	Returns true when the given account exists.	1651	Returns the inventory of the object _and_ their inventories, recursively.
786		1652
787	=cut	1653	=cut
788		1654
789	sub cf::player::exists($) {	1655	sub inv_recursive_;
790	cf::player::find $_[0]	1656	sub inv_recursive_ {
791	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1657	map { $_, inv_recursive_ $_->inv } @_
792	}	1658	}
		1659
		1660	sub inv_recursive {
		1661	inv_recursive_ inv $_[0]
		1662	}
		1663
		1664	package cf;
		1665
		1666	=back
		1667
		1668	=head3 cf::object::player
		1669
		1670	=over 4
793		1671
794	=item $player_object->reply ($npc, $msg[, $flags])	1672	=item $player_object->reply ($npc, $msg[, $flags])
795		1673
796	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1674	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
797	can be C<undef>. Does the right thing when the player is currently in a	1675	can be C<undef>. Does the right thing when the player is currently in a
…		…
799		1677
800	=cut	1678	=cut
801		1679
802	# rough implementation of a future "reply" method that works	1680	# rough implementation of a future "reply" method that works
803	# with dialog boxes.	1681	# with dialog boxes.
		1682	#TODO: the first argument must go, split into a $npc->reply_to ( method
804	sub cf::object::player::reply($$$;$) {	1683	sub cf::object::player::reply($$$;$) {
805	my ($self, $npc, $msg, $flags) = @_;	1684	my ($self, $npc, $msg, $flags) = @_;
806		1685
807	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1686	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
808		1687
…		…
812	$msg = $npc->name . " says: $msg" if $npc;	1691	$msg = $npc->name . " says: $msg" if $npc;
813	$self->message ($msg, $flags);	1692	$self->message ($msg, $flags);
814	}	1693	}
815	}	1694	}
816		1695
817	=item $player->ext_reply ($msgid, $msgtype, %msg)
818
819	Sends an ext reply to the player.
820
821	=cut
822
823	sub cf::player::ext_reply($$$%) {
824	my ($self, $id, %msg) = @_;
825
826	$msg{msgid} = $id;
827
828	$self->send ("ext " . to_json \%msg);
829	}
830
831	=item $player_object->may ("access")	1696	=item $player_object->may ("access")
832		1697
833	Returns wether the given player is authorized to access resource "access"	1698	Returns wether the given player is authorized to access resource "access"
834	(e.g. "command_wizcast").	1699	(e.g. "command_wizcast").
835		1700
…		…
842	(ref $cf::CFG{"may_$access"}	1707	(ref $cf::CFG{"may_$access"}
843	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1708	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
844	: $cf::CFG{"may_$access"})	1709	: $cf::CFG{"may_$access"})
845	}	1710	}
846		1711
847	=cut	1712	=item $player_object->enter_link
848		1713
849	#############################################################################	1714	Freezes the player and moves him/her to a special map (C<{link}>).
		1715
		1716	The player should be reaosnably safe there for short amounts of time. You
		1717	I<MUST> call C<leave_link> as soon as possible, though.
		1718
		1719	=item $player_object->leave_link ($map, $x, $y)
		1720
		1721	Moves the player out of the specila link map onto the given map. If the
		1722	map is not valid (or omitted), the player will be moved back to the
		1723	location he/she was before the call to C<enter_link>, or, if that fails,
		1724	to the emergency map position.
		1725
		1726	Might block.
		1727
		1728	=cut
		1729
		1730	sub cf::object::player::enter_link {
		1731	my ($self) = @_;
		1732
		1733	$self->deactivate_recursive;
		1734
		1735	return if $self->map == $LINK_MAP;
		1736
		1737	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1738	if $self->map;
		1739
		1740	$self->enter_map ($LINK_MAP, 20, 20);
		1741	}
		1742
		1743	sub cf::object::player::leave_link {
		1744	my ($self, $map, $x, $y) = @_;
		1745
		1746	my $link_pos = delete $self->{_link_pos};
		1747
		1748	unless ($map) {
		1749	# restore original map position
		1750	($map, $x, $y) = @{ $link_pos || [] };
		1751	$map = cf::map::find $map;
		1752
		1753	unless ($map) {
		1754	($map, $x, $y) = @$EMERGENCY_POSITION;
		1755	$map = cf::map::find $map
		1756	or die "FATAL: cannot load emergency map\n";
		1757	}
		1758	}
		1759
		1760	($x, $y) = (-1, -1)
		1761	unless (defined $x) && (defined $y);
		1762
		1763	# use -1 or undef as default coordinates, not 0, 0
		1764	($x, $y) = ($map->enter_x, $map->enter_y)
		1765	if $x <=0 && $y <= 0;
		1766
		1767	$map->load;
		1768	$map->load_diag;
		1769
		1770	return unless $self->contr->active;
		1771	$self->activate_recursive;
		1772	$self->enter_map ($map, $x, $y);
		1773	}
		1774
		1775	cf::player->attach (
		1776	on_logout => sub {
		1777	my ($pl) = @_;
		1778
		1779	# abort map switching before logout
		1780	if ($pl->ob->{_link_pos}) {
		1781	cf::sync_job {
		1782	$pl->ob->leave_link
		1783	};
		1784	}
		1785	},
		1786	on_login => sub {
		1787	my ($pl) = @_;
		1788
		1789	# try to abort aborted map switching on player login :)
		1790	# should happen only on crashes
		1791	if ($pl->ob->{_link_pos}) {
		1792	$pl->ob->enter_link;
		1793	(async {
		1794	# we need this sleep as the login has a concurrent enter_exit running
		1795	# and this sleep increases chances of the player not ending up in scorn
		1796	$pl->ob->reply (undef,
		1797	"There was an internal problem at your last logout, "
		1798	. "the server will try to bring you to your intended destination in a second.",
		1799	cf::NDI_RED);
		1800	Coro::Timer::sleep 1;
		1801	$pl->ob->leave_link;
		1802	})->prio (2);
		1803	}
		1804	},
		1805	);
		1806
		1807	=item $player_object->goto ($path, $x, $y)
		1808
		1809	=cut
		1810
		1811	sub cf::object::player::goto {
		1812	my ($self, $path, $x, $y) = @_;
		1813
		1814	$path = new cf::path $path;
		1815	$path ne "/" or Carp::cluck ("oy");#d#
		1816
		1817	$self->enter_link;
		1818
		1819	(async {
		1820	my $map = cf::map::find $path->as_string;
		1821	$map = $map->customise_for ($self) if $map;
		1822
		1823	# warn "entering ", $map->path, " at ($x, $y)\n"
		1824	# if $map;
		1825
		1826	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1827
		1828	$self->leave_link ($map, $x, $y);
		1829	})->prio (1);
		1830	}
		1831
		1832	=item $player_object->enter_exit ($exit_object)
		1833
		1834	=cut
		1835
		1836	sub parse_random_map_params {
		1837	my ($spec) = @_;
		1838
		1839	my $rmp = { # defaults
		1840	xsize => 10,
		1841	ysize => 10,
		1842	};
		1843
		1844	for (split /\n/, $spec) {
		1845	my ($k, $v) = split /\s+/, $_, 2;
		1846
		1847	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1848	}
		1849
		1850	$rmp
		1851	}
		1852
		1853	sub prepare_random_map {
		1854	my ($exit) = @_;
		1855
		1856	# all this does is basically replace the /! path by
		1857	# a new random map path (?random/...) with a seed
		1858	# that depends on the exit object
		1859
		1860	my $rmp = parse_random_map_params $exit->msg;
		1861
		1862	if ($exit->map) {
		1863	$rmp->{region} = $exit->map->region_name;
		1864	$rmp->{origin_map} = $exit->map->path;
		1865	$rmp->{origin_x} = $exit->x;
		1866	$rmp->{origin_y} = $exit->y;
		1867	}
		1868
		1869	$rmp->{random_seed} ||= $exit->random_seed;
		1870
		1871	my $data = cf::to_json $rmp;
		1872	my $md5 = Digest::MD5::md5_hex $data;
		1873
		1874	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1875	aio_write $fh, 0, (length $data), $data, 0;
		1876
		1877	$exit->slaying ("?random/$md5");
		1878	$exit->msg (undef);
		1879	}
		1880	}
		1881
		1882	sub cf::object::player::enter_exit {
		1883	my ($self, $exit) = @_;
		1884
		1885	return unless $self->type == cf::PLAYER;
		1886
		1887	$self->enter_link;
		1888
		1889	(async {
		1890	$self->deactivate_recursive; # just to be sure
		1891	unless (eval {
		1892	prepare_random_map $exit
		1893	if $exit->slaying eq "/!";
		1894
		1895	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1896	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1897
		1898	1;
		1899	}) {
		1900	$self->message ("Something went wrong deep within the crossfire server. "
		1901	. "I'll try to bring you back to the map you were before. "
		1902	. "Please report this to the dungeon master",
		1903	cf::NDI_UNIQUE | cf::NDI_RED);
		1904
		1905	warn "ERROR in enter_exit: $@";
		1906	$self->leave_link;
		1907	}
		1908	})->prio (1);
		1909	}
		1910
		1911	=head3 cf::client
		1912
		1913	=over 4
		1914
		1915	=item $client->send_drawinfo ($text, $flags)
		1916
		1917	Sends a drawinfo packet to the client. Circumvents output buffering so
		1918	should not be used under normal circumstances.
		1919
		1920	=cut
		1921
		1922	sub cf::client::send_drawinfo {
		1923	my ($self, $text, $flags) = @_;
		1924
		1925	utf8::encode $text;
		1926	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1927	}
		1928
		1929
		1930	=item $success = $client->query ($flags, "text", \&cb)
		1931
		1932	Queues a query to the client, calling the given callback with
		1933	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1934	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1935
		1936	Queries can fail, so check the return code. Or don't, as queries will become
		1937	reliable at some point in the future.
		1938
		1939	=cut
		1940
		1941	sub cf::client::query {
		1942	my ($self, $flags, $text, $cb) = @_;
		1943
		1944	return unless $self->state == ST_PLAYING
		1945	|| $self->state == ST_SETUP
		1946	|| $self->state == ST_CUSTOM;
		1947
		1948	$self->state (ST_CUSTOM);
		1949
		1950	utf8::encode $text;
		1951	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1952
		1953	$self->send_packet ($self->{query_queue}[0][0])
		1954	if @{ $self->{query_queue} } == 1;
		1955	}
		1956
		1957	cf::client->attach (
		1958	on_reply => sub {
		1959	my ($ns, $msg) = @_;
		1960
		1961	# this weird shuffling is so that direct followup queries
		1962	# get handled first
		1963	my $queue = delete $ns->{query_queue}
		1964	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1965
		1966	(shift @$queue)->[1]->($msg);
		1967
		1968	push @{ $ns->{query_queue} }, @$queue;
		1969
		1970	if (@{ $ns->{query_queue} } == @$queue) {
		1971	if (@$queue) {
		1972	$ns->send_packet ($ns->{query_queue}[0][0]);
		1973	} else {
		1974	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1975	}
		1976	}
		1977	},
		1978	);
		1979
		1980	=item $client->async (\&cb)
		1981
		1982	Create a new coroutine, running the specified callback. The coroutine will
		1983	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1984	or loss of connection).
		1985
		1986	=cut
		1987
		1988	sub cf::client::async {
		1989	my ($self, $cb) = @_;
		1990
		1991	my $coro = &Coro::async ($cb);
		1992
		1993	$coro->on_destroy (sub {
		1994	delete $self->{_coro}{$coro+0};
		1995	});
		1996
		1997	$self->{_coro}{$coro+0} = $coro;
		1998
		1999	$coro
		2000	}
		2001
		2002	cf::client->attach (
		2003	on_destroy => sub {
		2004	my ($ns) = @_;
		2005
		2006	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2007	},
		2008	);
		2009
		2010	=back
		2011
850		2012
851	=head2 SAFE SCRIPTING	2013	=head2 SAFE SCRIPTING
852		2014
853	Functions that provide a safe environment to compile and execute	2015	Functions that provide a safe environment to compile and execute
854	snippets of perl code without them endangering the safety of the server	2016	snippets of perl code without them endangering the safety of the server
…		…
869		2031
870	=pod	2032	=pod
871		2033
872	The following fucntions and emthods are available within a safe environment:	2034	The following fucntions and emthods are available within a safe environment:
873		2035
874	cf::object contr pay_amount pay_player	2036	cf::object contr pay_amount pay_player map
875	cf::object::player player	2037	cf::object::player player
876	cf::player peaceful	2038	cf::player peaceful
		2039	cf::map trigger
877		2040
878	=cut	2041	=cut
879		2042
880	for (	2043	for (
881	["cf::object" => qw(contr pay_amount pay_player)],	2044	["cf::object" => qw(contr pay_amount pay_player map)],
882	["cf::object::player" => qw(player)],	2045	["cf::object::player" => qw(player)],
883	["cf::player" => qw(peaceful)],	2046	["cf::player" => qw(peaceful)],
		2047	["cf::map" => qw(trigger)],
884	) {	2048	) {
885	no strict 'refs';	2049	no strict 'refs';
886	my ($pkg, @funs) = @$_;	2050	my ($pkg, @funs) = @$_;
887	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	2051	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
888	for @funs;	2052	for @funs;
…		…
1004		2168
1005	{	2169	{
1006	my $path = cf::localdir . "/database.pst";	2170	my $path = cf::localdir . "/database.pst";
1007		2171
1008	sub db_load() {	2172	sub db_load() {
1009	warn "loading database $path\n";#d# remove later
1010	$DB = stat $path ? Storable::retrieve $path : { };	2173	$DB = stat $path ? Storable::retrieve $path : { };
1011	}	2174	}
1012		2175
1013	my $pid;	2176	my $pid;
1014		2177
1015	sub db_save() {	2178	sub db_save() {
1016	warn "saving database $path\n";#d# remove later
1017	waitpid $pid, 0 if $pid;	2179	waitpid $pid, 0 if $pid;
1018	if (0 == ($pid = fork)) {	2180	if (0 == ($pid = fork)) {
1019	$DB->{_meta}{version} = 1;	2181	$DB->{_meta}{version} = 1;
1020	Storable::nstore $DB, "$path~";	2182	Storable::nstore $DB, "$path~";
1021	rename "$path~", $path;	2183	rename "$path~", $path;
…		…
1028	sub db_sync() {	2190	sub db_sync() {
1029	db_save if $dirty;	2191	db_save if $dirty;
1030	undef $dirty;	2192	undef $dirty;
1031	}	2193	}
1032		2194
1033	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	2195	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1034	db_sync;	2196	db_sync;
1035	});	2197	});
1036		2198
1037	sub db_dirty() {	2199	sub db_dirty() {
1038	$dirty = 1;	2200	$dirty = 1;
…		…
1052	$DB->{$_[0]} = $_[1];	2214	$DB->{$_[0]} = $_[1];
1053	}	2215	}
1054	db_dirty;	2216	db_dirty;
1055	}	2217	}
1056		2218
1057	attach_global	2219	cf::global->attach (
1058	prio => 10000,	2220	prio => 10000,
1059	on_cleanup => sub {	2221	on_cleanup => sub {
1060	db_sync;	2222	db_sync;
1061	},	2223	},
1062	;	2224	);
1063	}	2225	}
1064		2226
1065	#############################################################################	2227	#############################################################################
1066	# the server's main()	2228	# the server's main()
1067		2229
…		…
1069	open my $fh, "<:utf8", cf::confdir . "/config"	2231	open my $fh, "<:utf8", cf::confdir . "/config"
1070	or return;	2232	or return;
1071		2233
1072	local $/;	2234	local $/;
1073	*CFG = YAML::Syck::Load <$fh>;	2235	*CFG = YAML::Syck::Load <$fh>;
		2236
		2237	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2238
		2239	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2240	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2241
		2242	if (exists $CFG{mlockall}) {
		2243	eval {
		2244	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2245	and die "WARNING: m(un)lockall failed: $!\n";
		2246	};
		2247	warn $@ if $@;
		2248	}
1074	}	2249	}
1075		2250
1076	sub main {	2251	sub main {
		2252	# we must not ever block the main coroutine
		2253	local $Coro::idle = sub {
		2254	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2255	async { Event::one_event };
		2256	};
		2257
1077	cfg_load;	2258	cfg_load;
1078	db_load;	2259	db_load;
1079	load_extensions;	2260	load_extensions;
1080	Event::loop;	2261	Event::loop;
1081	}	2262	}
1082		2263
1083	#############################################################################	2264	#############################################################################
1084	# initialisation	2265	# initialisation and cleanup
1085		2266
		2267	# install some emergency cleanup handlers
		2268	BEGIN {
		2269	for my $signal (qw(INT HUP TERM)) {
		2270	Event->signal (
		2271	data => WF_AUTOCANCEL,
		2272	signal => $signal,
		2273	cb => sub {
		2274	cf::cleanup "SIG$signal";
		2275	},
		2276	);
		2277	}
		2278	}
		2279
		2280	sub emergency_save() {
		2281	my $freeze_guard = cf::freeze_mainloop;
		2282
		2283	warn "enter emergency perl save\n";
		2284
		2285	cf::sync_job {
		2286	# use a peculiar iteration method to avoid tripping on perl
		2287	# refcount bugs in for. also avoids problems with players
		2288	# and maps saved/Destroyed asynchronously.
		2289	warn "begin emergency player save\n";
		2290	for my $login (keys %cf::PLAYER) {
		2291	my $pl = $cf::PLAYER{$login} or next;
		2292	$pl->valid or next;
		2293	$pl->save;
		2294	}
		2295	warn "end emergency player save\n";
		2296
		2297	warn "begin emergency map save\n";
		2298	for my $path (keys %cf::MAP) {
		2299	my $map = $cf::MAP{$path} or next;
		2300	$map->valid or next;
		2301	$map->save;
		2302	}
		2303	warn "end emergency map save\n";
		2304	};
		2305
		2306	warn "leave emergency perl save\n";
		2307	}
		2308
1086	sub _perl_reload(&) {	2309	sub reload() {
1087	my ($msg) = @_;	2310	# can/must only be called in main
		2311	if ($Coro::current != $Coro::main) {
		2312	warn "can only reload from main coroutine\n";
		2313	return;
		2314	}
1088		2315
1089	$msg->("reloading...");	2316	warn "reloading...";
		2317
		2318	my $guard = freeze_mainloop;
		2319	cf::emergency_save;
1090		2320
1091	eval {	2321	eval {
		2322	# if anything goes wrong in here, we should simply crash as we already saved
		2323
1092	# cancel all watchers	2324	# cancel all watchers
1093	$_->cancel for Event::all_watchers;	2325	for (Event::all_watchers) {
		2326	$_->cancel if $_->data & WF_AUTOCANCEL;
		2327	}
		2328
		2329	# cancel all extension coros
		2330	$_->cancel for values %EXT_CORO;
		2331	%EXT_CORO = ();
1094		2332
1095	# unload all extensions	2333	# unload all extensions
1096	for (@exts) {	2334	for (@exts) {
1097	$msg->("unloading <$_>");	2335	warn "unloading <$_>";
1098	unload_extension $_;	2336	unload_extension $_;
1099	}	2337	}
1100		2338
1101	# unload all modules loaded from $LIBDIR	2339	# unload all modules loaded from $LIBDIR
1102	while (my ($k, $v) = each %INC) {	2340	while (my ($k, $v) = each %INC) {
1103	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2341	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1104		2342
1105	$msg->("removing <$k>");	2343	warn "removing <$k>";
1106	delete $INC{$k};	2344	delete $INC{$k};
1107		2345
1108	$k =~ s/\.pm$//;	2346	$k =~ s/\.pm$//;
1109	$k =~ s/\//::/g;	2347	$k =~ s/\//::/g;
1110		2348
…		…
1115	Symbol::delete_package $k;	2353	Symbol::delete_package $k;
1116	}	2354	}
1117		2355
1118	# sync database to disk	2356	# sync database to disk
1119	cf::db_sync;	2357	cf::db_sync;
		2358	IO::AIO::flush;
1120		2359
1121	# get rid of safe::, as good as possible	2360	# get rid of safe::, as good as possible
1122	Symbol::delete_package "safe::$_"	2361	Symbol::delete_package "safe::$_"
1123	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2362	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1124		2363
1125	# remove register_script_function callbacks	2364	# remove register_script_function callbacks
1126	# TODO	2365	# TODO
1127		2366
1128	# unload cf.pm "a bit"	2367	# unload cf.pm "a bit"
…		…
1131	# don't, removes xs symbols, too,	2370	# don't, removes xs symbols, too,
1132	# and global variables created in xs	2371	# and global variables created in xs
1133	#Symbol::delete_package __PACKAGE__;	2372	#Symbol::delete_package __PACKAGE__;
1134		2373
1135	# reload cf.pm	2374	# reload cf.pm
1136	$msg->("reloading cf.pm");	2375	warn "reloading cf.pm";
1137	require cf;	2376	require cf;
		2377	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1138		2378
1139	# load config and database again	2379	# load config and database again
1140	cf::cfg_load;	2380	cf::cfg_load;
1141	cf::db_load;	2381	cf::db_load;
1142		2382
1143	# load extensions	2383	# load extensions
1144	$msg->("load extensions");	2384	warn "load extensions";
1145	cf::load_extensions;	2385	cf::load_extensions;
1146		2386
1147	# reattach attachments to objects	2387	# reattach attachments to objects
1148	$msg->("reattach");	2388	warn "reattach";
1149	_global_reattach;	2389	_global_reattach;
		2390	reattach $_ for values %MAP;
1150	};	2391	};
1151	$msg->($@) if $@;
1152		2392
1153	$msg->("reloaded");	2393	if ($@) {
		2394	warn $@;
		2395	warn "error while reloading, exiting.";
		2396	exit 1;
		2397	}
		2398
		2399	warn "reloaded successfully";
1154	};	2400	};
1155		2401
1156	sub perl_reload() {	2402	#############################################################################
1157	_perl_reload {
1158	warn $_[0];
1159	print "$_[0]\n";
1160	};
1161	}
1162		2403
		2404	unless ($LINK_MAP) {
		2405	$LINK_MAP = cf::map::new;
		2406
		2407	$LINK_MAP->width (41);
		2408	$LINK_MAP->height (41);
		2409	$LINK_MAP->alloc;
		2410	$LINK_MAP->path ("{link}");
		2411	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2412	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2413
		2414	# dirty hack because... archetypes are not yet loaded
		2415	Event->timer (
		2416	after => 10,
		2417	cb => sub {
		2418	$_[0]->w->cancel;
		2419
		2420	# provide some exits "home"
		2421	my $exit = cf::object::new "exit";
		2422
		2423	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2424	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2425	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2426
		2427	$LINK_MAP->insert ($exit->clone, 19, 19);
		2428	$LINK_MAP->insert ($exit->clone, 19, 20);
		2429	$LINK_MAP->insert ($exit->clone, 19, 21);
		2430	$LINK_MAP->insert ($exit->clone, 20, 19);
		2431	$LINK_MAP->insert ($exit->clone, 20, 21);
		2432	$LINK_MAP->insert ($exit->clone, 21, 19);
		2433	$LINK_MAP->insert ($exit->clone, 21, 20);
		2434	$LINK_MAP->insert ($exit->clone, 21, 21);
		2435
		2436	$exit->destroy;
		2437	});
		2438
		2439	$LINK_MAP->{deny_save} = 1;
		2440	$LINK_MAP->{deny_reset} = 1;
		2441
		2442	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2443	}
		2444
		2445	register "<global>", __PACKAGE__;
		2446
1163	register_command "perl-reload", 0, sub {	2447	register_command "reload" => sub {
1164	my ($who, $arg) = @_;	2448	my ($who, $arg) = @_;
1165		2449
1166	if ($who->flag (FLAG_WIZ)) {	2450	if ($who->flag (FLAG_WIZ)) {
1167	_perl_reload {	2451	$who->message ("start of reload.");
1168	warn $_[0];	2452	reload;
1169	$who->message ($_[0]);	2453	$who->message ("end of reload.");
1170	};
1171	}	2454	}
1172	};	2455	};
1173		2456
1174	register "<global>", __PACKAGE__;
1175
1176	unshift @INC, $LIBDIR;	2457	unshift @INC, $LIBDIR;
1177		2458
1178	$TICK_WATCHER = Event->timer (	2459	$TICK_WATCHER = Event->timer (
		2460	reentrant => 0,
1179	prio => 1,	2461	prio => 0,
1180	async => 1,
1181	at => $NEXT_TICK || 1,	2462	at => $NEXT_TICK || $TICK,
		2463	data => WF_AUTOCANCEL,
1182	cb => sub {	2464	cb => sub {
1183	cf::server_tick; # one server iteration	2465	cf::server_tick; # one server iteration
1184		2466	$RUNTIME += $TICK;
1185	my $NOW = Event::time;
1186	$NEXT_TICK += $TICK;	2467	$NEXT_TICK += $TICK;
1187		2468
		2469	$WAIT_FOR_TICK->broadcast;
		2470	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2471
1188	# if we are delayed by four ticks or more, skip them all	2472	# if we are delayed by four ticks or more, skip them all
1189	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2473	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1190		2474
1191	$TICK_WATCHER->at ($NEXT_TICK);	2475	$TICK_WATCHER->at ($NEXT_TICK);
1192	$TICK_WATCHER->start;	2476	$TICK_WATCHER->start;
1193	},	2477	},
1194	);	2478	);
1195		2479
1196	IO::AIO::max_poll_time $TICK * 0.2;	2480	IO::AIO::max_poll_time $TICK * 0.2;
1197		2481
		2482	Event->io (
1198	Event->io (fd => IO::AIO::poll_fileno,	2483	fd => IO::AIO::poll_fileno,
1199	poll => 'r',	2484	poll => 'r',
1200	prio => 5,	2485	prio => 5,
		2486	data => WF_AUTOCANCEL,
1201	cb => \&IO::AIO::poll_cb);	2487	cb => \&IO::AIO::poll_cb,
		2488	);
		2489
		2490	Event->timer (
		2491	data => WF_AUTOCANCEL,
		2492	after => 0,
		2493	interval => 10,
		2494	cb => sub {
		2495	(Coro::unblock_sub {
		2496	write_runtime
		2497	or warn "ERROR: unable to write runtime file: $!";
		2498	})->();
		2499	},
		2500	);
		2501
		2502	END { cf::emergency_save }
1202		2503
1203	1	2504	1
1204		2505

Diff Legend

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