ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.79 by root, Tue Nov 7 14:58:35 2006 UTC vs.
Revision 1.101 by root, Mon Dec 25 14:43:23 2006 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro;
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18
10use IO::AIO (); 19use IO::AIO 2.3;
11use YAML::Syck (); 20use YAML::Syck ();
12use Time::HiRes; 21use Time::HiRes;
13use Event; 22
14$Event::Eval = 1; # no idea why this is required, but it is 23use 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
19use strict; 28$Coro::main->prio (Coro::PRIO_MIN);
20 29
21_init_vars; 30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 31
23our %COMMAND = (); 32our %COMMAND = ();
33our %COMMAND_TIME = ();
34our %EXTCMD = ();
35
24our @EVENT; 36our @EVENT;
25our $LIBDIR = maps_directory "perl"; 37our $LIBDIR = datadir . "/ext";
26 38
27our $TICK = MAX_TIME * 1e-6; 39our $TICK = MAX_TIME * 1e-6;
28our $TICK_WATCHER; 40our $TICK_WATCHER;
29our $NEXT_TICK; 41our $NEXT_TICK;
30 42
31our %CFG; 43our %CFG;
32 44
33our $uptime; 45our $UPTIME; $UPTIME ||= time;
34
35$uptime ||= time;
36 46
37############################################################################# 47#############################################################################
38 48
39=head2 GLOBAL VARIABLES 49=head2 GLOBAL VARIABLES
40 50
41=over 4 51=over 4
52
53=item $cf::UPTIME
54
55The timestamp of the server start (so not actually an uptime).
42 56
43=item $cf::LIBDIR 57=item $cf::LIBDIR
44 58
45The perl library directory, where extensions and cf-specific modules can 59The perl library directory, where extensions and cf-specific modules can
46be found. It will be added to C<@INC> automatically. 60be found. It will be added to C<@INC> automatically.
67 print STDERR "cfperl: $msg"; 81 print STDERR "cfperl: $msg";
68 LOG llevError, "cfperl: $msg"; 82 LOG llevError, "cfperl: $msg";
69 }; 83 };
70} 84}
71 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';
72@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 91@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
73 92
74# 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
75# within the Safe compartment. 94# within the Safe compartment.
76for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 95for 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)) {
77 no strict 'refs'; 102 no strict 'refs';
78 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 103 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79} 104}
80 105
81$Event::DIED = sub { 106$Event::DIED = sub {
83}; 108};
84 109
85my %ext_pkg; 110my %ext_pkg;
86my @exts; 111my @exts;
87my @hook; 112my @hook;
88my %command;
89my %extcmd;
90 113
91=head2 UTILITY FUNCTIONS 114=head2 UTILITY FUNCTIONS
92 115
93=over 4 116=over 4
94 117
122 145
123=cut 146=cut
124 147
125############################################################################# 148#############################################################################
126 149
127=head2 EVENTS AND OBJECT ATTACHMENTS 150=head2 ATTACHABLE OBJECTS
151
152Many objects in crossfire are so-called attachable objects. That means you can
153attach callbacks/event handlers (a collection of which is called an "attachment")
154to it. All such attachable objects support the following methods.
155
156In the following description, CLASS can be any of C<global>, C<object>
157C<player>, C<client> or C<map> (i.e. the attachable objects in
158crossfire+).
128 159
129=over 4 160=over 4
130 161
131=item $object->attach ($attachment, key => $value...)
132
133=item $object->detach ($attachment)
134
135Attach/detach a pre-registered attachment to an object.
136
137=item $player->attach ($attachment, key => $value...)
138
139=item $player->detach ($attachment)
140
141Attach/detach a pre-registered attachment to a player.
142
143=item $map->attach ($attachment, key => $value...) 162=item $attachable->attach ($attachment, key => $value...)
144 163
145=item $map->detach ($attachment) 164=item $attachable->detach ($attachment)
146 165
147Attach/detach a pre-registered attachment to a map. 166Attach/detach a pre-registered attachment to a specific object and give it
167the specified key/value pairs as arguments.
148 168
149=item $bool = $object->attached ($name) 169Example, attach a minesweeper attachment to the given object, making it a
17010x10 minesweeper game:
150 171
151=item $bool = $player->attached ($name) 172 $obj->attach (minesweeper => width => 10, height => 10);
152 173
153=item $bool = $map->attached ($name) 174=item $bool = $attachable->attached ($name)
154 175
155Checks wether the named attachment is currently attached to the object. 176Checks wether the named attachment is currently attached to the object.
156 177
157=item cf::attach_global ... 178=item cf::CLASS->attach ...
158 179
159Attach handlers for global events. 180=item cf::CLASS->detach ...
160 181
161This and all following C<attach_*>-functions expect any number of the 182Define an anonymous attachment and attach it to all objects of the given
162following handler/hook descriptions: 183CLASS. See the next function for an explanation of its arguments.
184
185You can attach to global events by using the C<cf::global> class.
186
187Example, log all player logins:
188
189 cf::player->attach (
190 on_login => sub {
191 my ($pl) = @_;
192 ...
193 },
194 );
195
196Example, 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
209Register an attachment by C<$name> through which attachable objects of the
210given CLASS can refer to this attachment.
211
212Some classes such as crossfire maps and objects can specify attachments
213that are attached at load/instantiate time, thus the need for a name.
214
215These calls expect any number of the following handler/hook descriptions:
163 216
164=over 4 217=over 4
165 218
166=item prio => $number 219=item prio => $number
167 220
169by another C<prio> setting). Lower priority handlers get executed 222by another C<prio> setting). Lower priority handlers get executed
170earlier. The default priority is C<0>, and many built-in handlers are 223earlier. The default priority is C<0>, and many built-in handlers are
171registered at priority C<-1000>, so lower priorities should not be used 224registered at priority C<-1000>, so lower priorities should not be used
172unless you know what you are doing. 225unless you know what you are doing.
173 226
227=item type => $type
228
229(Only for C<< cf::object->attach >> calls), limits the attachment to the
230given type of objects only (the additional parameter C<subtype> can be
231used to further limit to the given subtype).
232
174=item on_I<event> => \&cb 233=item on_I<event> => \&cb
175 234
176Call the given code reference whenever the named event happens (event is 235Call the given code reference whenever the named event happens (event is
177something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 236something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
178handlers are recognised generally depends on the type of object these 237handlers are recognised generally depends on the type of object these
187package and register them. Only handlers for eevents supported by the 246package and register them. Only handlers for eevents supported by the
188object/class are recognised. 247object/class are recognised.
189 248
190=back 249=back
191 250
192=item cf::attach_to_type $object_type, $subtype, ... 251Example, define an attachment called "sockpuppet" that calls the given
252event handler when a monster attacks:
193 253
194Attach handlers for a specific object type (e.g. TRANSPORT) and 254 cf::object::attachment sockpuppet =>
195subtype. If C<$subtype> is zero or undef, matches all objects of the given 255 on_skill_attack => sub {
196type. 256 my ($self, $victim) = @_;
197 257 ...
198=item cf::attach_to_objects ...
199
200Attach handlers to all objects. Do not use this except for debugging or
201very rare events, as handlers are (obviously) called for I<all> objects in
202the game.
203
204=item cf::attach_to_players ...
205
206Attach handlers to all players.
207
208=item cf::attach_to_maps ...
209
210Attach handlers to all maps.
211
212=item cf:register_attachment $name, ...
213
214Register an attachment by name through which objects can refer to this
215attachment.
216
217=item cf:register_player_attachment $name, ...
218
219Register an attachment by name through which players can refer to this
220attachment.
221
222=item cf:register_map_attachment $name, ...
223
224Register an attachment by name through which maps can refer to this
225attachment.
226
227=cut
228
229# the following variables are defined in .xs and must not be re-created
230our @CB_GLOBAL = (); # registry for all global events
231our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232our @CB_PLAYER = ();
233our @CB_TYPE = (); # registry for type (cf-object class) based events
234our @CB_MAP = ();
235
236my %attachment;
237
238sub _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).
255sub _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 } 258 }
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
297sub _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
349sub attach_global {
350 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
351}
352
353sub attach_to_type {
354 my $type = shift;
355 my $subtype = shift;
356
357 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358}
359
360sub attach_to_objects {
361 _attach @CB_OBJECT, KLASS_OBJECT, @_
362}
363
364sub attach_to_players {
365 _attach @CB_PLAYER, KLASS_PLAYER, @_
366}
367
368sub attach_to_maps {
369 _attach @CB_MAP, KLASS_MAP, @_
370}
371
372sub register_attachment {
373 my $name = shift;
374
375 $attachment{$name} = [[KLASS_OBJECT, @_]];
376}
377
378sub register_player_attachment {
379 my $name = shift;
380
381 $attachment{$name} = [[KLASS_PLAYER, @_]];
382}
383
384sub register_map_attachment {
385 my $name = shift;
386
387 $attachment{$name} = [[KLASS_MAP, @_]];
388}
389
390our $override;
391our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393sub override {
394 $override = 1;
395 @invoke_results = ();
396}
397
398sub 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 259 }
419}
420 260
421=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 261=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
429Generate a global/object/player/map-specific event with the given arguments.
430
431This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432removed in future versions), and there is no public API to access override
433results (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 262
447Just because you have a perl object does not mean that the corresponding 263Just because you have a perl object does not mean that the corresponding
448C-level object still exists. If you try to access an object that has no 264C-level object still exists. If you try to access an object that has no
449valid C counterpart anymore you get an exception at runtime. This method 265valid C counterpart anymore you get an exception at runtime. This method
450can be used to test for existence of the C object part without causing an 266can be used to test for existence of the C object part without causing an
451exception. 267exception.
452 268
269=cut
270
271# the following variables are defined in .xs and must not be re-created
272our @CB_GLOBAL = (); # registry for all global events
273our @CB_ATTACHABLE = (); # registry for all attachables
274our @CB_OBJECT = (); # all objects (should not be used except in emergency)
275our @CB_PLAYER = ();
276our @CB_CLIENT = ();
277our @CB_TYPE = (); # registry for type (cf-object class) based events
278our @CB_MAP = ();
279
280my %attachment;
281
282sub _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
295my %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).
300sub _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
349sub _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
370sub 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
379sub 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
390sub cf::attachable::attached {
391 my ($obj, $name) = @_;
392
393 exists $obj->{_attachment}{$name}
394}
395
396for 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
411our $override;
412our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
413
414sub override {
415 $override = 1;
416 @invoke_results = ();
417}
418
419sub 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
446Generate an object-specific event with the given arguments.
447
448This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
449removed in future versions), and there is no public API to access override
450results (if you must, access C<@cf::invoke_results> directly).
451
453=back 452=back
454 453
455=cut 454=cut
456
457*cf::object::valid =
458*cf::player::valid =
459*cf::map::valid = \&cf::_valid;
460 455
461############################################################################# 456#############################################################################
462# object support 457# object support
463 458
464sub instantiate { 459cf::attachable->attach (
460 prio => -1000000,
461 on_instantiate => sub {
465 my ($obj, $data) = @_; 462 my ($obj, $data) = @_;
466 463
467 $data = from_json $data; 464 $data = from_json $data;
468 465
469 for (@$data) { 466 for (@$data) {
470 my ($name, $args) = @$_; 467 my ($name, $args) = @$_;
471 468
472 $obj->attach ($name, %{$args || {} }); 469 $obj->attach ($name, %{$args || {} });
470 }
473 } 471 },
474} 472 on_reattach => sub {
475
476# basically do the same as instantiate, without calling instantiate 473 # basically do the same as instantiate, without calling instantiate
477sub reattach {
478 my ($obj) = @_; 474 my ($obj) = @_;
479 my $registry = $obj->registry; 475 my $registry = $obj->registry;
480 476
481 @$registry = (); 477 @$registry = ();
482 478
483 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 479 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
484 480
485 for my $name (keys %{ $obj->{_attachment} || {} }) { 481 for my $name (keys %{ $obj->{_attachment} || {} }) {
486 if (my $attach = $attachment{$name}) { 482 if (my $attach = $attachment{$name}) {
487 for (@$attach) { 483 for (@$attach) {
488 my ($klass, @attach) = @$_; 484 my ($klass, @attach) = @$_;
489 _attach @$registry, $klass, @attach; 485 _attach $registry, $klass, @attach;
486 }
487 } else {
488 warn "object uses attachment '$name' that is not available, postponing.\n";
490 } 489 }
491 } else {
492 warn "object uses attachment '$name' that is not available, postponing.\n";
493 } 490 }
494 } 491 },
495} 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);
496 503
497sub object_freezer_save { 504sub object_freezer_save {
498 my ($filename, $rdata, $objs) = @_; 505 my ($filename, $rdata, $objs) = @_;
499 506
500 if (length $$rdata) { 507 if (length $$rdata) {
523 unlink $filename; 530 unlink $filename;
524 unlink "$filename.pst"; 531 unlink "$filename.pst";
525 } 532 }
526} 533}
527 534
535sub object_freezer_as_string {
536 my ($rdata, $objs) = @_;
537
538 use Data::Dumper;
539
540 $$rdata . Dumper $objs
541}
542
528sub object_thawer_load { 543sub object_thawer_load {
529 my ($filename) = @_; 544 my ($filename) = @_;
530 545
531 local $/; 546 local $/;
532 547
542 } 557 }
543 558
544 () 559 ()
545} 560}
546 561
547attach_to_objects
548 prio => -1000000,
549 on_clone => sub {
550 my ($src, $dst) = @_;
551
552 @{$dst->registry} = @{$src->registry};
553
554 %$dst = %$src;
555
556 %{$dst->{_attachment}} = %{$src->{_attachment}}
557 if exists $src->{_attachment};
558 },
559;
560
561############################################################################# 562#############################################################################
562# old plug-in events 563# command handling &c
563 564
564sub inject_event { 565=item cf::register_command $name => \&callback($ob,$args);
565 my $extension = shift;
566 my $event_code = shift;
567 566
568 my $cb = $hook[$event_code]{$extension} 567Register a callback for execution when the client sends the user command
569 or return; 568$name.
570 569
571 &$cb 570=cut
572}
573
574sub inject_global_event {
575 my $event = shift;
576
577 my $cb = $hook[$event]
578 or return;
579
580 List::Util::max map &$_, values %$cb
581}
582
583sub inject_command {
584 my ($name, $obj, $params) = @_;
585
586 for my $cmd (@{ $command{$name} }) {
587 $cmd->[1]->($obj, $params);
588 }
589
590 -1
591}
592 571
593sub register_command { 572sub register_command {
594 my ($name, $time, $cb) = @_; 573 my ($name, $cb) = @_;
595 574
596 my $caller = caller; 575 my $caller = caller;
597 #warn "registering command '$name/$time' to '$caller'"; 576 #warn "registering command '$name/$time' to '$caller'";
598 577
599 push @{ $command{$name} }, [$time, $cb, $caller]; 578 push @{ $COMMAND{$name} }, [$caller, $cb];
600 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
601} 579}
580
581=item cf::register_extcmd $name => \&callback($pl,$packet);
582
583Register a callbackf ro execution when the client sends an extcmd packet.
584
585If the callback returns something, it is sent back as if reply was being
586called.
587
588=cut
602 589
603sub register_extcmd { 590sub register_extcmd {
604 my ($name, $cb) = @_; 591 my ($name, $cb) = @_;
605 592
606 my $caller = caller; 593 my $caller = caller;
607 #warn "registering extcmd '$name' to '$caller'"; 594 #warn "registering extcmd '$name' to '$caller'";
608 595
609 $extcmd{$name} = [$cb, $caller]; 596 $EXTCMD{$name} = [$cb, $caller];
610} 597}
598
599cf::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);
611 630
612sub register { 631sub register {
613 my ($base, $pkg) = @_; 632 my ($base, $pkg) = @_;
614 633
615 #TODO 634 #TODO
634 . "#line 1 \"$path\"\n{\n" 653 . "#line 1 \"$path\"\n{\n"
635 . (do { local $/; <$fh> }) 654 . (do { local $/; <$fh> })
636 . "\n};\n1"; 655 . "\n};\n1";
637 656
638 eval $source 657 eval $source
639 or die "$path: $@"; 658 or die $@ ? "$path: $@\n"
659 : "extension disabled.\n";
640 660
641 push @exts, $pkg; 661 push @exts, $pkg;
642 $ext_pkg{$base} = $pkg; 662 $ext_pkg{$base} = $pkg;
643 663
644# no strict 'refs'; 664# no strict 'refs';
657# for my $idx (0 .. $#PLUGIN_EVENT) { 677# for my $idx (0 .. $#PLUGIN_EVENT) {
658# delete $hook[$idx]{$pkg}; 678# delete $hook[$idx]{$pkg};
659# } 679# }
660 680
661 # remove commands 681 # remove commands
662 for my $name (keys %command) { 682 for my $name (keys %COMMAND) {
663 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 683 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
664 684
665 if (@cb) { 685 if (@cb) {
666 $command{$name} = \@cb; 686 $COMMAND{$name} = \@cb;
667 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
668 } else { 687 } else {
669 delete $command{$name};
670 delete $COMMAND{"$name\000"}; 688 delete $COMMAND{$name};
671 } 689 }
672 } 690 }
673 691
674 # remove extcmds 692 # remove extcmds
675 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 693 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
676 delete $extcmd{$name}; 694 delete $EXTCMD{$name};
677 } 695 }
678 696
679 if (my $cb = $pkg->can ("unload")) { 697 if (my $cb = $pkg->can ("unload")) {
680 eval { 698 eval {
681 $cb->($pkg); 699 $cb->($pkg);
685 703
686 Symbol::delete_package $pkg; 704 Symbol::delete_package $pkg;
687} 705}
688 706
689sub load_extensions { 707sub load_extensions {
690 my $LIBDIR = maps_directory "perl";
691
692 for my $ext (<$LIBDIR/*.ext>) { 708 for my $ext (<$LIBDIR/*.ext>) {
693 next unless -r $ext; 709 next unless -r $ext;
694 eval { 710 eval {
695 load_extension $ext; 711 load_extension $ext;
696 1 712 1
697 } or warn "$ext not loaded: $@"; 713 } or warn "$ext not loaded: $@";
698 } 714 }
699} 715}
700 716
701############################################################################# 717#############################################################################
702# extcmd framework, basically convert ext <msg>
703# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
704
705attach_to_players
706 on_extcmd => sub {
707 my ($pl, $buf) = @_;
708
709 my $msg = eval { from_json $buf };
710
711 if (ref $msg) {
712 if (my $cb = $extcmd{$msg->{msgtype}}) {
713 if (my %reply = $cb->[0]->($pl, $msg)) {
714 $pl->ext_reply ($msg->{msgid}, %reply);
715 }
716 }
717 } else {
718 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
719 }
720
721 cf::override;
722 },
723;
724
725#############################################################################
726# load/save/clean perl data associated with a map 718# load/save/clean perl data associated with a map
727 719
728*cf::mapsupport::on_clean = sub { 720*cf::mapsupport::on_clean = sub {
729 my ($map) = @_; 721 my ($map) = @_;
730 722
732 defined $path or return; 724 defined $path or return;
733 725
734 unlink "$path.pst"; 726 unlink "$path.pst";
735}; 727};
736 728
737attach_to_maps prio => -10000, package => cf::mapsupport::; 729cf::map->attach (prio => -10000, package => cf::mapsupport::);
738 730
739############################################################################# 731#############################################################################
740# load/save perl data associated with player->ob objects 732# load/save perl data associated with player->ob objects
741 733
742sub all_objects(@) { 734sub all_objects(@) {
743 @_, map all_objects ($_->inv), @_ 735 @_, map all_objects ($_->inv), @_
744} 736}
745 737
746# TODO: compatibility cruft, remove when no longer needed 738# TODO: compatibility cruft, remove when no longer needed
747attach_to_players 739cf::player->attach (
748 on_load => sub { 740 on_load => sub {
749 my ($pl, $path) = @_; 741 my ($pl, $path) = @_;
750 742
751 for my $o (all_objects $pl->ob) { 743 for my $o (all_objects $pl->ob) {
752 if (my $value = $o->get_ob_key_value ("_perl_data")) { 744 if (my $value = $o->get_ob_key_value ("_perl_data")) {
754 746
755 %$o = %{ Storable::thaw pack "H*", $value }; 747 %$o = %{ Storable::thaw pack "H*", $value };
756 } 748 }
757 } 749 }
758 }, 750 },
759; 751);
760 752
761############################################################################# 753#############################################################################
762 754
763=head2 CORE EXTENSIONS 755=head2 CORE EXTENSIONS
764 756
765Functions and methods that extend core crossfire objects. 757Functions and methods that extend core crossfire objects.
758
759=head3 cf::player
766 760
767=over 4 761=over 4
768 762
769=item cf::player::exists $login 763=item cf::player::exists $login
770 764
775sub cf::player::exists($) { 769sub cf::player::exists($) {
776 cf::player::find $_[0] 770 cf::player::find $_[0]
777 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;
778} 772}
779 773
774=item $player->ext_reply ($msgid, $msgtype, %msg)
775
776Sends an ext reply to the player.
777
778=cut
779
780sub 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
780=item $player_object->reply ($npc, $msg[, $flags]) 794=item $player_object->reply ($npc, $msg[, $flags])
781 795
782Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 796Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
783can be C<undef>. Does the right thing when the player is currently in a 797can be C<undef>. Does the right thing when the player is currently in a
784dialogue with the given NPC character. 798dialogue with the given NPC character.
785 799
786=cut 800=cut
787 801
788# rough implementation of a future "reply" method that works 802# rough implementation of a future "reply" method that works
789# with dialog boxes. 803# with dialog boxes.
804#TODO: the first argument must go, split into a $npc->reply_to ( method
790sub cf::object::player::reply($$$;$) { 805sub cf::object::player::reply($$$;$) {
791 my ($self, $npc, $msg, $flags) = @_; 806 my ($self, $npc, $msg, $flags) = @_;
792 807
793 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
794 809
798 $msg = $npc->name . " says: $msg" if $npc; 813 $msg = $npc->name . " says: $msg" if $npc;
799 $self->message ($msg, $flags); 814 $self->message ($msg, $flags);
800 } 815 }
801} 816}
802 817
803=item $player->ext_reply ($msgid, $msgtype, %msg)
804
805Sends an ext reply to the player.
806
807=cut
808
809sub cf::player::ext_reply($$$%) {
810 my ($self, $id, %msg) = @_;
811
812 $msg{msgid} = $id;
813
814 $self->send ("ext " . to_json \%msg);
815}
816
817=item $player_object->may ("access") 818=item $player_object->may ("access")
818 819
819Returns wether the given player is authorized to access resource "access" 820Returns wether the given player is authorized to access resource "access"
820(e.g. "command_wizcast"). 821(e.g. "command_wizcast").
821 822
828 (ref $cf::CFG{"may_$access"} 829 (ref $cf::CFG{"may_$access"}
829 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 830 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
830 : $cf::CFG{"may_$access"}) 831 : $cf::CFG{"may_$access"})
831} 832}
832 833
833=cut 834=head3 cf::client
834 835
835############################################################################# 836=over 4
837
838=item $client->send_drawinfo ($text, $flags)
839
840Sends a drawinfo packet to the client. Circumvents output buffering so
841should not be used under normal circumstances.
842
843=cut
844
845sub 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
855Queues a query to the client, calling the given callback with
856the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
857C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
858
859Queries can fail, so check the return code. Or don't, as queries will become
860reliable at some point in the future.
861
862=cut
863
864sub 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
880cf::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
904Create a new coroutine, running the specified callback. The coroutine will
905be automatically cancelled when the client gets destroyed (e.g. on logout,
906or loss of connection).
907
908=cut
909
910sub 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
924cf::client->attach (
925 on_destroy => sub {
926 my ($ns) = @_;
927
928 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
929 },
930);
931
932=back
933
836 934
837=head2 SAFE SCRIPTING 935=head2 SAFE SCRIPTING
838 936
839Functions that provide a safe environment to compile and execute 937Functions that provide a safe environment to compile and execute
840snippets of perl code without them endangering the safety of the server 938snippets of perl code without them endangering the safety of the server
855 953
856=pod 954=pod
857 955
858The following fucntions and emthods are available within a safe environment: 956The following fucntions and emthods are available within a safe environment:
859 957
860 cf::object contr pay_amount pay_player 958 cf::object contr pay_amount pay_player map
861 cf::object::player player 959 cf::object::player player
862 cf::player peaceful 960 cf::player peaceful
961 cf::map trigger
863 962
864=cut 963=cut
865 964
866for ( 965for (
867 ["cf::object" => qw(contr pay_amount pay_player)], 966 ["cf::object" => qw(contr pay_amount pay_player map)],
868 ["cf::object::player" => qw(player)], 967 ["cf::object::player" => qw(player)],
869 ["cf::player" => qw(peaceful)], 968 ["cf::player" => qw(peaceful)],
969 ["cf::map" => qw(trigger)],
870) { 970) {
871 no strict 'refs'; 971 no strict 'refs';
872 my ($pkg, @funs) = @$_; 972 my ($pkg, @funs) = @$_;
873 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 973 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
874 for @funs; 974 for @funs;
1014 sub db_sync() { 1114 sub db_sync() {
1015 db_save if $dirty; 1115 db_save if $dirty;
1016 undef $dirty; 1116 undef $dirty;
1017 } 1117 }
1018 1118
1019 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 {
1020 db_sync; 1120 db_sync;
1021 }); 1121 });
1022 1122
1023 sub db_dirty() { 1123 sub db_dirty() {
1024 $dirty = 1; 1124 $dirty = 1;
1038 $DB->{$_[0]} = $_[1]; 1138 $DB->{$_[0]} = $_[1];
1039 } 1139 }
1040 db_dirty; 1140 db_dirty;
1041 } 1141 }
1042 1142
1043 attach_global 1143 cf::global->attach (
1044 prio => 10000, 1144 prio => 10000,
1045 on_cleanup => sub { 1145 on_cleanup => sub {
1046 db_sync; 1146 db_sync;
1047 }, 1147 },
1048 ; 1148 );
1049} 1149}
1050 1150
1051############################################################################# 1151#############################################################################
1052# the server's main() 1152# the server's main()
1053 1153
1074 1174
1075 $msg->("reloading..."); 1175 $msg->("reloading...");
1076 1176
1077 eval { 1177 eval {
1078 # cancel all watchers 1178 # cancel all watchers
1079 $_->cancel for Event::all_watchers; 1179 for (Event::all_watchers) {
1180 $_->cancel if $_->data & WF_AUTOCANCEL;
1181 }
1080 1182
1081 # unload all extensions 1183 # unload all extensions
1082 for (@exts) { 1184 for (@exts) {
1083 $msg->("unloading <$_>"); 1185 $msg->("unloading <$_>");
1084 unload_extension $_; 1186 unload_extension $_;
1119 #Symbol::delete_package __PACKAGE__; 1221 #Symbol::delete_package __PACKAGE__;
1120 1222
1121 # reload cf.pm 1223 # reload cf.pm
1122 $msg->("reloading cf.pm"); 1224 $msg->("reloading cf.pm");
1123 require cf; 1225 require cf;
1226 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124 1227
1125 # load config and database again 1228 # load config and database again
1126 cf::cfg_load; 1229 cf::cfg_load;
1127 cf::db_load; 1230 cf::db_load;
1128 1231
1144 warn $_[0]; 1247 warn $_[0];
1145 print "$_[0]\n"; 1248 print "$_[0]\n";
1146 }; 1249 };
1147} 1250}
1148 1251
1252register "<global>", __PACKAGE__;
1253
1149register_command "perl-reload", 0, sub { 1254register_command "perl-reload" => sub {
1150 my ($who, $arg) = @_; 1255 my ($who, $arg) = @_;
1151 1256
1152 if ($who->flag (FLAG_WIZ)) { 1257 if ($who->flag (FLAG_WIZ)) {
1153 _perl_reload { 1258 _perl_reload {
1154 warn $_[0]; 1259 warn $_[0];
1155 $who->message ($_[0]); 1260 $who->message ($_[0]);
1156 }; 1261 };
1157 } 1262 }
1158}; 1263};
1159 1264
1160register "<global>", __PACKAGE__;
1161
1162unshift @INC, $LIBDIR; 1265unshift @INC, $LIBDIR;
1163 1266
1164$TICK_WATCHER = Event->timer ( 1267$TICK_WATCHER = Event->timer (
1165 prio => 1, 1268 prio => 0,
1166 async => 1,
1167 at => $NEXT_TICK || 1, 1269 at => $NEXT_TICK || 1,
1270 data => WF_AUTOCANCEL,
1168 cb => sub { 1271 cb => sub {
1169 cf::server_tick; # one server iteration 1272 cf::server_tick; # one server iteration
1170 1273
1171 my $NOW = Event::time; 1274 my $NOW = Event::time;
1172 $NEXT_TICK += $TICK; 1275 $NEXT_TICK += $TICK;
1177 $TICK_WATCHER->at ($NEXT_TICK); 1280 $TICK_WATCHER->at ($NEXT_TICK);
1178 $TICK_WATCHER->start; 1281 $TICK_WATCHER->start;
1179 }, 1282 },
1180); 1283);
1181 1284
1182eval { IO::AIO::max_poll_time $TICK * 0.2 }; #d# remove eval after restart 1285IO::AIO::max_poll_time $TICK * 0.2;
1183 1286
1184Event->io (fd => IO::AIO::poll_fileno, 1287Event->io (fd => IO::AIO::poll_fileno,
1185 poll => 'r', 1288 poll => 'r',
1186 prio => 5, 1289 prio => 5,
1290 data => WF_AUTOCANCEL,
1187 cb => \&IO::AIO::poll_cb); 1291 cb => \&IO::AIO::poll_cb);
1188 1292
11891 12931
1190 1294

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines