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.76 by root, Mon Oct 2 15:28:36 2006 UTC vs.
Revision 1.149 by root, Mon Jan 8 14:11:05 2007 UTC

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

Diff Legend

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