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

Diff Legend

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