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

Diff Legend

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