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

Diff Legend

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