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

Diff Legend

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