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

Diff Legend

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