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.85 by root, Mon Dec 11 22:56:57 2006 UTC vs.
Revision 1.155 by root, Tue Jan 9 21:32:42 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 Data::Dumper;
		21	use Digest::MD5;
		22	use Fcntl;
10	use IO::AIO ();	23	use IO::AIO 2.32 ();
11	use YAML::Syck ();	24	use YAML::Syck ();
12	use Time::HiRes;	25	use Time::HiRes;
13	use Event;	26
14	$Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		28
		29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		30
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	32	$YAML::Syck::ImplicitUnicode = 1;
18		33
19	use strict;	34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20		35
21	our %COMMAND = ();	36	our %COMMAND = ();
22	our %COMMAND_TIME = ();	37	our %COMMAND_TIME = ();
23	our %EXTCMD = ();	38	our %EXTCMD = ();
24		39
25	_init_vars;
26
27	our @EVENT;	40	our @EVENT;
28	our $LIBDIR = maps_directory "perl";	41	our $LIBDIR = datadir . "/ext";
29		42
30	our $TICK = MAX_TIME * 1e-6;	43	our $TICK = MAX_TIME * 1e-6;
31	our $TICK_WATCHER;	44	our $TICK_WATCHER;
32	our $NEXT_TICK;	45	our $NEXT_TICK;
		46	our $NOW;
33		47
34	our %CFG;	48	our %CFG;
35		49
36	our $UPTIME; $UPTIME ||= time;	50	our $UPTIME; $UPTIME ||= time;
		51	our $RUNTIME;
		52
		53	our %PLAYER; # all users
		54	our %MAP; # all maps
		55	our $LINK_MAP; # the special {link} map
		56	our $RANDOM_MAPS = cf::localdir . "/random";
		57	our %EXT_CORO; # coroutines bound to extensions
		58
		59	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		60	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		61
		62	binmode STDOUT;
		63	binmode STDERR;
		64
		65	# read virtual server time, if available
		66	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		67	open my $fh, "<", cf::localdir . "/runtime"
		68	or die "unable to read runtime file: $!";
		69	$RUNTIME = <$fh> + 0.;
		70	}
		71
		72	mkdir cf::localdir;
		73	mkdir cf::localdir . "/" . cf::playerdir;
		74	mkdir cf::localdir . "/" . cf::tmpdir;
		75	mkdir cf::localdir . "/" . cf::uniquedir;
		76	mkdir $RANDOM_MAPS;
		77
		78	# a special map that is always available
		79	our $LINK_MAP;
		80	our $EMERGENCY_POSITION;
37		81
38	#############################################################################	82	#############################################################################
39		83
40	=head2 GLOBAL VARIABLES	84	=head2 GLOBAL VARIABLES
41		85
42	=over 4	86	=over 4
43		87
44	=item $cf::UPTIME	88	=item $cf::UPTIME
45		89
46	The timestamp of the server start (so not actually an uptime).	90	The timestamp of the server start (so not actually an uptime).
		91
		92	=item $cf::RUNTIME
		93
		94	The time this server has run, starts at 0 and is increased by $cf::TICK on
		95	every server tick.
47		96
48	=item $cf::LIBDIR	97	=item $cf::LIBDIR
49		98
50	The perl library directory, where extensions and cf-specific modules can	99	The perl library directory, where extensions and cf-specific modules can
51	be found. It will be added to C<@INC> automatically.	100	be found. It will be added to C<@INC> automatically.
52		101
		102	=item $cf::NOW
		103
		104	The time of the last (current) server tick.
		105
53	=item $cf::TICK	106	=item $cf::TICK
54		107
55	The interval between server ticks, in seconds.	108	The interval between server ticks, in seconds.
56		109
57	=item %cf::CFG	110	=item %cf::CFG
58		111
59	Configuration for the server, loaded from C</etc/crossfire/config>, or	112	Configuration for the server, loaded from C</etc/crossfire/config>, or
60	from wherever your confdir points to.	113	from wherever your confdir points to.
		114
		115	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		116
		117	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		118	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		119	processing has been done. Call C<< ->wait >> on them to maximise the
		120	window of cpu time available, or simply to synchronise to the server tick.
61		121
62	=back	122	=back
63		123
64	=cut	124	=cut
65		125
66	BEGIN {	126	BEGIN {
67	*CORE::GLOBAL::warn = sub {	127	*CORE::GLOBAL::warn = sub {
68	my $msg = join "", @_;	128	my $msg = join "", @_;
		129	utf8::encode $msg;
		130
69	$msg .= "\n"	131	$msg .= "\n"
70	unless $msg =~ /\n$/;	132	unless $msg =~ /\n$/;
71		133
72	print STDERR "cfperl: $msg";
73	LOG llevError, "cfperl: $msg";	134	LOG llevError, $msg;
74	};	135	};
75	}	136	}
76		137
		138	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		139	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		140	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		141	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		142	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
77	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	143	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
78		144
79	# we bless all objects into (empty) derived classes to force a method lookup	145	# we bless all objects into (empty) derived classes to force a method lookup
80	# within the Safe compartment.	146	# 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)) {	147	for my $pkg (qw(
		148	cf::global cf::attachable
		149	cf::object cf::object::player
		150	cf::client cf::player
		151	cf::arch cf::living
		152	cf::map cf::party cf::region
		153	)) {
82	no strict 'refs';	154	no strict 'refs';
83	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	155	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84	}	156	}
85		157
86	$Event::DIED = sub {	158	$Event::DIED = sub {
…		…
93		165
94	=head2 UTILITY FUNCTIONS	166	=head2 UTILITY FUNCTIONS
95		167
96	=over 4	168	=over 4
97		169
		170	=item dumpval $ref
		171
98	=cut	172	=cut
		173
		174	sub dumpval {
		175	eval {
		176	local $SIG{__DIE__};
		177	my $d;
		178	if (1) {
		179	$d = new Data::Dumper([$_[0]], ["*var"]);
		180	$d->Terse(1);
		181	$d->Indent(2);
		182	$d->Quotekeys(0);
		183	$d->Useqq(1);
		184	#$d->Bless(...);
		185	$d->Seen($_[1]) if @_ > 1;
		186	$d = $d->Dump();
		187	}
		188	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		189	$d
		190	} || "[unable to dump $_[0]: '$@']";
		191	}
99		192
100	use JSON::Syck (); # TODO# replace by JSON::PC once working	193	use JSON::Syck (); # TODO# replace by JSON::PC once working
101		194
102	=item $ref = cf::from_json $json	195	=item $ref = cf::from_json $json
103		196
…		…
119	sub to_json($) {	212	sub to_json($) {
120	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	213	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
121	JSON::Syck::Dump $_[0]	214	JSON::Syck::Dump $_[0]
122	}	215	}
123		216
		217	=item cf::lock_wait $string
		218
		219	Wait until the given lock is available. See cf::lock_acquire.
		220
		221	=item my $lock = cf::lock_acquire $string
		222
		223	Wait until the given lock is available and then acquires it and returns
		224	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		225	for example when the coroutine gets canceled), the lock is automatically
		226	returned.
		227
		228	Lock names should begin with a unique identifier (for example, cf::map::find
		229	uses map_find and cf::map::load uses map_load).
		230
		231	=cut
		232
		233	our %LOCK;
		234
		235	sub lock_wait($) {
		236	my ($key) = @_;
		237
		238	# wait for lock, if any
		239	while ($LOCK{$key}) {
		240	push @{ $LOCK{$key} }, $Coro::current;
		241	Coro::schedule;
		242	}
		243	}
		244
		245	sub lock_acquire($) {
		246	my ($key) = @_;
		247
		248	# wait, to be sure we are not locked
		249	lock_wait $key;
		250
		251	$LOCK{$key} = [];
		252
		253	Coro::guard {
		254	# wake up all waiters, to be on the safe side
		255	$_->ready for @{ delete $LOCK{$key} };
		256	}
		257	}
		258
		259	sub freeze_mainloop {
		260	return unless $TICK_WATCHER->is_active;
		261
		262	my $guard = Coro::guard { $TICK_WATCHER->start };
		263	$TICK_WATCHER->stop;
		264	$guard
		265	}
		266
		267	=item cf::async { BLOCK }
		268
		269	Currently the same as Coro::async_pool, meaning you cannot use
		270	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		271	thing you are allowed to do is call C<prio> on it.
		272
		273	=cut
		274
		275	BEGIN { *async = \&Coro::async_pool }
		276
		277	=item cf::sync_job { BLOCK }
		278
		279	The design of crossfire+ requires that the main coro ($Coro::main) is
		280	always able to handle events or runnable, as crossfire+ is only partly
		281	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		282
		283	If it must be done, put the blocking parts into C<sync_job>. This will run
		284	the given BLOCK in another coroutine while waiting for the result. The
		285	server will be frozen during this time, so the block should either finish
		286	fast or be very important.
		287
		288	=cut
		289
		290	sub sync_job(&) {
		291	my ($job) = @_;
		292
		293	if ($Coro::current == $Coro::main) {
		294	# this is the main coro, too bad, we have to block
		295	# till the operation succeeds, freezing the server :/
		296
		297	# TODO: use suspend/resume instead
		298	# (but this is cancel-safe)
		299	my $freeze_guard = freeze_mainloop;
		300
		301	my $busy = 1;
		302	my @res;
		303
		304	(async {
		305	@res = eval { $job->() };
		306	warn $@ if $@;
		307	undef $busy;
		308	})->prio (Coro::PRIO_MAX);
		309
		310	while ($busy) {
		311	Coro::cede or Event::one_event;
		312	}
		313
		314	wantarray ? @res : $res[0]
		315	} else {
		316	# we are in another coroutine, how wonderful, everything just works
		317
		318	$job->()
		319	}
		320	}
		321
		322	=item $coro = cf::async_ext { BLOCK }
		323
		324	Like async, but this coro is automcatially being canceled when the
		325	extension calling this is being unloaded.
		326
		327	=cut
		328
		329	sub async_ext(&) {
		330	my $cb = shift;
		331
		332	my $coro = &Coro::async ($cb);
		333
		334	$coro->on_destroy (sub {
		335	delete $EXT_CORO{$coro+0};
		336	});
		337	$EXT_CORO{$coro+0} = $coro;
		338
		339	$coro
		340	}
		341
		342	sub write_runtime {
		343	my $runtime = cf::localdir . "/runtime";
		344
		345	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		346	or return;
		347
		348	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		349	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		350	and return;
		351
		352	aio_fsync $fh
		353	and return;
		354
		355	close $fh
		356	or return;
		357
		358	aio_rename "$runtime~", $runtime
		359	and return;
		360
		361	1
		362	}
		363
124	=back	364	=back
125		365
126	=cut	366	=cut
127		367
128	#############################################################################	368	#############################################################################
129		369
130	=head2 EVENTS AND OBJECT ATTACHMENTS	370	package cf::path;
		371
		372	# used to convert map paths into valid unix filenames by repalcing / by ∕
		373	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		374
		375	sub new {
		376	my ($class, $path, $base) = @_;
		377
		378	$path = $path->as_string if ref $path;
		379
		380	my $self = bless { }, $class;
		381
		382	# {... are special paths that are not touched
		383	# ?xxx/... are special absolute paths
		384	# ?random/... random maps
		385	# /! non-realised random map exit
		386	# /... normal maps
		387	# ~/... per-player maps without a specific player (DO NOT USE)
		388	# ~user/... per-player map of a specific user
		389
		390	if ($path =~ /^{/) {
		391	# fine as it is
		392	} elsif ($path =~ s{^\?random/}{}) {
		393	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		394	$self->{random} = cf::from_json $data;
		395	} else {
		396	if ($path =~ s{^~([^/]+)?}{}) {
		397	$self->{user_rel} = 1;
		398
		399	if (defined $1) {
		400	$self->{user} = $1;
		401	} elsif ($base =~ m{^~([^/]+)/}) {
		402	$self->{user} = $1;
		403	} else {
		404	warn "cannot resolve user-relative path without user <$path,$base>\n";
		405	}
		406	} elsif ($path =~ /^\//) {
		407	# already absolute
		408	} else {
		409	$base =~ s{[^/]+/?$}{};
		410	return $class->new ("$base/$path");
		411	}
		412
		413	for ($path) {
		414	redo if s{/\.?/}{/};
		415	redo if s{/[^/]+/\.\./}{/};
		416	}
		417	}
		418
		419	$self->{path} = $path;
		420
		421	$self
		422	}
		423
		424	# the name / primary key / in-game path
		425	sub as_string {
		426	my ($self) = @_;
		427
		428	$self->{user_rel} ? "~$self->{user}$self->{path}"
		429	: $self->{random} ? "?random/$self->{path}"
		430	: $self->{path}
		431	}
		432
		433	# the displayed name, this is a one way mapping
		434	sub visible_name {
		435	my ($self) = @_;
		436
		437	# if (my $rmp = $self->{random}) {
		438	# # todo: be more intelligent about this
		439	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		440	# } else {
		441	$self->as_string
		442	# }
		443	}
		444
		445	# escape the /'s in the path
		446	sub _escaped_path {
		447	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		448	$path
		449	}
		450
		451	# the original (read-only) location
		452	sub load_path {
		453	my ($self) = @_;
		454
		455	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		456	}
		457
		458	# the temporary/swap location
		459	sub save_path {
		460	my ($self) = @_;
		461
		462	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		463	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		464	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		465	}
		466
		467	# the unique path, might be eq to save_path
		468	sub uniq_path {
		469	my ($self) = @_;
		470
		471	$self->{user_rel} || $self->{random}
		472	? undef
		473	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		474	}
		475
		476	# return random map parameters, or undef
		477	sub random_map_params {
		478	my ($self) = @_;
		479
		480	$self->{random}
		481	}
		482
		483	# this is somewhat ugly, but style maps do need special treatment
		484	sub is_style_map {
		485	$_[0]{path} =~ m{^/styles/}
		486	}
		487
		488	package cf;
		489
		490	#############################################################################
		491
		492	=head2 ATTACHABLE OBJECTS
		493
		494	Many objects in crossfire are so-called attachable objects. That means you can
		495	attach callbacks/event handlers (a collection of which is called an "attachment")
		496	to it. All such attachable objects support the following methods.
		497
		498	In the following description, CLASS can be any of C<global>, C<object>
		499	C<player>, C<client> or C<map> (i.e. the attachable objects in
		500	crossfire+).
131		501
132	=over 4	502	=over 4
133		503
134	=item $object->attach ($attachment, key => $value...)
135
136	=item $object->detach ($attachment)
137
138	Attach/detach a pre-registered attachment to an object.
139
140	=item $player->attach ($attachment, key => $value...)
141
142	=item $player->detach ($attachment)
143
144	Attach/detach a pre-registered attachment to a player.
145
146	=item $map->attach ($attachment, key => $value...)	504	=item $attachable->attach ($attachment, key => $value...)
147		505
148	=item $map->detach ($attachment)	506	=item $attachable->detach ($attachment)
149		507
150	Attach/detach a pre-registered attachment to a map.	508	Attach/detach a pre-registered attachment to a specific object and give it
		509	the specified key/value pairs as arguments.
151		510
152	=item $bool = $object->attached ($name)	511	Example, attach a minesweeper attachment to the given object, making it a
		512	10x10 minesweeper game:
153		513
154	=item $bool = $player->attached ($name)	514	$obj->attach (minesweeper => width => 10, height => 10);
155		515
156	=item $bool = $map->attached ($name)	516	=item $bool = $attachable->attached ($name)
157		517
158	Checks wether the named attachment is currently attached to the object.	518	Checks wether the named attachment is currently attached to the object.
159		519
160	=item cf::attach_global ...	520	=item cf::CLASS->attach ...
161		521
162	Attach handlers for global events.	522	=item cf::CLASS->detach ...
163		523
164	This and all following C<attach_*>-functions expect any number of the	524	Define an anonymous attachment and attach it to all objects of the given
165	following handler/hook descriptions:	525	CLASS. See the next function for an explanation of its arguments.
		526
		527	You can attach to global events by using the C<cf::global> class.
		528
		529	Example, log all player logins:
		530
		531	cf::player->attach (
		532	on_login => sub {
		533	my ($pl) = @_;
		534	...
		535	},
		536	);
		537
		538	Example, attach to the jeweler skill:
		539
		540	cf::object->attach (
		541	type => cf::SKILL,
		542	subtype => cf::SK_JEWELER,
		543	on_use_skill => sub {
		544	my ($sk, $ob, $part, $dir, $msg) = @_;
		545	...
		546	},
		547	);
		548
		549	=item cf::CLASS::attachment $name, ...
		550
		551	Register an attachment by C<$name> through which attachable objects of the
		552	given CLASS can refer to this attachment.
		553
		554	Some classes such as crossfire maps and objects can specify attachments
		555	that are attached at load/instantiate time, thus the need for a name.
		556
		557	These calls expect any number of the following handler/hook descriptions:
166		558
167	=over 4	559	=over 4
168		560
169	=item prio => $number	561	=item prio => $number
170		562
…		…
172	by another C<prio> setting). Lower priority handlers get executed	564	by another C<prio> setting). Lower priority handlers get executed
173	earlier. The default priority is C<0>, and many built-in handlers are	565	earlier. The default priority is C<0>, and many built-in handlers are
174	registered at priority C<-1000>, so lower priorities should not be used	566	registered at priority C<-1000>, so lower priorities should not be used
175	unless you know what you are doing.	567	unless you know what you are doing.
176		568
		569	=item type => $type
		570
		571	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		572	given type of objects only (the additional parameter C<subtype> can be
		573	used to further limit to the given subtype).
		574
177	=item on_I<event> => \&cb	575	=item on_I<event> => \&cb
178		576
179	Call the given code reference whenever the named event happens (event is	577	Call the given code reference whenever the named event happens (event is
180	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	578	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
181	handlers are recognised generally depends on the type of object these	579	handlers are recognised generally depends on the type of object these
…		…
190	package and register them. Only handlers for eevents supported by the	588	package and register them. Only handlers for eevents supported by the
191	object/class are recognised.	589	object/class are recognised.
192		590
193	=back	591	=back
194		592
195	=item cf::attach_to_type $object_type, $subtype, ...	593	Example, define an attachment called "sockpuppet" that calls the given
		594	event handler when a monster attacks:
196		595
197	Attach handlers for a specific object type (e.g. TRANSPORT) and	596	cf::object::attachment sockpuppet =>
198	subtype. If C<$subtype> is zero or undef, matches all objects of the given	597	on_skill_attack => sub {
199	type.	598	my ($self, $victim) = @_;
200		599	...
201	=item cf::attach_to_objects ...
202
203	Attach handlers to all objects. Do not use this except for debugging or
204	very rare events, as handlers are (obviously) called for I<all> objects in
205	the game.
206
207	=item cf::attach_to_players ...
208
209	Attach handlers to all players.
210
211	=item cf::attach_to_maps ...
212
213	Attach handlers to all maps.
214
215	=item cf:register_attachment $name, ...
216
217	Register an attachment by name through which objects can refer to this
218	attachment.
219
220	=item cf:register_player_attachment $name, ...
221
222	Register an attachment by name through which players can refer to this
223	attachment.
224
225	=item cf:register_map_attachment $name, ...
226
227	Register an attachment by name through which maps can refer to this
228	attachment.
229
230	=cut
231
232	# the following variables are defined in .xs and must not be re-created
233	our @CB_GLOBAL = (); # registry for all global events
234	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
235	our @CB_PLAYER = ();
236	our @CB_TYPE = (); # registry for type (cf-object class) based events
237	our @CB_MAP = ();
238
239	my %attachment;
240
241	sub _attach_cb($\%$$$) {
242	my ($registry, $undo, $event, $prio, $cb) = @_;
243
244	use sort 'stable';
245
246	$cb = [$prio, $cb];
247
248	@{$registry->[$event]} = sort
249	{ $a->[0] cmp $b->[0] }
250	@{$registry->[$event] || []}, $cb;
251
252	push @{$undo->{cb}}, [$event, $cb];
253	}
254
255	# attach handles attaching event callbacks
256	# the only thing the caller has to do is pass the correct
257	# registry (== where the callback attaches to).
258	sub _attach(\@$@) {
259	my ($registry, $klass, @arg) = @_;
260
261	my $prio = 0;
262
263	my %undo = (
264	registry => $registry,
265	cb => [],
266	);
267
268	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
269
270	while (@arg) {
271	my $type = shift @arg;
272
273	if ($type eq "prio") {
274	$prio = shift @arg;
275
276	} elsif ($type eq "package") {
277	my $pkg = shift @arg;
278
279	while (my ($name, $id) = each %cb_id) {
280	if (my $cb = $pkg->can ($name)) {
281	_attach_cb $registry, %undo, $id, $prio, $cb;
282	}
283	}	600	}
284
285	} elsif (exists $cb_id{$type}) {
286	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
287
288	} elsif (ref $type) {
289	warn "attaching objects not supported, ignoring.\n";
290
291	} else {
292	shift @arg;
293	warn "attach argument '$type' not supported, ignoring.\n";
294	}
295	}
296
297	\%undo
298	}
299
300	sub _attach_attachment {
301	my ($obj, $name, %arg) = @_;
302
303	return if exists $obj->{_attachment}{$name};
304
305	my $res;
306
307	if (my $attach = $attachment{$name}) {
308	my $registry = $obj->registry;
309
310	for (@$attach) {
311	my ($klass, @attach) = @$_;
312	$res = _attach @$registry, $klass, @attach;
313	}
314
315	$obj->{$name} = \%arg;
316	} else {
317	warn "object uses attachment '$name' that is not available, postponing.\n";
318	}
319
320	$obj->{_attachment}{$name} = undef;
321
322	$res->{attachment} = $name;
323	$res
324	}
325
326	*cf::object::attach =
327	*cf::player::attach =
328	*cf::map::attach = sub {
329	my ($obj, $name, %arg) = @_;
330
331	_attach_attachment $obj, $name, %arg;
332	};
333
334	# all those should be optimised
335	*cf::object::detach =
336	*cf::player::detach =
337	*cf::map::detach = sub {
338	my ($obj, $name) = @_;
339
340	delete $obj->{_attachment}{$name};
341	reattach ($obj);
342	};
343
344	*cf::object::attached =
345	*cf::player::attached =
346	*cf::map::attached = sub {
347	my ($obj, $name) = @_;
348
349	exists $obj->{_attachment}{$name}
350	};
351
352	sub attach_global {
353	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
354	}
355
356	sub attach_to_type {
357	my $type = shift;
358	my $subtype = shift;
359
360	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
361	}
362
363	sub attach_to_objects {
364	_attach @CB_OBJECT, KLASS_OBJECT, @_
365	}
366
367	sub attach_to_players {
368	_attach @CB_PLAYER, KLASS_PLAYER, @_
369	}
370
371	sub attach_to_maps {
372	_attach @CB_MAP, KLASS_MAP, @_
373	}
374
375	sub register_attachment {
376	my $name = shift;
377
378	$attachment{$name} = [[KLASS_OBJECT, @_]];
379	}
380
381	sub register_player_attachment {
382	my $name = shift;
383
384	$attachment{$name} = [[KLASS_PLAYER, @_]];
385	}
386
387	sub register_map_attachment {
388	my $name = shift;
389
390	$attachment{$name} = [[KLASS_MAP, @_]];
391	}
392
393	our $override;
394	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
395
396	sub override {
397	$override = 1;
398	@invoke_results = ();
399	}
400
401	sub do_invoke {
402	my $event = shift;
403	my $callbacks = shift;
404
405	@invoke_results = ();
406
407	local $override;
408
409	for (@$callbacks) {
410	eval { &{$_->[1]} };
411
412	if ($@) {
413	warn "$@";
414	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
415	override;
416	}
417
418	return 1 if $override;
419	}
420
421	0	601	}
422	}
423		602
424	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	603	=item $attachable->valid
425
426	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
427
428	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
429
430	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
431
432	Generate a global/object/player/map-specific event with the given arguments.
433
434	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
435	removed in future versions), and there is no public API to access override
436	results (if you must, access C<@cf::invoke_results> directly).
437
438	=back
439
440	=cut
441
442	#############################################################################
443
444	=head2 METHODS VALID FOR ALL CORE OBJECTS
445
446	=over 4
447
448	=item $object->valid, $player->valid, $map->valid
449		604
450	Just because you have a perl object does not mean that the corresponding	605	Just because you have a perl object does not mean that the corresponding
451	C-level object still exists. If you try to access an object that has no	606	C-level object still exists. If you try to access an object that has no
452	valid C counterpart anymore you get an exception at runtime. This method	607	valid C counterpart anymore you get an exception at runtime. This method
453	can be used to test for existence of the C object part without causing an	608	can be used to test for existence of the C object part without causing an
454	exception.	609	exception.
455		610
		611	=cut
		612
		613	# the following variables are defined in .xs and must not be re-created
		614	our @CB_GLOBAL = (); # registry for all global events
		615	our @CB_ATTACHABLE = (); # registry for all attachables
		616	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		617	our @CB_PLAYER = ();
		618	our @CB_CLIENT = ();
		619	our @CB_TYPE = (); # registry for type (cf-object class) based events
		620	our @CB_MAP = ();
		621
		622	my %attachment;
		623
		624	sub _attach_cb($$$$) {
		625	my ($registry, $event, $prio, $cb) = @_;
		626
		627	use sort 'stable';
		628
		629	$cb = [$prio, $cb];
		630
		631	@{$registry->[$event]} = sort
		632	{ $a->[0] cmp $b->[0] }
		633	@{$registry->[$event] || []}, $cb;
		634	}
		635
		636	# hack
		637	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		638
		639	# attach handles attaching event callbacks
		640	# the only thing the caller has to do is pass the correct
		641	# registry (== where the callback attaches to).
		642	sub _attach {
		643	my ($registry, $klass, @arg) = @_;
		644
		645	my $object_type;
		646	my $prio = 0;
		647	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		648
		649	#TODO: get rid of this hack
		650	if ($attachable_klass{$klass}) {
		651	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		652	}
		653
		654	while (@arg) {
		655	my $type = shift @arg;
		656
		657	if ($type eq "prio") {
		658	$prio = shift @arg;
		659
		660	} elsif ($type eq "type") {
		661	$object_type = shift @arg;
		662	$registry = $CB_TYPE[$object_type] ||= [];
		663
		664	} elsif ($type eq "subtype") {
		665	defined $object_type or Carp::croak "subtype specified without type";
		666	my $object_subtype = shift @arg;
		667	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		668
		669	} elsif ($type eq "package") {
		670	my $pkg = shift @arg;
		671
		672	while (my ($name, $id) = each %cb_id) {
		673	if (my $cb = $pkg->can ($name)) {
		674	_attach_cb $registry, $id, $prio, $cb;
		675	}
		676	}
		677
		678	} elsif (exists $cb_id{$type}) {
		679	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		680
		681	} elsif (ref $type) {
		682	warn "attaching objects not supported, ignoring.\n";
		683
		684	} else {
		685	shift @arg;
		686	warn "attach argument '$type' not supported, ignoring.\n";
		687	}
		688	}
		689	}
		690
		691	sub _object_attach {
		692	my ($obj, $name, %arg) = @_;
		693
		694	return if exists $obj->{_attachment}{$name};
		695
		696	if (my $attach = $attachment{$name}) {
		697	my $registry = $obj->registry;
		698
		699	for (@$attach) {
		700	my ($klass, @attach) = @$_;
		701	_attach $registry, $klass, @attach;
		702	}
		703
		704	$obj->{$name} = \%arg;
		705	} else {
		706	warn "object uses attachment '$name' that is not available, postponing.\n";
		707	}
		708
		709	$obj->{_attachment}{$name} = undef;
		710	}
		711
		712	sub cf::attachable::attach {
		713	if (ref $_[0]) {
		714	_object_attach @_;
		715	} else {
		716	_attach shift->_attach_registry, @_;
		717	}
		718	};
		719
		720	# all those should be optimised
		721	sub cf::attachable::detach {
		722	my ($obj, $name) = @_;
		723
		724	if (ref $obj) {
		725	delete $obj->{_attachment}{$name};
		726	reattach ($obj);
		727	} else {
		728	Carp::croak "cannot, currently, detach class attachments";
		729	}
		730	};
		731
		732	sub cf::attachable::attached {
		733	my ($obj, $name) = @_;
		734
		735	exists $obj->{_attachment}{$name}
		736	}
		737
		738	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		739	eval "#line " . __LINE__ . " 'cf.pm'
		740	sub cf::\L$klass\E::_attach_registry {
		741	(\\\@CB_$klass, KLASS_$klass)
		742	}
		743
		744	sub cf::\L$klass\E::attachment {
		745	my \$name = shift;
		746
		747	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		748	}
		749	";
		750	die if $@;
		751	}
		752
		753	our $override;
		754	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		755
		756	sub override {
		757	$override = 1;
		758	@invoke_results = ();
		759	}
		760
		761	sub do_invoke {
		762	my $event = shift;
		763	my $callbacks = shift;
		764
		765	@invoke_results = ();
		766
		767	local $override;
		768
		769	for (@$callbacks) {
		770	eval { &{$_->[1]} };
		771
		772	if ($@) {
		773	warn "$@";
		774	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		775	override;
		776	}
		777
		778	return 1 if $override;
		779	}
		780
		781	0
		782	}
		783
		784	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		785
		786	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		787
		788	Generate an object-specific event with the given arguments.
		789
		790	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		791	removed in future versions), and there is no public API to access override
		792	results (if you must, access C<@cf::invoke_results> directly).
		793
456	=back	794	=back
457		795
458	=cut	796	=cut
459
460	*cf::object::valid =
461	*cf::player::valid =
462	*cf::map::valid = \&cf::_valid;
463		797
464	#############################################################################	798	#############################################################################
465	# object support	799	# object support
466		800
467	sub instantiate {
468	my ($obj, $data) = @_;
469
470	$data = from_json $data;
471
472	for (@$data) {
473	my ($name, $args) = @$_;
474
475	$obj->attach ($name, %{$args || {} });
476	}
477	}
478
479	# basically do the same as instantiate, without calling instantiate
480	sub reattach {	801	sub reattach {
		802	# basically do the same as instantiate, without calling instantiate
481	my ($obj) = @_;	803	my ($obj) = @_;
		804
482	my $registry = $obj->registry;	805	my $registry = $obj->registry;
483		806
484	@$registry = ();	807	@$registry = ();
485		808
486	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	809	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
487		810
488	for my $name (keys %{ $obj->{_attachment} || {} }) {	811	for my $name (keys %{ $obj->{_attachment} || {} }) {
489	if (my $attach = $attachment{$name}) {	812	if (my $attach = $attachment{$name}) {
490	for (@$attach) {	813	for (@$attach) {
491	my ($klass, @attach) = @$_;	814	my ($klass, @attach) = @$_;
492	_attach @$registry, $klass, @attach;	815	_attach $registry, $klass, @attach;
493	}	816	}
494	} else {	817	} else {
495	warn "object uses attachment '$name' that is not available, postponing.\n";	818	warn "object uses attachment '$name' that is not available, postponing.\n";
496	}	819	}
497	}	820	}
498	}	821	}
499		822
500	sub object_freezer_save {	823	cf::attachable->attach (
501	my ($filename, $rdata, $objs) = @_;
502
503	if (length $$rdata) {
504	warn sprintf "saving %s (%d,%d)\n",
505	$filename, length $$rdata, scalar @$objs;
506
507	if (open my $fh, ">:raw", "$filename~") {
508	chmod SAVE_MODE, $fh;
509	syswrite $fh, $$rdata;
510	close $fh;
511
512	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
513	chmod SAVE_MODE, $fh;
514	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
515	close $fh;
516	rename "$filename.pst~", "$filename.pst";
517	} else {
518	unlink "$filename.pst";
519	}
520
521	rename "$filename~", $filename;
522	} else {
523	warn "FATAL: $filename~: $!\n";
524	}
525	} else {
526	unlink $filename;
527	unlink "$filename.pst";
528	}
529	}
530
531	sub object_freezer_as_string {
532	my ($rdata, $objs) = @_;
533
534	use Data::Dumper;
535
536	$$rdata . Dumper $objs
537	}
538
539	sub object_thawer_load {
540	my ($filename) = @_;
541
542	local $/;
543
544	my $av;
545
546	#TODO: use sysread etc.
547	if (open my $data, "<:raw:perlio", $filename) {
548	$data = <$data>;
549	if (open my $pst, "<:raw:perlio", "$filename.pst") {
550	$av = eval { (Storable::thaw <$pst>)->{objs} };
551	}
552	return ($data, $av);
553	}
554
555	()
556	}
557
558	attach_to_objects
559	prio => -1000000,	824	prio => -1000000,
		825	on_instantiate => sub {
		826	my ($obj, $data) = @_;
		827
		828	$data = from_json $data;
		829
		830	for (@$data) {
		831	my ($name, $args) = @$_;
		832
		833	$obj->attach ($name, %{$args || {} });
		834	}
		835	},
		836	on_reattach => \&reattach,
560	on_clone => sub {	837	on_clone => sub {
561	my ($src, $dst) = @_;	838	my ($src, $dst) = @_;
562		839
563	@{$dst->registry} = @{$src->registry};	840	@{$dst->registry} = @{$src->registry};
564		841
565	%$dst = %$src;	842	%$dst = %$src;
566		843
567	%{$dst->{_attachment}} = %{$src->{_attachment}}	844	%{$dst->{_attachment}} = %{$src->{_attachment}}
568	if exists $src->{_attachment};	845	if exists $src->{_attachment};
569	},	846	},
570	;	847	);
		848
		849	sub object_freezer_save {
		850	my ($filename, $rdata, $objs) = @_;
		851
		852	sync_job {
		853	if (length $$rdata) {
		854	warn sprintf "saving %s (%d,%d)\n",
		855	$filename, length $$rdata, scalar @$objs;
		856
		857	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		858	chmod SAVE_MODE, $fh;
		859	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		860	aio_fsync $fh;
		861	close $fh;
		862
		863	if (@$objs) {
		864	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		865	chmod SAVE_MODE, $fh;
		866	my $data = Storable::nfreeze { version => 1, objs => $objs };
		867	aio_write $fh, 0, (length $data), $data, 0;
		868	aio_fsync $fh;
		869	close $fh;
		870	aio_rename "$filename.pst~", "$filename.pst";
		871	}
		872	} else {
		873	aio_unlink "$filename.pst";
		874	}
		875
		876	aio_rename "$filename~", $filename;
		877	} else {
		878	warn "FATAL: $filename~: $!\n";
		879	}
		880	} else {
		881	aio_unlink $filename;
		882	aio_unlink "$filename.pst";
		883	}
		884	}
		885	}
		886
		887	sub object_freezer_as_string {
		888	my ($rdata, $objs) = @_;
		889
		890	use Data::Dumper;
		891
		892	$$rdata . Dumper $objs
		893	}
		894
		895	sub object_thawer_load {
		896	my ($filename) = @_;
		897
		898	my ($data, $av);
		899
		900	(aio_load $filename, $data) >= 0
		901	or return;
		902
		903	unless (aio_stat "$filename.pst") {
		904	(aio_load "$filename.pst", $av) >= 0
		905	or return;
		906	$av = eval { (Storable::thaw $av)->{objs} };
		907	}
		908
		909	warn sprintf "loading %s (%d)\n",
		910	$filename, length $data, scalar @{$av || []};#d#
		911	return ($data, $av);
		912	}
571		913
572	#############################################################################	914	#############################################################################
573	# command handling &c	915	# command handling &c
574		916
575	=item cf::register_command $name => \&callback($ob,$args);	917	=item cf::register_command $name => \&callback($ob,$args);
…		…
604	#warn "registering extcmd '$name' to '$caller'";	946	#warn "registering extcmd '$name' to '$caller'";
605		947
606	$EXTCMD{$name} = [$cb, $caller];	948	$EXTCMD{$name} = [$cb, $caller];
607	}	949	}
608		950
609	attach_to_players	951	cf::player->attach (
610	on_command => sub {	952	on_command => sub {
611	my ($pl, $name, $params) = @_;	953	my ($pl, $name, $params) = @_;
612		954
613	my $cb = $COMMAND{$name}	955	my $cb = $COMMAND{$name}
614	or return;	956	or return;
…		…
634	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	976	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
635	}	977	}
636		978
637	cf::override;	979	cf::override;
638	},	980	},
639	;	981	);
640		982
641	sub register {	983	sub register {
642	my ($base, $pkg) = @_;	984	my ($base, $pkg) = @_;
643		985
644	#TODO	986	#TODO
…		…
713		1055
714	Symbol::delete_package $pkg;	1056	Symbol::delete_package $pkg;
715	}	1057	}
716		1058
717	sub load_extensions {	1059	sub load_extensions {
718	my $LIBDIR = maps_directory "perl";
719
720	for my $ext (<$LIBDIR/*.ext>) {	1060	for my $ext (<$LIBDIR/*.ext>) {
721	next unless -r $ext;	1061	next unless -r $ext;
722	eval {	1062	eval {
723	load_extension $ext;	1063	load_extension $ext;
724	1	1064	1
…		…
736	defined $path or return;	1076	defined $path or return;
737		1077
738	unlink "$path.pst";	1078	unlink "$path.pst";
739	};	1079	};
740		1080
741	attach_to_maps prio => -10000, package => cf::mapsupport::;	1081	cf::map->attach (prio => -10000, package => cf::mapsupport::);
742		1082
743	#############################################################################	1083	#############################################################################
744	# load/save perl data associated with player->ob objects
745		1084
746	sub all_objects(@) {	1085	=head2 CORE EXTENSIONS
747	@_, map all_objects ($_->inv), @_
748	}
749		1086
750	# TODO: compatibility cruft, remove when no longer needed	1087	Functions and methods that extend core crossfire objects.
751	attach_to_players	1088
752	on_load => sub {	1089	=cut
		1090
		1091	package cf::player;
		1092
		1093	use Coro::AIO;
		1094
		1095	=head3 cf::player
		1096
		1097	=over 4
		1098
		1099	=item cf::player::find $login
		1100
		1101	Returns the given player object, loading it if necessary (might block).
		1102
		1103	=cut
		1104
		1105	sub playerdir($) {
		1106	cf::localdir
		1107	. "/"
		1108	. cf::playerdir
		1109	. "/"
		1110	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		1111	}
		1112
		1113	sub path($) {
		1114	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		1115
		1116	(playerdir $login) . "/$login.pl"
		1117	}
		1118
		1119	sub find_active($) {
		1120	$cf::PLAYER{$_[0]}
		1121	and $cf::PLAYER{$_[0]}->active
		1122	and $cf::PLAYER{$_[0]}
		1123	}
		1124
		1125	sub exists($) {
		1126	my ($login) = @_;
		1127
		1128	$cf::PLAYER{$login}
		1129	or cf::sync_job { !aio_stat $login }
		1130	}
		1131
		1132	sub find($) {
		1133	return $cf::PLAYER{$_[0]} || do {
		1134	my $login = $_[0];
		1135
		1136	my $guard = cf::lock_acquire "user_find:$login";
		1137
		1138	$cf::PLAYER{$_[0]} || do {
		1139	my $pl = load_pl path $login
		1140	or return;
		1141	$cf::PLAYER{$login} = $pl
		1142	}
		1143	}
		1144	}
		1145
		1146	sub save($) {
		1147	my ($pl) = @_;
		1148
		1149	return if $pl->{deny_save};
		1150
		1151	my $path = path $pl;
		1152	my $guard = cf::lock_acquire "user_save:$path";
		1153
		1154	return if $pl->{deny_save};
		1155
		1156	aio_mkdir playerdir $pl, 0770;
		1157	$pl->{last_save} = $cf::RUNTIME;
		1158
		1159	$pl->save_pl ($path);
		1160	Coro::cede;
		1161	}
		1162
		1163	sub new($) {
		1164	my ($login) = @_;
		1165
		1166	my $self = create;
		1167
		1168	$self->ob->name ($login);
		1169	$self->{deny_save} = 1;
		1170
		1171	$cf::PLAYER{$login} = $self;
		1172
		1173	$self
		1174	}
		1175
		1176	=item $pl->quit_character
		1177
		1178	Nukes the player without looking back. If logged in, the connection will
		1179	be destroyed. May block for a long time.
		1180
		1181	=cut
		1182
		1183	sub quit_character {
		1184	my ($pl) = @_;
		1185
		1186	$pl->{deny_save} = 1;
		1187	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1188
		1189	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1190	$pl->deactivate;
		1191	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1192	$pl->ns->destroy if $pl->ns;
		1193
		1194	my $path = playerdir $pl;
		1195	my $temp = "$path~$cf::RUNTIME~deleting~";
		1196	aio_rename $path, $temp;
		1197	delete $cf::PLAYER{$pl->ob->name};
		1198	$pl->destroy;
		1199	IO::AIO::aio_rmtree $temp;
		1200	}
		1201
		1202	=item cf::player::list_logins
		1203
		1204	Returns am arrayref of all valid playernames in the system, can take a
		1205	while and may block, so not sync_job-capable, ever.
		1206
		1207	=cut
		1208
		1209	sub list_logins {
		1210	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1211	or return [];
		1212
		1213	my @logins;
		1214
		1215	for my $login (@$dirs) {
		1216	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1217	aio_read $fh, 0, 512, my $buf, 0 or next;
		1218	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1219
		1220	utf8::decode $login;
		1221	push @logins, $login;
		1222	}
		1223
		1224	\@logins
		1225	}
		1226
		1227	=item $player->maps
		1228
		1229	Returns an arrayref of cf::path's of all maps that are private for this
		1230	player. May block.
		1231
		1232	=cut
		1233
		1234	sub maps($) {
		1235	my ($pl) = @_;
		1236
		1237	my $files = aio_readdir playerdir $pl
		1238	or return;
		1239
		1240	my @paths;
		1241
		1242	for (@$files) {
		1243	utf8::decode $_;
		1244	next if /\.(?:pl|pst)$/;
		1245	next unless /^$PATH_SEP/;
		1246
		1247	s/$PATH_SEP/\//g;
		1248	push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
		1249	}
		1250
		1251	\@paths
		1252	}
		1253
		1254	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1255
		1256	Sends an ext reply to the player.
		1257
		1258	=cut
		1259
		1260	sub ext_reply($$$%) {
		1261	my ($self, $id, %msg) = @_;
		1262
		1263	$msg{msgid} = $id;
		1264
		1265	$self->send ("ext " . cf::to_json \%msg);
		1266	}
		1267
		1268	package cf;
		1269
		1270	=back
		1271
		1272
		1273	=head3 cf::map
		1274
		1275	=over 4
		1276
		1277	=cut
		1278
		1279	package cf::map;
		1280
		1281	use Fcntl;
		1282	use Coro::AIO;
		1283
		1284	our $MAX_RESET = 3600;
		1285	our $DEFAULT_RESET = 3000;
		1286
		1287	sub generate_random_map {
		1288	my ($path, $rmp) = @_;
		1289
		1290	# mit "rum" bekleckern, nicht
		1291	cf::map::_create_random_map
		1292	$path,
		1293	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1294	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1295	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1296	$rmp->{exit_on_final_map},
		1297	$rmp->{xsize}, $rmp->{ysize},
		1298	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1299	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1300	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1301	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1302	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1303	(cf::region::find $rmp->{region})
		1304	}
		1305
		1306	# and all this just because we cannot iterate over
		1307	# all maps in C++...
		1308	sub change_all_map_light {
		1309	my ($change) = @_;
		1310
		1311	$_->change_map_light ($change)
		1312	for grep $_->outdoor, values %cf::MAP;
		1313	}
		1314
		1315	sub try_load_header($) {
753	my ($pl, $path) = @_;	1316	my ($path) = @_;
754		1317
755	for my $o (all_objects $pl->ob) {	1318	utf8::encode $path;
756	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1319	aio_open $path, O_RDONLY, 0
757	$o->set_ob_key_value ("_perl_data");	1320	or return;
758		1321
759	%$o = %{ Storable::thaw pack "H*", $value };	1322	my $map = cf::map::new
		1323	or return;
		1324
		1325	# for better error messages only, will be overwritten
		1326	$map->path ($path);
		1327
		1328	$map->load_header ($path)
		1329	or return;
		1330
		1331	$map->{load_path} = $path;
		1332
		1333	$map
		1334	}
		1335
		1336	sub find;
		1337	sub find {
		1338	my ($path, $origin) = @_;
		1339
		1340	#warn "find<$path,$origin>\n";#d#
		1341
		1342	$path = new cf::path $path, $origin && $origin->path;
		1343	my $key = $path->as_string;
		1344
		1345	cf::lock_wait "map_find:$key";
		1346
		1347	$cf::MAP{$key} || do {
		1348	my $guard = cf::lock_acquire "map_find:$key";
		1349
		1350	# do it the slow way
		1351	my $map = try_load_header $path->save_path;
		1352
		1353	Coro::cede;
		1354
		1355	if ($map) {
		1356	$map->last_access ((delete $map->{last_access})
		1357	|| $cf::RUNTIME); #d#
		1358	# safety
		1359	$map->{instantiate_time} = $cf::RUNTIME
		1360	if $map->{instantiate_time} > $cf::RUNTIME;
		1361	} else {
		1362	if (my $rmp = $path->random_map_params) {
		1363	$map = generate_random_map $key, $rmp;
		1364	} else {
		1365	$map = try_load_header $path->load_path;
760	}	1366	}
		1367
		1368	$map or return;
		1369
		1370	$map->{load_original} = 1;
		1371	$map->{instantiate_time} = $cf::RUNTIME;
		1372	$map->last_access ($cf::RUNTIME);
		1373	$map->instantiate;
		1374
		1375	# per-player maps become, after loading, normal maps
		1376	$map->per_player (0) if $path->{user_rel};
761	}	1377	}
		1378
		1379	$map->path ($key);
		1380	$map->{path} = $path;
		1381	$map->{last_save} = $cf::RUNTIME;
		1382
		1383	Coro::cede;
		1384
		1385	if ($map->should_reset) {
		1386	$map->reset;
		1387	undef $guard;
		1388	$map = find $path
		1389	or return;
		1390	}
		1391
		1392	$cf::MAP{$key} = $map
762	},	1393	}
763	;	1394	}
764		1395
765	#############################################################################	1396	sub load {
		1397	my ($self) = @_;
766		1398
767	=head2 CORE EXTENSIONS	1399	my $path = $self->{path};
		1400	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
768		1401
769	Functions and methods that extend core crossfire objects.	1402	return if $self->in_memory != cf::MAP_SWAPPED;
		1403
		1404	$self->in_memory (cf::MAP_LOADING);
		1405
		1406	$self->alloc;
		1407	$self->load_objects ($self->{load_path}, 1)
		1408	or return;
		1409
		1410	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1411	if delete $self->{load_original};
		1412
		1413	if (my $uniq = $path->uniq_path) {
		1414	utf8::encode $uniq;
		1415	if (aio_open $uniq, O_RDONLY, 0) {
		1416	$self->clear_unique_items;
		1417	$self->load_objects ($uniq, 0);
		1418	}
		1419	}
		1420
		1421	Coro::cede;
		1422
		1423	# now do the right thing for maps
		1424	$self->link_multipart_objects;
		1425
		1426	if ($self->{path}->is_style_map) {
		1427	$self->{deny_save} = 1;
		1428	$self->{deny_reset} = 1;
		1429	} else {
		1430	$self->fix_auto_apply;
		1431	$self->decay_objects;
		1432	$self->update_buttons;
		1433	$self->set_darkness_map;
		1434	$self->difficulty ($self->estimate_difficulty)
		1435	unless $self->difficulty;
		1436	$self->activate;
		1437	}
		1438
		1439	Coro::cede;
		1440
		1441	$self->in_memory (cf::MAP_IN_MEMORY);
		1442	}
		1443
		1444	sub find_sync {
		1445	my ($path, $origin) = @_;
		1446
		1447	cf::sync_job { cf::map::find $path, $origin }
		1448	}
		1449
		1450	sub do_load_sync {
		1451	my ($map) = @_;
		1452
		1453	cf::sync_job { $map->load };
		1454	}
		1455
		1456	sub save {
		1457	my ($self) = @_;
		1458
		1459	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1460
		1461	$self->{last_save} = $cf::RUNTIME;
		1462
		1463	return unless $self->dirty;
		1464
		1465	my $save = $self->{path}->save_path; utf8::encode $save;
		1466	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1467
		1468	$self->{load_path} = $save;
		1469
		1470	return if $self->{deny_save};
		1471
		1472	local $self->{last_access} = $self->last_access;#d#
		1473
		1474	cf::async {
		1475	$_->contr->save for $self->players;
		1476	};
		1477
		1478	if ($uniq) {
		1479	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1480	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1481	} else {
		1482	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1483	}
		1484	}
		1485
		1486	sub swap_out {
		1487	my ($self) = @_;
		1488
		1489	# save first because save cedes
		1490	$self->save;
		1491
		1492	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1493
		1494	return if $self->players;
		1495	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1496	return if $self->{deny_save};
		1497
		1498	$self->clear;
		1499	$self->in_memory (cf::MAP_SWAPPED);
		1500	}
		1501
		1502	sub reset_at {
		1503	my ($self) = @_;
		1504
		1505	# TODO: safety, remove and allow resettable per-player maps
		1506	return 1e99 if $self->{path}{user_rel};
		1507	return 1e99 if $self->{deny_reset};
		1508
		1509	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1510	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1511
		1512	$time + $to
		1513	}
		1514
		1515	sub should_reset {
		1516	my ($self) = @_;
		1517
		1518	$self->reset_at <= $cf::RUNTIME
		1519	}
		1520
		1521	sub unlink_save {
		1522	my ($self) = @_;
		1523
		1524	utf8::encode (my $save = $self->{path}->save_path);
		1525	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1526	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1527	}
		1528
		1529	sub rename {
		1530	my ($self, $new_path) = @_;
		1531
		1532	$self->unlink_save;
		1533
		1534	delete $cf::MAP{$self->path};
		1535	$self->{path} = new cf::path $new_path;
		1536	$self->path ($self->{path}->as_string);
		1537	$cf::MAP{$self->path} = $self;
		1538
		1539	$self->save;
		1540	}
		1541
		1542	sub reset {
		1543	my ($self) = @_;
		1544
		1545	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1546
		1547	return if $self->players;
		1548	return if $self->{path}{user_rel};#d#
		1549
		1550	warn "resetting map ", $self->path;#d#
		1551
		1552	delete $cf::MAP{$self->path};
		1553
		1554	$_->clear_links_to ($self) for values %cf::MAP;
		1555
		1556	$self->unlink_save;
		1557	$self->destroy;
		1558	}
		1559
		1560	my $nuke_counter = "aaaa";
		1561
		1562	sub nuke {
		1563	my ($self) = @_;
		1564
		1565	$self->{deny_save} = 1;
		1566	$self->reset_timeout (1);
		1567	$self->rename ("{nuke}/" . ($nuke_counter++));
		1568	$self->reset; # polite request, might not happen
		1569	}
		1570
		1571	sub customise_for {
		1572	my ($map, $ob) = @_;
		1573
		1574	if ($map->per_player) {
		1575	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
		1576	}
		1577
		1578	$map
		1579	}
		1580
		1581	package cf;
		1582
		1583	=back
		1584
		1585	=head3 cf::object
		1586
		1587	=cut
		1588
		1589	package cf::object;
770		1590
771	=over 4	1591	=over 4
772		1592
773	=item cf::player::exists $login	1593	=item $ob->inv_recursive
774		1594
775	Returns true when the given account exists.	1595	Returns the inventory of the object _and_ their inventories, recursively.
776		1596
777	=cut	1597	=cut
778		1598
779	sub cf::player::exists($) {	1599	sub inv_recursive_;
780	cf::player::find $_[0]	1600	sub inv_recursive_ {
781	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1601	map { $_, inv_recursive_ $_->inv } @_
782	}	1602	}
		1603
		1604	sub inv_recursive {
		1605	inv_recursive_ inv $_[0]
		1606	}
		1607
		1608	package cf;
		1609
		1610	=back
		1611
		1612	=head3 cf::object::player
		1613
		1614	=over 4
783		1615
784	=item $player_object->reply ($npc, $msg[, $flags])	1616	=item $player_object->reply ($npc, $msg[, $flags])
785		1617
786	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1618	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
787	can be C<undef>. Does the right thing when the player is currently in a	1619	can be C<undef>. Does the right thing when the player is currently in a
…		…
789		1621
790	=cut	1622	=cut
791		1623
792	# rough implementation of a future "reply" method that works	1624	# rough implementation of a future "reply" method that works
793	# with dialog boxes.	1625	# with dialog boxes.
		1626	#TODO: the first argument must go, split into a $npc->reply_to ( method
794	sub cf::object::player::reply($$$;$) {	1627	sub cf::object::player::reply($$$;$) {
795	my ($self, $npc, $msg, $flags) = @_;	1628	my ($self, $npc, $msg, $flags) = @_;
796		1629
797	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1630	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
798		1631
…		…
802	$msg = $npc->name . " says: $msg" if $npc;	1635	$msg = $npc->name . " says: $msg" if $npc;
803	$self->message ($msg, $flags);	1636	$self->message ($msg, $flags);
804	}	1637	}
805	}	1638	}
806		1639
807	=item $player->ext_reply ($msgid, $msgtype, %msg)
808
809	Sends an ext reply to the player.
810
811	=cut
812
813	sub cf::player::ext_reply($$$%) {
814	my ($self, $id, %msg) = @_;
815
816	$msg{msgid} = $id;
817
818	$self->send ("ext " . to_json \%msg);
819	}
820
821	=item $player_object->may ("access")	1640	=item $player_object->may ("access")
822		1641
823	Returns wether the given player is authorized to access resource "access"	1642	Returns wether the given player is authorized to access resource "access"
824	(e.g. "command_wizcast").	1643	(e.g. "command_wizcast").
825		1644
…		…
832	(ref $cf::CFG{"may_$access"}	1651	(ref $cf::CFG{"may_$access"}
833	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1652	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
834	: $cf::CFG{"may_$access"})	1653	: $cf::CFG{"may_$access"})
835	}	1654	}
836		1655
837	=cut	1656	=item $player_object->enter_link
838		1657
839	#############################################################################	1658	Freezes the player and moves him/her to a special map (C<{link}>).
		1659
		1660	The player should be reaosnably safe there for short amounts of time. You
		1661	I<MUST> call C<leave_link> as soon as possible, though.
		1662
		1663	=item $player_object->leave_link ($map, $x, $y)
		1664
		1665	Moves the player out of the specila link map onto the given map. If the
		1666	map is not valid (or omitted), the player will be moved back to the
		1667	location he/she was before the call to C<enter_link>, or, if that fails,
		1668	to the emergency map position.
		1669
		1670	Might block.
		1671
		1672	=cut
		1673
		1674	sub cf::object::player::enter_link {
		1675	my ($self) = @_;
		1676
		1677	$self->deactivate_recursive;
		1678
		1679	return if $self->map == $LINK_MAP;
		1680
		1681	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1682	if $self->map;
		1683
		1684	$self->enter_map ($LINK_MAP, 20, 20);
		1685	}
		1686
		1687	sub cf::object::player::leave_link {
		1688	my ($self, $map, $x, $y) = @_;
		1689
		1690	my $link_pos = delete $self->{_link_pos};
		1691
		1692	unless ($map) {
		1693	# restore original map position
		1694	($map, $x, $y) = @{ $link_pos || [] };
		1695	$map = cf::map::find $map;
		1696
		1697	unless ($map) {
		1698	($map, $x, $y) = @$EMERGENCY_POSITION;
		1699	$map = cf::map::find $map
		1700	or die "FATAL: cannot load emergency map\n";
		1701	}
		1702	}
		1703
		1704	($x, $y) = (-1, -1)
		1705	unless (defined $x) && (defined $y);
		1706
		1707	# use -1 or undef as default coordinates, not 0, 0
		1708	($x, $y) = ($map->enter_x, $map->enter_y)
		1709	if $x <=0 && $y <= 0;
		1710
		1711	$map->load;
		1712
		1713	return unless $self->contr->active;
		1714	$self->activate_recursive;
		1715	$self->enter_map ($map, $x, $y);
		1716	}
		1717
		1718	cf::player->attach (
		1719	on_logout => sub {
		1720	my ($pl) = @_;
		1721
		1722	# abort map switching before logout
		1723	if ($pl->ob->{_link_pos}) {
		1724	cf::sync_job {
		1725	$pl->ob->leave_link
		1726	};
		1727	}
		1728	},
		1729	on_login => sub {
		1730	my ($pl) = @_;
		1731
		1732	# try to abort aborted map switching on player login :)
		1733	# should happen only on crashes
		1734	if ($pl->ob->{_link_pos}) {
		1735	$pl->ob->enter_link;
		1736	(async {
		1737	# we need this sleep as the login has a concurrent enter_exit running
		1738	# and this sleep increases chances of the player not ending up in scorn
		1739	$pl->ob->reply (undef,
		1740	"There was an internal problem at your last logout, "
		1741	. "the server will try to bring you to your intended destination in a second.",
		1742	cf::NDI_RED);
		1743	Coro::Timer::sleep 1;
		1744	$pl->ob->leave_link;
		1745	})->prio (2);
		1746	}
		1747	},
		1748	);
		1749
		1750	=item $player_object->goto ($path, $x, $y)
		1751
		1752	=cut
		1753
		1754	sub cf::object::player::goto {
		1755	my ($self, $path, $x, $y) = @_;
		1756
		1757	$path = new cf::path $path;
		1758	$path ne "/" or Carp::cluck ("oy");#d#
		1759
		1760	$self->enter_link;
		1761
		1762	(async {
		1763	my $map = cf::map::find $path->as_string;
		1764	$map = $map->customise_for ($self) if $map;
		1765
		1766	# warn "entering ", $map->path, " at ($x, $y)\n"
		1767	# if $map;
		1768
		1769	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1770
		1771	$self->leave_link ($map, $x, $y);
		1772	})->prio (1);
		1773	}
		1774
		1775	=item $player_object->enter_exit ($exit_object)
		1776
		1777	=cut
		1778
		1779	sub parse_random_map_params {
		1780	my ($spec) = @_;
		1781
		1782	my $rmp = { # defaults
		1783	xsize => 10,
		1784	ysize => 10,
		1785	};
		1786
		1787	for (split /\n/, $spec) {
		1788	my ($k, $v) = split /\s+/, $_, 2;
		1789
		1790	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1791	}
		1792
		1793	$rmp
		1794	}
		1795
		1796	sub prepare_random_map {
		1797	my ($exit) = @_;
		1798
		1799	# all this does is basically replace the /! path by
		1800	# a new random map path (?random/...) with a seed
		1801	# that depends on the exit object
		1802
		1803	my $rmp = parse_random_map_params $exit->msg;
		1804
		1805	if ($exit->map) {
		1806	$rmp->{region} = $exit->map->region_name;
		1807	$rmp->{origin_map} = $exit->map->path;
		1808	$rmp->{origin_x} = $exit->x;
		1809	$rmp->{origin_y} = $exit->y;
		1810	}
		1811
		1812	$rmp->{random_seed} ||= $exit->random_seed;
		1813
		1814	my $data = cf::to_json $rmp;
		1815	my $md5 = Digest::MD5::md5_hex $data;
		1816
		1817	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1818	aio_write $fh, 0, (length $data), $data, 0;
		1819
		1820	$exit->slaying ("?random/$md5");
		1821	$exit->msg (undef);
		1822	}
		1823	}
		1824
		1825	sub cf::object::player::enter_exit {
		1826	my ($self, $exit) = @_;
		1827
		1828	return unless $self->type == cf::PLAYER;
		1829
		1830	$self->enter_link;
		1831
		1832	(async {
		1833	$self->deactivate_recursive; # just to be sure
		1834	unless (eval {
		1835	prepare_random_map $exit
		1836	if $exit->slaying eq "/!";
		1837
		1838	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1839	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1840
		1841	1;
		1842	}) {
		1843	$self->message ("Something went wrong deep within the crossfire server. "
		1844	. "I'll try to bring you back to the map you were before. "
		1845	. "Please report this to the dungeon master",
		1846	cf::NDI_UNIQUE | cf::NDI_RED);
		1847
		1848	warn "ERROR in enter_exit: $@";
		1849	$self->leave_link;
		1850	}
		1851	})->prio (1);
		1852	}
		1853
		1854	=head3 cf::client
		1855
		1856	=over 4
		1857
		1858	=item $client->send_drawinfo ($text, $flags)
		1859
		1860	Sends a drawinfo packet to the client. Circumvents output buffering so
		1861	should not be used under normal circumstances.
		1862
		1863	=cut
		1864
		1865	sub cf::client::send_drawinfo {
		1866	my ($self, $text, $flags) = @_;
		1867
		1868	utf8::encode $text;
		1869	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1870	}
		1871
		1872
		1873	=item $success = $client->query ($flags, "text", \&cb)
		1874
		1875	Queues a query to the client, calling the given callback with
		1876	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1877	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1878
		1879	Queries can fail, so check the return code. Or don't, as queries will become
		1880	reliable at some point in the future.
		1881
		1882	=cut
		1883
		1884	sub cf::client::query {
		1885	my ($self, $flags, $text, $cb) = @_;
		1886
		1887	return unless $self->state == ST_PLAYING
		1888	|| $self->state == ST_SETUP
		1889	|| $self->state == ST_CUSTOM;
		1890
		1891	$self->state (ST_CUSTOM);
		1892
		1893	utf8::encode $text;
		1894	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1895
		1896	$self->send_packet ($self->{query_queue}[0][0])
		1897	if @{ $self->{query_queue} } == 1;
		1898	}
		1899
		1900	cf::client->attach (
		1901	on_reply => sub {
		1902	my ($ns, $msg) = @_;
		1903
		1904	# this weird shuffling is so that direct followup queries
		1905	# get handled first
		1906	my $queue = delete $ns->{query_queue}
		1907	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1908
		1909	(shift @$queue)->[1]->($msg);
		1910
		1911	push @{ $ns->{query_queue} }, @$queue;
		1912
		1913	if (@{ $ns->{query_queue} } == @$queue) {
		1914	if (@$queue) {
		1915	$ns->send_packet ($ns->{query_queue}[0][0]);
		1916	} else {
		1917	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1918	}
		1919	}
		1920	},
		1921	);
		1922
		1923	=item $client->async (\&cb)
		1924
		1925	Create a new coroutine, running the specified callback. The coroutine will
		1926	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1927	or loss of connection).
		1928
		1929	=cut
		1930
		1931	sub cf::client::async {
		1932	my ($self, $cb) = @_;
		1933
		1934	my $coro = &Coro::async ($cb);
		1935
		1936	$coro->on_destroy (sub {
		1937	delete $self->{_coro}{$coro+0};
		1938	});
		1939
		1940	$self->{_coro}{$coro+0} = $coro;
		1941
		1942	$coro
		1943	}
		1944
		1945	cf::client->attach (
		1946	on_destroy => sub {
		1947	my ($ns) = @_;
		1948
		1949	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1950	},
		1951	);
		1952
		1953	=back
		1954
840		1955
841	=head2 SAFE SCRIPTING	1956	=head2 SAFE SCRIPTING
842		1957
843	Functions that provide a safe environment to compile and execute	1958	Functions that provide a safe environment to compile and execute
844	snippets of perl code without them endangering the safety of the server	1959	snippets of perl code without them endangering the safety of the server
…		…
859		1974
860	=pod	1975	=pod
861		1976
862	The following fucntions and emthods are available within a safe environment:	1977	The following fucntions and emthods are available within a safe environment:
863		1978
864	cf::object contr pay_amount pay_player	1979	cf::object contr pay_amount pay_player map
865	cf::object::player player	1980	cf::object::player player
866	cf::player peaceful	1981	cf::player peaceful
		1982	cf::map trigger
867		1983
868	=cut	1984	=cut
869		1985
870	for (	1986	for (
871	["cf::object" => qw(contr pay_amount pay_player)],	1987	["cf::object" => qw(contr pay_amount pay_player map)],
872	["cf::object::player" => qw(player)],	1988	["cf::object::player" => qw(player)],
873	["cf::player" => qw(peaceful)],	1989	["cf::player" => qw(peaceful)],
		1990	["cf::map" => qw(trigger)],
874	) {	1991	) {
875	no strict 'refs';	1992	no strict 'refs';
876	my ($pkg, @funs) = @$_;	1993	my ($pkg, @funs) = @$_;
877	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1994	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
878	for @funs;	1995	for @funs;
…		…
994		2111
995	{	2112	{
996	my $path = cf::localdir . "/database.pst";	2113	my $path = cf::localdir . "/database.pst";
997		2114
998	sub db_load() {	2115	sub db_load() {
999	warn "loading database $path\n";#d# remove later
1000	$DB = stat $path ? Storable::retrieve $path : { };	2116	$DB = stat $path ? Storable::retrieve $path : { };
1001	}	2117	}
1002		2118
1003	my $pid;	2119	my $pid;
1004		2120
1005	sub db_save() {	2121	sub db_save() {
1006	warn "saving database $path\n";#d# remove later
1007	waitpid $pid, 0 if $pid;	2122	waitpid $pid, 0 if $pid;
1008	if (0 == ($pid = fork)) {	2123	if (0 == ($pid = fork)) {
1009	$DB->{_meta}{version} = 1;	2124	$DB->{_meta}{version} = 1;
1010	Storable::nstore $DB, "$path~";	2125	Storable::nstore $DB, "$path~";
1011	rename "$path~", $path;	2126	rename "$path~", $path;
…		…
1018	sub db_sync() {	2133	sub db_sync() {
1019	db_save if $dirty;	2134	db_save if $dirty;
1020	undef $dirty;	2135	undef $dirty;
1021	}	2136	}
1022		2137
1023	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	2138	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1024	db_sync;	2139	db_sync;
1025	});	2140	});
1026		2141
1027	sub db_dirty() {	2142	sub db_dirty() {
1028	$dirty = 1;	2143	$dirty = 1;
…		…
1042	$DB->{$_[0]} = $_[1];	2157	$DB->{$_[0]} = $_[1];
1043	}	2158	}
1044	db_dirty;	2159	db_dirty;
1045	}	2160	}
1046		2161
1047	attach_global	2162	cf::global->attach (
1048	prio => 10000,	2163	prio => 10000,
1049	on_cleanup => sub {	2164	on_cleanup => sub {
1050	db_sync;	2165	db_sync;
1051	},	2166	},
1052	;	2167	);
1053	}	2168	}
1054		2169
1055	#############################################################################	2170	#############################################################################
1056	# the server's main()	2171	# the server's main()
1057		2172
…		…
1059	open my $fh, "<:utf8", cf::confdir . "/config"	2174	open my $fh, "<:utf8", cf::confdir . "/config"
1060	or return;	2175	or return;
1061		2176
1062	local $/;	2177	local $/;
1063	*CFG = YAML::Syck::Load <$fh>;	2178	*CFG = YAML::Syck::Load <$fh>;
		2179
		2180	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2181
		2182	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2183	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2184
		2185	if (exists $CFG{mlockall}) {
		2186	eval {
		2187	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2188	and die "WARNING: m(un)lockall failed: $!\n";
		2189	};
		2190	warn $@ if $@;
		2191	}
1064	}	2192	}
1065		2193
1066	sub main {	2194	sub main {
		2195	# we must not ever block the main coroutine
		2196	local $Coro::idle = sub {
		2197	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2198	async { Event::one_event };
		2199	};
		2200
1067	cfg_load;	2201	cfg_load;
1068	db_load;	2202	db_load;
1069	load_extensions;	2203	load_extensions;
1070	Event::loop;	2204	Event::loop;
1071	}	2205	}
1072		2206
1073	#############################################################################	2207	#############################################################################
1074	# initialisation	2208	# initialisation and cleanup
1075		2209
		2210	# install some emergency cleanup handlers
		2211	BEGIN {
		2212	for my $signal (qw(INT HUP TERM)) {
		2213	Event->signal (
		2214	data => WF_AUTOCANCEL,
		2215	signal => $signal,
		2216	cb => sub {
		2217	cf::cleanup "SIG$signal";
		2218	},
		2219	);
		2220	}
		2221	}
		2222
		2223	sub emergency_save {
		2224	my $freeze_guard = cf::freeze_mainloop;
		2225
		2226	warn "enter emergency perl save\n";
		2227
		2228	cf::sync_job {
		2229	# use a peculiar iteration method to avoid tripping on perl
		2230	# refcount bugs in for. also avoids problems with players
		2231	# and maps saved/Destroyed asynchronously.
		2232	warn "begin emergency player save\n";
		2233	for my $login (keys %cf::PLAYER) {
		2234	my $pl = $cf::PLAYER{$login} or next;
		2235	$pl->valid or next;
		2236	$pl->save;
		2237	}
		2238	warn "end emergency player save\n";
		2239
		2240	warn "begin emergency map save\n";
		2241	for my $path (keys %cf::MAP) {
		2242	my $map = $cf::MAP{$path} or next;
		2243	$map->valid or next;
		2244	$map->save;
		2245	}
		2246	warn "end emergency map save\n";
		2247	};
		2248
		2249	warn "leave emergency perl save\n";
		2250	}
		2251
1076	sub _perl_reload(&) {	2252	sub reload() {
1077	my ($msg) = @_;	2253	# can/must only be called in main
		2254	if ($Coro::current != $Coro::main) {
		2255	warn "can only reload from main coroutine\n";
		2256	return;
		2257	}
1078		2258
1079	$msg->("reloading...");	2259	warn "reloading...";
		2260
		2261	my $guard = freeze_mainloop;
		2262	cf::emergency_save;
1080		2263
1081	eval {	2264	eval {
		2265	# if anything goes wrong in here, we should simply crash as we already saved
		2266
1082	# cancel all watchers	2267	# cancel all watchers
1083	$_->cancel for Event::all_watchers;	2268	for (Event::all_watchers) {
		2269	$_->cancel if $_->data & WF_AUTOCANCEL;
		2270	}
		2271
		2272	# cancel all extension coros
		2273	$_->cancel for values %EXT_CORO;
		2274	%EXT_CORO = ();
1084		2275
1085	# unload all extensions	2276	# unload all extensions
1086	for (@exts) {	2277	for (@exts) {
1087	$msg->("unloading <$_>");	2278	warn "unloading <$_>";
1088	unload_extension $_;	2279	unload_extension $_;
1089	}	2280	}
1090		2281
1091	# unload all modules loaded from $LIBDIR	2282	# unload all modules loaded from $LIBDIR
1092	while (my ($k, $v) = each %INC) {	2283	while (my ($k, $v) = each %INC) {
1093	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2284	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1094		2285
1095	$msg->("removing <$k>");	2286	warn "removing <$k>";
1096	delete $INC{$k};	2287	delete $INC{$k};
1097		2288
1098	$k =~ s/\.pm$//;	2289	$k =~ s/\.pm$//;
1099	$k =~ s/\//::/g;	2290	$k =~ s/\//::/g;
1100		2291
…		…
1105	Symbol::delete_package $k;	2296	Symbol::delete_package $k;
1106	}	2297	}
1107		2298
1108	# sync database to disk	2299	# sync database to disk
1109	cf::db_sync;	2300	cf::db_sync;
		2301	IO::AIO::flush;
1110		2302
1111	# get rid of safe::, as good as possible	2303	# get rid of safe::, as good as possible
1112	Symbol::delete_package "safe::$_"	2304	Symbol::delete_package "safe::$_"
1113	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2305	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1114		2306
1115	# remove register_script_function callbacks	2307	# remove register_script_function callbacks
1116	# TODO	2308	# TODO
1117		2309
1118	# unload cf.pm "a bit"	2310	# unload cf.pm "a bit"
…		…
1121	# don't, removes xs symbols, too,	2313	# don't, removes xs symbols, too,
1122	# and global variables created in xs	2314	# and global variables created in xs
1123	#Symbol::delete_package __PACKAGE__;	2315	#Symbol::delete_package __PACKAGE__;
1124		2316
1125	# reload cf.pm	2317	# reload cf.pm
1126	$msg->("reloading cf.pm");	2318	warn "reloading cf.pm";
1127	require cf;	2319	require cf;
		2320	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1128		2321
1129	# load config and database again	2322	# load config and database again
1130	cf::cfg_load;	2323	cf::cfg_load;
1131	cf::db_load;	2324	cf::db_load;
1132		2325
1133	# load extensions	2326	# load extensions
1134	$msg->("load extensions");	2327	warn "load extensions";
1135	cf::load_extensions;	2328	cf::load_extensions;
1136		2329
1137	# reattach attachments to objects	2330	# reattach attachments to objects
1138	$msg->("reattach");	2331	warn "reattach";
1139	_global_reattach;	2332	_global_reattach;
		2333	reattach $_ for values %MAP;
1140	};	2334	};
1141	$msg->($@) if $@;
1142		2335
1143	$msg->("reloaded");	2336	if ($@) {
		2337	warn $@;
		2338	warn "error while reloading, exiting.";
		2339	exit 1;
		2340	}
		2341
		2342	warn "reloaded successfully";
1144	};	2343	};
1145		2344
1146	sub perl_reload() {	2345	#############################################################################
1147	_perl_reload {	2346
1148	warn $_[0];	2347	unless ($LINK_MAP) {
1149	print "$_[0]\n";	2348	$LINK_MAP = cf::map::new;
1150	};	2349
		2350	$LINK_MAP->width (41);
		2351	$LINK_MAP->height (41);
		2352	$LINK_MAP->alloc;
		2353	$LINK_MAP->path ("{link}");
		2354	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2355	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2356
		2357	# dirty hack because... archetypes are not yet loaded
		2358	Event->timer (
		2359	after => 10,
		2360	cb => sub {
		2361	$_[0]->w->cancel;
		2362
		2363	# provide some exits "home"
		2364	my $exit = cf::object::new "exit";
		2365
		2366	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2367	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2368	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2369
		2370	$LINK_MAP->insert ($exit->clone, 19, 19);
		2371	$LINK_MAP->insert ($exit->clone, 19, 20);
		2372	$LINK_MAP->insert ($exit->clone, 19, 21);
		2373	$LINK_MAP->insert ($exit->clone, 20, 19);
		2374	$LINK_MAP->insert ($exit->clone, 20, 21);
		2375	$LINK_MAP->insert ($exit->clone, 21, 19);
		2376	$LINK_MAP->insert ($exit->clone, 21, 20);
		2377	$LINK_MAP->insert ($exit->clone, 21, 21);
		2378
		2379	$exit->destroy;
		2380	});
		2381
		2382	$LINK_MAP->{deny_save} = 1;
		2383	$LINK_MAP->{deny_reset} = 1;
		2384
		2385	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1151	}	2386	}
1152		2387
1153	register "<global>", __PACKAGE__;	2388	register "<global>", __PACKAGE__;
1154		2389
1155	register_command "perl-reload" => sub {	2390	register_command "reload" => sub {
1156	my ($who, $arg) = @_;	2391	my ($who, $arg) = @_;
1157		2392
1158	if ($who->flag (FLAG_WIZ)) {	2393	if ($who->flag (FLAG_WIZ)) {
1159	_perl_reload {	2394	$who->message ("start of reload.");
1160	warn $_[0];	2395	reload;
1161	$who->message ($_[0]);	2396	$who->message ("end of reload.");
1162	};
1163	}	2397	}
1164	};	2398	};
1165		2399
1166	unshift @INC, $LIBDIR;	2400	unshift @INC, $LIBDIR;
1167		2401
1168	$TICK_WATCHER = Event->timer (	2402	$TICK_WATCHER = Event->timer (
		2403	reentrant => 0,
1169	prio => 1,	2404	prio => 0,
1170	async => 1,
1171	at => $NEXT_TICK || 1,	2405	at => $NEXT_TICK || $TICK,
		2406	data => WF_AUTOCANCEL,
1172	cb => sub {	2407	cb => sub {
1173	cf::server_tick; # one server iteration	2408	cf::server_tick; # one server iteration
1174		2409	$RUNTIME += $TICK;
1175	my $NOW = Event::time;
1176	$NEXT_TICK += $TICK;	2410	$NEXT_TICK += $TICK;
1177		2411
		2412	$WAIT_FOR_TICK->broadcast;
		2413	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2414
1178	# if we are delayed by four ticks or more, skip them all	2415	# if we are delayed by four ticks or more, skip them all
1179	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2416	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1180		2417
1181	$TICK_WATCHER->at ($NEXT_TICK);	2418	$TICK_WATCHER->at ($NEXT_TICK);
1182	$TICK_WATCHER->start;	2419	$TICK_WATCHER->start;
1183	},	2420	},
1184	);	2421	);
1185		2422
1186	IO::AIO::max_poll_time $TICK * 0.2;	2423	IO::AIO::max_poll_time $TICK * 0.2;
1187		2424
		2425	Event->io (
1188	Event->io (fd => IO::AIO::poll_fileno,	2426	fd => IO::AIO::poll_fileno,
1189	poll => 'r',	2427	poll => 'r',
1190	prio => 5,	2428	prio => 5,
		2429	data => WF_AUTOCANCEL,
1191	cb => \&IO::AIO::poll_cb);	2430	cb => \&IO::AIO::poll_cb,
		2431	);
		2432
		2433	Event->timer (
		2434	data => WF_AUTOCANCEL,
		2435	after => 0,
		2436	interval => 10,
		2437	cb => sub {
		2438	(Coro::unblock_sub {
		2439	write_runtime
		2440	or warn "ERROR: unable to write runtime file: $!";
		2441	})->();
		2442	},
		2443	);
		2444
		2445	END { cf::emergency_save }
1192		2446
1193	1	2447	1
1194		2448

Diff Legend

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