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

Diff Legend

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