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

Diff Legend

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