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.121 by root, Tue Jan 2 11:11:52 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 $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];
35		78
36	#############################################################################	79	#############################################################################
37		80
38	=head2 GLOBAL VARIABLES	81	=head2 GLOBAL VARIABLES
39		82
40	=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.
41		93
42	=item $cf::LIBDIR	94	=item $cf::LIBDIR
43		95
44	The perl library directory, where extensions and cf-specific modules can	96	The perl library directory, where extensions and cf-specific modules can
45	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.
46		102
47	=item $cf::TICK	103	=item $cf::TICK
48		104
49	The interval between server ticks, in seconds.	105	The interval between server ticks, in seconds.
50		106
…		…
58	=cut	114	=cut
59		115
60	BEGIN {	116	BEGIN {
61	*CORE::GLOBAL::warn = sub {	117	*CORE::GLOBAL::warn = sub {
62	my $msg = join "", @_;	118	my $msg = join "", @_;
		119	utf8::encode $msg;
		120
63	$msg .= "\n"	121	$msg .= "\n"
64	unless $msg =~ /\n$/;	122	unless $msg =~ /\n$/;
65		123
66	print STDERR "cfperl: $msg";
67	LOG llevError, "cfperl: $msg";	124	LOG llevError, "cfperl: $msg";
68	};	125	};
69	}	126	}
70		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';
71	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	133	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72		134
73	# 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
74	# within the Safe compartment.	136	# 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)) {	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	)) {
76	no strict 'refs';	144	no strict 'refs';
77	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	145	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78	}	146	}
79		147
80	$Event::DIED = sub {	148	$Event::DIED = sub {
…		…
82	};	150	};
83		151
84	my %ext_pkg;	152	my %ext_pkg;
85	my @exts;	153	my @exts;
86	my @hook;	154	my @hook;
87	my %command;
88	my %extcmd;
89		155
90	=head2 UTILITY FUNCTIONS	156	=head2 UTILITY FUNCTIONS
91		157
92	=over 4	158	=over 4
93		159
…		…
115	sub to_json($) {	181	sub to_json($) {
116	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	182	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
117	JSON::Syck::Dump $_[0]	183	JSON::Syck::Dump $_[0]
118	}	184	}
119		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
120	=back	343	=back
121		344
122	=cut	345	=cut
123		346
124	#############################################################################	347	#############################################################################
125		348
126	=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+).
127		478
128	=over 4	479	=over 4
129		480
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...)	481	=item $attachable->attach ($attachment, key => $value...)
143		482
144	=item $map->detach ($attachment)	483	=item $attachable->detach ($attachment)
145		484
146	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.
147		487
148	=item $bool = $object->attached ($name)	488	Example, attach a minesweeper attachment to the given object, making it a
		489	10x10 minesweeper game:
149		490
150	=item $bool = $player->attached ($name)	491	$obj->attach (minesweeper => width => 10, height => 10);
151		492
152	=item $bool = $map->attached ($name)	493	=item $bool = $attachable->attached ($name)
153		494
154	Checks wether the named attachment is currently attached to the object.	495	Checks wether the named attachment is currently attached to the object.
155		496
156	=item cf::attach_global ...	497	=item cf::CLASS->attach ...
157		498
158	Attach handlers for global events.	499	=item cf::CLASS->detach ...
159		500
160	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
161	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:
162		535
163	=over 4	536	=over 4
164		537
165	=item prio => $number	538	=item prio => $number
166		539
…		…
168	by another C<prio> setting). Lower priority handlers get executed	541	by another C<prio> setting). Lower priority handlers get executed
169	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
170	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
171	unless you know what you are doing.	544	unless you know what you are doing.
172		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
173	=item on_I<event> => \&cb	552	=item on_I<event> => \&cb
174		553
175	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
176	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
177	handlers are recognised generally depends on the type of object these	556	handlers are recognised generally depends on the type of object these
…		…
186	package and register them. Only handlers for eevents supported by the	565	package and register them. Only handlers for eevents supported by the
187	object/class are recognised.	566	object/class are recognised.
188		567
189	=back	568	=back
190		569
191	=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:
192		572
193	Attach handlers for a specific object type (e.g. TRANSPORT) and	573	cf::object::attachment sockpuppet =>
194	subtype. If C<$subtype> is zero or undef, matches all objects of the given	574	on_skill_attack => sub {
195	type.	575	my ($self, $victim) = @_;
196		576	...
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	}	577	}
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	578	}
418	}
419		579
420	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	580	=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		581
446	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
447	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
448	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
449	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
450	exception.	586	exception.
451		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
452	=back	771	=back
453		772
454	=cut	773	=cut
455
456	*cf::object::valid =
457	*cf::player::valid =
458	*cf::map::valid = \&cf::_valid;
459		774
460	#############################################################################	775	#############################################################################
461	# object support	776	# object support
462		777
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 {	778	sub reattach {
		779	# basically do the same as instantiate, without calling instantiate
477	my ($obj) = @_;	780	my ($obj) = @_;
		781
478	my $registry = $obj->registry;	782	my $registry = $obj->registry;
479		783
480	@$registry = ();	784	@$registry = ();
481		785
482	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	786	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
483		787
484	for my $name (keys %{ $obj->{_attachment} || {} }) {	788	for my $name (keys %{ $obj->{_attachment} || {} }) {
485	if (my $attach = $attachment{$name}) {	789	if (my $attach = $attachment{$name}) {
486	for (@$attach) {	790	for (@$attach) {
487	my ($klass, @attach) = @$_;	791	my ($klass, @attach) = @$_;
488	_attach @$registry, $klass, @attach;	792	_attach $registry, $klass, @attach;
489	}	793	}
490	} else {	794	} else {
491	warn "object uses attachment '$name' that is not available, postponing.\n";	795	warn "object uses attachment '$name' that is not available, postponing.\n";
492	}	796	}
493	}	797	}
494	}	798	}
495		799
496	sub object_freezer_save {	800	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,	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,
548	on_clone => sub {	814	on_clone => sub {
549	my ($src, $dst) = @_;	815	my ($src, $dst) = @_;
550		816
551	@{$dst->registry} = @{$src->registry};	817	@{$dst->registry} = @{$src->registry};
552		818
553	%$dst = %$src;	819	%$dst = %$src;
554		820
555	%{$dst->{_attachment}} = %{$src->{_attachment}}	821	%{$dst->{_attachment}} = %{$src->{_attachment}}
556	if exists $src->{_attachment};	822	if exists $src->{_attachment};
557	},	823	},
558	;	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	}
559		890
560	#############################################################################	891	#############################################################################
561	# old plug-in events	892	# command handling &c
562		893
563	sub inject_event {	894	=item cf::register_command $name => \&callback($ob,$args);
564	my $extension = shift;
565	my $event_code = shift;
566		895
567	my $cb = $hook[$event_code]{$extension}	896	Register a callback for execution when the client sends the user command
568	or return;	897	$name.
569		898
570	&$cb	899	=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		900
592	sub register_command {	901	sub register_command {
593	my ($name, $time, $cb) = @_;	902	my ($name, $cb) = @_;
594		903
595	my $caller = caller;	904	my $caller = caller;
596	#warn "registering command '$name/$time' to '$caller'";	905	#warn "registering command '$name/$time' to '$caller'";
597		906
598	push @{ $command{$name} }, [$time, $cb, $caller];	907	push @{ $COMMAND{$name} }, [$caller, $cb];
599	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
600	}	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
601		918
602	sub register_extcmd {	919	sub register_extcmd {
603	my ($name, $cb) = @_;	920	my ($name, $cb) = @_;
604		921
605	my $caller = caller;	922	my $caller = caller;
606	#warn "registering extcmd '$name' to '$caller'";	923	#warn "registering extcmd '$name' to '$caller'";
607		924
608	$extcmd{$name} = [$cb, $caller];	925	$EXTCMD{$name} = [$cb, $caller];
609	}	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	);
610		959
611	sub register {	960	sub register {
612	my ($base, $pkg) = @_;	961	my ($base, $pkg) = @_;
613		962
614	#TODO	963	#TODO
…		…
633	. "#line 1 \"$path\"\n{\n"	982	. "#line 1 \"$path\"\n{\n"
634	. (do { local $/; <$fh> })	983	. (do { local $/; <$fh> })
635	. "\n};\n1";	984	. "\n};\n1";
636		985
637	eval $source	986	eval $source
638	or die "$path: $@";	987	or die $@ ? "$path: $@\n"
		988	: "extension disabled.\n";
639		989
640	push @exts, $pkg;	990	push @exts, $pkg;
641	$ext_pkg{$base} = $pkg;	991	$ext_pkg{$base} = $pkg;
642		992
643	# no strict 'refs';	993	# no strict 'refs';
…		…
656	# for my $idx (0 .. $#PLUGIN_EVENT) {	1006	# for my $idx (0 .. $#PLUGIN_EVENT) {
657	# delete $hook[$idx]{$pkg};	1007	# delete $hook[$idx]{$pkg};
658	# }	1008	# }
659		1009
660	# remove commands	1010	# remove commands
661	for my $name (keys %command) {	1011	for my $name (keys %COMMAND) {
662	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	1012	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
663		1013
664	if (@cb) {	1014	if (@cb) {
665	$command{$name} = \@cb;	1015	$COMMAND{$name} = \@cb;
666	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
667	} else {	1016	} else {
668	delete $command{$name};
669	delete $COMMAND{"$name\000"};	1017	delete $COMMAND{$name};
670	}	1018	}
671	}	1019	}
672		1020
673	# remove extcmds	1021	# remove extcmds
674	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1022	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
675	delete $extcmd{$name};	1023	delete $EXTCMD{$name};
676	}	1024	}
677		1025
678	if (my $cb = $pkg->can ("unload")) {	1026	if (my $cb = $pkg->can ("unload")) {
679	eval {	1027	eval {
680	$cb->($pkg);	1028	$cb->($pkg);
…		…
684		1032
685	Symbol::delete_package $pkg;	1033	Symbol::delete_package $pkg;
686	}	1034	}
687		1035
688	sub load_extensions {	1036	sub load_extensions {
689	my $LIBDIR = maps_directory "perl";
690
691	for my $ext (<$LIBDIR/*.ext>) {	1037	for my $ext (<$LIBDIR/*.ext>) {
692	next unless -r $ext;	1038	next unless -r $ext;
693	eval {	1039	eval {
694	load_extension $ext;	1040	load_extension $ext;
695	1	1041	1
696	} or warn "$ext not loaded: $@";	1042	} or warn "$ext not loaded: $@";
697	}	1043	}
698	}	1044	}
699		1045
700	#############################################################################	1046	#############################################################################
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	1047	# load/save/clean perl data associated with a map
726		1048
727	*cf::mapsupport::on_clean = sub {	1049	*cf::mapsupport::on_clean = sub {
728	my ($map) = @_;	1050	my ($map) = @_;
729		1051
…		…
731	defined $path or return;	1053	defined $path or return;
732		1054
733	unlink "$path.pst";	1055	unlink "$path.pst";
734	};	1056	};
735		1057
736	attach_to_maps prio => -10000, package => cf::mapsupport::;	1058	cf::map->attach (prio => -10000, package => cf::mapsupport::);
737		1059
738	#############################################################################	1060	#############################################################################
739	# load/save perl data associated with player->ob objects	1061	# load/save perl data associated with player->ob objects
740		1062
741	sub all_objects(@) {	1063	sub all_objects(@) {
742	@_, map all_objects ($_->inv), @_	1064	@_, map all_objects ($_->inv), @_
743	}	1065	}
744		1066
745	# TODO: compatibility cruft, remove when no longer needed	1067	# TODO: compatibility cruft, remove when no longer needed
746	attach_to_players	1068	cf::player->attach (
747	on_load => sub {	1069	on_load => sub {
748	my ($pl, $path) = @_;	1070	my ($pl, $path) = @_;
749		1071
750	for my $o (all_objects $pl->ob) {	1072	for my $o (all_objects $pl->ob) {
751	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1073	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
753		1075
754	%$o = %{ Storable::thaw pack "H*", $value };	1076	%$o = %{ Storable::thaw pack "H*", $value };
755	}	1077	}
756	}	1078	}
757	},	1079	},
758	;	1080	);
759		1081
760	#############################################################################	1082	#############################################################################
761		1083
762	=head2 CORE EXTENSIONS	1084	=head2 CORE EXTENSIONS
763		1085
764	Functions and methods that extend core crossfire objects.	1086	Functions and methods that extend core crossfire objects.
		1087
		1088	=head3 cf::player
765		1089
766	=over 4	1090	=over 4
767		1091
768	=item cf::player::exists $login	1092	=item cf::player::exists $login
769		1093
…		…
774	sub cf::player::exists($) {	1098	sub cf::player::exists($) {
775	cf::player::find $_[0]	1099	cf::player::find $_[0]
776	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;
777	}	1101	}
778		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) for values %cf::MAP;
		1159	}
		1160
		1161	sub try_load_header($) {
		1162	my ($path) = @_;
		1163
		1164	utf8::encode $path;
		1165	aio_open $path, O_RDONLY, 0
		1166	or return;
		1167
		1168	my $map = cf::map::new
		1169	or return;
		1170
		1171	$map->load_header ($path)
		1172	or return;
		1173
		1174	$map->{load_path} = $path;
		1175
		1176	$map
		1177	}
		1178
		1179	sub find_map {
		1180	my ($path, $origin) = @_;
		1181
		1182	#warn "find_map<$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	if ($map) {
		1196	# safety
		1197	$map->{instantiate_time} = $cf::RUNTIME
		1198	if $map->{instantiate_time} > $cf::RUNTIME;
		1199	} else {
		1200	if (my $rmp = $path->random_map_params) {
		1201	$map = generate_random_map $key, $rmp;
		1202	} else {
		1203	$map = try_load_header $path->load_path;
		1204	}
		1205
		1206	$map or return;
		1207
		1208	$map->{load_original} = 1;
		1209	$map->{instantiate_time} = $cf::RUNTIME;
		1210	$map->instantiate;
		1211
		1212	# per-player maps become, after loading, normal maps
		1213	$map->per_player (0) if $path->{user_rel};
		1214	}
		1215
		1216	$map->path ($key);
		1217	$map->{path} = $path;
		1218	$map->{last_save} = $cf::RUNTIME;
		1219	$map->last_access ($cf::RUNTIME);
		1220
		1221	if ($map->should_reset) {
		1222	$map->reset;
		1223	$map = find_map $path;
		1224	}
		1225
		1226	$cf::MAP{$key} = $map
		1227	}
		1228	}
		1229
		1230	sub load {
		1231	my ($self) = @_;
		1232
		1233	my $path = $self->{path};
		1234	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1235
		1236	return if $self->in_memory != cf::MAP_SWAPPED;
		1237
		1238	$self->in_memory (cf::MAP_LOADING);
		1239
		1240	$self->alloc;
		1241	$self->load_objects ($self->{load_path}, 1)
		1242	or return;
		1243
		1244	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1245	if delete $self->{load_original};
		1246
		1247	if (my $uniq = $path->uniq_path) {
		1248	utf8::encode $uniq;
		1249	if (aio_open $uniq, O_RDONLY, 0) {
		1250	$self->clear_unique_items;
		1251	$self->load_objects ($uniq, 0);
		1252	}
		1253	}
		1254
		1255	# now do the right thing for maps
		1256	$self->link_multipart_objects;
		1257
		1258	if ($self->{path}->is_style_map) {
		1259	$self->{deny_save} = 1;
		1260	$self->{deny_reset} = 1;
		1261	} else {
		1262	$self->fix_auto_apply;
		1263	$self->decay_objects;
		1264	$self->update_buttons;
		1265	$self->set_darkness_map;
		1266	$self->difficulty ($self->estimate_difficulty)
		1267	unless $self->difficulty;
		1268	$self->activate;
		1269	}
		1270
		1271	$self->in_memory (cf::MAP_IN_MEMORY);
		1272	}
		1273
		1274	sub load_map_sync {
		1275	my ($path, $origin) = @_;
		1276
		1277	#warn "load_map_sync<$path, $origin>\n";#d#
		1278
		1279	cf::sync_job {
		1280	my $map = cf::map::find_map $path, $origin
		1281	or return;
		1282	$map->load;
		1283	$map
		1284	}
		1285	}
		1286
		1287	sub save {
		1288	my ($self) = @_;
		1289
		1290	$self->{last_save} = $cf::RUNTIME;
		1291
		1292	return unless $self->dirty;
		1293
		1294	my $save = $self->{path}->save_path; utf8::encode $save;
		1295	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1296
		1297	$self->{load_path} = $save;
		1298
		1299	return if $self->{deny_save};
		1300
		1301	if ($uniq) {
		1302	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1303	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1304	} else {
		1305	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1306	}
		1307	}
		1308
		1309	sub swap_out {
		1310	my ($self) = @_;
		1311
		1312	return if $self->players;
		1313	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1314	return if $self->{deny_save};
		1315
		1316	$self->save;
		1317	$self->clear;
		1318	$self->in_memory (cf::MAP_SWAPPED);
		1319	}
		1320
		1321	sub reset_at {
		1322	my ($self) = @_;
		1323
		1324	# TODO: safety, remove and allow resettable per-player maps
		1325	return 1e99 if $self->{path}{user_rel};
		1326	return 1e99 if $self->{deny_reset};
		1327
		1328	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1329	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1330
		1331	$time + $to
		1332	}
		1333
		1334	sub should_reset {
		1335	my ($self) = @_;
		1336
		1337	$self->reset_at <= $cf::RUNTIME
		1338	}
		1339
		1340	sub unlink_save {
		1341	my ($self) = @_;
		1342
		1343	utf8::encode (my $save = $self->{path}->save_path);
		1344	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1345	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1346	}
		1347
		1348	sub rename {
		1349	my ($self, $new_path) = @_;
		1350
		1351	$self->unlink_save;
		1352
		1353	delete $cf::MAP{$self->path};
		1354	$self->{path} = new cf::path $new_path;
		1355	$self->path ($self->{path}->as_string);
		1356	$cf::MAP{$self->path} = $self;
		1357
		1358	$self->save;
		1359	}
		1360
		1361	sub reset {
		1362	my ($self) = @_;
		1363
		1364	return if $self->players;
		1365	return if $self->{path}{user_rel};#d#
		1366
		1367	warn "resetting map ", $self->path;#d#
		1368
		1369	delete $cf::MAP{$self->path};
		1370
		1371	$_->clear_links_to ($self) for values %cf::MAP;
		1372
		1373	$self->unlink_save;
		1374	$self->destroy;
		1375	}
		1376
		1377	my $nuke_counter = "aaaa";
		1378
		1379	sub nuke {
		1380	my ($self) = @_;
		1381
		1382	$self->{deny_save} = 1;
		1383	$self->reset_timeout (1);
		1384	$self->rename ("{nuke}/" . ($nuke_counter++));
		1385	$self->reset; # polite request, might not happen
		1386	}
		1387
		1388	sub customise_for {
		1389	my ($map, $ob) = @_;
		1390
		1391	if ($map->per_player) {
		1392	return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
		1393	}
		1394
		1395	$map
		1396	}
		1397
		1398	sub emergency_save {
		1399	local $cf::FREEZE = 1;
		1400
		1401	warn "enter emergency map save\n";
		1402
		1403	cf::sync_job {
		1404	warn "begin emergency map save\n";
		1405	$_->save for values %cf::MAP;
		1406	};
		1407
		1408	warn "end emergency map save\n";
		1409	}
		1410
		1411	package cf;
		1412
		1413	=back
		1414
		1415
		1416	=head3 cf::object::player
		1417
		1418	=over 4
		1419
779	=item $object->reply ($npc, $msg[, $flags])	1420	=item $player_object->reply ($npc, $msg[, $flags])
780		1421
781	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1422	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	1423	can be C<undef>. Does the right thing when the player is currently in a
783	dialogue with the given NPC character.	1424	dialogue with the given NPC character.
784		1425
785	=cut	1426	=cut
786		1427
787	# rough implementation of a future "reply" method that works	1428	# rough implementation of a future "reply" method that works
788	# with dialog boxes.	1429	# with dialog boxes.
		1430	#TODO: the first argument must go, split into a $npc->reply_to ( method
789	sub cf::object::player::reply($$$;$) {	1431	sub cf::object::player::reply($$$;$) {
790	my ($self, $npc, $msg, $flags) = @_;	1432	my ($self, $npc, $msg, $flags) = @_;
791		1433
792	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1434	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
793		1435
…		…
797	$msg = $npc->name . " says: $msg" if $npc;	1439	$msg = $npc->name . " says: $msg" if $npc;
798	$self->message ($msg, $flags);	1440	$self->message ($msg, $flags);
799	}	1441	}
800	}	1442	}
801		1443
802	=item $player->ext_reply ($msgid, $msgtype, %msg)	1444	=item $player_object->may ("access")
803		1445
804	Sends an ext reply to the player.	1446	Returns wether the given player is authorized to access resource "access"
		1447	(e.g. "command_wizcast").
805		1448
806	=cut	1449	=cut
807		1450
808	sub cf::player::ext_reply($$$%) {	1451	sub cf::object::player::may {
		1452	my ($self, $access) = @_;
		1453
		1454	$self->flag (cf::FLAG_WIZ) ||
		1455	(ref $cf::CFG{"may_$access"}
		1456	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1457	: $cf::CFG{"may_$access"})
		1458	}
		1459
		1460	=item $player_object->enter_link
		1461
		1462	Freezes the player and moves him/her to a special map (C<{link}>).
		1463
		1464	The player should be reaosnably safe there for short amounts of time. You
		1465	I<MUST> call C<leave_link> as soon as possible, though.
		1466
		1467	=item $player_object->leave_link ($map, $x, $y)
		1468
		1469	Moves the player out of the specila link map onto the given map. If the
		1470	map is not valid (or omitted), the player will be moved back to the
		1471	location he/she was before the call to C<enter_link>, or, if that fails,
		1472	to the emergency map position.
		1473
		1474	Might block.
		1475
		1476	=cut
		1477
		1478	sub cf::object::player::enter_link {
		1479	my ($self) = @_;
		1480
		1481	$self->deactivate_recursive;
		1482
		1483	return if $self->map == $LINK_MAP;
		1484
		1485	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1486	if $self->map;
		1487
		1488	$self->enter_map ($LINK_MAP, 20, 20);
		1489	}
		1490
		1491	sub cf::object::player::leave_link {
		1492	my ($self, $map, $x, $y) = @_;
		1493
		1494	my $link_pos = delete $self->{_link_pos};
		1495
		1496	unless ($map) {
		1497	# restore original map position
		1498	($map, $x, $y) = @{ $link_pos || [] };
		1499	$map = cf::map::find_map $map;
		1500
		1501	unless ($map) {
		1502	($map, $x, $y) = @$EMERGENCY_POSITION;
		1503	$map = cf::map::find_map $map
		1504	or die "FATAL: cannot load emergency map\n";
		1505	}
		1506	}
		1507
		1508	($x, $y) = (-1, -1)
		1509	unless (defined $x) && (defined $y);
		1510
		1511	# use -1 or undef as default coordinates, not 0, 0
		1512	($x, $y) = ($map->enter_x, $map->enter_y)
		1513	if $x <=0 && $y <= 0;
		1514
		1515	$map->load;
		1516
		1517	$self->activate_recursive;
		1518	$self->enter_map ($map, $x, $y);
		1519	}
		1520
		1521	cf::player->attach (
		1522	on_logout => sub {
		1523	my ($pl) = @_;
		1524
		1525	# abort map switching before logout
		1526	if ($pl->ob->{_link_pos}) {
		1527	cf::sync_job {
		1528	$pl->ob->leave_link
		1529	};
		1530	}
		1531	},
		1532	on_login => sub {
		1533	my ($pl) = @_;
		1534
		1535	# try to abort aborted map switching on player login :)
		1536	# should happen only on crashes
		1537	if ($pl->ob->{_link_pos}) {
		1538	$pl->ob->enter_link;
		1539	Coro::async {
		1540	# we need this sleep as the login has a concurrent enter_exit running
		1541	# and this sleep increases chances of the player not ending up in scorn
		1542	Coro::Timer::sleep 1;
		1543	$pl->ob->leave_link;
		1544	};
		1545	}
		1546	},
		1547	);
		1548
		1549	=item $player_object->goto_map ($path, $x, $y)
		1550
		1551	=cut
		1552
		1553	sub cf::object::player::goto_map {
		1554	my ($self, $path, $x, $y) = @_;
		1555
		1556	$self->enter_link;
		1557
		1558	(Coro::async {
		1559	$path = new cf::path $path;
		1560
		1561	my $map = cf::map::find_map $path->as_string;
		1562	$map = $map->customise_for ($self) if $map;
		1563
		1564	# warn "entering ", $map->path, " at ($x, $y)\n"
		1565	# if $map;
		1566
		1567	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1568
		1569	$self->leave_link ($map, $x, $y);
		1570	})->prio (1);
		1571	}
		1572
		1573	=item $player_object->enter_exit ($exit_object)
		1574
		1575	=cut
		1576
		1577	sub parse_random_map_params {
		1578	my ($spec) = @_;
		1579
		1580	my $rmp = { # defaults
		1581	xsize => 10,
		1582	ysize => 10,
		1583	};
		1584
		1585	for (split /\n/, $spec) {
		1586	my ($k, $v) = split /\s+/, $_, 2;
		1587
		1588	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1589	}
		1590
		1591	$rmp
		1592	}
		1593
		1594	sub prepare_random_map {
		1595	my ($exit) = @_;
		1596
		1597	# all this does is basically replace the /! path by
		1598	# a new random map path (?random/...) with a seed
		1599	# that depends on the exit object
		1600
		1601	my $rmp = parse_random_map_params $exit->msg;
		1602
		1603	if ($exit->map) {
		1604	$rmp->{region} = $exit->map->region_name;
		1605	$rmp->{origin_map} = $exit->map->path;
		1606	$rmp->{origin_x} = $exit->x;
		1607	$rmp->{origin_y} = $exit->y;
		1608	}
		1609
		1610	$rmp->{random_seed} ||= $exit->random_seed;
		1611
		1612	my $data = cf::to_json $rmp;
		1613	my $md5 = Digest::MD5::md5_hex $data;
		1614
		1615	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1616	aio_write $fh, 0, (length $data), $data, 0;
		1617
		1618	$exit->slaying ("?random/$md5");
		1619	$exit->msg (undef);
		1620	}
		1621	}
		1622
		1623	sub cf::object::player::enter_exit {
809	my ($self, $id, %msg) = @_;	1624	my ($self, $exit) = @_;
810		1625
811	$msg{msgid} = $id;	1626	return unless $self->type == cf::PLAYER;
812		1627
813	$self->send ("ext " . to_json \%msg);	1628	$self->enter_link;
		1629
		1630	(Coro::async {
		1631	unless (eval {
		1632
		1633	prepare_random_map $exit
		1634	if $exit->slaying eq "/!";
		1635
		1636	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1637	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1638
		1639	1;
		1640	}) {
		1641	$self->message ("Something went wrong deep within the crossfire server. "
		1642	. "I'll try to bring you back to the map you were before. "
		1643	. "Please report this to the dungeon master",
		1644	cf::NDI_UNIQUE | cf::NDI_RED);
		1645
		1646	warn "ERROR in enter_exit: $@";
		1647	$self->leave_link;
		1648	}
		1649	})->prio (1);
814	}	1650	}
		1651
		1652	=head3 cf::client
		1653
		1654	=over 4
		1655
		1656	=item $client->send_drawinfo ($text, $flags)
		1657
		1658	Sends a drawinfo packet to the client. Circumvents output buffering so
		1659	should not be used under normal circumstances.
		1660
		1661	=cut
		1662
		1663	sub cf::client::send_drawinfo {
		1664	my ($self, $text, $flags) = @_;
		1665
		1666	utf8::encode $text;
		1667	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1668	}
		1669
		1670
		1671	=item $success = $client->query ($flags, "text", \&cb)
		1672
		1673	Queues a query to the client, calling the given callback with
		1674	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1675	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1676
		1677	Queries can fail, so check the return code. Or don't, as queries will become
		1678	reliable at some point in the future.
		1679
		1680	=cut
		1681
		1682	sub cf::client::query {
		1683	my ($self, $flags, $text, $cb) = @_;
		1684
		1685	return unless $self->state == ST_PLAYING
		1686	|| $self->state == ST_SETUP
		1687	|| $self->state == ST_CUSTOM;
		1688
		1689	$self->state (ST_CUSTOM);
		1690
		1691	utf8::encode $text;
		1692	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1693
		1694	$self->send_packet ($self->{query_queue}[0][0])
		1695	if @{ $self->{query_queue} } == 1;
		1696	}
		1697
		1698	cf::client->attach (
		1699	on_reply => sub {
		1700	my ($ns, $msg) = @_;
		1701
		1702	# this weird shuffling is so that direct followup queries
		1703	# get handled first
		1704	my $queue = delete $ns->{query_queue};
		1705
		1706	(shift @$queue)->[1]->($msg);
		1707
		1708	push @{ $ns->{query_queue} }, @$queue;
		1709
		1710	if (@{ $ns->{query_queue} } == @$queue) {
		1711	if (@$queue) {
		1712	$ns->send_packet ($ns->{query_queue}[0][0]);
		1713	} else {
		1714	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1715	}
		1716	}
		1717	},
		1718	);
		1719
		1720	=item $client->coro (\&cb)
		1721
		1722	Create a new coroutine, running the specified callback. The coroutine will
		1723	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1724	or loss of connection).
		1725
		1726	=cut
		1727
		1728	sub cf::client::coro {
		1729	my ($self, $cb) = @_;
		1730
		1731	my $coro; $coro = async {
		1732	eval {
		1733	$cb->();
		1734	};
		1735	warn $@ if $@;
		1736	};
		1737
		1738	$coro->on_destroy (sub {
		1739	delete $self->{_coro}{$coro+0};
		1740	});
		1741
		1742	$self->{_coro}{$coro+0} = $coro;
		1743
		1744	$coro
		1745	}
		1746
		1747	cf::client->attach (
		1748	on_destroy => sub {
		1749	my ($ns) = @_;
		1750
		1751	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1752	},
		1753	);
815		1754
816	=back	1755	=back
817		1756
818	=cut
819
820	#############################################################################
821		1757
822	=head2 SAFE SCRIPTING	1758	=head2 SAFE SCRIPTING
823		1759
824	Functions that provide a safe environment to compile and execute	1760	Functions that provide a safe environment to compile and execute
825	snippets of perl code without them endangering the safety of the server	1761	snippets of perl code without them endangering the safety of the server
826	itself. Looping constructs, I/O operators and other built-in functionality	1762	itself. Looping constructs, I/O operators and other built-in functionality
827	is not available in the safe scripting environment, and the number of	1763	is not available in the safe scripting environment, and the number of
828	functions and methods that cna be called is greatly reduced.	1764	functions and methods that can be called is greatly reduced.
829		1765
830	=cut	1766	=cut
831		1767
832	our $safe = new Safe "safe";	1768	our $safe = new Safe "safe";
833	our $safe_hole = new Safe::Hole;	1769	our $safe_hole = new Safe::Hole;
…		…
840		1776
841	=pod	1777	=pod
842		1778
843	The following fucntions and emthods are available within a safe environment:	1779	The following fucntions and emthods are available within a safe environment:
844		1780
845	cf::object contr pay_amount pay_player	1781	cf::object contr pay_amount pay_player map
846	cf::object::player player	1782	cf::object::player player
847	cf::player peaceful	1783	cf::player peaceful
		1784	cf::map trigger
848		1785
849	=cut	1786	=cut
850		1787
851	for (	1788	for (
852	["cf::object" => qw(contr pay_amount pay_player)],	1789	["cf::object" => qw(contr pay_amount pay_player map)],
853	["cf::object::player" => qw(player)],	1790	["cf::object::player" => qw(player)],
854	["cf::player" => qw(peaceful)],	1791	["cf::player" => qw(peaceful)],
		1792	["cf::map" => qw(trigger)],
855	) {	1793	) {
856	no strict 'refs';	1794	no strict 'refs';
857	my ($pkg, @funs) = @$_;	1795	my ($pkg, @funs) = @$_;
858	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1796	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
859	for @funs;	1797	for @funs;
…		…
969		1907
970	Immediately write the database to disk I<if it is dirty>.	1908	Immediately write the database to disk I<if it is dirty>.
971		1909
972	=cut	1910	=cut
973		1911
		1912	our $DB;
		1913
974	{	1914	{
975	my $db;
976	my $path = cf::localdir . "/database.pst";	1915	my $path = cf::localdir . "/database.pst";
977		1916
978	sub db_load() {	1917	sub db_load() {
979	warn "loading database $path\n";#d# remove later
980	$db = stat $path ? Storable::retrieve $path : { };	1918	$DB = stat $path ? Storable::retrieve $path : { };
981	}	1919	}
982		1920
983	my $pid;	1921	my $pid;
984		1922
985	sub db_save() {	1923	sub db_save() {
986	warn "saving database $path\n";#d# remove later
987	waitpid $pid, 0 if $pid;	1924	waitpid $pid, 0 if $pid;
988	if (0 == ($pid = fork)) {	1925	if (0 == ($pid = fork)) {
989	$db->{_meta}{version} = 1;	1926	$DB->{_meta}{version} = 1;
990	Storable::nstore $db, "$path~";	1927	Storable::nstore $DB, "$path~";
991	rename "$path~", $path;	1928	rename "$path~", $path;
992	cf::_exit 0 if defined $pid;	1929	cf::_exit 0 if defined $pid;
993	}	1930	}
994	}	1931	}
995		1932
…		…
998	sub db_sync() {	1935	sub db_sync() {
999	db_save if $dirty;	1936	db_save if $dirty;
1000	undef $dirty;	1937	undef $dirty;
1001	}	1938	}
1002		1939
1003	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1940	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1004	db_sync;	1941	db_sync;
1005	});	1942	});
1006		1943
1007	sub db_dirty() {	1944	sub db_dirty() {
1008	$dirty = 1;	1945	$dirty = 1;
1009	$idle->start;	1946	$idle->start;
1010	}	1947	}
1011		1948
1012	sub db_get($;$) {	1949	sub db_get($;$) {
1013	@_ >= 2	1950	@_ >= 2
1014	? $db->{$_[0]}{$_[1]}	1951	? $DB->{$_[0]}{$_[1]}
1015	: ($db->{$_[0]} ||= { })	1952	: ($DB->{$_[0]} ||= { })
1016	}	1953	}
1017		1954
1018	sub db_put($$;$) {	1955	sub db_put($$;$) {
1019	if (@_ >= 3) {	1956	if (@_ >= 3) {
1020	$db->{$_[0]}{$_[1]} = $_[2];	1957	$DB->{$_[0]}{$_[1]} = $_[2];
1021	} else {	1958	} else {
1022	$db->{$_[0]} = $_[1];	1959	$DB->{$_[0]} = $_[1];
1023	}	1960	}
1024	db_dirty;	1961	db_dirty;
1025	}	1962	}
1026		1963
1027	attach_global	1964	cf::global->attach (
1028	prio => 10000,	1965	prio => 10000,
1029	on_cleanup => sub {	1966	on_cleanup => sub {
1030	db_sync;	1967	db_sync;
1031	},	1968	},
1032	;	1969	);
1033	}	1970	}
1034		1971
1035	#############################################################################	1972	#############################################################################
1036	# the server's main()	1973	# the server's main()
1037		1974
…		…
1042	local $/;	1979	local $/;
1043	*CFG = YAML::Syck::Load <$fh>;	1980	*CFG = YAML::Syck::Load <$fh>;
1044	}	1981	}
1045		1982
1046	sub main {	1983	sub main {
		1984	# we must not ever block the main coroutine
		1985	local $Coro::idle = sub {
		1986	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		1987	(Coro::unblock_sub {
		1988	Event::one_event;
		1989	})->();
		1990	};
		1991
1047	cfg_load;	1992	cfg_load;
1048	db_load;	1993	db_load;
1049	load_extensions;	1994	load_extensions;
1050	Event::loop;	1995	Event::loop;
1051	}	1996	}
1052		1997
1053	#############################################################################	1998	#############################################################################
1054	# initialisation	1999	# initialisation
1055		2000
1056	sub _perl_reload(&) {	2001	sub reload() {
1057	my ($msg) = @_;	2002	# can/must only be called in main
		2003	if ($Coro::current != $Coro::main) {
		2004	warn "can only reload from main coroutine\n";
		2005	return;
		2006	}
1058		2007
1059	$msg->("reloading...");	2008	warn "reloading...";
		2009
		2010	local $FREEZE = 1;
		2011	cf::emergency_save;
1060		2012
1061	eval {	2013	eval {
		2014	# if anything goes wrong in here, we should simply crash as we already saved
		2015
1062	# cancel all watchers	2016	# cancel all watchers
1063	$_->cancel for Event::all_watchers;	2017	for (Event::all_watchers) {
		2018	$_->cancel if $_->data & WF_AUTOCANCEL;
		2019	}
		2020
		2021	# cancel all extension coros
		2022	$_->cancel for values %EXT_CORO;
		2023	%EXT_CORO = ();
1064		2024
1065	# unload all extensions	2025	# unload all extensions
1066	for (@exts) {	2026	for (@exts) {
1067	$msg->("unloading <$_>");	2027	warn "unloading <$_>";
1068	unload_extension $_;	2028	unload_extension $_;
1069	}	2029	}
1070		2030
1071	# unload all modules loaded from $LIBDIR	2031	# unload all modules loaded from $LIBDIR
1072	while (my ($k, $v) = each %INC) {	2032	while (my ($k, $v) = each %INC) {
1073	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2033	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1074		2034
1075	$msg->("removing <$k>");	2035	warn "removing <$k>";
1076	delete $INC{$k};	2036	delete $INC{$k};
1077		2037
1078	$k =~ s/\.pm$//;	2038	$k =~ s/\.pm$//;
1079	$k =~ s/\//::/g;	2039	$k =~ s/\//::/g;
1080		2040
…		…
1085	Symbol::delete_package $k;	2045	Symbol::delete_package $k;
1086	}	2046	}
1087		2047
1088	# sync database to disk	2048	# sync database to disk
1089	cf::db_sync;	2049	cf::db_sync;
		2050	IO::AIO::flush;
1090		2051
1091	# get rid of safe::, as good as possible	2052	# get rid of safe::, as good as possible
1092	Symbol::delete_package "safe::$_"	2053	Symbol::delete_package "safe::$_"
1093	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2054	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1094		2055
1095	# remove register_script_function callbacks	2056	# remove register_script_function callbacks
1096	# TODO	2057	# TODO
1097		2058
1098	# unload cf.pm "a bit"	2059	# unload cf.pm "a bit"
…		…
1101	# don't, removes xs symbols, too,	2062	# don't, removes xs symbols, too,
1102	# and global variables created in xs	2063	# and global variables created in xs
1103	#Symbol::delete_package __PACKAGE__;	2064	#Symbol::delete_package __PACKAGE__;
1104		2065
1105	# reload cf.pm	2066	# reload cf.pm
1106	$msg->("reloading cf.pm");	2067	warn "reloading cf.pm";
1107	require cf;	2068	require cf;
		2069	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1108		2070
1109	# load config and database again	2071	# load config and database again
1110	cf::cfg_load;	2072	cf::cfg_load;
1111	cf::db_load;	2073	cf::db_load;
1112		2074
1113	# load extensions	2075	# load extensions
1114	$msg->("load extensions");	2076	warn "load extensions";
1115	cf::load_extensions;	2077	cf::load_extensions;
1116		2078
1117	# reattach attachments to objects	2079	# reattach attachments to objects
1118	$msg->("reattach");	2080	warn "reattach";
1119	_global_reattach;	2081	_global_reattach;
1120	};	2082	};
1121	$msg->($@) if $@;
1122		2083
1123	$msg->("reloaded");	2084	if ($@) {
		2085	warn $@;
		2086	warn "error while reloading, exiting.";
		2087	exit 1;
		2088	}
		2089
		2090	warn "reloaded successfully";
1124	};	2091	};
1125		2092
1126	sub perl_reload() {	2093	#############################################################################
1127	_perl_reload {
1128	warn $_[0];
1129	print "$_[0]\n";
1130	};
1131	}
1132		2094
		2095	unless ($LINK_MAP) {
		2096	$LINK_MAP = cf::map::new;
		2097
		2098	$LINK_MAP->width (41);
		2099	$LINK_MAP->height (41);
		2100	$LINK_MAP->alloc;
		2101	$LINK_MAP->path ("{link}");
		2102	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2103	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2104
		2105	# dirty hack because... archetypes are not yet loaded
		2106	Event->timer (
		2107	after => 2,
		2108	cb => sub {
		2109	$_[0]->w->cancel;
		2110
		2111	# provide some exits "home"
		2112	my $exit = cf::object::new "exit";
		2113
		2114	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2115	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2116	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2117
		2118	$LINK_MAP->insert ($exit->clone, 19, 19);
		2119	$LINK_MAP->insert ($exit->clone, 19, 20);
		2120	$LINK_MAP->insert ($exit->clone, 19, 21);
		2121	$LINK_MAP->insert ($exit->clone, 20, 19);
		2122	$LINK_MAP->insert ($exit->clone, 20, 21);
		2123	$LINK_MAP->insert ($exit->clone, 21, 19);
		2124	$LINK_MAP->insert ($exit->clone, 21, 20);
		2125	$LINK_MAP->insert ($exit->clone, 21, 21);
		2126
		2127	$exit->destroy;
		2128	});
		2129
		2130	$LINK_MAP->{deny_save} = 1;
		2131	$LINK_MAP->{deny_reset} = 1;
		2132
		2133	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2134	}
		2135
		2136	register "<global>", __PACKAGE__;
		2137
1133	register_command "perl-reload", 0, sub {	2138	register_command "reload" => sub {
1134	my ($who, $arg) = @_;	2139	my ($who, $arg) = @_;
1135		2140
1136	if ($who->flag (FLAG_WIZ)) {	2141	if ($who->flag (FLAG_WIZ)) {
1137	_perl_reload {	2142	$who->message ("start of reload.");
1138	warn $_[0];	2143	reload;
1139	$who->message ($_[0]);	2144	$who->message ("end of reload.");
1140	};
1141	}	2145	}
1142	};	2146	};
1143		2147
1144	register "<global>", __PACKAGE__;
1145
1146	unshift @INC, $LIBDIR;	2148	unshift @INC, $LIBDIR;
1147		2149
1148	$TICK_WATCHER = Event->timer (	2150	$TICK_WATCHER = Event->timer (
		2151	reentrant => 0,
1149	prio => 1,	2152	prio => 0,
1150	at => $NEXT_TICK || 1,	2153	at => $NEXT_TICK || $TICK,
		2154	data => WF_AUTOCANCEL,
1151	cb => sub {	2155	cb => sub {
		2156	unless ($FREEZE) {
1152	cf::server_tick; # one server iteration	2157	cf::server_tick; # one server iteration
		2158	$RUNTIME += $TICK;
		2159	}
1153		2160
1154	my $NOW = Event::time;
1155	$NEXT_TICK += $TICK;	2161	$NEXT_TICK += $TICK;
1156		2162
1157	# if we are delayed by four ticks, skip them all	2163	# if we are delayed by four ticks or more, skip them all
1158	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2164	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1159		2165
1160	$TICK_WATCHER->at ($NEXT_TICK);	2166	$TICK_WATCHER->at ($NEXT_TICK);
1161	$TICK_WATCHER->start;	2167	$TICK_WATCHER->start;
1162	},	2168	},
1163	);	2169	);
1164		2170
		2171	IO::AIO::max_poll_time $TICK * 0.2;
		2172
		2173	Event->io (
		2174	fd => IO::AIO::poll_fileno,
		2175	poll => 'r',
		2176	prio => 5,
		2177	data => WF_AUTOCANCEL,
		2178	cb => \&IO::AIO::poll_cb,
		2179	);
		2180
		2181	Event->timer (
		2182	data => WF_AUTOCANCEL,
		2183	after => 0,
		2184	interval => 10,
		2185	cb => sub {
		2186	(Coro::unblock_sub {
		2187	write_runtime
		2188	or warn "ERROR: unable to write runtime file: $!";
		2189	})->();
		2190	},
		2191	);
		2192
1165	1	2193	1
1166		2194

Diff Legend

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