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

Diff Legend

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