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

Diff Legend

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