ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.73 by root, Sun Oct 1 11:46:51 2006 UTC vs.
Revision 1.131 by root, Thu Jan 4 00:53:54 2007 UTC

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

Diff Legend

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