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

Diff Legend

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