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

Diff Legend

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