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.70 by root, Sun Oct 1 10:55:37 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Digest::MD5;
		21	use Fcntl;
		22	use IO::AIO 2.31 ();
		23	use YAML::Syck ();
10	use Time::HiRes;	24	use Time::HiRes;
11	use Event;	25
12	$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
13		27
14	use strict;	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		29	$YAML::Syck::ImplicitUnicode = 1;
15		30
16	_init_vars;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		34
18	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
19	our @EVENT;	39	our @EVENT;
20	our $LIBDIR = maps_directory "perl";	40	our $LIBDIR = datadir . "/ext";
21		41
22	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	43	our $TICK_WATCHER;
24	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
25		46
26	our %CFG;	47	our %CFG;
27		48
		49	our $UPTIME; $UPTIME ||= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
		76
28	#############################################################################	77	#############################################################################
29		78
30	=head2 GLOBAL VARIABLES	79	=head2 GLOBAL VARIABLES
31		80
32	=over 4	81	=over 4
		82
		83	=item $cf::UPTIME
		84
		85	The timestamp of the server start (so not actually an uptime).
		86
		87	=item $cf::RUNTIME
		88
		89	The time this server has run, starts at 0 and is increased by $cf::TICK on
		90	every server tick.
33		91
34	=item $cf::LIBDIR	92	=item $cf::LIBDIR
35		93
36	The perl library directory, where extensions and cf-specific modules can	94	The perl library directory, where extensions and cf-specific modules can
37	be found. It will be added to C<@INC> automatically.	95	be found. It will be added to C<@INC> automatically.
		96
		97	=item $cf::NOW
		98
		99	The time of the last (current) server tick.
38		100
39	=item $cf::TICK	101	=item $cf::TICK
40		102
41	The interval between server ticks, in seconds.	103	The interval between server ticks, in seconds.
42		104
…		…
50	=cut	112	=cut
51		113
52	BEGIN {	114	BEGIN {
53	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
54	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
55	$msg .= "\n"	119	$msg .= "\n"
56	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
57		121
58	print STDERR "cfperl: $msg";
59	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
60	};	123	};
61	}	124	}
62		125
		126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
63	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
64		132
65	# we bless all objects into (empty) derived classes to force a method lookup	133	# we bless all objects into (empty) derived classes to force a method lookup
66	# within the Safe compartment.	134	# within the Safe compartment.
67	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	135	for my $pkg (qw(
		136	cf::global cf::attachable
		137	cf::object cf::object::player
		138	cf::client cf::player
		139	cf::arch cf::living
		140	cf::map cf::party cf::region
		141	)) {
68	no strict 'refs';	142	no strict 'refs';
69	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
70	}	144	}
71		145
72	$Event::DIED = sub {	146	$Event::DIED = sub {
…		…
74	};	148	};
75		149
76	my %ext_pkg;	150	my %ext_pkg;
77	my @exts;	151	my @exts;
78	my @hook;	152	my @hook;
79	my %command;
80	my %extcmd;
81		153
82	=head2 UTILITY FUNCTIONS	154	=head2 UTILITY FUNCTIONS
83		155
84	=over 4	156	=over 4
85		157
…		…
107	sub to_json($) {	179	sub to_json($) {
108	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
109	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
110	}	182	}
111		183
		184	=item cf::sync_job { BLOCK }
		185
		186	The design of crossfire+ requires that the main coro ($Coro::main) is
		187	always able to handle events or runnable, as crossfire+ is only partly
		188	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		189
		190	If it must be done, put the blocking parts into C<sync_job>. This will run
		191	the given BLOCK in another coroutine while waiting for the result. The
		192	server will be frozen during this time, so the block should either finish
		193	fast or be very important.
		194
		195	=cut
		196
		197	sub sync_job(&) {
		198	my ($job) = @_;
		199
		200	my $busy = 1;
		201	my @res;
		202
		203	# TODO: use suspend/resume instead
		204	local $FREEZE = 1;
		205
		206	my $coro = Coro::async {
		207	@res = eval { $job->() };
		208	warn $@ if $@;
		209	undef $busy;
		210	};
		211
		212	if ($Coro::current == $Coro::main) {
		213	$coro->prio (Coro::PRIO_MAX);
		214	while ($busy) {
		215	Coro::cede_notself;
		216	Event::one_event unless Coro::nready;
		217	}
		218	} else {
		219	$coro->join;
		220	}
		221
		222	wantarray ? @res : $res[0]
		223	}
		224
		225	=item $coro = cf::coro { BLOCK }
		226
		227	Creates and returns a new coro. This coro is automcatially being canceled
		228	when the extension calling this is being unloaded.
		229
		230	=cut
		231
		232	sub coro(&) {
		233	my $cb = shift;
		234
		235	my $coro; $coro = async {
		236	eval {
		237	$cb->();
		238	};
		239	warn $@ if $@;
		240	};
		241
		242	$coro->on_destroy (sub {
		243	delete $EXT_CORO{$coro+0};
		244	});
		245	$EXT_CORO{$coro+0} = $coro;
		246
		247	$coro
		248	}
		249
		250	sub write_runtime {
		251	my $runtime = cf::localdir . "/runtime";
		252
		253	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		254	or return;
		255
		256	my $value = $cf::RUNTIME;
		257	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		258	and return;
		259
		260	aio_fsync $fh
		261	and return;
		262
		263	close $fh
		264	or return;
		265
		266	aio_rename "$runtime~", $runtime
		267	and return;
		268
		269	1
		270	}
		271
112	=back	272	=back
113		273
		274	=cut
		275
114	#############################################################################	276	#############################################################################
115		277
116	=head2 EVENTS AND OBJECT ATTACHMENTS	278	package cf::path;
		279
		280	sub new {
		281	my ($class, $path, $base) = @_;
		282
		283	my $self = bless { }, $class;
		284
		285	if ($path =~ s{^\?random/}{}) {
		286	$self->{random} = cf::from_json $path;
		287	} else {
		288	if ($path =~ s{^~([^/]+)?}{}) {
		289	$self->{user_rel} = 1;
		290
		291	if (defined $1) {
		292	$self->{user} = $1;
		293	} elsif ($base =~ m{^~([^/]+)/}) {
		294	$self->{user} = $1;
		295	} else {
		296	warn "cannot resolve user-relative path without user <$path,$base>\n";
		297	}
		298	} elsif ($path =~ /^\//) {
		299	# already absolute
		300	} else {
		301	$base =~ s{[^/]+/?$}{};
		302	return $class->new ("$base/$path");
		303	}
		304
		305	for ($path) {
		306	redo if s{/\.?/}{/};
		307	redo if s{/[^/]+/\.\./}{/};
		308	}
		309	}
		310
		311	$self->{path} = $path;
		312
		313	$self
		314	}
		315
		316	# the name / primary key / in-game path
		317	sub as_string {
		318	my ($self) = @_;
		319
		320	$self->{user_rel} ? "~$self->{user}$self->{path}"
		321	: $self->{random} ? "?random/$self->{path}"
		322	: $self->{path}
		323	}
		324
		325	# the displayed name, this is a one way mapping
		326	sub visible_name {
		327	my ($self) = @_;
		328
		329	$self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
		330	: $self->as_string
		331	}
		332
		333	# escape the /'s in the path
		334	sub _escaped_path {
		335	# ∕ is U+2215
		336	(my $path = $_[0]{path}) =~ s/\//∕/g;
		337	$path
		338	}
		339
		340	# the original (read-only) location
		341	sub load_path {
		342	my ($self) = @_;
		343
		344	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		345	}
		346
		347	# the temporary/swap location
		348	sub save_path {
		349	my ($self) = @_;
		350
		351	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		352	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
		353	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		354	}
		355
		356	# the unique path, might be eq to save_path
		357	sub uniq_path {
		358	my ($self) = @_;
		359
		360	$self->{user_rel} || $self->{random}
		361	? undef
		362	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		363	}
		364
		365	# return random map parameters, or undef
		366	sub random_map_params {
		367	my ($self) = @_;
		368
		369	$self->{random}
		370	}
		371
		372	# this is somewhat ugly, but style maps do need special treatment
		373	sub is_style_map {
		374	$_[0]{path} =~ m{^/styles/}
		375	}
		376
		377	package cf;
		378
		379	#############################################################################
		380
		381	=head2 ATTACHABLE OBJECTS
		382
		383	Many objects in crossfire are so-called attachable objects. That means you can
		384	attach callbacks/event handlers (a collection of which is called an "attachment")
		385	to it. All such attachable objects support the following methods.
		386
		387	In the following description, CLASS can be any of C<global>, C<object>
		388	C<player>, C<client> or C<map> (i.e. the attachable objects in
		389	crossfire+).
117		390
118	=over 4	391	=over 4
119		392
120	=item $object->attach ($attachment, key => $value...)
121
122	=item $object->detach ($attachment)
123
124	Attach/detach a pre-registered attachment to an object.
125
126	=item $player->attach ($attachment, key => $value...)
127
128	=item $player->detach ($attachment)
129
130	Attach/detach a pre-registered attachment to a player.
131
132	=item $map->attach ($attachment, key => $value...)	393	=item $attachable->attach ($attachment, key => $value...)
133		394
134	=item $map->detach ($attachment)	395	=item $attachable->detach ($attachment)
135		396
136	Attach/detach a pre-registered attachment to a map.	397	Attach/detach a pre-registered attachment to a specific object and give it
		398	the specified key/value pairs as arguments.
137		399
138	=item $bool = $object->attached ($name)	400	Example, attach a minesweeper attachment to the given object, making it a
		401	10x10 minesweeper game:
139		402
140	=item $bool = $player->attached ($name)	403	$obj->attach (minesweeper => width => 10, height => 10);
141		404
142	=item $bool = $map->attached ($name)	405	=item $bool = $attachable->attached ($name)
143		406
144	Checks wether the named attachment is currently attached to the object.	407	Checks wether the named attachment is currently attached to the object.
145		408
146	=item cf::attach_global ...	409	=item cf::CLASS->attach ...
147		410
148	Attach handlers for global events.	411	=item cf::CLASS->detach ...
149		412
150	This and all following C<attach_*>-functions expect any number of the	413	Define an anonymous attachment and attach it to all objects of the given
151	following handler/hook descriptions:	414	CLASS. See the next function for an explanation of its arguments.
		415
		416	You can attach to global events by using the C<cf::global> class.
		417
		418	Example, log all player logins:
		419
		420	cf::player->attach (
		421	on_login => sub {
		422	my ($pl) = @_;
		423	...
		424	},
		425	);
		426
		427	Example, attach to the jeweler skill:
		428
		429	cf::object->attach (
		430	type => cf::SKILL,
		431	subtype => cf::SK_JEWELER,
		432	on_use_skill => sub {
		433	my ($sk, $ob, $part, $dir, $msg) = @_;
		434	...
		435	},
		436	);
		437
		438	=item cf::CLASS::attachment $name, ...
		439
		440	Register an attachment by C<$name> through which attachable objects of the
		441	given CLASS can refer to this attachment.
		442
		443	Some classes such as crossfire maps and objects can specify attachments
		444	that are attached at load/instantiate time, thus the need for a name.
		445
		446	These calls expect any number of the following handler/hook descriptions:
152		447
153	=over 4	448	=over 4
154		449
155	=item prio => $number	450	=item prio => $number
156		451
…		…
158	by another C<prio> setting). Lower priority handlers get executed	453	by another C<prio> setting). Lower priority handlers get executed
159	earlier. The default priority is C<0>, and many built-in handlers are	454	earlier. The default priority is C<0>, and many built-in handlers are
160	registered at priority C<-1000>, so lower priorities should not be used	455	registered at priority C<-1000>, so lower priorities should not be used
161	unless you know what you are doing.	456	unless you know what you are doing.
162		457
		458	=item type => $type
		459
		460	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		461	given type of objects only (the additional parameter C<subtype> can be
		462	used to further limit to the given subtype).
		463
163	=item on_I<event> => \&cb	464	=item on_I<event> => \&cb
164		465
165	Call the given code reference whenever the named event happens (event is	466	Call the given code reference whenever the named event happens (event is
166	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	467	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
167	handlers are recognised generally depends on the type of object these	468	handlers are recognised generally depends on the type of object these
…		…
176	package and register them. Only handlers for eevents supported by the	477	package and register them. Only handlers for eevents supported by the
177	object/class are recognised.	478	object/class are recognised.
178		479
179	=back	480	=back
180		481
181	=item cf::attach_to_type $object_type, $subtype, ...	482	Example, define an attachment called "sockpuppet" that calls the given
		483	event handler when a monster attacks:
182		484
183	Attach handlers for a specific object type (e.g. TRANSPORT) and	485	cf::object::attachment sockpuppet =>
184	subtype. If C<$subtype> is zero or undef, matches all objects of the given	486	on_skill_attack => sub {
185	type.	487	my ($self, $victim) = @_;
186		488	...
187	=item cf::attach_to_objects ...
188
189	Attach handlers to all objects. Do not use this except for debugging or
190	very rare events, as handlers are (obviously) called for I<all> objects in
191	the game.
192
193	=item cf::attach_to_players ...
194
195	Attach handlers to all players.
196
197	=item cf::attach_to_maps ...
198
199	Attach handlers to all maps.
200
201	=item cf:register_attachment $name, ...
202
203	Register an attachment by name through which objects can refer to this
204	attachment.
205
206	=item cf:register_player_attachment $name, ...
207
208	Register an attachment by name through which players can refer to this
209	attachment.
210
211	=item cf:register_map_attachment $name, ...
212
213	Register an attachment by name through which maps can refer to this
214	attachment.
215
216	=cut
217
218	# the following variables are defined in .xs and must not be re-created
219	our @CB_GLOBAL = (); # registry for all global events
220	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
221	our @CB_PLAYER = ();
222	our @CB_TYPE = (); # registry for type (cf-object class) based events
223	our @CB_MAP = ();
224
225	my %attachment;
226
227	sub _attach_cb($\%$$$) {
228	my ($registry, $undo, $event, $prio, $cb) = @_;
229
230	use sort 'stable';
231
232	$cb = [$prio, $cb];
233
234	@{$registry->[$event]} = sort
235	{ $a->[0] cmp $b->[0] }
236	@{$registry->[$event] || []}, $cb;
237
238	push @{$undo->{cb}}, [$event, $cb];
239	}
240
241	# attach handles attaching event callbacks
242	# the only thing the caller has to do is pass the correct
243	# registry (== where the callback attaches to).
244	sub _attach(\@$@) {
245	my ($registry, $klass, @arg) = @_;
246
247	my $prio = 0;
248
249	my %undo = (
250	registry => $registry,
251	cb => [],
252	);
253
254	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
255
256	while (@arg) {
257	my $type = shift @arg;
258
259	if ($type eq "prio") {
260	$prio = shift @arg;
261
262	} elsif ($type eq "package") {
263	my $pkg = shift @arg;
264
265	while (my ($name, $id) = each %cb_id) {
266	if (my $cb = $pkg->can ($name)) {
267	_attach_cb $registry, %undo, $id, $prio, $cb;
268	}
269	}	489	}
270
271	} elsif (exists $cb_id{$type}) {
272	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
273
274	} elsif (ref $type) {
275	warn "attaching objects not supported, ignoring.\n";
276
277	} else {
278	shift @arg;
279	warn "attach argument '$type' not supported, ignoring.\n";
280	}
281	}
282
283	\%undo
284	}
285
286	sub _attach_attachment {
287	my ($obj, $name, %arg) = @_;
288
289	return if exists $obj->{_attachment}{$name};
290
291	my $res;
292
293	if (my $attach = $attachment{$name}) {
294	my $registry = $obj->registry;
295
296	for (@$attach) {
297	my ($klass, @attach) = @$_;
298	$res = _attach @$registry, $klass, @attach;
299	}
300
301	$obj->{$name} = \%arg;
302	} else {
303	warn "object uses attachment '$name' that is not available, postponing.\n";
304	}
305
306	$obj->{_attachment}{$name} = undef;
307
308	$res->{attachment} = $name;
309	$res
310	}
311
312	*cf::object::attach =
313	*cf::player::attach =
314	*cf::map::attach = sub {
315	my ($obj, $name, %arg) = @_;
316
317	_attach_attachment $obj, $name, %arg;
318	};
319
320	# all those should be optimised
321	*cf::object::detach =
322	*cf::player::detach =
323	*cf::map::detach = sub {
324	my ($obj, $name) = @_;
325
326	delete $obj->{_attachment}{$name};
327	reattach ($obj);
328	};
329
330	*cf::object::attached =
331	*cf::player::attached =
332	*cf::map::attached = sub {
333	my ($obj, $name) = @_;
334
335	exists $obj->{_attachment}{$name}
336	};
337
338	sub attach_global {
339	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
340	}
341
342	sub attach_to_type {
343	my $type = shift;
344	my $subtype = shift;
345
346	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
347	}
348
349	sub attach_to_objects {
350	_attach @CB_OBJECT, KLASS_OBJECT, @_
351	}
352
353	sub attach_to_players {
354	_attach @CB_PLAYER, KLASS_PLAYER, @_
355	}
356
357	sub attach_to_maps {
358	_attach @CB_MAP, KLASS_MAP, @_
359	}
360
361	sub register_attachment {
362	my $name = shift;
363
364	$attachment{$name} = [[KLASS_OBJECT, @_]];
365	}
366
367	sub register_player_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_PLAYER, @_]];
371	}
372
373	sub register_map_attachment {
374	my $name = shift;
375
376	$attachment{$name} = [[KLASS_MAP, @_]];
377	}
378
379	our $override;
380	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
381
382	sub override {
383	$override = 1;
384	@invoke_results = ();
385	}
386
387	sub do_invoke {
388	my $event = shift;
389	my $callbacks = shift;
390
391	@invoke_results = ();
392
393	local $override;
394
395	for (@$callbacks) {
396	eval { &{$_->[1]} };
397
398	if ($@) {
399	warn "$@";
400	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
401	override;
402	}
403
404	return 1 if $override;
405	}
406
407	0	490	}
408	}
409		491
410	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	492	=item $attachable->valid
411
412	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
413
414	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
415
416	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
417
418	Generate a global/object/player/map-specific event with the given arguments.
419
420	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
421	removed in future versions), and there is no public API to access override
422	results (if you must, access C<@cf::invoke_results> directly).
423
424	=back
425
426	#############################################################################
427
428	=head2 METHODS VALID FOR ALL CORE OBJECTS
429
430	=over 4
431
432	=item $object->valid, $player->valid, $map->valid
433		493
434	Just because you have a perl object does not mean that the corresponding	494	Just because you have a perl object does not mean that the corresponding
435	C-level object still exists. If you try to access an object that has no	495	C-level object still exists. If you try to access an object that has no
436	valid C counterpart anymore you get an exception at runtime. This method	496	valid C counterpart anymore you get an exception at runtime. This method
437	can be used to test for existence of the C object part without causing an	497	can be used to test for existence of the C object part without causing an
438	exception.	498	exception.
439		499
		500	=cut
		501
		502	# the following variables are defined in .xs and must not be re-created
		503	our @CB_GLOBAL = (); # registry for all global events
		504	our @CB_ATTACHABLE = (); # registry for all attachables
		505	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		506	our @CB_PLAYER = ();
		507	our @CB_CLIENT = ();
		508	our @CB_TYPE = (); # registry for type (cf-object class) based events
		509	our @CB_MAP = ();
		510
		511	my %attachment;
		512
		513	sub _attach_cb($$$$) {
		514	my ($registry, $event, $prio, $cb) = @_;
		515
		516	use sort 'stable';
		517
		518	$cb = [$prio, $cb];
		519
		520	@{$registry->[$event]} = sort
		521	{ $a->[0] cmp $b->[0] }
		522	@{$registry->[$event] || []}, $cb;
		523	}
		524
		525	# hack
		526	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		527
		528	# attach handles attaching event callbacks
		529	# the only thing the caller has to do is pass the correct
		530	# registry (== where the callback attaches to).
		531	sub _attach {
		532	my ($registry, $klass, @arg) = @_;
		533
		534	my $object_type;
		535	my $prio = 0;
		536	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		537
		538	#TODO: get rid of this hack
		539	if ($attachable_klass{$klass}) {
		540	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		541	}
		542
		543	while (@arg) {
		544	my $type = shift @arg;
		545
		546	if ($type eq "prio") {
		547	$prio = shift @arg;
		548
		549	} elsif ($type eq "type") {
		550	$object_type = shift @arg;
		551	$registry = $CB_TYPE[$object_type] ||= [];
		552
		553	} elsif ($type eq "subtype") {
		554	defined $object_type or Carp::croak "subtype specified without type";
		555	my $object_subtype = shift @arg;
		556	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		557
		558	} elsif ($type eq "package") {
		559	my $pkg = shift @arg;
		560
		561	while (my ($name, $id) = each %cb_id) {
		562	if (my $cb = $pkg->can ($name)) {
		563	_attach_cb $registry, $id, $prio, $cb;
		564	}
		565	}
		566
		567	} elsif (exists $cb_id{$type}) {
		568	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		569
		570	} elsif (ref $type) {
		571	warn "attaching objects not supported, ignoring.\n";
		572
		573	} else {
		574	shift @arg;
		575	warn "attach argument '$type' not supported, ignoring.\n";
		576	}
		577	}
		578	}
		579
		580	sub _object_attach {
		581	my ($obj, $name, %arg) = @_;
		582
		583	return if exists $obj->{_attachment}{$name};
		584
		585	if (my $attach = $attachment{$name}) {
		586	my $registry = $obj->registry;
		587
		588	for (@$attach) {
		589	my ($klass, @attach) = @$_;
		590	_attach $registry, $klass, @attach;
		591	}
		592
		593	$obj->{$name} = \%arg;
		594	} else {
		595	warn "object uses attachment '$name' that is not available, postponing.\n";
		596	}
		597
		598	$obj->{_attachment}{$name} = undef;
		599	}
		600
		601	sub cf::attachable::attach {
		602	if (ref $_[0]) {
		603	_object_attach @_;
		604	} else {
		605	_attach shift->_attach_registry, @_;
		606	}
		607	};
		608
		609	# all those should be optimised
		610	sub cf::attachable::detach {
		611	my ($obj, $name) = @_;
		612
		613	if (ref $obj) {
		614	delete $obj->{_attachment}{$name};
		615	reattach ($obj);
		616	} else {
		617	Carp::croak "cannot, currently, detach class attachments";
		618	}
		619	};
		620
		621	sub cf::attachable::attached {
		622	my ($obj, $name) = @_;
		623
		624	exists $obj->{_attachment}{$name}
		625	}
		626
		627	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		628	eval "#line " . __LINE__ . " 'cf.pm'
		629	sub cf::\L$klass\E::_attach_registry {
		630	(\\\@CB_$klass, KLASS_$klass)
		631	}
		632
		633	sub cf::\L$klass\E::attachment {
		634	my \$name = shift;
		635
		636	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		637	}
		638	";
		639	die if $@;
		640	}
		641
		642	our $override;
		643	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		644
		645	sub override {
		646	$override = 1;
		647	@invoke_results = ();
		648	}
		649
		650	sub do_invoke {
		651	my $event = shift;
		652	my $callbacks = shift;
		653
		654	@invoke_results = ();
		655
		656	local $override;
		657
		658	for (@$callbacks) {
		659	eval { &{$_->[1]} };
		660
		661	if ($@) {
		662	warn "$@";
		663	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		664	override;
		665	}
		666
		667	return 1 if $override;
		668	}
		669
		670	0
		671	}
		672
		673	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		674
		675	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		676
		677	Generate an object-specific event with the given arguments.
		678
		679	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		680	removed in future versions), and there is no public API to access override
		681	results (if you must, access C<@cf::invoke_results> directly).
		682
440	=back	683	=back
441		684
442	=cut	685	=cut
443
444	*cf::object::valid =
445	*cf::player::valid =
446	*cf::map::valid = \&cf::_valid;
447		686
448	#############################################################################	687	#############################################################################
449	# object support	688	# object support
450		689
451	sub instantiate {
452	my ($obj, $data) = @_;
453
454	$data = from_json $data;
455
456	for (@$data) {
457	my ($name, $args) = @$_;
458
459	$obj->attach ($name, %{$args || {} });
460	}
461	}
462
463	# basically do the same as instantiate, without calling instantiate
464	sub reattach {	690	sub reattach {
		691	# basically do the same as instantiate, without calling instantiate
465	my ($obj) = @_;	692	my ($obj) = @_;
		693
466	my $registry = $obj->registry;	694	my $registry = $obj->registry;
467		695
468	@$registry = ();	696	@$registry = ();
469		697
470	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	698	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
471		699
472	for my $name (keys %{ $obj->{_attachment} || {} }) {	700	for my $name (keys %{ $obj->{_attachment} || {} }) {
473	if (my $attach = $attachment{$name}) {	701	if (my $attach = $attachment{$name}) {
474	for (@$attach) {	702	for (@$attach) {
475	my ($klass, @attach) = @$_;	703	my ($klass, @attach) = @$_;
476	_attach @$registry, $klass, @attach;	704	_attach $registry, $klass, @attach;
477	}	705	}
478	} else {	706	} else {
479	warn "object uses attachment '$name' that is not available, postponing.\n";	707	warn "object uses attachment '$name' that is not available, postponing.\n";
480	}	708	}
481	}	709	}
482	}	710	}
483		711
484	sub object_freezer_save {	712	cf::attachable->attach (
485	my ($filename, $rdata, $objs) = @_;
486
487	if (length $$rdata) {
488	warn sprintf "saving %s (%d,%d)\n",
489	$filename, length $$rdata, scalar @$objs;
490
491	if (open my $fh, ">:raw", "$filename~") {
492	chmod SAVE_MODE, $fh;
493	syswrite $fh, $$rdata;
494	close $fh;
495
496	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
497	chmod SAVE_MODE, $fh;
498	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
499	close $fh;
500	rename "$filename.pst~", "$filename.pst";
501	} else {
502	unlink "$filename.pst";
503	}
504
505	rename "$filename~", $filename;
506	} else {
507	warn "FATAL: $filename~: $!\n";
508	}
509	} else {
510	unlink $filename;
511	unlink "$filename.pst";
512	}
513	}
514
515	sub object_thawer_load {
516	my ($filename) = @_;
517
518	local $/;
519
520	my $av;
521
522	#TODO: use sysread etc.
523	if (open my $data, "<:raw:perlio", $filename) {
524	$data = <$data>;
525	if (open my $pst, "<:raw:perlio", "$filename.pst") {
526	$av = eval { (Storable::thaw <$pst>)->{objs} };
527	}
528	return ($data, $av);
529	}
530
531	()
532	}
533
534	attach_to_objects
535	prio => -1000000,	713	prio => -1000000,
		714	on_instantiate => sub {
		715	my ($obj, $data) = @_;
		716
		717	$data = from_json $data;
		718
		719	for (@$data) {
		720	my ($name, $args) = @$_;
		721
		722	$obj->attach ($name, %{$args || {} });
		723	}
		724	},
		725	on_reattach => \&reattach,
536	on_clone => sub {	726	on_clone => sub {
537	my ($src, $dst) = @_;	727	my ($src, $dst) = @_;
538		728
539	@{$dst->registry} = @{$src->registry};	729	@{$dst->registry} = @{$src->registry};
540		730
541	%$dst = %$src;	731	%$dst = %$src;
542		732
543	%{$dst->{_attachment}} = %{$src->{_attachment}}	733	%{$dst->{_attachment}} = %{$src->{_attachment}}
544	if exists $src->{_attachment};	734	if exists $src->{_attachment};
545	},	735	},
546	;	736	);
		737
		738	sub object_freezer_save {
		739	my ($filename, $rdata, $objs) = @_;
		740
		741	sync_job {
		742	if (length $$rdata) {
		743	warn sprintf "saving %s (%d,%d)\n",
		744	$filename, length $$rdata, scalar @$objs;
		745
		746	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		747	chmod SAVE_MODE, $fh;
		748	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		749	aio_fsync $fh;
		750	close $fh;
		751
		752	if (@$objs) {
		753	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		754	chmod SAVE_MODE, $fh;
		755	my $data = Storable::nfreeze { version => 1, objs => $objs };
		756	aio_write $fh, 0, (length $data), $data, 0;
		757	aio_fsync $fh;
		758	close $fh;
		759	aio_rename "$filename.pst~", "$filename.pst";
		760	}
		761	} else {
		762	aio_unlink "$filename.pst";
		763	}
		764
		765	aio_rename "$filename~", $filename;
		766	} else {
		767	warn "FATAL: $filename~: $!\n";
		768	}
		769	} else {
		770	aio_unlink $filename;
		771	aio_unlink "$filename.pst";
		772	}
		773	}
		774	}
		775
		776	sub object_freezer_as_string {
		777	my ($rdata, $objs) = @_;
		778
		779	use Data::Dumper;
		780
		781	$$rdata . Dumper $objs
		782	}
		783
		784	sub object_thawer_load {
		785	my ($filename) = @_;
		786
		787	my ($data, $av);
		788
		789	(aio_load $filename, $data) >= 0
		790	or return;
		791
		792	unless (aio_stat "$filename.pst") {
		793	(aio_load "$filename.pst", $av) >= 0
		794	or return;
		795	$av = eval { (Storable::thaw <$av>)->{objs} };
		796	}
		797
		798	return ($data, $av);
		799	}
547		800
548	#############################################################################	801	#############################################################################
549	# old plug-in events	802	# command handling &c
550		803
551	sub inject_event {	804	=item cf::register_command $name => \&callback($ob,$args);
552	my $extension = shift;
553	my $event_code = shift;
554		805
555	my $cb = $hook[$event_code]{$extension}	806	Register a callback for execution when the client sends the user command
556	or return;	807	$name.
557		808
558	&$cb	809	=cut
559	}
560
561	sub inject_global_event {
562	my $event = shift;
563
564	my $cb = $hook[$event]
565	or return;
566
567	List::Util::max map &$_, values %$cb
568	}
569
570	sub inject_command {
571	my ($name, $obj, $params) = @_;
572
573	for my $cmd (@{ $command{$name} }) {
574	$cmd->[1]->($obj, $params);
575	}
576
577	-1
578	}
579		810
580	sub register_command {	811	sub register_command {
581	my ($name, $time, $cb) = @_;	812	my ($name, $cb) = @_;
582		813
583	my $caller = caller;	814	my $caller = caller;
584	#warn "registering command '$name/$time' to '$caller'";	815	#warn "registering command '$name/$time' to '$caller'";
585		816
586	push @{ $command{$name} }, [$time, $cb, $caller];	817	push @{ $COMMAND{$name} }, [$caller, $cb];
587	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
588	}	818	}
		819
		820	=item cf::register_extcmd $name => \&callback($pl,$packet);
		821
		822	Register a callbackf ro execution when the client sends an extcmd packet.
		823
		824	If the callback returns something, it is sent back as if reply was being
		825	called.
		826
		827	=cut
589		828
590	sub register_extcmd {	829	sub register_extcmd {
591	my ($name, $cb) = @_;	830	my ($name, $cb) = @_;
592		831
593	my $caller = caller;	832	my $caller = caller;
594	#warn "registering extcmd '$name' to '$caller'";	833	#warn "registering extcmd '$name' to '$caller'";
595		834
596	$extcmd{$name} = [$cb, $caller];	835	$EXTCMD{$name} = [$cb, $caller];
597	}	836	}
		837
		838	cf::player->attach (
		839	on_command => sub {
		840	my ($pl, $name, $params) = @_;
		841
		842	my $cb = $COMMAND{$name}
		843	or return;
		844
		845	for my $cmd (@$cb) {
		846	$cmd->[1]->($pl->ob, $params);
		847	}
		848
		849	cf::override;
		850	},
		851	on_extcmd => sub {
		852	my ($pl, $buf) = @_;
		853
		854	my $msg = eval { from_json $buf };
		855
		856	if (ref $msg) {
		857	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		858	if (my %reply = $cb->[0]->($pl, $msg)) {
		859	$pl->ext_reply ($msg->{msgid}, %reply);
		860	}
		861	}
		862	} else {
		863	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		864	}
		865
		866	cf::override;
		867	},
		868	);
598		869
599	sub register {	870	sub register {
600	my ($base, $pkg) = @_;	871	my ($base, $pkg) = @_;
601		872
602	#TODO	873	#TODO
…		…
621	. "#line 1 \"$path\"\n{\n"	892	. "#line 1 \"$path\"\n{\n"
622	. (do { local $/; <$fh> })	893	. (do { local $/; <$fh> })
623	. "\n};\n1";	894	. "\n};\n1";
624		895
625	eval $source	896	eval $source
626	or die "$path: $@";	897	or die $@ ? "$path: $@\n"
		898	: "extension disabled.\n";
627		899
628	push @exts, $pkg;	900	push @exts, $pkg;
629	$ext_pkg{$base} = $pkg;	901	$ext_pkg{$base} = $pkg;
630		902
631	# no strict 'refs';	903	# no strict 'refs';
…		…
644	# for my $idx (0 .. $#PLUGIN_EVENT) {	916	# for my $idx (0 .. $#PLUGIN_EVENT) {
645	# delete $hook[$idx]{$pkg};	917	# delete $hook[$idx]{$pkg};
646	# }	918	# }
647		919
648	# remove commands	920	# remove commands
649	for my $name (keys %command) {	921	for my $name (keys %COMMAND) {
650	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	922	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
651		923
652	if (@cb) {	924	if (@cb) {
653	$command{$name} = \@cb;	925	$COMMAND{$name} = \@cb;
654	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
655	} else {	926	} else {
656	delete $command{$name};
657	delete $COMMAND{"$name\000"};	927	delete $COMMAND{$name};
658	}	928	}
659	}	929	}
660		930
661	# remove extcmds	931	# remove extcmds
662	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	932	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
663	delete $extcmd{$name};	933	delete $EXTCMD{$name};
664	}	934	}
665		935
666	if (my $cb = $pkg->can ("unload")) {	936	if (my $cb = $pkg->can ("unload")) {
667	eval {	937	eval {
668	$cb->($pkg);	938	$cb->($pkg);
…		…
672		942
673	Symbol::delete_package $pkg;	943	Symbol::delete_package $pkg;
674	}	944	}
675		945
676	sub load_extensions {	946	sub load_extensions {
677	my $LIBDIR = maps_directory "perl";
678
679	for my $ext (<$LIBDIR/*.ext>) {	947	for my $ext (<$LIBDIR/*.ext>) {
680	next unless -r $ext;	948	next unless -r $ext;
681	eval {	949	eval {
682	load_extension $ext;	950	load_extension $ext;
683	1	951	1
684	} or warn "$ext not loaded: $@";	952	} or warn "$ext not loaded: $@";
685	}	953	}
686	}	954	}
687		955
688	#############################################################################	956	#############################################################################
689	# extcmd framework, basically convert ext <msg>
690	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
691
692	attach_to_players
693	on_extcmd => sub {
694	my ($pl, $buf) = @_;
695
696	my $msg = eval { from_json $buf };
697
698	if (ref $msg) {
699	if (my $cb = $extcmd{$msg->{msgtype}}) {
700	if (my %reply = $cb->[0]->($pl, $msg)) {
701	$pl->ext_reply ($msg->{msgid}, %reply);
702	}
703	}
704	} else {
705	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
706	}
707
708	cf::override;
709	},
710	;
711
712	#############################################################################
713	# load/save/clean perl data associated with a map	957	# load/save/clean perl data associated with a map
714		958
715	*cf::mapsupport::on_clean = sub {	959	*cf::mapsupport::on_clean = sub {
716	my ($map) = @_;	960	my ($map) = @_;
717		961
…		…
719	defined $path or return;	963	defined $path or return;
720		964
721	unlink "$path.pst";	965	unlink "$path.pst";
722	};	966	};
723		967
724	attach_to_maps prio => -10000, package => cf::mapsupport::;	968	cf::map->attach (prio => -10000, package => cf::mapsupport::);
725		969
726	#############################################################################	970	#############################################################################
727	# load/save perl data associated with player->ob objects	971	# load/save perl data associated with player->ob objects
728		972
729	sub all_objects(@) {	973	sub all_objects(@) {
730	@_, map all_objects ($_->inv), @_	974	@_, map all_objects ($_->inv), @_
731	}	975	}
732		976
733	# TODO: compatibility cruft, remove when no longer needed	977	# TODO: compatibility cruft, remove when no longer needed
734	attach_to_players	978	cf::player->attach (
735	on_load => sub {	979	on_load => sub {
736	my ($pl, $path) = @_;	980	my ($pl, $path) = @_;
737		981
738	for my $o (all_objects $pl->ob) {	982	for my $o (all_objects $pl->ob) {
739	if (my $value = $o->get_ob_key_value ("_perl_data")) {	983	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
741		985
742	%$o = %{ Storable::thaw pack "H*", $value };	986	%$o = %{ Storable::thaw pack "H*", $value };
743	}	987	}
744	}	988	}
745	},	989	},
746	;	990	);
747		991
748	#############################################################################	992	#############################################################################
749		993
750	=head2 CORE EXTENSIONS	994	=head2 CORE EXTENSIONS
751		995
752	Functions and methods that extend core crossfire objects.	996	Functions and methods that extend core crossfire objects.
		997
		998	=head3 cf::player
753		999
754	=over 4	1000	=over 4
755		1001
756	=item cf::player::exists $login	1002	=item cf::player::exists $login
757		1003
…		…
762	sub cf::player::exists($) {	1008	sub cf::player::exists($) {
763	cf::player::find $_[0]	1009	cf::player::find $_[0]
764	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1010	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
765	}	1011	}
766		1012
		1013	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1014
		1015	Sends an ext reply to the player.
		1016
		1017	=cut
		1018
		1019	sub cf::player::ext_reply($$$%) {
		1020	my ($self, $id, %msg) = @_;
		1021
		1022	$msg{msgid} = $id;
		1023
		1024	$self->send ("ext " . to_json \%msg);
		1025	}
		1026
		1027	=back
		1028
		1029	=head3 cf::object::player
		1030
		1031	=over 4
		1032
767	=item $player->reply ($npc, $msg[, $flags])	1033	=item $player_object->reply ($npc, $msg[, $flags])
768		1034
769	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1035	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
770	can be C<undef>. Does the right thing when the player is currently in a	1036	can be C<undef>. Does the right thing when the player is currently in a
771	dialogue with the given NPC character.	1037	dialogue with the given NPC character.
772		1038
773	=cut	1039	=cut
774		1040
775	# rough implementation of a future "reply" method that works	1041	# rough implementation of a future "reply" method that works
776	# with dialog boxes.	1042	# with dialog boxes.
		1043	#TODO: the first argument must go, split into a $npc->reply_to ( method
777	sub cf::object::player::reply($$$;$) {	1044	sub cf::object::player::reply($$$;$) {
778	my ($self, $npc, $msg, $flags) = @_;	1045	my ($self, $npc, $msg, $flags) = @_;
779		1046
780	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1047	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
781		1048
…		…
785	$msg = $npc->name . " says: $msg" if $npc;	1052	$msg = $npc->name . " says: $msg" if $npc;
786	$self->message ($msg, $flags);	1053	$self->message ($msg, $flags);
787	}	1054	}
788	}	1055	}
789		1056
790	=item $player->ext_reply ($msgid, $msgtype, %msg)	1057	=item $player_object->may ("access")
791		1058
792	Sends an ext reply to the player.	1059	Returns wether the given player is authorized to access resource "access"
		1060	(e.g. "command_wizcast").
793		1061
794	=cut	1062	=cut
795		1063
796	sub cf::player::ext_reply($$$%) {	1064	sub cf::object::player::may {
		1065	my ($self, $access) = @_;
		1066
		1067	$self->flag (cf::FLAG_WIZ) ||
		1068	(ref $cf::CFG{"may_$access"}
		1069	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1070	: $cf::CFG{"may_$access"})
		1071	}
		1072
		1073	=head3 cf::client
		1074
		1075	=over 4
		1076
		1077	=item $client->send_drawinfo ($text, $flags)
		1078
		1079	Sends a drawinfo packet to the client. Circumvents output buffering so
		1080	should not be used under normal circumstances.
		1081
		1082	=cut
		1083
		1084	sub cf::client::send_drawinfo {
		1085	my ($self, $text, $flags) = @_;
		1086
		1087	utf8::encode $text;
		1088	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1089	}
		1090
		1091
		1092	=item $success = $client->query ($flags, "text", \&cb)
		1093
		1094	Queues a query to the client, calling the given callback with
		1095	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1096	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1097
		1098	Queries can fail, so check the return code. Or don't, as queries will become
		1099	reliable at some point in the future.
		1100
		1101	=cut
		1102
		1103	sub cf::client::query {
		1104	my ($self, $flags, $text, $cb) = @_;
		1105
		1106	return unless $self->state == ST_PLAYING
		1107	|| $self->state == ST_SETUP
		1108	|| $self->state == ST_CUSTOM;
		1109
		1110	$self->state (ST_CUSTOM);
		1111
		1112	utf8::encode $text;
		1113	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1114
		1115	$self->send_packet ($self->{query_queue}[0][0])
		1116	if @{ $self->{query_queue} } == 1;
		1117	}
		1118
		1119	cf::client->attach (
		1120	on_reply => sub {
		1121	my ($ns, $msg) = @_;
		1122
		1123	# this weird shuffling is so that direct followup queries
		1124	# get handled first
		1125	my $queue = delete $ns->{query_queue};
		1126
		1127	(shift @$queue)->[1]->($msg);
		1128
		1129	push @{ $ns->{query_queue} }, @$queue;
		1130
		1131	if (@{ $ns->{query_queue} } == @$queue) {
		1132	if (@$queue) {
		1133	$ns->send_packet ($ns->{query_queue}[0][0]);
		1134	} else {
		1135	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1136	}
		1137	}
		1138	},
		1139	);
		1140
		1141	=item $client->coro (\&cb)
		1142
		1143	Create a new coroutine, running the specified callback. The coroutine will
		1144	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1145	or loss of connection).
		1146
		1147	=cut
		1148
		1149	sub cf::client::coro {
797	my ($self, $id, %msg) = @_;	1150	my ($self, $cb) = @_;
798		1151
799	$msg{msgid} = $id;	1152	my $coro; $coro = async {
		1153	eval {
		1154	$cb->();
		1155	};
		1156	warn $@ if $@;
		1157	};
800		1158
801	$self->send ("ext " . to_json \%msg);	1159	$coro->on_destroy (sub {
		1160	delete $self->{_coro}{$coro+0};
		1161	});
		1162
		1163	$self->{_coro}{$coro+0} = $coro;
		1164
		1165	$coro
802	}	1166	}
		1167
		1168	cf::client->attach (
		1169	on_destroy => sub {
		1170	my ($ns) = @_;
		1171
		1172	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1173	},
		1174	);
803		1175
804	=back	1176	=back
805		1177
806	=cut
807
808	#############################################################################
809		1178
810	=head2 SAFE SCRIPTING	1179	=head2 SAFE SCRIPTING
811		1180
812	Functions that provide a safe environment to compile and execute	1181	Functions that provide a safe environment to compile and execute
813	snippets of perl code without them endangering the safety of the server	1182	snippets of perl code without them endangering the safety of the server
814	itself. Looping constructs, I/O operators and other built-in functionality	1183	itself. Looping constructs, I/O operators and other built-in functionality
815	is not available in the safe scripting environment, and the number of	1184	is not available in the safe scripting environment, and the number of
816	functions and methods that cna be called is greatly reduced.	1185	functions and methods that can be called is greatly reduced.
817		1186
818	=cut	1187	=cut
819		1188
820	our $safe = new Safe "safe";	1189	our $safe = new Safe "safe";
821	our $safe_hole = new Safe::Hole;	1190	our $safe_hole = new Safe::Hole;
…		…
828		1197
829	=pod	1198	=pod
830		1199
831	The following fucntions and emthods are available within a safe environment:	1200	The following fucntions and emthods are available within a safe environment:
832		1201
833	cf::object contr pay_amount pay_player	1202	cf::object contr pay_amount pay_player map
834	cf::object::player player	1203	cf::object::player player
835	cf::player peaceful	1204	cf::player peaceful
		1205	cf::map trigger
836		1206
837	=cut	1207	=cut
838		1208
839	for (	1209	for (
840	["cf::object" => qw(contr pay_amount pay_player)],	1210	["cf::object" => qw(contr pay_amount pay_player map)],
841	["cf::object::player" => qw(player)],	1211	["cf::object::player" => qw(player)],
842	["cf::player" => qw(peaceful)],	1212	["cf::player" => qw(peaceful)],
		1213	["cf::map" => qw(trigger)],
843	) {	1214	) {
844	no strict 'refs';	1215	no strict 'refs';
845	my ($pkg, @funs) = @$_;	1216	my ($pkg, @funs) = @$_;
846	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1217	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
847	for @funs;	1218	for @funs;
…		…
912	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1283	*{"safe::$fun"} = $safe_hole->wrap ($cb);
913	}	1284	}
914		1285
915	=back	1286	=back
916		1287
		1288	=cut
		1289
917	#############################################################################	1290	#############################################################################
918		1291
919	=head2 EXTENSION DATABASE SUPPORT	1292	=head2 EXTENSION DATABASE SUPPORT
920		1293
921	Crossfire maintains a very simple database for extension use. It can	1294	Crossfire maintains a very simple database for extension use. It can
…		…
955		1328
956	Immediately write the database to disk I<if it is dirty>.	1329	Immediately write the database to disk I<if it is dirty>.
957		1330
958	=cut	1331	=cut
959		1332
		1333	our $DB;
		1334
960	{	1335	{
961	my $db;
962	my $path = cf::localdir . "/database.pst";	1336	my $path = cf::localdir . "/database.pst";
963		1337
964	sub db_load() {	1338	sub db_load() {
965	warn "loading database $path\n";#d# remove later	1339	warn "loading database $path\n";#d# remove later
966	$db = stat $path ? Storable::retrieve $path : { };	1340	$DB = stat $path ? Storable::retrieve $path : { };
967	}	1341	}
968		1342
969	my $pid;	1343	my $pid;
970		1344
971	sub db_save() {	1345	sub db_save() {
972	warn "saving database $path\n";#d# remove later	1346	warn "saving database $path\n";#d# remove later
973	waitpid $pid, 0 if $pid;	1347	waitpid $pid, 0 if $pid;
974	if (0 == ($pid = fork)) {	1348	if (0 == ($pid = fork)) {
975	$db->{_meta}{version} = 1;	1349	$DB->{_meta}{version} = 1;
976	Storable::nstore $db, "$path~";	1350	Storable::nstore $DB, "$path~";
977	rename "$path~", $path;	1351	rename "$path~", $path;
978	cf::_exit 0 if defined $pid;	1352	cf::_exit 0 if defined $pid;
979	}	1353	}
980	}	1354	}
981		1355
…		…
984	sub db_sync() {	1358	sub db_sync() {
985	db_save if $dirty;	1359	db_save if $dirty;
986	undef $dirty;	1360	undef $dirty;
987	}	1361	}
988		1362
989	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1363	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
990	db_sync;	1364	db_sync;
991	});	1365	});
992		1366
993	sub db_dirty() {	1367	sub db_dirty() {
994	$dirty = 1;	1368	$dirty = 1;
995	$idle->start;	1369	$idle->start;
996	}	1370	}
997		1371
998	sub db_get($;$) {	1372	sub db_get($;$) {
999	@_ >= 2	1373	@_ >= 2
1000	? $db->{$_[0]}{$_[1]}	1374	? $DB->{$_[0]}{$_[1]}
1001	: ($db->{$_[0]} ||= { })	1375	: ($DB->{$_[0]} ||= { })
1002	}	1376	}
1003		1377
1004	sub db_put($$;$) {	1378	sub db_put($$;$) {
1005	if (@_ >= 3) {	1379	if (@_ >= 3) {
1006	$db->{$_[0]}{$_[1]} = $_[2];	1380	$DB->{$_[0]}{$_[1]} = $_[2];
1007	} else {	1381	} else {
1008	$db->{$_[0]} = $_[1];	1382	$DB->{$_[0]} = $_[1];
1009	}	1383	}
1010	db_dirty;	1384	db_dirty;
1011	}	1385	}
1012		1386
1013	attach_global	1387	cf::global->attach (
1014	prio => 10000,	1388	prio => 10000,
1015	on_cleanup => sub {	1389	on_cleanup => sub {
1016	db_sync;	1390	db_sync;
1017	},	1391	},
1018	;	1392	);
1019	}	1393	}
1020		1394
1021	#############################################################################	1395	#############################################################################
1022	# the server's main()	1396	# the server's main()
1023		1397
		1398	sub cfg_load {
		1399	open my $fh, "<:utf8", cf::confdir . "/config"
		1400	or return;
		1401
		1402	local $/;
		1403	*CFG = YAML::Syck::Load <$fh>;
		1404	}
		1405
1024	sub main {	1406	sub main {
		1407	# we must not ever block the main coroutine
		1408	local $Coro::idle = sub {
		1409	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1410	(Coro::unblock_sub {
		1411	Event::one_event;
		1412	})->();
		1413	};
		1414
		1415	cfg_load;
1025	db_load;	1416	db_load;
1026	load_extensions;	1417	load_extensions;
1027	Event::loop;	1418	Event::loop;
1028	}	1419	}
1029		1420
1030	#############################################################################	1421	#############################################################################
1031	# initialisation	1422	# initialisation
1032		1423
1033	sub _perl_reload(&) {	1424	sub perl_reload() {
1034	my ($msg) = @_;	1425	# can/must only be called in main
		1426	if ($Coro::current != $Coro::main) {
		1427	warn "can only reload from main coroutine\n";
		1428	return;
		1429	}
1035		1430
1036	$msg->("reloading...");	1431	warn "reloading...";
		1432
		1433	local $FREEZE = 1;
		1434	cf::emergency_save;
1037		1435
1038	eval {	1436	eval {
		1437	# if anything goes wrong in here, we should simply crash as we already saved
		1438
1039	# cancel all watchers	1439	# cancel all watchers
1040	$_->cancel for Event::all_watchers;	1440	for (Event::all_watchers) {
		1441	$_->cancel if $_->data & WF_AUTOCANCEL;
		1442	}
		1443
		1444	# cancel all extension coros
		1445	$_->cancel for values %EXT_CORO;
		1446	%EXT_CORO = ();
1041		1447
1042	# unload all extensions	1448	# unload all extensions
1043	for (@exts) {	1449	for (@exts) {
1044	$msg->("unloading <$_>");	1450	warn "unloading <$_>";
1045	unload_extension $_;	1451	unload_extension $_;
1046	}	1452	}
1047		1453
1048	# unload all modules loaded from $LIBDIR	1454	# unload all modules loaded from $LIBDIR
1049	while (my ($k, $v) = each %INC) {	1455	while (my ($k, $v) = each %INC) {
1050	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1456	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1051		1457
1052	$msg->("removing <$k>");	1458	warn "removing <$k>";
1053	delete $INC{$k};	1459	delete $INC{$k};
1054		1460
1055	$k =~ s/\.pm$//;	1461	$k =~ s/\.pm$//;
1056	$k =~ s/\//::/g;	1462	$k =~ s/\//::/g;
1057		1463
…		…
1062	Symbol::delete_package $k;	1468	Symbol::delete_package $k;
1063	}	1469	}
1064		1470
1065	# sync database to disk	1471	# sync database to disk
1066	cf::db_sync;	1472	cf::db_sync;
		1473	IO::AIO::flush;
1067		1474
1068	# get rid of safe::, as good as possible	1475	# get rid of safe::, as good as possible
1069	Symbol::delete_package "safe::$_"	1476	Symbol::delete_package "safe::$_"
1070	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1477	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1071		1478
1072	# remove register_script_function callbacks	1479	# remove register_script_function callbacks
1073	# TODO	1480	# TODO
1074		1481
1075	# unload cf.pm "a bit"	1482	# unload cf.pm "a bit"
…		…
1078	# don't, removes xs symbols, too,	1485	# don't, removes xs symbols, too,
1079	# and global variables created in xs	1486	# and global variables created in xs
1080	#Symbol::delete_package __PACKAGE__;	1487	#Symbol::delete_package __PACKAGE__;
1081		1488
1082	# reload cf.pm	1489	# reload cf.pm
1083	$msg->("reloading cf.pm");	1490	warn "reloading cf.pm";
1084	require cf;	1491	require cf;
		1492	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1085		1493
1086	# load database again	1494	# load config and database again
		1495	cf::cfg_load;
1087	cf::db_load;	1496	cf::db_load;
1088		1497
1089	# load extensions	1498	# load extensions
1090	$msg->("load extensions");	1499	warn "load extensions";
1091	cf::load_extensions;	1500	cf::load_extensions;
1092		1501
1093	# reattach attachments to objects	1502	# reattach attachments to objects
1094	$msg->("reattach");	1503	warn "reattach";
1095	_global_reattach;	1504	_global_reattach;
1096	};	1505	};
1097	$msg->($@) if $@;
1098		1506
1099	$msg->("reloaded");	1507	if ($@) {
		1508	warn $@;
		1509	warn "error while reloading, exiting.";
		1510	exit 1;
		1511	}
		1512
		1513	warn "reloaded successfully";
1100	};	1514	};
1101		1515
1102	sub perl_reload() {	1516	#############################################################################
1103	_perl_reload {
1104	warn $_[0];
1105	print "$_[0]\n";
1106	};
1107	}
1108		1517
		1518	unless ($LINK_MAP) {
		1519	$LINK_MAP = cf::map::new;
		1520
		1521	$LINK_MAP->width (41);
		1522	$LINK_MAP->height (41);
		1523	$LINK_MAP->alloc;
		1524	$LINK_MAP->path ("{link}");
		1525	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		1526	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		1527	}
		1528
		1529	register "<global>", __PACKAGE__;
		1530
1109	register_command "perl-reload", 0, sub {	1531	register_command "perl-reload" => sub {
1110	my ($who, $arg) = @_;	1532	my ($who, $arg) = @_;
1111		1533
1112	if ($who->flag (FLAG_WIZ)) {	1534	if ($who->flag (FLAG_WIZ)) {
		1535	$who->message ("start of reload.");
1113	_perl_reload {	1536	perl_reload;
1114	warn $_[0];	1537	$who->message ("end of reload.");
1115	$who->message ($_[0]);
1116	};
1117	}	1538	}
1118	};	1539	};
1119		1540
1120	register "<global>", __PACKAGE__;
1121
1122	unshift @INC, $LIBDIR;	1541	unshift @INC, $LIBDIR;
1123		1542
1124	$TICK_WATCHER = Event->timer (	1543	$TICK_WATCHER = Event->timer (
		1544	reentrant => 0,
1125	prio => 1,	1545	prio => 0,
1126	at => $NEXT_TICK || 1,	1546	at => $NEXT_TICK || $TICK,
		1547	data => WF_AUTOCANCEL,
1127	cb => sub {	1548	cb => sub {
		1549	unless ($FREEZE) {
1128	cf::server_tick; # one server iteration	1550	cf::server_tick; # one server iteration
		1551	$RUNTIME += $TICK;
		1552	}
1129		1553
1130	my $NOW = Event::time;
1131	$NEXT_TICK += $TICK;	1554	$NEXT_TICK += $TICK;
1132		1555
1133	# if we are delayed by four ticks, skip them all	1556	# if we are delayed by four ticks or more, skip them all
1134	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1557	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1135		1558
1136	$TICK_WATCHER->at ($NEXT_TICK);	1559	$TICK_WATCHER->at ($NEXT_TICK);
1137	$TICK_WATCHER->start;	1560	$TICK_WATCHER->start;
1138	},	1561	},
1139	);	1562	);
1140		1563
		1564	IO::AIO::max_poll_time $TICK * 0.2;
		1565
		1566	Event->io (
		1567	fd => IO::AIO::poll_fileno,
		1568	poll => 'r',
		1569	prio => 5,
		1570	data => WF_AUTOCANCEL,
		1571	cb => \&IO::AIO::poll_cb,
		1572	);
		1573
		1574	Event->timer (
		1575	data => WF_AUTOCANCEL,
		1576	after => 0,
		1577	interval => 10,
		1578	cb => sub {
		1579	(Coro::unblock_sub {
		1580	write_runtime
		1581	or warn "ERROR: unable to write runtime file: $!";
		1582	})->();
		1583	},
		1584	);
		1585
1141	1	1586	1
1142		1587

Diff Legend

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