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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43:23 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;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18
10	use IO::AIO ();	19	use IO::AIO 2.3;
11	use YAML::Syck ();	20	use YAML::Syck ();
12	use Time::HiRes;	21	use Time::HiRes;
13	use Event;	22
14	$Event::Eval = 1; # no idea why this is required, but it is	23	use Event; $Event::Eval = 1; # no idea why this is required, but it is
15		24
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	25	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	26	$YAML::Syck::ImplicitUnicode = 1;
18		27
19	use strict;	28	$Coro::main->prio (Coro::PRIO_MIN);
20		29
21	_init_vars;	30	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		31
23	our %COMMAND = ();	32	our %COMMAND = ();
		33	our %COMMAND_TIME = ();
		34	our %EXTCMD = ();
		35
24	our @EVENT;	36	our @EVENT;
25	our $LIBDIR = maps_directory "perl";	37	our $LIBDIR = datadir . "/ext";
26		38
27	our $TICK = MAX_TIME * 1e-6;	39	our $TICK = MAX_TIME * 1e-6;
28	our $TICK_WATCHER;	40	our $TICK_WATCHER;
29	our $NEXT_TICK;	41	our $NEXT_TICK;
30		42
69	print STDERR "cfperl: $msg";	81	print STDERR "cfperl: $msg";
70	LOG llevError, "cfperl: $msg";	82	LOG llevError, "cfperl: $msg";
71	};	83	};
72	}	84	}
73		85
		86	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		87	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		88	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		89	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		90	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
74	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	91	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
75		92
76	# we bless all objects into (empty) derived classes to force a method lookup	93	# we bless all objects into (empty) derived classes to force a method lookup
77	# within the Safe compartment.	94	# within the Safe compartment.
78	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	95	for my $pkg (qw(
		96	cf::global cf::attachable
		97	cf::object cf::object::player
		98	cf::client cf::player
		99	cf::arch cf::living
		100	cf::map cf::party cf::region
		101	)) {
79	no strict 'refs';	102	no strict 'refs';
80	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	103	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
81	}	104	}
82		105
83	$Event::DIED = sub {	106	$Event::DIED = sub {
…		…
85	};	108	};
86		109
87	my %ext_pkg;	110	my %ext_pkg;
88	my @exts;	111	my @exts;
89	my @hook;	112	my @hook;
90	my %command;
91	my %extcmd;
92		113
93	=head2 UTILITY FUNCTIONS	114	=head2 UTILITY FUNCTIONS
94		115
95	=over 4	116	=over 4
96		117
…		…
124		145
125	=cut	146	=cut
126		147
127	#############################################################################	148	#############################################################################
128		149
129	=head2 EVENTS AND OBJECT ATTACHMENTS	150	=head2 ATTACHABLE OBJECTS
		151
		152	Many objects in crossfire are so-called attachable objects. That means you can
		153	attach callbacks/event handlers (a collection of which is called an "attachment")
		154	to it. All such attachable objects support the following methods.
		155
		156	In the following description, CLASS can be any of C<global>, C<object>
		157	C<player>, C<client> or C<map> (i.e. the attachable objects in
		158	crossfire+).
130		159
131	=over 4	160	=over 4
132		161
133	=item $object->attach ($attachment, key => $value...)
134
135	=item $object->detach ($attachment)
136
137	Attach/detach a pre-registered attachment to an object.
138
139	=item $player->attach ($attachment, key => $value...)
140
141	=item $player->detach ($attachment)
142
143	Attach/detach a pre-registered attachment to a player.
144
145	=item $map->attach ($attachment, key => $value...)	162	=item $attachable->attach ($attachment, key => $value...)
146		163
147	=item $map->detach ($attachment)	164	=item $attachable->detach ($attachment)
148		165
149	Attach/detach a pre-registered attachment to a map.	166	Attach/detach a pre-registered attachment to a specific object and give it
		167	the specified key/value pairs as arguments.
150		168
151	=item $bool = $object->attached ($name)	169	Example, attach a minesweeper attachment to the given object, making it a
		170	10x10 minesweeper game:
152		171
153	=item $bool = $player->attached ($name)	172	$obj->attach (minesweeper => width => 10, height => 10);
154		173
155	=item $bool = $map->attached ($name)	174	=item $bool = $attachable->attached ($name)
156		175
157	Checks wether the named attachment is currently attached to the object.	176	Checks wether the named attachment is currently attached to the object.
158		177
159	=item cf::attach_global ...	178	=item cf::CLASS->attach ...
160		179
161	Attach handlers for global events.	180	=item cf::CLASS->detach ...
162		181
163	This and all following C<attach_*>-functions expect any number of the	182	Define an anonymous attachment and attach it to all objects of the given
164	following handler/hook descriptions:	183	CLASS. See the next function for an explanation of its arguments.
		184
		185	You can attach to global events by using the C<cf::global> class.
		186
		187	Example, log all player logins:
		188
		189	cf::player->attach (
		190	on_login => sub {
		191	my ($pl) = @_;
		192	...
		193	},
		194	);
		195
		196	Example, attach to the jeweler skill:
		197
		198	cf::object->attach (
		199	type => cf::SKILL,
		200	subtype => cf::SK_JEWELER,
		201	on_use_skill => sub {
		202	my ($sk, $ob, $part, $dir, $msg) = @_;
		203	...
		204	},
		205	);
		206
		207	=item cf::CLASS::attachment $name, ...
		208
		209	Register an attachment by C<$name> through which attachable objects of the
		210	given CLASS can refer to this attachment.
		211
		212	Some classes such as crossfire maps and objects can specify attachments
		213	that are attached at load/instantiate time, thus the need for a name.
		214
		215	These calls expect any number of the following handler/hook descriptions:
165		216
166	=over 4	217	=over 4
167		218
168	=item prio => $number	219	=item prio => $number
169		220
…		…
171	by another C<prio> setting). Lower priority handlers get executed	222	by another C<prio> setting). Lower priority handlers get executed
172	earlier. The default priority is C<0>, and many built-in handlers are	223	earlier. The default priority is C<0>, and many built-in handlers are
173	registered at priority C<-1000>, so lower priorities should not be used	224	registered at priority C<-1000>, so lower priorities should not be used
174	unless you know what you are doing.	225	unless you know what you are doing.
175		226
		227	=item type => $type
		228
		229	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		230	given type of objects only (the additional parameter C<subtype> can be
		231	used to further limit to the given subtype).
		232
176	=item on_I<event> => \&cb	233	=item on_I<event> => \&cb
177		234
178	Call the given code reference whenever the named event happens (event is	235	Call the given code reference whenever the named event happens (event is
179	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	236	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
180	handlers are recognised generally depends on the type of object these	237	handlers are recognised generally depends on the type of object these
…		…
189	package and register them. Only handlers for eevents supported by the	246	package and register them. Only handlers for eevents supported by the
190	object/class are recognised.	247	object/class are recognised.
191		248
192	=back	249	=back
193		250
194	=item cf::attach_to_type $object_type, $subtype, ...	251	Example, define an attachment called "sockpuppet" that calls the given
		252	event handler when a monster attacks:
195		253
196	Attach handlers for a specific object type (e.g. TRANSPORT) and	254	cf::object::attachment sockpuppet =>
197	subtype. If C<$subtype> is zero or undef, matches all objects of the given	255	on_skill_attack => sub {
198	type.	256	my ($self, $victim) = @_;
199		257	...
200	=item cf::attach_to_objects ...
201
202	Attach handlers to all objects. Do not use this except for debugging or
203	very rare events, as handlers are (obviously) called for I<all> objects in
204	the game.
205
206	=item cf::attach_to_players ...
207
208	Attach handlers to all players.
209
210	=item cf::attach_to_maps ...
211
212	Attach handlers to all maps.
213
214	=item cf:register_attachment $name, ...
215
216	Register an attachment by name through which objects can refer to this
217	attachment.
218
219	=item cf:register_player_attachment $name, ...
220
221	Register an attachment by name through which players can refer to this
222	attachment.
223
224	=item cf:register_map_attachment $name, ...
225
226	Register an attachment by name through which maps can refer to this
227	attachment.
228
229	=cut
230
231	# the following variables are defined in .xs and must not be re-created
232	our @CB_GLOBAL = (); # registry for all global events
233	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
234	our @CB_PLAYER = ();
235	our @CB_TYPE = (); # registry for type (cf-object class) based events
236	our @CB_MAP = ();
237
238	my %attachment;
239
240	sub _attach_cb($\%$$$) {
241	my ($registry, $undo, $event, $prio, $cb) = @_;
242
243	use sort 'stable';
244
245	$cb = [$prio, $cb];
246
247	@{$registry->[$event]} = sort
248	{ $a->[0] cmp $b->[0] }
249	@{$registry->[$event] \|\| []}, $cb;
250
251	push @{$undo->{cb}}, [$event, $cb];
252	}
253
254	# attach handles attaching event callbacks
255	# the only thing the caller has to do is pass the correct
256	# registry (== where the callback attaches to).
257	sub _attach(\@$@) {
258	my ($registry, $klass, @arg) = @_;
259
260	my $prio = 0;
261
262	my %undo = (
263	registry => $registry,
264	cb => [],
265	);
266
267	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
268
269	while (@arg) {
270	my $type = shift @arg;
271
272	if ($type eq "prio") {
273	$prio = shift @arg;
274
275	} elsif ($type eq "package") {
276	my $pkg = shift @arg;
277
278	while (my ($name, $id) = each %cb_id) {
279	if (my $cb = $pkg->can ($name)) {
280	_attach_cb $registry, %undo, $id, $prio, $cb;
281	}
282	}	258	}
283
284	} elsif (exists $cb_id{$type}) {
285	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
286
287	} elsif (ref $type) {
288	warn "attaching objects not supported, ignoring.\n";
289
290	} else {
291	shift @arg;
292	warn "attach argument '$type' not supported, ignoring.\n";
293	}
294	}
295
296	\%undo
297	}
298
299	sub _attach_attachment {
300	my ($obj, $name, %arg) = @_;
301
302	return if exists $obj->{_attachment}{$name};
303
304	my $res;
305
306	if (my $attach = $attachment{$name}) {
307	my $registry = $obj->registry;
308
309	for (@$attach) {
310	my ($klass, @attach) = @$_;
311	$res = _attach @$registry, $klass, @attach;
312	}
313
314	$obj->{$name} = \%arg;
315	} else {
316	warn "object uses attachment '$name' that is not available, postponing.\n";
317	}
318
319	$obj->{_attachment}{$name} = undef;
320
321	$res->{attachment} = $name;
322	$res
323	}
324
325	*cf::object::attach =
326	*cf::player::attach =
327	*cf::map::attach = sub {
328	my ($obj, $name, %arg) = @_;
329
330	_attach_attachment $obj, $name, %arg;
331	};
332
333	# all those should be optimised
334	*cf::object::detach =
335	*cf::player::detach =
336	*cf::map::detach = sub {
337	my ($obj, $name) = @_;
338
339	delete $obj->{_attachment}{$name};
340	reattach ($obj);
341	};
342
343	*cf::object::attached =
344	*cf::player::attached =
345	*cf::map::attached = sub {
346	my ($obj, $name) = @_;
347
348	exists $obj->{_attachment}{$name}
349	};
350
351	sub attach_global {
352	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
353	}
354
355	sub attach_to_type {
356	my $type = shift;
357	my $subtype = shift;
358
359	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
360	}
361
362	sub attach_to_objects {
363	_attach @CB_OBJECT, KLASS_OBJECT, @_
364	}
365
366	sub attach_to_players {
367	_attach @CB_PLAYER, KLASS_PLAYER, @_
368	}
369
370	sub attach_to_maps {
371	_attach @CB_MAP, KLASS_MAP, @_
372	}
373
374	sub register_attachment {
375	my $name = shift;
376
377	$attachment{$name} = [[KLASS_OBJECT, @_]];
378	}
379
380	sub register_player_attachment {
381	my $name = shift;
382
383	$attachment{$name} = [[KLASS_PLAYER, @_]];
384	}
385
386	sub register_map_attachment {
387	my $name = shift;
388
389	$attachment{$name} = [[KLASS_MAP, @_]];
390	}
391
392	our $override;
393	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
394
395	sub override {
396	$override = 1;
397	@invoke_results = ();
398	}
399
400	sub do_invoke {
401	my $event = shift;
402	my $callbacks = shift;
403
404	@invoke_results = ();
405
406	local $override;
407
408	for (@$callbacks) {
409	eval { &{$_->[1]} };
410
411	if ($@) {
412	warn "$@";
413	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
414	override;
415	}
416
417	return 1 if $override;
418	}
419
420	0	259	}
421	}
422		260
423	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	261	=item $attachable->valid
424
425	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
426
427	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
428
429	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
430
431	Generate a global/object/player/map-specific event with the given arguments.
432
433	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
434	removed in future versions), and there is no public API to access override
435	results (if you must, access C<@cf::invoke_results> directly).
436
437	=back
438
439	=cut
440
441	#############################################################################
442
443	=head2 METHODS VALID FOR ALL CORE OBJECTS
444
445	=over 4
446
447	=item $object->valid, $player->valid, $map->valid
448		262
449	Just because you have a perl object does not mean that the corresponding	263	Just because you have a perl object does not mean that the corresponding
450	C-level object still exists. If you try to access an object that has no	264	C-level object still exists. If you try to access an object that has no
451	valid C counterpart anymore you get an exception at runtime. This method	265	valid C counterpart anymore you get an exception at runtime. This method
452	can be used to test for existence of the C object part without causing an	266	can be used to test for existence of the C object part without causing an
453	exception.	267	exception.
454		268
		269	=cut
		270
		271	# the following variables are defined in .xs and must not be re-created
		272	our @CB_GLOBAL = (); # registry for all global events
		273	our @CB_ATTACHABLE = (); # registry for all attachables
		274	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		275	our @CB_PLAYER = ();
		276	our @CB_CLIENT = ();
		277	our @CB_TYPE = (); # registry for type (cf-object class) based events
		278	our @CB_MAP = ();
		279
		280	my %attachment;
		281
		282	sub _attach_cb($$$$) {
		283	my ($registry, $event, $prio, $cb) = @_;
		284
		285	use sort 'stable';
		286
		287	$cb = [$prio, $cb];
		288
		289	@{$registry->[$event]} = sort
		290	{ $a->[0] cmp $b->[0] }
		291	@{$registry->[$event] \|\| []}, $cb;
		292	}
		293
		294	# hack
		295	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		296
		297	# attach handles attaching event callbacks
		298	# the only thing the caller has to do is pass the correct
		299	# registry (== where the callback attaches to).
		300	sub _attach {
		301	my ($registry, $klass, @arg) = @_;
		302
		303	my $object_type;
		304	my $prio = 0;
		305	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		306
		307	#TODO: get rid of this hack
		308	if ($attachable_klass{$klass}) {
		309	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		310	}
		311
		312	while (@arg) {
		313	my $type = shift @arg;
		314
		315	if ($type eq "prio") {
		316	$prio = shift @arg;
		317
		318	} elsif ($type eq "type") {
		319	$object_type = shift @arg;
		320	$registry = $CB_TYPE[$object_type] \|\|= [];
		321
		322	} elsif ($type eq "subtype") {
		323	defined $object_type or Carp::croak "subtype specified without type";
		324	my $object_subtype = shift @arg;
		325	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] \|\|= [];
		326
		327	} elsif ($type eq "package") {
		328	my $pkg = shift @arg;
		329
		330	while (my ($name, $id) = each %cb_id) {
		331	if (my $cb = $pkg->can ($name)) {
		332	_attach_cb $registry, $id, $prio, $cb;
		333	}
		334	}
		335
		336	} elsif (exists $cb_id{$type}) {
		337	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		338
		339	} elsif (ref $type) {
		340	warn "attaching objects not supported, ignoring.\n";
		341
		342	} else {
		343	shift @arg;
		344	warn "attach argument '$type' not supported, ignoring.\n";
		345	}
		346	}
		347	}
		348
		349	sub _object_attach {
		350	my ($obj, $name, %arg) = @_;
		351
		352	return if exists $obj->{_attachment}{$name};
		353
		354	if (my $attach = $attachment{$name}) {
		355	my $registry = $obj->registry;
		356
		357	for (@$attach) {
		358	my ($klass, @attach) = @$_;
		359	_attach $registry, $klass, @attach;
		360	}
		361
		362	$obj->{$name} = \%arg;
		363	} else {
		364	warn "object uses attachment '$name' that is not available, postponing.\n";
		365	}
		366
		367	$obj->{_attachment}{$name} = undef;
		368	}
		369
		370	sub cf::attachable::attach {
		371	if (ref $_[0]) {
		372	_object_attach @_;
		373	} else {
		374	_attach shift->_attach_registry, @_;
		375	}
		376	};
		377
		378	# all those should be optimised
		379	sub cf::attachable::detach {
		380	my ($obj, $name) = @_;
		381
		382	if (ref $obj) {
		383	delete $obj->{_attachment}{$name};
		384	reattach ($obj);
		385	} else {
		386	Carp::croak "cannot, currently, detach class attachments";
		387	}
		388	};
		389
		390	sub cf::attachable::attached {
		391	my ($obj, $name) = @_;
		392
		393	exists $obj->{_attachment}{$name}
		394	}
		395
		396	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		397	eval "#line " . __LINE__ . " 'cf.pm'
		398	sub cf::\L$klass\E::_attach_registry {
		399	(\\\@CB_$klass, KLASS_$klass)
		400	}
		401
		402	sub cf::\L$klass\E::attachment {
		403	my \$name = shift;
		404
		405	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		406	}
		407	";
		408	die if $@;
		409	}
		410
		411	our $override;
		412	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		413
		414	sub override {
		415	$override = 1;
		416	@invoke_results = ();
		417	}
		418
		419	sub do_invoke {
		420	my $event = shift;
		421	my $callbacks = shift;
		422
		423	@invoke_results = ();
		424
		425	local $override;
		426
		427	for (@$callbacks) {
		428	eval { &{$_->[1]} };
		429
		430	if ($@) {
		431	warn "$@";
		432	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		433	override;
		434	}
		435
		436	return 1 if $override;
		437	}
		438
		439	0
		440	}
		441
		442	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		443
		444	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		445
		446	Generate an object-specific event with the given arguments.
		447
		448	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		449	removed in future versions), and there is no public API to access override
		450	results (if you must, access C<@cf::invoke_results> directly).
		451
455	=back	452	=back
456		453
457	=cut	454	=cut
458
459	*cf::object::valid =
460	*cf::player::valid =
461	*cf::map::valid = \&cf::_valid;
462		455
463	#############################################################################	456	#############################################################################
464	# object support	457	# object support
465		458
466	sub instantiate {	459	cf::attachable->attach (
		460	prio => -1000000,
		461	on_instantiate => sub {
467	my ($obj, $data) = @_;	462	my ($obj, $data) = @_;
468		463
469	$data = from_json $data;	464	$data = from_json $data;
470		465
471	for (@$data) {	466	for (@$data) {
472	my ($name, $args) = @$_;	467	my ($name, $args) = @$_;
473		468
474	$obj->attach ($name, %{$args \|\| {} });	469	$obj->attach ($name, %{$args \|\| {} });
		470	}
475	}	471	},
476	}	472	on_reattach => sub {
477
478	# basically do the same as instantiate, without calling instantiate	473	# basically do the same as instantiate, without calling instantiate
479	sub reattach {
480	my ($obj) = @_;	474	my ($obj) = @_;
481	my $registry = $obj->registry;	475	my $registry = $obj->registry;
482		476
483	@$registry = ();	477	@$registry = ();
484		478
485	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	479	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
486		480
487	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {	481	for my $name (keys %{ $obj->{_attachment} \|\| {} }) {
488	if (my $attach = $attachment{$name}) {	482	if (my $attach = $attachment{$name}) {
489	for (@$attach) {	483	for (@$attach) {
490	my ($klass, @attach) = @$_;	484	my ($klass, @attach) = @$_;
491	_attach @$registry, $klass, @attach;	485	_attach $registry, $klass, @attach;
		486	}
		487	} else {
		488	warn "object uses attachment '$name' that is not available, postponing.\n";
492	}	489	}
493	} else {
494	warn "object uses attachment '$name' that is not available, postponing.\n";
495	}	490	}
496	}	491	},
497	}	492	on_clone => sub {
		493	my ($src, $dst) = @_;
		494
		495	@{$dst->registry} = @{$src->registry};
		496
		497	%$dst = %$src;
		498
		499	%{$dst->{_attachment}} = %{$src->{_attachment}}
		500	if exists $src->{_attachment};
		501	},
		502	);
498		503
499	sub object_freezer_save {	504	sub object_freezer_save {
500	my ($filename, $rdata, $objs) = @_;	505	my ($filename, $rdata, $objs) = @_;
501		506
502	if (length $$rdata) {	507	if (length $$rdata) {
…		…
552	}	557	}
553		558
554	()	559	()
555	}	560	}
556		561
557	attach_to_objects
558	prio => -1000000,
559	on_clone => sub {
560	my ($src, $dst) = @_;
561
562	@{$dst->registry} = @{$src->registry};
563
564	%$dst = %$src;
565
566	%{$dst->{_attachment}} = %{$src->{_attachment}}
567	if exists $src->{_attachment};
568	},
569	;
570
571	#############################################################################	562	#############################################################################
572	# old plug-in events	563	# command handling &c
573		564
574	sub inject_event {	565	=item cf::register_command $name => \&callback($ob,$args);
575	my $extension = shift;
576	my $event_code = shift;
577		566
578	my $cb = $hook[$event_code]{$extension}	567	Register a callback for execution when the client sends the user command
579	or return;	568	$name.
580		569
581	&$cb	570	=cut
582	}
583
584	sub inject_global_event {
585	my $event = shift;
586
587	my $cb = $hook[$event]
588	or return;
589
590	List::Util::max map &$_, values %$cb
591	}
592
593	sub inject_command {
594	my ($name, $obj, $params) = @_;
595
596	for my $cmd (@{ $command{$name} }) {
597	$cmd->[1]->($obj, $params);
598	}
599
600	-1
601	}
602		571
603	sub register_command {	572	sub register_command {
604	my ($name, $time, $cb) = @_;	573	my ($name, $cb) = @_;
605		574
606	my $caller = caller;	575	my $caller = caller;
607	#warn "registering command '$name/$time' to '$caller'";	576	#warn "registering command '$name/$time' to '$caller'";
608		577
609	push @{ $command{$name} }, [$time, $cb, $caller];	578	push @{ $COMMAND{$name} }, [$caller, $cb];
610	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
611	}	579	}
		580
		581	=item cf::register_extcmd $name => \&callback($pl,$packet);
		582
		583	Register a callbackf ro execution when the client sends an extcmd packet.
		584
		585	If the callback returns something, it is sent back as if reply was being
		586	called.
		587
		588	=cut
612		589
613	sub register_extcmd {	590	sub register_extcmd {
614	my ($name, $cb) = @_;	591	my ($name, $cb) = @_;
615		592
616	my $caller = caller;	593	my $caller = caller;
617	#warn "registering extcmd '$name' to '$caller'";	594	#warn "registering extcmd '$name' to '$caller'";
618		595
619	$extcmd{$name} = [$cb, $caller];	596	$EXTCMD{$name} = [$cb, $caller];
620	}	597	}
		598
		599	cf::player->attach (
		600	on_command => sub {
		601	my ($pl, $name, $params) = @_;
		602
		603	my $cb = $COMMAND{$name}
		604	or return;
		605
		606	for my $cmd (@$cb) {
		607	$cmd->[1]->($pl->ob, $params);
		608	}
		609
		610	cf::override;
		611	},
		612	on_extcmd => sub {
		613	my ($pl, $buf) = @_;
		614
		615	my $msg = eval { from_json $buf };
		616
		617	if (ref $msg) {
		618	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		619	if (my %reply = $cb->[0]->($pl, $msg)) {
		620	$pl->ext_reply ($msg->{msgid}, %reply);
		621	}
		622	}
		623	} else {
		624	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		625	}
		626
		627	cf::override;
		628	},
		629	);
621		630
622	sub register {	631	sub register {
623	my ($base, $pkg) = @_;	632	my ($base, $pkg) = @_;
624		633
625	#TODO	634	#TODO
…		…
668	# for my $idx (0 .. $#PLUGIN_EVENT) {	677	# for my $idx (0 .. $#PLUGIN_EVENT) {
669	# delete $hook[$idx]{$pkg};	678	# delete $hook[$idx]{$pkg};
670	# }	679	# }
671		680
672	# remove commands	681	# remove commands
673	for my $name (keys %command) {	682	for my $name (keys %COMMAND) {
674	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	683	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
675		684
676	if (@cb) {	685	if (@cb) {
677	$command{$name} = \@cb;	686	$COMMAND{$name} = \@cb;
678	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
679	} else {	687	} else {
680	delete $command{$name};
681	delete $COMMAND{"$name\000"};	688	delete $COMMAND{$name};
682	}	689	}
683	}	690	}
684		691
685	# remove extcmds	692	# remove extcmds
686	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	693	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
687	delete $extcmd{$name};	694	delete $EXTCMD{$name};
688	}	695	}
689		696
690	if (my $cb = $pkg->can ("unload")) {	697	if (my $cb = $pkg->can ("unload")) {
691	eval {	698	eval {
692	$cb->($pkg);	699	$cb->($pkg);
…		…
696		703
697	Symbol::delete_package $pkg;	704	Symbol::delete_package $pkg;
698	}	705	}
699		706
700	sub load_extensions {	707	sub load_extensions {
701	my $LIBDIR = maps_directory "perl";
702
703	for my $ext (<$LIBDIR/*.ext>) {	708	for my $ext (<$LIBDIR/*.ext>) {
704	next unless -r $ext;	709	next unless -r $ext;
705	eval {	710	eval {
706	load_extension $ext;	711	load_extension $ext;
707	1	712	1
708	} or warn "$ext not loaded: $@";	713	} or warn "$ext not loaded: $@";
709	}	714	}
710	}	715	}
711		716
712	#############################################################################	717	#############################################################################
713	# extcmd framework, basically convert ext <msg>
714	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
715
716	attach_to_players
717	on_extcmd => sub {
718	my ($pl, $buf) = @_;
719
720	my $msg = eval { from_json $buf };
721
722	if (ref $msg) {
723	if (my $cb = $extcmd{$msg->{msgtype}}) {
724	if (my %reply = $cb->[0]->($pl, $msg)) {
725	$pl->ext_reply ($msg->{msgid}, %reply);
726	}
727	}
728	} else {
729	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
730	}
731
732	cf::override;
733	},
734	;
735
736	#############################################################################
737	# load/save/clean perl data associated with a map	718	# load/save/clean perl data associated with a map
738		719
739	*cf::mapsupport::on_clean = sub {	720	*cf::mapsupport::on_clean = sub {
740	my ($map) = @_;	721	my ($map) = @_;
741		722
…		…
743	defined $path or return;	724	defined $path or return;
744		725
745	unlink "$path.pst";	726	unlink "$path.pst";
746	};	727	};
747		728
748	attach_to_maps prio => -10000, package => cf::mapsupport::;	729	cf::map->attach (prio => -10000, package => cf::mapsupport::);
749		730
750	#############################################################################	731	#############################################################################
751	# load/save perl data associated with player->ob objects	732	# load/save perl data associated with player->ob objects
752		733
753	sub all_objects(@) {	734	sub all_objects(@) {
754	@_, map all_objects ($_->inv), @_	735	@_, map all_objects ($_->inv), @_
755	}	736	}
756		737
757	# TODO: compatibility cruft, remove when no longer needed	738	# TODO: compatibility cruft, remove when no longer needed
758	attach_to_players	739	cf::player->attach (
759	on_load => sub {	740	on_load => sub {
760	my ($pl, $path) = @_;	741	my ($pl, $path) = @_;
761		742
762	for my $o (all_objects $pl->ob) {	743	for my $o (all_objects $pl->ob) {
763	if (my $value = $o->get_ob_key_value ("_perl_data")) {	744	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
765		746
766	%$o = %{ Storable::thaw pack "H*", $value };	747	%$o = %{ Storable::thaw pack "H*", $value };
767	}	748	}
768	}	749	}
769	},	750	},
770	;	751	);
771		752
772	#############################################################################	753	#############################################################################
773		754
774	=head2 CORE EXTENSIONS	755	=head2 CORE EXTENSIONS
775		756
776	Functions and methods that extend core crossfire objects.	757	Functions and methods that extend core crossfire objects.
		758
		759	=head3 cf::player
777		760
778	=over 4	761	=over 4
779		762
780	=item cf::player::exists $login	763	=item cf::player::exists $login
781		764
…		…
786	sub cf::player::exists($) {	769	sub cf::player::exists($) {
787	cf::player::find $_[0]	770	cf::player::find $_[0]
788	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	771	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
789	}	772	}
790		773
		774	=item $player->ext_reply ($msgid, $msgtype, %msg)
		775
		776	Sends an ext reply to the player.
		777
		778	=cut
		779
		780	sub cf::player::ext_reply($$$%) {
		781	my ($self, $id, %msg) = @_;
		782
		783	$msg{msgid} = $id;
		784
		785	$self->send ("ext " . to_json \%msg);
		786	}
		787
		788	=back
		789
		790	=head3 cf::object::player
		791
		792	=over 4
		793
791	=item $player_object->reply ($npc, $msg[, $flags])	794	=item $player_object->reply ($npc, $msg[, $flags])
792		795
793	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	796	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
794	can be C<undef>. Does the right thing when the player is currently in a	797	can be C<undef>. Does the right thing when the player is currently in a
795	dialogue with the given NPC character.	798	dialogue with the given NPC character.
796		799
797	=cut	800	=cut
798		801
799	# rough implementation of a future "reply" method that works	802	# rough implementation of a future "reply" method that works
800	# with dialog boxes.	803	# with dialog boxes.
		804	#TODO: the first argument must go, split into a $npc->reply_to ( method
801	sub cf::object::player::reply($$$;$) {	805	sub cf::object::player::reply($$$;$) {
802	my ($self, $npc, $msg, $flags) = @_;	806	my ($self, $npc, $msg, $flags) = @_;
803		807
804	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	808	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
805		809
…		…
809	$msg = $npc->name . " says: $msg" if $npc;	813	$msg = $npc->name . " says: $msg" if $npc;
810	$self->message ($msg, $flags);	814	$self->message ($msg, $flags);
811	}	815	}
812	}	816	}
813		817
814	=item $player->ext_reply ($msgid, $msgtype, %msg)
815
816	Sends an ext reply to the player.
817
818	=cut
819
820	sub cf::player::ext_reply($$$%) {
821	my ($self, $id, %msg) = @_;
822
823	$msg{msgid} = $id;
824
825	$self->send ("ext " . to_json \%msg);
826	}
827
828	=item $player_object->may ("access")	818	=item $player_object->may ("access")
829		819
830	Returns wether the given player is authorized to access resource "access"	820	Returns wether the given player is authorized to access resource "access"
831	(e.g. "command_wizcast").	821	(e.g. "command_wizcast").
832		822
…		…
839	(ref $cf::CFG{"may_$access"}	829	(ref $cf::CFG{"may_$access"}
840	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	830	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
841	: $cf::CFG{"may_$access"})	831	: $cf::CFG{"may_$access"})
842	}	832	}
843		833
844	=cut	834	=head3 cf::client
845		835
846	#############################################################################	836	=over 4
		837
		838	=item $client->send_drawinfo ($text, $flags)
		839
		840	Sends a drawinfo packet to the client. Circumvents output buffering so
		841	should not be used under normal circumstances.
		842
		843	=cut
		844
		845	sub cf::client::send_drawinfo {
		846	my ($self, $text, $flags) = @_;
		847
		848	utf8::encode $text;
		849	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		850	}
		851
		852
		853	=item $success = $client->query ($flags, "text", \&cb)
		854
		855	Queues a query to the client, calling the given callback with
		856	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		857	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		858
		859	Queries can fail, so check the return code. Or don't, as queries will become
		860	reliable at some point in the future.
		861
		862	=cut
		863
		864	sub cf::client::query {
		865	my ($self, $flags, $text, $cb) = @_;
		866
		867	return unless $self->state == ST_PLAYING
		868	\|\| $self->state == ST_SETUP
		869	\|\| $self->state == ST_CUSTOM;
		870
		871	$self->state (ST_CUSTOM);
		872
		873	utf8::encode $text;
		874	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		875
		876	$self->send_packet ($self->{query_queue}[0][0])
		877	if @{ $self->{query_queue} } == 1;
		878	}
		879
		880	cf::client->attach (
		881	on_reply => sub {
		882	my ($ns, $msg) = @_;
		883
		884	# this weird shuffling is so that direct followup queries
		885	# get handled first
		886	my $queue = delete $ns->{query_queue};
		887
		888	(shift @$queue)->[1]->($msg);
		889
		890	push @{ $ns->{query_queue} }, @$queue;
		891
		892	if (@{ $ns->{query_queue} } == @$queue) {
		893	if (@$queue) {
		894	$ns->send_packet ($ns->{query_queue}[0][0]);
		895	} else {
		896	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		897	}
		898	}
		899	},
		900	);
		901
		902	=item $client->coro (\&cb)
		903
		904	Create a new coroutine, running the specified callback. The coroutine will
		905	be automatically cancelled when the client gets destroyed (e.g. on logout,
		906	or loss of connection).
		907
		908	=cut
		909
		910	sub cf::client::coro {
		911	my ($self, $cb) = @_;
		912
		913	my $coro; $coro = async {
		914	eval {
		915	$cb->();
		916	};
		917	warn $@ if $@;
		918	delete $self->{_coro}{$coro+0};
		919	};
		920
		921	$self->{_coro}{$coro+0} = $coro;
		922	}
		923
		924	cf::client->attach (
		925	on_destroy => sub {
		926	my ($ns) = @_;
		927
		928	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		929	},
		930	);
		931
		932	=back
		933
847		934
848	=head2 SAFE SCRIPTING	935	=head2 SAFE SCRIPTING
849		936
850	Functions that provide a safe environment to compile and execute	937	Functions that provide a safe environment to compile and execute
851	snippets of perl code without them endangering the safety of the server	938	snippets of perl code without them endangering the safety of the server
…		…
866		953
867	=pod	954	=pod
868		955
869	The following fucntions and emthods are available within a safe environment:	956	The following fucntions and emthods are available within a safe environment:
870		957
871	cf::object contr pay_amount pay_player	958	cf::object contr pay_amount pay_player map
872	cf::object::player player	959	cf::object::player player
873	cf::player peaceful	960	cf::player peaceful
		961	cf::map trigger
874		962
875	=cut	963	=cut
876		964
877	for (	965	for (
878	["cf::object" => qw(contr pay_amount pay_player)],	966	["cf::object" => qw(contr pay_amount pay_player map)],
879	["cf::object::player" => qw(player)],	967	["cf::object::player" => qw(player)],
880	["cf::player" => qw(peaceful)],	968	["cf::player" => qw(peaceful)],
		969	["cf::map" => qw(trigger)],
881	) {	970	) {
882	no strict 'refs';	971	no strict 'refs';
883	my ($pkg, @funs) = @$_;	972	my ($pkg, @funs) = @$_;
884	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	973	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
885	for @funs;	974	for @funs;
…		…
1025	sub db_sync() {	1114	sub db_sync() {
1026	db_save if $dirty;	1115	db_save if $dirty;
1027	undef $dirty;	1116	undef $dirty;
1028	}	1117	}
1029		1118
1030	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1119	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1031	db_sync;	1120	db_sync;
1032	});	1121	});
1033		1122
1034	sub db_dirty() {	1123	sub db_dirty() {
1035	$dirty = 1;	1124	$dirty = 1;
…		…
1049	$DB->{$_[0]} = $_[1];	1138	$DB->{$_[0]} = $_[1];
1050	}	1139	}
1051	db_dirty;	1140	db_dirty;
1052	}	1141	}
1053		1142
1054	attach_global	1143	cf::global->attach (
1055	prio => 10000,	1144	prio => 10000,
1056	on_cleanup => sub {	1145	on_cleanup => sub {
1057	db_sync;	1146	db_sync;
1058	},	1147	},
1059	;	1148	);
1060	}	1149	}
1061		1150
1062	#############################################################################	1151	#############################################################################
1063	# the server's main()	1152	# the server's main()
1064		1153
…		…
1085		1174
1086	$msg->("reloading...");	1175	$msg->("reloading...");
1087		1176
1088	eval {	1177	eval {
1089	# cancel all watchers	1178	# cancel all watchers
1090	$_->cancel for Event::all_watchers;	1179	for (Event::all_watchers) {
		1180	$_->cancel if $_->data & WF_AUTOCANCEL;
		1181	}
1091		1182
1092	# unload all extensions	1183	# unload all extensions
1093	for (@exts) {	1184	for (@exts) {
1094	$msg->("unloading <$_>");	1185	$msg->("unloading <$_>");
1095	unload_extension $_;	1186	unload_extension $_;
…		…
1130	#Symbol::delete_package __PACKAGE__;	1221	#Symbol::delete_package __PACKAGE__;
1131		1222
1132	# reload cf.pm	1223	# reload cf.pm
1133	$msg->("reloading cf.pm");	1224	$msg->("reloading cf.pm");
1134	require cf;	1225	require cf;
		1226	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135		1227
1136	# load config and database again	1228	# load config and database again
1137	cf::cfg_load;	1229	cf::cfg_load;
1138	cf::db_load;	1230	cf::db_load;
1139		1231
…		…
1155	warn $_[0];	1247	warn $_[0];
1156	print "$_[0]\n";	1248	print "$_[0]\n";
1157	};	1249	};
1158	}	1250	}
1159		1251
		1252	register "<global>", __PACKAGE__;
		1253
1160	register_command "perl-reload", 0, sub {	1254	register_command "perl-reload" => sub {
1161	my ($who, $arg) = @_;	1255	my ($who, $arg) = @_;
1162		1256
1163	if ($who->flag (FLAG_WIZ)) {	1257	if ($who->flag (FLAG_WIZ)) {
1164	_perl_reload {	1258	_perl_reload {
1165	warn $_[0];	1259	warn $_[0];
1166	$who->message ($_[0]);	1260	$who->message ($_[0]);
1167	};	1261	};
1168	}	1262	}
1169	};	1263	};
1170		1264
1171	register "<global>", __PACKAGE__;
1172
1173	unshift @INC, $LIBDIR;	1265	unshift @INC, $LIBDIR;
1174		1266
1175	$TICK_WATCHER = Event->timer (	1267	$TICK_WATCHER = Event->timer (
1176	prio => 1,	1268	prio => 0,
1177	async => 1,
1178	at => $NEXT_TICK \|\| 1,	1269	at => $NEXT_TICK \|\| 1,
		1270	data => WF_AUTOCANCEL,
1179	cb => sub {	1271	cb => sub {
1180	cf::server_tick; # one server iteration	1272	cf::server_tick; # one server iteration
1181		1273
1182	my $NOW = Event::time;	1274	my $NOW = Event::time;
1183	$NEXT_TICK += $TICK;	1275	$NEXT_TICK += $TICK;
…		…
1193	IO::AIO::max_poll_time $TICK * 0.2;	1285	IO::AIO::max_poll_time $TICK * 0.2;
1194		1286
1195	Event->io (fd => IO::AIO::poll_fileno,	1287	Event->io (fd => IO::AIO::poll_fileno,
1196	poll => 'r',	1288	poll => 'r',
1197	prio => 5,	1289	prio => 5,
		1290	data => WF_AUTOCANCEL,
1198	cb => \&IO::AIO::poll_cb);	1291	cb => \&IO::AIO::poll_cb);
1199		1292
1200	1	1293	1
1201		1294

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs. Revision 1.101 by root, Mon Dec 25 14:43:23 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.84 by root, Mon Dec 11 02:54:57 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43:23 2006 UTC