[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.81 by root, Tue Nov 7 17:38:22 2006 UTC vs.
Revision 1.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;
10	use IO::AIO ();	22	use IO::AIO 2.31 ();
11	use YAML::Syck ();	23	use YAML::Syck ();
12	use Time::HiRes;	24	use Time::HiRes;
13	use Event;	25
14	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		27
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
18		30
19	use strict;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20		32
21	_init_vars;	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		34
23	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
24	our @EVENT;	39	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	40	our $LIBDIR = datadir . "/ext";
26		41
27	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	43	our $TICK_WATCHER;
29	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
30		46
31	our %CFG;	47	our %CFG;
32		48
33	our $uptime;	49	our $UPTIME; $UPTIME \|\|= time;
		50	our $RUNTIME;
34		51
35	$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;
36		76
37	#############################################################################	77	#############################################################################
38		78
39	=head2 GLOBAL VARIABLES	79	=head2 GLOBAL VARIABLES
40		80
41	=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.
42		91
43	=item $cf::LIBDIR	92	=item $cf::LIBDIR
44		93
45	The perl library directory, where extensions and cf-specific modules can	94	The perl library directory, where extensions and cf-specific modules can
46	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.
47		100
48	=item $cf::TICK	101	=item $cf::TICK
49		102
50	The interval between server ticks, in seconds.	103	The interval between server ticks, in seconds.
51		104
59	=cut	112	=cut
60		113
61	BEGIN {	114	BEGIN {
62	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
63	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
64	$msg .= "\n"	119	$msg .= "\n"
65	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
66		121
67	print STDERR "cfperl: $msg";
68	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
69	};	123	};
70	}	124	}
71		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';
72	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
73		132
74	# 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
75	# within the Safe compartment.	134	# within the Safe compartment.
76	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	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	)) {
77	no strict 'refs';	142	no strict 'refs';
78	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79	}	144	}
80		145
81	$Event::DIED = sub {	146	$Event::DIED = sub {
…		…
83	};	148	};
84		149
85	my %ext_pkg;	150	my %ext_pkg;
86	my @exts;	151	my @exts;
87	my @hook;	152	my @hook;
88	my %command;
89	my %extcmd;
90		153
91	=head2 UTILITY FUNCTIONS	154	=head2 UTILITY FUNCTIONS
92		155
93	=over 4	156	=over 4
94		157
…		…
116	sub to_json($) {	179	sub to_json($) {
117	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
118	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
119	}	182	}
120		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
121	=back	272	=back
122		273
123	=cut	274	=cut
124		275
125	#############################################################################	276	#############################################################################
126		277
127	=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+).
128		395
129	=over 4	396	=over 4
130		397
131	=item $object->attach ($attachment, key => $value...)
132
133	=item $object->detach ($attachment)
134
135	Attach/detach a pre-registered attachment to an object.
136
137	=item $player->attach ($attachment, key => $value...)
138
139	=item $player->detach ($attachment)
140
141	Attach/detach a pre-registered attachment to a player.
142
143	=item $map->attach ($attachment, key => $value...)	398	=item $attachable->attach ($attachment, key => $value...)
144		399
145	=item $map->detach ($attachment)	400	=item $attachable->detach ($attachment)
146		401
147	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.
148		404
149	=item $bool = $object->attached ($name)	405	Example, attach a minesweeper attachment to the given object, making it a
		406	10x10 minesweeper game:
150		407
151	=item $bool = $player->attached ($name)	408	$obj->attach (minesweeper => width => 10, height => 10);
152		409
153	=item $bool = $map->attached ($name)	410	=item $bool = $attachable->attached ($name)
154		411
155	Checks wether the named attachment is currently attached to the object.	412	Checks wether the named attachment is currently attached to the object.
156		413
157	=item cf::attach_global ...	414	=item cf::CLASS->attach ...
158		415
159	Attach handlers for global events.	416	=item cf::CLASS->detach ...
160		417
161	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
162	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:
163		452
164	=over 4	453	=over 4
165		454
166	=item prio => $number	455	=item prio => $number
167		456
…		…
169	by another C<prio> setting). Lower priority handlers get executed	458	by another C<prio> setting). Lower priority handlers get executed
170	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
171	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
172	unless you know what you are doing.	461	unless you know what you are doing.
173		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
174	=item on_I<event> => \&cb	469	=item on_I<event> => \&cb
175		470
176	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
177	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
178	handlers are recognised generally depends on the type of object these	473	handlers are recognised generally depends on the type of object these
…		…
187	package and register them. Only handlers for eevents supported by the	482	package and register them. Only handlers for eevents supported by the
188	object/class are recognised.	483	object/class are recognised.
189		484
190	=back	485	=back
191		486
192	=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:
193		489
194	Attach handlers for a specific object type (e.g. TRANSPORT) and	490	cf::object::attachment sockpuppet =>
195	subtype. If C<$subtype> is zero or undef, matches all objects of the given	491	on_skill_attack => sub {
196	type.	492	my ($self, $victim) = @_;
197		493	...
198	=item cf::attach_to_objects ...
199
200	Attach handlers to all objects. Do not use this except for debugging or
201	very rare events, as handlers are (obviously) called for I<all> objects in
202	the game.
203
204	=item cf::attach_to_players ...
205
206	Attach handlers to all players.
207
208	=item cf::attach_to_maps ...
209
210	Attach handlers to all maps.
211
212	=item cf:register_attachment $name, ...
213
214	Register an attachment by name through which objects can refer to this
215	attachment.
216
217	=item cf:register_player_attachment $name, ...
218
219	Register an attachment by name through which players can refer to this
220	attachment.
221
222	=item cf:register_map_attachment $name, ...
223
224	Register an attachment by name through which maps can refer to this
225	attachment.
226
227	=cut
228
229	# the following variables are defined in .xs and must not be re-created
230	our @CB_GLOBAL = (); # registry for all global events
231	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232	our @CB_PLAYER = ();
233	our @CB_TYPE = (); # registry for type (cf-object class) based events
234	our @CB_MAP = ();
235
236	my %attachment;
237
238	sub _attach_cb($\%$$$) {
239	my ($registry, $undo, $event, $prio, $cb) = @_;
240
241	use sort 'stable';
242
243	$cb = [$prio, $cb];
244
245	@{$registry->[$event]} = sort
246	{ $a->[0] cmp $b->[0] }
247	@{$registry->[$event] \|\| []}, $cb;
248
249	push @{$undo->{cb}}, [$event, $cb];
250	}
251
252	# attach handles attaching event callbacks
253	# the only thing the caller has to do is pass the correct
254	# registry (== where the callback attaches to).
255	sub _attach(\@$@) {
256	my ($registry, $klass, @arg) = @_;
257
258	my $prio = 0;
259
260	my %undo = (
261	registry => $registry,
262	cb => [],
263	);
264
265	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267	while (@arg) {
268	my $type = shift @arg;
269
270	if ($type eq "prio") {
271	$prio = shift @arg;
272
273	} elsif ($type eq "package") {
274	my $pkg = shift @arg;
275
276	while (my ($name, $id) = each %cb_id) {
277	if (my $cb = $pkg->can ($name)) {
278	_attach_cb $registry, %undo, $id, $prio, $cb;
279	}
280	}	494	}
281
282	} elsif (exists $cb_id{$type}) {
283	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285	} elsif (ref $type) {
286	warn "attaching objects not supported, ignoring.\n";
287
288	} else {
289	shift @arg;
290	warn "attach argument '$type' not supported, ignoring.\n";
291	}
292	}
293
294	\%undo
295	}
296
297	sub _attach_attachment {
298	my ($obj, $name, %arg) = @_;
299
300	return if exists $obj->{_attachment}{$name};
301
302	my $res;
303
304	if (my $attach = $attachment{$name}) {
305	my $registry = $obj->registry;
306
307	for (@$attach) {
308	my ($klass, @attach) = @$_;
309	$res = _attach @$registry, $klass, @attach;
310	}
311
312	$obj->{$name} = \%arg;
313	} else {
314	warn "object uses attachment '$name' that is not available, postponing.\n";
315	}
316
317	$obj->{_attachment}{$name} = undef;
318
319	$res->{attachment} = $name;
320	$res
321	}
322
323	*cf::object::attach =
324	*cf::player::attach =
325	*cf::map::attach = sub {
326	my ($obj, $name, %arg) = @_;
327
328	_attach_attachment $obj, $name, %arg;
329	};
330
331	# all those should be optimised
332	*cf::object::detach =
333	*cf::player::detach =
334	*cf::map::detach = sub {
335	my ($obj, $name) = @_;
336
337	delete $obj->{_attachment}{$name};
338	reattach ($obj);
339	};
340
341	*cf::object::attached =
342	*cf::player::attached =
343	*cf::map::attached = sub {
344	my ($obj, $name) = @_;
345
346	exists $obj->{_attachment}{$name}
347	};
348
349	sub attach_global {
350	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
351	}
352
353	sub attach_to_type {
354	my $type = shift;
355	my $subtype = shift;
356
357	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358	}
359
360	sub attach_to_objects {
361	_attach @CB_OBJECT, KLASS_OBJECT, @_
362	}
363
364	sub attach_to_players {
365	_attach @CB_PLAYER, KLASS_PLAYER, @_
366	}
367
368	sub attach_to_maps {
369	_attach @CB_MAP, KLASS_MAP, @_
370	}
371
372	sub register_attachment {
373	my $name = shift;
374
375	$attachment{$name} = [[KLASS_OBJECT, @_]];
376	}
377
378	sub register_player_attachment {
379	my $name = shift;
380
381	$attachment{$name} = [[KLASS_PLAYER, @_]];
382	}
383
384	sub register_map_attachment {
385	my $name = shift;
386
387	$attachment{$name} = [[KLASS_MAP, @_]];
388	}
389
390	our $override;
391	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393	sub override {
394	$override = 1;
395	@invoke_results = ();
396	}
397
398	sub do_invoke {
399	my $event = shift;
400	my $callbacks = shift;
401
402	@invoke_results = ();
403
404	local $override;
405
406	for (@$callbacks) {
407	eval { &{$_->[1]} };
408
409	if ($@) {
410	warn "$@";
411	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412	override;
413	}
414
415	return 1 if $override;
416	}
417
418	0	495	}
419	}
420		496
421	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	497	=item $attachable->valid
422
423	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429	Generate a global/object/player/map-specific event with the given arguments.
430
431	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432	removed in future versions), and there is no public API to access override
433	results (if you must, access C<@cf::invoke_results> directly).
434
435	=back
436
437	=cut
438
439	#############################################################################
440
441	=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443	=over 4
444
445	=item $object->valid, $player->valid, $map->valid
446		498
447	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
448	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
449	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
450	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
451	exception.	503	exception.
452		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
453	=back	688	=back
454		689
455	=cut	690	=cut
456
457	*cf::object::valid =
458	*cf::player::valid =
459	*cf::map::valid = \&cf::_valid;
460		691
461	#############################################################################	692	#############################################################################
462	# object support	693	# object support
463		694
464	sub instantiate {
465	my ($obj, $data) = @_;
466
467	$data = from_json $data;
468
469	for (@$data) {
470	my ($name, $args) = @$_;
471
472	$obj->attach ($name, %{$args \|\| {} });
473	}
474	}
475
476	# basically do the same as instantiate, without calling instantiate
477	sub reattach {	695	sub reattach {
		696	# basically do the same as instantiate, without calling instantiate
478	my ($obj) = @_;	697	my ($obj) = @_;
		698
479	my $registry = $obj->registry;	699	my $registry = $obj->registry;
480		700
481	@$registry = ();	701	@$registry = ();
482		702
483	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	703	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
484		704
485	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	705	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
486	if (my $attach = $attachment{$name}) {	706	if (my $attach = $attachment{$name}) {
487	for (@$attach) {	707	for (@$attach) {
488	my ($klass, @attach) = @$_;	708	my ($klass, @attach) = @$_;
489	_attach @$registry, $klass, @attach;	709	_attach $registry, $klass, @attach;
490	}	710	}
491	} else {	711	} else {
492	warn "object uses attachment '$name' that is not available, postponing.\n";	712	warn "object uses attachment '$name' that is not available, postponing.\n";
493	}	713	}
494	}	714	}
495	}	715	}
496		716
497	sub object_freezer_save {	717	cf::attachable->attach (
498	my ($filename, $rdata, $objs) = @_;
499
500	if (length $$rdata) {
501	warn sprintf "saving %s (%d,%d)\n",
502	$filename, length $$rdata, scalar @$objs;
503
504	if (open my $fh, ">:raw", "$filename~") {
505	chmod SAVE_MODE, $fh;
506	syswrite $fh, $$rdata;
507	close $fh;
508
509	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510	chmod SAVE_MODE, $fh;
511	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
512	close $fh;
513	rename "$filename.pst~", "$filename.pst";
514	} else {
515	unlink "$filename.pst";
516	}
517
518	rename "$filename~", $filename;
519	} else {
520	warn "FATAL: $filename~: $!\n";
521	}
522	} else {
523	unlink $filename;
524	unlink "$filename.pst";
525	}
526	}
527
528	sub object_freezer_as_string {
529	my ($rdata, $objs) = @_;
530
531	use Data::Dumper;
532
533	$$rdata . Dumper $objs
534	}
535
536	sub object_thawer_load {
537	my ($filename) = @_;
538
539	local $/;
540
541	my $av;
542
543	#TODO: use sysread etc.
544	if (open my $data, "<:raw:perlio", $filename) {
545	$data = <$data>;
546	if (open my $pst, "<:raw:perlio", "$filename.pst") {
547	$av = eval { (Storable::thaw <$pst>)->{objs} };
548	}
549	return ($data, $av);
550	}
551
552	()
553	}
554
555	attach_to_objects
556	prio => -1000000,	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,
557	on_clone => sub {	731	on_clone => sub {
558	my ($src, $dst) = @_;	732	my ($src, $dst) = @_;
559		733
560	@{$dst->registry} = @{$src->registry};	734	@{$dst->registry} = @{$src->registry};
561		735
562	%$dst = %$src;	736	%$dst = %$src;
563		737
564	%{$dst->{_attachment}} = %{$src->{_attachment}}	738	%{$dst->{_attachment}} = %{$src->{_attachment}}
565	if exists $src->{_attachment};	739	if exists $src->{_attachment};
566	},	740	},
567	;	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	}
568		805
569	#############################################################################	806	#############################################################################
570	# old plug-in events	807	# command handling &c
571		808
572	sub inject_event {	809	=item cf::register_command $name => \&callback($ob,$args);
573	my $extension = shift;
574	my $event_code = shift;
575		810
576	my $cb = $hook[$event_code]{$extension}	811	Register a callback for execution when the client sends the user command
577	or return;	812	$name.
578		813
579	&$cb	814	=cut
580	}
581
582	sub inject_global_event {
583	my $event = shift;
584
585	my $cb = $hook[$event]
586	or return;
587
588	List::Util::max map &$_, values %$cb
589	}
590
591	sub inject_command {
592	my ($name, $obj, $params) = @_;
593
594	for my $cmd (@{ $command{$name} }) {
595	$cmd->[1]->($obj, $params);
596	}
597
598	-1
599	}
600		815
601	sub register_command {	816	sub register_command {
602	my ($name, $time, $cb) = @_;	817	my ($name, $cb) = @_;
603		818
604	my $caller = caller;	819	my $caller = caller;
605	#warn "registering command '$name/$time' to '$caller'";	820	#warn "registering command '$name/$time' to '$caller'";
606		821
607	push @{ $command{$name} }, [$time, $cb, $caller];	822	push @{ $COMMAND{$name} }, [$caller, $cb];
608	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
609	}	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
610		833
611	sub register_extcmd {	834	sub register_extcmd {
612	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
613		836
614	my $caller = caller;	837	my $caller = caller;
615	#warn "registering extcmd '$name' to '$caller'";	838	#warn "registering extcmd '$name' to '$caller'";
616		839
617	$extcmd{$name} = [$cb, $caller];	840	$EXTCMD{$name} = [$cb, $caller];
618	}	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	);
619		874
620	sub register {	875	sub register {
621	my ($base, $pkg) = @_;	876	my ($base, $pkg) = @_;
622		877
623	#TODO	878	#TODO
…		…
642	. "#line 1 \"$path\"\n{\n"	897	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	898	. (do { local $/; <$fh> })
644	. "\n};\n1";	899	. "\n};\n1";
645		900
646	eval $source	901	eval $source
647	or die "$path: $@";	902	or die $@ ? "$path: $@\n"
		903	: "extension disabled.\n";
648		904
649	push @exts, $pkg;	905	push @exts, $pkg;
650	$ext_pkg{$base} = $pkg;	906	$ext_pkg{$base} = $pkg;
651		907
652	# no strict 'refs';	908	# no strict 'refs';
…		…
665	# for my $idx (0 .. $#PLUGIN_EVENT) {	921	# for my $idx (0 .. $#PLUGIN_EVENT) {
666	# delete $hook[$idx]{$pkg};	922	# delete $hook[$idx]{$pkg};
667	# }	923	# }
668		924
669	# remove commands	925	# remove commands
670	for my $name (keys %command) {	926	for my $name (keys %COMMAND) {
671	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	927	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
672		928
673	if (@cb) {	929	if (@cb) {
674	$command{$name} = \@cb;	930	$COMMAND{$name} = \@cb;
675	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
676	} else {	931	} else {
677	delete $command{$name};
678	delete $COMMAND{"$name\000"};	932	delete $COMMAND{$name};
679	}	933	}
680	}	934	}
681		935
682	# remove extcmds	936	# remove extcmds
683	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	937	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
684	delete $extcmd{$name};	938	delete $EXTCMD{$name};
685	}	939	}
686		940
687	if (my $cb = $pkg->can ("unload")) {	941	if (my $cb = $pkg->can ("unload")) {
688	eval {	942	eval {
689	$cb->($pkg);	943	$cb->($pkg);
…		…
693		947
694	Symbol::delete_package $pkg;	948	Symbol::delete_package $pkg;
695	}	949	}
696		950
697	sub load_extensions {	951	sub load_extensions {
698	my $LIBDIR = maps_directory "perl";
699
700	for my $ext (<$LIBDIR/*.ext>) {	952	for my $ext (<$LIBDIR/*.ext>) {
701	next unless -r $ext;	953	next unless -r $ext;
702	eval {	954	eval {
703	load_extension $ext;	955	load_extension $ext;
704	1	956	1
705	} or warn "$ext not loaded: $@";	957	} or warn "$ext not loaded: $@";
706	}	958	}
707	}	959	}
708		960
709	#############################################################################	961	#############################################################################
710	# extcmd framework, basically convert ext <msg>
711	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
712
713	attach_to_players
714	on_extcmd => sub {
715	my ($pl, $buf) = @_;
716
717	my $msg = eval { from_json $buf };
718
719	if (ref $msg) {
720	if (my $cb = $extcmd{$msg->{msgtype}}) {
721	if (my %reply = $cb->[0]->($pl, $msg)) {
722	$pl->ext_reply ($msg->{msgid}, %reply);
723	}
724	}
725	} else {
726	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
727	}
728
729	cf::override;
730	},
731	;
732
733	#############################################################################
734	# load/save/clean perl data associated with a map	962	# load/save/clean perl data associated with a map
735		963
736	*cf::mapsupport::on_clean = sub {	964	*cf::mapsupport::on_clean = sub {
737	my ($map) = @_;	965	my ($map) = @_;
738		966
…		…
740	defined $path or return;	968	defined $path or return;
741		969
742	unlink "$path.pst";	970	unlink "$path.pst";
743	};	971	};
744		972
745	attach_to_maps prio => -10000, package => cf::mapsupport::;	973	cf::map->attach (prio => -10000, package => cf::mapsupport::);
746		974
747	#############################################################################	975	#############################################################################
748	# load/save perl data associated with player->ob objects	976	# load/save perl data associated with player->ob objects
749		977
750	sub all_objects(@) {	978	sub all_objects(@) {
751	@_, map all_objects ($_->inv), @_	979	@_, map all_objects ($_->inv), @_
752	}	980	}
753		981
754	# TODO: compatibility cruft, remove when no longer needed	982	# TODO: compatibility cruft, remove when no longer needed
755	attach_to_players	983	cf::player->attach (
756	on_load => sub {	984	on_load => sub {
757	my ($pl, $path) = @_;	985	my ($pl, $path) = @_;
758		986
759	for my $o (all_objects $pl->ob) {	987	for my $o (all_objects $pl->ob) {
760	if (my $value = $o->get_ob_key_value ("_perl_data")) {	988	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
762		990
763	%$o = %{ Storable::thaw pack "H*", $value };	991	%$o = %{ Storable::thaw pack "H*", $value };
764	}	992	}
765	}	993	}
766	},	994	},
767	;	995	);
768		996
769	#############################################################################	997	#############################################################################
770		998
771	=head2 CORE EXTENSIONS	999	=head2 CORE EXTENSIONS
772		1000
773	Functions and methods that extend core crossfire objects.	1001	Functions and methods that extend core crossfire objects.
		1002
		1003	=head3 cf::player
774		1004
775	=over 4	1005	=over 4
776		1006
777	=item cf::player::exists $login	1007	=item cf::player::exists $login
778		1008
…		…
783	sub cf::player::exists($) {	1013	sub cf::player::exists($) {
784	cf::player::find $_[0]	1014	cf::player::find $_[0]
785	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;
786	}	1016	}
787		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
788	=item $player_object->reply ($npc, $msg[, $flags])	1038	=item $player_object->reply ($npc, $msg[, $flags])
789		1039
790	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>
791	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
792	dialogue with the given NPC character.	1042	dialogue with the given NPC character.
793		1043
794	=cut	1044	=cut
795		1045
796	# rough implementation of a future "reply" method that works	1046	# rough implementation of a future "reply" method that works
797	# with dialog boxes.	1047	# with dialog boxes.
		1048	#TODO: the first argument must go, split into a $npc->reply_to ( method
798	sub cf::object::player::reply($$$;$) {	1049	sub cf::object::player::reply($$$;$) {
799	my ($self, $npc, $msg, $flags) = @_;	1050	my ($self, $npc, $msg, $flags) = @_;
800		1051
801	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	1052	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
802		1053
…		…
806	$msg = $npc->name . " says: $msg" if $npc;	1057	$msg = $npc->name . " says: $msg" if $npc;
807	$self->message ($msg, $flags);	1058	$self->message ($msg, $flags);
808	}	1059	}
809	}	1060	}
810		1061
811	=item $player->ext_reply ($msgid, $msgtype, %msg)
812
813	Sends an ext reply to the player.
814
815	=cut
816
817	sub cf::player::ext_reply($$$%) {
818	my ($self, $id, %msg) = @_;
819
820	$msg{msgid} = $id;
821
822	$self->send ("ext " . to_json \%msg);
823	}
824
825	=item $player_object->may ("access")	1062	=item $player_object->may ("access")
826		1063
827	Returns wether the given player is authorized to access resource "access"	1064	Returns wether the given player is authorized to access resource "access"
828	(e.g. "command_wizcast").	1065	(e.g. "command_wizcast").
829		1066
…		…
836	(ref $cf::CFG{"may_$access"}	1073	(ref $cf::CFG{"may_$access"}
837	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1074	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
838	: $cf::CFG{"may_$access"})	1075	: $cf::CFG{"may_$access"})
839	}	1076	}
840		1077
841	=cut	1078	=head3 cf::client
842		1079
843	#############################################################################	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 {
		1155	my ($self, $cb) = @_;
		1156
		1157	my $coro; $coro = async {
		1158	eval {
		1159	$cb->();
		1160	};
		1161	warn $@ if $@;
		1162	};
		1163
		1164	$coro->on_destroy (sub {
		1165	delete $self->{_coro}{$coro+0};
		1166	});
		1167
		1168	$self->{_coro}{$coro+0} = $coro;
		1169
		1170	$coro
		1171	}
		1172
		1173	cf::client->attach (
		1174	on_destroy => sub {
		1175	my ($ns) = @_;
		1176
		1177	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		1178	},
		1179	);
		1180
		1181	=back
		1182
844		1183
845	=head2 SAFE SCRIPTING	1184	=head2 SAFE SCRIPTING
846		1185
847	Functions that provide a safe environment to compile and execute	1186	Functions that provide a safe environment to compile and execute
848	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
…		…
863		1202
864	=pod	1203	=pod
865		1204
866	The following fucntions and emthods are available within a safe environment:	1205	The following fucntions and emthods are available within a safe environment:
867		1206
868	cf::object contr pay_amount pay_player	1207	cf::object contr pay_amount pay_player map
869	cf::object::player player	1208	cf::object::player player
870	cf::player peaceful	1209	cf::player peaceful
		1210	cf::map trigger
871		1211
872	=cut	1212	=cut
873		1213
874	for (	1214	for (
875	["cf::object" => qw(contr pay_amount pay_player)],	1215	["cf::object" => qw(contr pay_amount pay_player map)],
876	["cf::object::player" => qw(player)],	1216	["cf::object::player" => qw(player)],
877	["cf::player" => qw(peaceful)],	1217	["cf::player" => qw(peaceful)],
		1218	["cf::map" => qw(trigger)],
878	) {	1219	) {
879	no strict 'refs';	1220	no strict 'refs';
880	my ($pkg, @funs) = @$_;	1221	my ($pkg, @funs) = @$_;
881	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1222	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
882	for @funs;	1223	for @funs;
…		…
1022	sub db_sync() {	1363	sub db_sync() {
1023	db_save if $dirty;	1364	db_save if $dirty;
1024	undef $dirty;	1365	undef $dirty;
1025	}	1366	}
1026		1367
1027	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 {
1028	db_sync;	1369	db_sync;
1029	});	1370	});
1030		1371
1031	sub db_dirty() {	1372	sub db_dirty() {
1032	$dirty = 1;	1373	$dirty = 1;
…		…
1046	$DB->{$_[0]} = $_[1];	1387	$DB->{$_[0]} = $_[1];
1047	}	1388	}
1048	db_dirty;	1389	db_dirty;
1049	}	1390	}
1050		1391
1051	attach_global	1392	cf::global->attach (
1052	prio => 10000,	1393	prio => 10000,
1053	on_cleanup => sub {	1394	on_cleanup => sub {
1054	db_sync;	1395	db_sync;
1055	},	1396	},
1056	;	1397	);
1057	}	1398	}
1058		1399
1059	#############################################################################	1400	#############################################################################
1060	# the server's main()	1401	# the server's main()
1061		1402
…		…
1066	local $/;	1407	local $/;
1067	*CFG = YAML::Syck::Load <$fh>;	1408	*CFG = YAML::Syck::Load <$fh>;
1068	}	1409	}
1069		1410
1070	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
1071	cfg_load;	1420	cfg_load;
1072	db_load;	1421	db_load;
1073	load_extensions;	1422	load_extensions;
1074	Event::loop;	1423	Event::loop;
1075	}	1424	}
1076		1425
1077	#############################################################################	1426	#############################################################################
1078	# initialisation	1427	# initialisation
1079		1428
1080	sub _perl_reload(&) {	1429	sub perl_reload() {
1081	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	}
1082		1435
1083	$msg->("reloading...");	1436	warn "reloading...";
		1437
		1438	local $FREEZE = 1;
		1439	cf::emergency_save;
1084		1440
1085	eval {	1441	eval {
		1442	# if anything goes wrong in here, we should simply crash as we already saved
		1443
1086	# cancel all watchers	1444	# cancel all watchers
1087	$_->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 = ();
1088		1452
1089	# unload all extensions	1453	# unload all extensions
1090	for (@exts) {	1454	for (@exts) {
1091	$msg->("unloading <$_>");	1455	warn "unloading <$_>";
1092	unload_extension $_;	1456	unload_extension $_;
1093	}	1457	}
1094		1458
1095	# unload all modules loaded from $LIBDIR	1459	# unload all modules loaded from $LIBDIR
1096	while (my ($k, $v) = each %INC) {	1460	while (my ($k, $v) = each %INC) {
1097	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1461	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1098		1462
1099	$msg->("removing <$k>");	1463	warn "removing <$k>";
1100	delete $INC{$k};	1464	delete $INC{$k};
1101		1465
1102	$k =~ s/\.pm$//;	1466	$k =~ s/\.pm$//;
1103	$k =~ s/\//::/g;	1467	$k =~ s/\//::/g;
1104		1468
…		…
1109	Symbol::delete_package $k;	1473	Symbol::delete_package $k;
1110	}	1474	}
1111		1475
1112	# sync database to disk	1476	# sync database to disk
1113	cf::db_sync;	1477	cf::db_sync;
		1478	IO::AIO::flush;
1114		1479
1115	# get rid of safe::, as good as possible	1480	# get rid of safe::, as good as possible
1116	Symbol::delete_package "safe::$_"	1481	Symbol::delete_package "safe::$_"
1117	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);
1118		1483
1119	# remove register_script_function callbacks	1484	# remove register_script_function callbacks
1120	# TODO	1485	# TODO
1121		1486
1122	# unload cf.pm "a bit"	1487	# unload cf.pm "a bit"
…		…
1125	# don't, removes xs symbols, too,	1490	# don't, removes xs symbols, too,
1126	# and global variables created in xs	1491	# and global variables created in xs
1127	#Symbol::delete_package __PACKAGE__;	1492	#Symbol::delete_package __PACKAGE__;
1128		1493
1129	# reload cf.pm	1494	# reload cf.pm
1130	$msg->("reloading cf.pm");	1495	warn "reloading cf.pm";
1131	require cf;	1496	require cf;
		1497	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1132		1498
1133	# load config and database again	1499	# load config and database again
1134	cf::cfg_load;	1500	cf::cfg_load;
1135	cf::db_load;	1501	cf::db_load;
1136		1502
1137	# load extensions	1503	# load extensions
1138	$msg->("load extensions");	1504	warn "load extensions";
1139	cf::load_extensions;	1505	cf::load_extensions;
1140		1506
1141	# reattach attachments to objects	1507	# reattach attachments to objects
1142	$msg->("reattach");	1508	warn "reattach";
1143	_global_reattach;	1509	_global_reattach;
1144	};	1510	};
1145	$msg->($@) if $@;
1146		1511
1147	$msg->("reloaded");	1512	if ($@) {
		1513	warn $@;
		1514	warn "error while reloading, exiting.";
		1515	exit 1;
		1516	}
		1517
		1518	warn "reloaded successfully";
1148	};	1519	};
1149		1520
1150	sub perl_reload() {	1521	#############################################################################
1151	_perl_reload {
1152	warn $_[0];
1153	print "$_[0]\n";
1154	};
1155	}
1156		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
1157	register_command "perl-reload", 0, sub {	1536	register_command "perl-reload" => sub {
1158	my ($who, $arg) = @_;	1537	my ($who, $arg) = @_;
1159		1538
1160	if ($who->flag (FLAG_WIZ)) {	1539	if ($who->flag (FLAG_WIZ)) {
		1540	$who->message ("start of reload.");
1161	_perl_reload {	1541	perl_reload;
1162	warn $_[0];	1542	$who->message ("end of reload.");
1163	$who->message ($_[0]);
1164	};
1165	}	1543	}
1166	};	1544	};
1167		1545
1168	register "<global>", __PACKAGE__;
1169
1170	unshift @INC, $LIBDIR;	1546	unshift @INC, $LIBDIR;
1171		1547
1172	$TICK_WATCHER = Event->timer (	1548	$TICK_WATCHER = Event->timer (
		1549	reentrant => 0,
1173	prio => 1,	1550	prio => 0,
1174	async => 1,
1175	at => $NEXT_TICK \|\| 1,	1551	at => $NEXT_TICK \|\| $TICK,
		1552	data => WF_AUTOCANCEL,
1176	cb => sub {	1553	cb => sub {
		1554	unless ($FREEZE) {
1177	cf::server_tick; # one server iteration	1555	cf::server_tick; # one server iteration
		1556	$RUNTIME += $TICK;
		1557	}
1178		1558
1179	my $NOW = Event::time;
1180	$NEXT_TICK += $TICK;	1559	$NEXT_TICK += $TICK;
1181		1560
1182	# if we are delayed by four ticks or more, skip them all	1561	# if we are delayed by four ticks or more, skip them all
1183	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1562	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1184		1563
1185	$TICK_WATCHER->at ($NEXT_TICK);	1564	$TICK_WATCHER->at ($NEXT_TICK);
1186	$TICK_WATCHER->start;	1565	$TICK_WATCHER->start;
1187	},	1566	},
1188	);	1567	);
1189		1568
1190	IO::AIO::max_poll_time $TICK * 0.2;	1569	IO::AIO::max_poll_time $TICK * 0.2;
1191		1570
		1571	Event->io (
1192	Event->io (fd => IO::AIO::poll_fileno,	1572	fd => IO::AIO::poll_fileno,
1193	poll => 'r',	1573	poll => 'r',
1194	prio => 5,	1574	prio => 5,
		1575	data => WF_AUTOCANCEL,
1195	cb => \&IO::AIO::poll_cb);	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	);
1196		1590
1197	1	1591	1
1198		1592

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.81 by root, Tue Nov 7 17:38:22 2006 UTC vs. Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.81 by root, Tue Nov 7 17:38:22 2006 UTC vs.
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC