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

Diff Legend

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