ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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