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.76 by root, Mon Oct 2 15:28:36 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 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
19use IO::AIO 2.3;
10use YAML::Syck (); 20use YAML::Syck ();
11use Time::HiRes; 21use Time::HiRes;
12use Event; 22
13$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
14 24
15# 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?
16$YAML::Syck::ImplicitUnicode = 1; 26$YAML::Syck::ImplicitUnicode = 1;
17 27
18use strict; 28$Coro::main->prio (Coro::PRIO_MIN);
19 29
20_init_vars; 30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
21 31
22our %COMMAND = (); 32our %COMMAND = ();
33our %COMMAND_TIME = ();
34our %EXTCMD = ();
35
23our @EVENT; 36our @EVENT;
24our $LIBDIR = maps_directory "perl"; 37our $LIBDIR = datadir . "/ext";
25 38
26our $TICK = MAX_TIME * 1e-6; 39our $TICK = MAX_TIME * 1e-6;
27our $TICK_WATCHER; 40our $TICK_WATCHER;
28our $NEXT_TICK; 41our $NEXT_TICK;
29 42
30our %CFG; 43our %CFG;
31 44
32our $uptime; 45our $UPTIME; $UPTIME ||= time;
33
34$uptime ||= time;
35 46
36############################################################################# 47#############################################################################
37 48
38=head2 GLOBAL VARIABLES 49=head2 GLOBAL VARIABLES
39 50
40=over 4 51=over 4
52
53=item $cf::UPTIME
54
55The timestamp of the server start (so not actually an uptime).
41 56
42=item $cf::LIBDIR 57=item $cf::LIBDIR
43 58
44The perl library directory, where extensions and cf-specific modules can 59The perl library directory, where extensions and cf-specific modules can
45be found. It will be added to C<@INC> automatically. 60be found. It will be added to C<@INC> automatically.
66 print STDERR "cfperl: $msg"; 81 print STDERR "cfperl: $msg";
67 LOG llevError, "cfperl: $msg"; 82 LOG llevError, "cfperl: $msg";
68 }; 83 };
69} 84}
70 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';
71@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 91@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72 92
73# 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
74# within the Safe compartment. 94# within the Safe compartment.
75for 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)) {
76 no strict 'refs'; 102 no strict 'refs';
77 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 103 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
78} 104}
79 105
80$Event::DIED = sub { 106$Event::DIED = sub {
82}; 108};
83 109
84my %ext_pkg; 110my %ext_pkg;
85my @exts; 111my @exts;
86my @hook; 112my @hook;
87my %command;
88my %extcmd;
89 113
90=head2 UTILITY FUNCTIONS 114=head2 UTILITY FUNCTIONS
91 115
92=over 4 116=over 4
93 117
121 145
122=cut 146=cut
123 147
124############################################################################# 148#############################################################################
125 149
126=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+).
127 159
128=over 4 160=over 4
129 161
130=item $object->attach ($attachment, key => $value...)
131
132=item $object->detach ($attachment)
133
134Attach/detach a pre-registered attachment to an object.
135
136=item $player->attach ($attachment, key => $value...)
137
138=item $player->detach ($attachment)
139
140Attach/detach a pre-registered attachment to a player.
141
142=item $map->attach ($attachment, key => $value...) 162=item $attachable->attach ($attachment, key => $value...)
143 163
144=item $map->detach ($attachment) 164=item $attachable->detach ($attachment)
145 165
146Attach/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.
147 168
148=item $bool = $object->attached ($name) 169Example, attach a minesweeper attachment to the given object, making it a
17010x10 minesweeper game:
149 171
150=item $bool = $player->attached ($name) 172 $obj->attach (minesweeper => width => 10, height => 10);
151 173
152=item $bool = $map->attached ($name) 174=item $bool = $attachable->attached ($name)
153 175
154Checks wether the named attachment is currently attached to the object. 176Checks wether the named attachment is currently attached to the object.
155 177
156=item cf::attach_global ... 178=item cf::CLASS->attach ...
157 179
158Attach handlers for global events. 180=item cf::CLASS->detach ...
159 181
160This and all following C<attach_*>-functions expect any number of the 182Define an anonymous attachment and attach it to all objects of the given
161following 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:
162 216
163=over 4 217=over 4
164 218
165=item prio => $number 219=item prio => $number
166 220
168by another C<prio> setting). Lower priority handlers get executed 222by another C<prio> setting). Lower priority handlers get executed
169earlier. 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
170registered at priority C<-1000>, so lower priorities should not be used 224registered at priority C<-1000>, so lower priorities should not be used
171unless you know what you are doing. 225unless you know what you are doing.
172 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
173=item on_I<event> => \&cb 233=item on_I<event> => \&cb
174 234
175Call the given code reference whenever the named event happens (event is 235Call the given code reference whenever the named event happens (event is
176something 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
177handlers are recognised generally depends on the type of object these 237handlers are recognised generally depends on the type of object these
186package and register them. Only handlers for eevents supported by the 246package and register them. Only handlers for eevents supported by the
187object/class are recognised. 247object/class are recognised.
188 248
189=back 249=back
190 250
191=item cf::attach_to_type $object_type, $subtype, ... 251Example, define an attachment called "sockpuppet" that calls the given
252event handler when a monster attacks:
192 253
193Attach handlers for a specific object type (e.g. TRANSPORT) and 254 cf::object::attachment sockpuppet =>
194subtype. If C<$subtype> is zero or undef, matches all objects of the given 255 on_skill_attack => sub {
195type. 256 my ($self, $victim) = @_;
196 257 ...
197=item cf::attach_to_objects ...
198
199Attach handlers to all objects. Do not use this except for debugging or
200very rare events, as handlers are (obviously) called for I<all> objects in
201the game.
202
203=item cf::attach_to_players ...
204
205Attach handlers to all players.
206
207=item cf::attach_to_maps ...
208
209Attach handlers to all maps.
210
211=item cf:register_attachment $name, ...
212
213Register an attachment by name through which objects can refer to this
214attachment.
215
216=item cf:register_player_attachment $name, ...
217
218Register an attachment by name through which players can refer to this
219attachment.
220
221=item cf:register_map_attachment $name, ...
222
223Register an attachment by name through which maps can refer to this
224attachment.
225
226=cut
227
228# the following variables are defined in .xs and must not be re-created
229our @CB_GLOBAL = (); # registry for all global events
230our @CB_OBJECT = (); # all objects (should not be used except in emergency)
231our @CB_PLAYER = ();
232our @CB_TYPE = (); # registry for type (cf-object class) based events
233our @CB_MAP = ();
234
235my %attachment;
236
237sub _attach_cb($\%$$$) {
238 my ($registry, $undo, $event, $prio, $cb) = @_;
239
240 use sort 'stable';
241
242 $cb = [$prio, $cb];
243
244 @{$registry->[$event]} = sort
245 { $a->[0] cmp $b->[0] }
246 @{$registry->[$event] || []}, $cb;
247
248 push @{$undo->{cb}}, [$event, $cb];
249}
250
251# attach handles attaching event callbacks
252# the only thing the caller has to do is pass the correct
253# registry (== where the callback attaches to).
254sub _attach(\@$@) {
255 my ($registry, $klass, @arg) = @_;
256
257 my $prio = 0;
258
259 my %undo = (
260 registry => $registry,
261 cb => [],
262 );
263
264 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
265
266 while (@arg) {
267 my $type = shift @arg;
268
269 if ($type eq "prio") {
270 $prio = shift @arg;
271
272 } elsif ($type eq "package") {
273 my $pkg = shift @arg;
274
275 while (my ($name, $id) = each %cb_id) {
276 if (my $cb = $pkg->can ($name)) {
277 _attach_cb $registry, %undo, $id, $prio, $cb;
278 }
279 } 258 }
280
281 } elsif (exists $cb_id{$type}) {
282 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
283
284 } elsif (ref $type) {
285 warn "attaching objects not supported, ignoring.\n";
286
287 } else {
288 shift @arg;
289 warn "attach argument '$type' not supported, ignoring.\n";
290 }
291 }
292
293 \%undo
294}
295
296sub _attach_attachment {
297 my ($obj, $name, %arg) = @_;
298
299 return if exists $obj->{_attachment}{$name};
300
301 my $res;
302
303 if (my $attach = $attachment{$name}) {
304 my $registry = $obj->registry;
305
306 for (@$attach) {
307 my ($klass, @attach) = @$_;
308 $res = _attach @$registry, $klass, @attach;
309 }
310
311 $obj->{$name} = \%arg;
312 } else {
313 warn "object uses attachment '$name' that is not available, postponing.\n";
314 }
315
316 $obj->{_attachment}{$name} = undef;
317
318 $res->{attachment} = $name;
319 $res
320}
321
322*cf::object::attach =
323*cf::player::attach =
324*cf::map::attach = sub {
325 my ($obj, $name, %arg) = @_;
326
327 _attach_attachment $obj, $name, %arg;
328};
329
330# all those should be optimised
331*cf::object::detach =
332*cf::player::detach =
333*cf::map::detach = sub {
334 my ($obj, $name) = @_;
335
336 delete $obj->{_attachment}{$name};
337 reattach ($obj);
338};
339
340*cf::object::attached =
341*cf::player::attached =
342*cf::map::attached = sub {
343 my ($obj, $name) = @_;
344
345 exists $obj->{_attachment}{$name}
346};
347
348sub attach_global {
349 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
350}
351
352sub attach_to_type {
353 my $type = shift;
354 my $subtype = shift;
355
356 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
357}
358
359sub attach_to_objects {
360 _attach @CB_OBJECT, KLASS_OBJECT, @_
361}
362
363sub attach_to_players {
364 _attach @CB_PLAYER, KLASS_PLAYER, @_
365}
366
367sub attach_to_maps {
368 _attach @CB_MAP, KLASS_MAP, @_
369}
370
371sub register_attachment {
372 my $name = shift;
373
374 $attachment{$name} = [[KLASS_OBJECT, @_]];
375}
376
377sub register_player_attachment {
378 my $name = shift;
379
380 $attachment{$name} = [[KLASS_PLAYER, @_]];
381}
382
383sub register_map_attachment {
384 my $name = shift;
385
386 $attachment{$name} = [[KLASS_MAP, @_]];
387}
388
389our $override;
390our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
391
392sub override {
393 $override = 1;
394 @invoke_results = ();
395}
396
397sub do_invoke {
398 my $event = shift;
399 my $callbacks = shift;
400
401 @invoke_results = ();
402
403 local $override;
404
405 for (@$callbacks) {
406 eval { &{$_->[1]} };
407
408 if ($@) {
409 warn "$@";
410 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
411 override;
412 }
413
414 return 1 if $override;
415 }
416
417 0 259 }
418}
419 260
420=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 261=item $attachable->valid
421
422=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
423
424=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
425
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments.
429
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
431removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly).
433
434=back
435
436=cut
437
438#############################################################################
439
440=head2 METHODS VALID FOR ALL CORE OBJECTS
441
442=over 4
443
444=item $object->valid, $player->valid, $map->valid
445 262
446Just 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
447C-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
448valid C counterpart anymore you get an exception at runtime. This method 265valid C counterpart anymore you get an exception at runtime. This method
449can 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
450exception. 267exception.
451 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
452=back 452=back
453 453
454=cut 454=cut
455
456*cf::object::valid =
457*cf::player::valid =
458*cf::map::valid = \&cf::_valid;
459 455
460############################################################################# 456#############################################################################
461# object support 457# object support
462 458
463sub instantiate {
464 my ($obj, $data) = @_;
465
466 $data = from_json $data;
467
468 for (@$data) {
469 my ($name, $args) = @$_;
470
471 $obj->attach ($name, %{$args || {} });
472 }
473}
474
475# basically do the same as instantiate, without calling instantiate
476sub reattach { 459sub reattach {
460 # basically do the same as instantiate, without calling instantiate
477 my ($obj) = @_; 461 my ($obj) = @_;
462
478 my $registry = $obj->registry; 463 my $registry = $obj->registry;
479 464
480 @$registry = (); 465 @$registry = ();
481 466
482 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 467 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
483 468
484 for my $name (keys %{ $obj->{_attachment} || {} }) { 469 for my $name (keys %{ $obj->{_attachment} || {} }) {
485 if (my $attach = $attachment{$name}) { 470 if (my $attach = $attachment{$name}) {
486 for (@$attach) { 471 for (@$attach) {
487 my ($klass, @attach) = @$_; 472 my ($klass, @attach) = @$_;
488 _attach @$registry, $klass, @attach; 473 _attach $registry, $klass, @attach;
489 } 474 }
490 } else { 475 } else {
491 warn "object uses attachment '$name' that is not available, postponing.\n"; 476 warn "object uses attachment '$name' that is not available, postponing.\n";
492 } 477 }
493 } 478 }
494} 479}
480
481cf::attachable->attach (
482 prio => -1000000,
483 on_instantiate => sub {
484 my ($obj, $data) = @_;
485
486 $data = from_json $data;
487
488 for (@$data) {
489 my ($name, $args) = @$_;
490
491 $obj->attach ($name, %{$args || {} });
492 }
493 },
494 on_reattach => \&reattach,
495 on_clone => sub {
496 my ($src, $dst) = @_;
497
498 @{$dst->registry} = @{$src->registry};
499
500 %$dst = %$src;
501
502 %{$dst->{_attachment}} = %{$src->{_attachment}}
503 if exists $src->{_attachment};
504 },
505);
495 506
496sub object_freezer_save { 507sub object_freezer_save {
497 my ($filename, $rdata, $objs) = @_; 508 my ($filename, $rdata, $objs) = @_;
498 509
499 if (length $$rdata) { 510 if (length $$rdata) {
522 unlink $filename; 533 unlink $filename;
523 unlink "$filename.pst"; 534 unlink "$filename.pst";
524 } 535 }
525} 536}
526 537
538sub object_freezer_as_string {
539 my ($rdata, $objs) = @_;
540
541 use Data::Dumper;
542
543 $$rdata . Dumper $objs
544}
545
527sub object_thawer_load { 546sub object_thawer_load {
528 my ($filename) = @_; 547 my ($filename) = @_;
529 548
530 local $/; 549 local $/;
531 550
541 } 560 }
542 561
543 () 562 ()
544} 563}
545 564
546attach_to_objects
547 prio => -1000000,
548 on_clone => sub {
549 my ($src, $dst) = @_;
550
551 @{$dst->registry} = @{$src->registry};
552
553 %$dst = %$src;
554
555 %{$dst->{_attachment}} = %{$src->{_attachment}}
556 if exists $src->{_attachment};
557 },
558;
559
560############################################################################# 565#############################################################################
561# old plug-in events 566# command handling &c
562 567
563sub inject_event { 568=item cf::register_command $name => \&callback($ob,$args);
564 my $extension = shift;
565 my $event_code = shift;
566 569
567 my $cb = $hook[$event_code]{$extension} 570Register a callback for execution when the client sends the user command
568 or return; 571$name.
569 572
570 &$cb 573=cut
571}
572
573sub inject_global_event {
574 my $event = shift;
575
576 my $cb = $hook[$event]
577 or return;
578
579 List::Util::max map &$_, values %$cb
580}
581
582sub inject_command {
583 my ($name, $obj, $params) = @_;
584
585 for my $cmd (@{ $command{$name} }) {
586 $cmd->[1]->($obj, $params);
587 }
588
589 -1
590}
591 574
592sub register_command { 575sub register_command {
593 my ($name, $time, $cb) = @_; 576 my ($name, $cb) = @_;
594 577
595 my $caller = caller; 578 my $caller = caller;
596 #warn "registering command '$name/$time' to '$caller'"; 579 #warn "registering command '$name/$time' to '$caller'";
597 580
598 push @{ $command{$name} }, [$time, $cb, $caller]; 581 push @{ $COMMAND{$name} }, [$caller, $cb];
599 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
600} 582}
583
584=item cf::register_extcmd $name => \&callback($pl,$packet);
585
586Register a callbackf ro execution when the client sends an extcmd packet.
587
588If the callback returns something, it is sent back as if reply was being
589called.
590
591=cut
601 592
602sub register_extcmd { 593sub register_extcmd {
603 my ($name, $cb) = @_; 594 my ($name, $cb) = @_;
604 595
605 my $caller = caller; 596 my $caller = caller;
606 #warn "registering extcmd '$name' to '$caller'"; 597 #warn "registering extcmd '$name' to '$caller'";
607 598
608 $extcmd{$name} = [$cb, $caller]; 599 $EXTCMD{$name} = [$cb, $caller];
609} 600}
601
602cf::player->attach (
603 on_command => sub {
604 my ($pl, $name, $params) = @_;
605
606 my $cb = $COMMAND{$name}
607 or return;
608
609 for my $cmd (@$cb) {
610 $cmd->[1]->($pl->ob, $params);
611 }
612
613 cf::override;
614 },
615 on_extcmd => sub {
616 my ($pl, $buf) = @_;
617
618 my $msg = eval { from_json $buf };
619
620 if (ref $msg) {
621 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
622 if (my %reply = $cb->[0]->($pl, $msg)) {
623 $pl->ext_reply ($msg->{msgid}, %reply);
624 }
625 }
626 } else {
627 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
628 }
629
630 cf::override;
631 },
632);
610 633
611sub register { 634sub register {
612 my ($base, $pkg) = @_; 635 my ($base, $pkg) = @_;
613 636
614 #TODO 637 #TODO
633 . "#line 1 \"$path\"\n{\n" 656 . "#line 1 \"$path\"\n{\n"
634 . (do { local $/; <$fh> }) 657 . (do { local $/; <$fh> })
635 . "\n};\n1"; 658 . "\n};\n1";
636 659
637 eval $source 660 eval $source
638 or die "$path: $@"; 661 or die $@ ? "$path: $@\n"
662 : "extension disabled.\n";
639 663
640 push @exts, $pkg; 664 push @exts, $pkg;
641 $ext_pkg{$base} = $pkg; 665 $ext_pkg{$base} = $pkg;
642 666
643# no strict 'refs'; 667# no strict 'refs';
656# for my $idx (0 .. $#PLUGIN_EVENT) { 680# for my $idx (0 .. $#PLUGIN_EVENT) {
657# delete $hook[$idx]{$pkg}; 681# delete $hook[$idx]{$pkg};
658# } 682# }
659 683
660 # remove commands 684 # remove commands
661 for my $name (keys %command) { 685 for my $name (keys %COMMAND) {
662 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 686 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
663 687
664 if (@cb) { 688 if (@cb) {
665 $command{$name} = \@cb; 689 $COMMAND{$name} = \@cb;
666 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
667 } else { 690 } else {
668 delete $command{$name};
669 delete $COMMAND{"$name\000"}; 691 delete $COMMAND{$name};
670 } 692 }
671 } 693 }
672 694
673 # remove extcmds 695 # remove extcmds
674 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 696 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
675 delete $extcmd{$name}; 697 delete $EXTCMD{$name};
676 } 698 }
677 699
678 if (my $cb = $pkg->can ("unload")) { 700 if (my $cb = $pkg->can ("unload")) {
679 eval { 701 eval {
680 $cb->($pkg); 702 $cb->($pkg);
684 706
685 Symbol::delete_package $pkg; 707 Symbol::delete_package $pkg;
686} 708}
687 709
688sub load_extensions { 710sub load_extensions {
689 my $LIBDIR = maps_directory "perl";
690
691 for my $ext (<$LIBDIR/*.ext>) { 711 for my $ext (<$LIBDIR/*.ext>) {
692 next unless -r $ext; 712 next unless -r $ext;
693 eval { 713 eval {
694 load_extension $ext; 714 load_extension $ext;
695 1 715 1
696 } or warn "$ext not loaded: $@"; 716 } or warn "$ext not loaded: $@";
697 } 717 }
698} 718}
699 719
700############################################################################# 720#############################################################################
701# extcmd framework, basically convert ext <msg>
702# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
703
704attach_to_players
705 on_extcmd => sub {
706 my ($pl, $buf) = @_;
707
708 my $msg = eval { from_json $buf };
709
710 if (ref $msg) {
711 if (my $cb = $extcmd{$msg->{msgtype}}) {
712 if (my %reply = $cb->[0]->($pl, $msg)) {
713 $pl->ext_reply ($msg->{msgid}, %reply);
714 }
715 }
716 } else {
717 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
718 }
719
720 cf::override;
721 },
722;
723
724#############################################################################
725# load/save/clean perl data associated with a map 721# load/save/clean perl data associated with a map
726 722
727*cf::mapsupport::on_clean = sub { 723*cf::mapsupport::on_clean = sub {
728 my ($map) = @_; 724 my ($map) = @_;
729 725
731 defined $path or return; 727 defined $path or return;
732 728
733 unlink "$path.pst"; 729 unlink "$path.pst";
734}; 730};
735 731
736attach_to_maps prio => -10000, package => cf::mapsupport::; 732cf::map->attach (prio => -10000, package => cf::mapsupport::);
737 733
738############################################################################# 734#############################################################################
739# load/save perl data associated with player->ob objects 735# load/save perl data associated with player->ob objects
740 736
741sub all_objects(@) { 737sub all_objects(@) {
742 @_, map all_objects ($_->inv), @_ 738 @_, map all_objects ($_->inv), @_
743} 739}
744 740
745# TODO: compatibility cruft, remove when no longer needed 741# TODO: compatibility cruft, remove when no longer needed
746attach_to_players 742cf::player->attach (
747 on_load => sub { 743 on_load => sub {
748 my ($pl, $path) = @_; 744 my ($pl, $path) = @_;
749 745
750 for my $o (all_objects $pl->ob) { 746 for my $o (all_objects $pl->ob) {
751 if (my $value = $o->get_ob_key_value ("_perl_data")) { 747 if (my $value = $o->get_ob_key_value ("_perl_data")) {
753 749
754 %$o = %{ Storable::thaw pack "H*", $value }; 750 %$o = %{ Storable::thaw pack "H*", $value };
755 } 751 }
756 } 752 }
757 }, 753 },
758; 754);
759 755
760############################################################################# 756#############################################################################
761 757
762=head2 CORE EXTENSIONS 758=head2 CORE EXTENSIONS
763 759
764Functions and methods that extend core crossfire objects. 760Functions and methods that extend core crossfire objects.
761
762=head3 cf::player
765 763
766=over 4 764=over 4
767 765
768=item cf::player::exists $login 766=item cf::player::exists $login
769 767
774sub cf::player::exists($) { 772sub cf::player::exists($) {
775 cf::player::find $_[0] 773 cf::player::find $_[0]
776 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 774 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
777} 775}
778 776
777=item $player->ext_reply ($msgid, $msgtype, %msg)
778
779Sends an ext reply to the player.
780
781=cut
782
783sub cf::player::ext_reply($$$%) {
784 my ($self, $id, %msg) = @_;
785
786 $msg{msgid} = $id;
787
788 $self->send ("ext " . to_json \%msg);
789}
790
791=back
792
793=head3 cf::object::player
794
795=over 4
796
779=item $object->reply ($npc, $msg[, $flags]) 797=item $player_object->reply ($npc, $msg[, $flags])
780 798
781Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 799Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
782can be C<undef>. Does the right thing when the player is currently in a 800can be C<undef>. Does the right thing when the player is currently in a
783dialogue with the given NPC character. 801dialogue with the given NPC character.
784 802
785=cut 803=cut
786 804
787# rough implementation of a future "reply" method that works 805# rough implementation of a future "reply" method that works
788# with dialog boxes. 806# with dialog boxes.
807#TODO: the first argument must go, split into a $npc->reply_to ( method
789sub cf::object::player::reply($$$;$) { 808sub cf::object::player::reply($$$;$) {
790 my ($self, $npc, $msg, $flags) = @_; 809 my ($self, $npc, $msg, $flags) = @_;
791 810
792 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 811 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
793 812
797 $msg = $npc->name . " says: $msg" if $npc; 816 $msg = $npc->name . " says: $msg" if $npc;
798 $self->message ($msg, $flags); 817 $self->message ($msg, $flags);
799 } 818 }
800} 819}
801 820
802=item $player->ext_reply ($msgid, $msgtype, %msg) 821=item $player_object->may ("access")
803 822
804Sends an ext reply to the player. 823Returns wether the given player is authorized to access resource "access"
824(e.g. "command_wizcast").
805 825
806=cut 826=cut
807 827
808sub cf::player::ext_reply($$$%) { 828sub cf::object::player::may {
829 my ($self, $access) = @_;
830
831 $self->flag (cf::FLAG_WIZ) ||
832 (ref $cf::CFG{"may_$access"}
833 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
834 : $cf::CFG{"may_$access"})
835}
836
837=head3 cf::client
838
839=over 4
840
841=item $client->send_drawinfo ($text, $flags)
842
843Sends a drawinfo packet to the client. Circumvents output buffering so
844should not be used under normal circumstances.
845
846=cut
847
848sub cf::client::send_drawinfo {
849 my ($self, $text, $flags) = @_;
850
851 utf8::encode $text;
852 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
853}
854
855
856=item $success = $client->query ($flags, "text", \&cb)
857
858Queues a query to the client, calling the given callback with
859the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
860C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
861
862Queries can fail, so check the return code. Or don't, as queries will become
863reliable at some point in the future.
864
865=cut
866
867sub cf::client::query {
868 my ($self, $flags, $text, $cb) = @_;
869
870 return unless $self->state == ST_PLAYING
871 || $self->state == ST_SETUP
872 || $self->state == ST_CUSTOM;
873
874 $self->state (ST_CUSTOM);
875
876 utf8::encode $text;
877 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
878
879 $self->send_packet ($self->{query_queue}[0][0])
880 if @{ $self->{query_queue} } == 1;
881}
882
883cf::client->attach (
884 on_reply => sub {
885 my ($ns, $msg) = @_;
886
887 # this weird shuffling is so that direct followup queries
888 # get handled first
889 my $queue = delete $ns->{query_queue};
890
891 (shift @$queue)->[1]->($msg);
892
893 push @{ $ns->{query_queue} }, @$queue;
894
895 if (@{ $ns->{query_queue} } == @$queue) {
896 if (@$queue) {
897 $ns->send_packet ($ns->{query_queue}[0][0]);
898 } else {
899 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
900 }
901 }
902 },
903);
904
905=item $client->coro (\&cb)
906
907Create a new coroutine, running the specified callback. The coroutine will
908be automatically cancelled when the client gets destroyed (e.g. on logout,
909or loss of connection).
910
911=cut
912
913sub cf::client::coro {
809 my ($self, $id, %msg) = @_; 914 my ($self, $cb) = @_;
810 915
811 $msg{msgid} = $id; 916 my $coro; $coro = async {
917 eval {
918 $cb->();
919 };
920 warn $@ if $@;
921 delete $self->{_coro}{$coro+0};
922 };
812 923
813 $self->send ("ext " . to_json \%msg); 924 $self->{_coro}{$coro+0} = $coro;
814} 925}
926
927cf::client->attach (
928 on_destroy => sub {
929 my ($ns) = @_;
930
931 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
932 },
933);
815 934
816=back 935=back
817 936
818=cut
819
820#############################################################################
821 937
822=head2 SAFE SCRIPTING 938=head2 SAFE SCRIPTING
823 939
824Functions that provide a safe environment to compile and execute 940Functions that provide a safe environment to compile and execute
825snippets of perl code without them endangering the safety of the server 941snippets of perl code without them endangering the safety of the server
826itself. Looping constructs, I/O operators and other built-in functionality 942itself. Looping constructs, I/O operators and other built-in functionality
827is not available in the safe scripting environment, and the number of 943is not available in the safe scripting environment, and the number of
828functions and methods that cna be called is greatly reduced. 944functions and methods that can be called is greatly reduced.
829 945
830=cut 946=cut
831 947
832our $safe = new Safe "safe"; 948our $safe = new Safe "safe";
833our $safe_hole = new Safe::Hole; 949our $safe_hole = new Safe::Hole;
840 956
841=pod 957=pod
842 958
843The following fucntions and emthods are available within a safe environment: 959The following fucntions and emthods are available within a safe environment:
844 960
845 cf::object contr pay_amount pay_player 961 cf::object contr pay_amount pay_player map
846 cf::object::player player 962 cf::object::player player
847 cf::player peaceful 963 cf::player peaceful
964 cf::map trigger
848 965
849=cut 966=cut
850 967
851for ( 968for (
852 ["cf::object" => qw(contr pay_amount pay_player)], 969 ["cf::object" => qw(contr pay_amount pay_player map)],
853 ["cf::object::player" => qw(player)], 970 ["cf::object::player" => qw(player)],
854 ["cf::player" => qw(peaceful)], 971 ["cf::player" => qw(peaceful)],
972 ["cf::map" => qw(trigger)],
855) { 973) {
856 no strict 'refs'; 974 no strict 'refs';
857 my ($pkg, @funs) = @$_; 975 my ($pkg, @funs) = @$_;
858 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 976 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
859 for @funs; 977 for @funs;
969 1087
970Immediately write the database to disk I<if it is dirty>. 1088Immediately write the database to disk I<if it is dirty>.
971 1089
972=cut 1090=cut
973 1091
1092our $DB;
1093
974{ 1094{
975 my $db;
976 my $path = cf::localdir . "/database.pst"; 1095 my $path = cf::localdir . "/database.pst";
977 1096
978 sub db_load() { 1097 sub db_load() {
979 warn "loading database $path\n";#d# remove later 1098 warn "loading database $path\n";#d# remove later
980 $db = stat $path ? Storable::retrieve $path : { }; 1099 $DB = stat $path ? Storable::retrieve $path : { };
981 } 1100 }
982 1101
983 my $pid; 1102 my $pid;
984 1103
985 sub db_save() { 1104 sub db_save() {
986 warn "saving database $path\n";#d# remove later 1105 warn "saving database $path\n";#d# remove later
987 waitpid $pid, 0 if $pid; 1106 waitpid $pid, 0 if $pid;
988 if (0 == ($pid = fork)) { 1107 if (0 == ($pid = fork)) {
989 $db->{_meta}{version} = 1; 1108 $DB->{_meta}{version} = 1;
990 Storable::nstore $db, "$path~"; 1109 Storable::nstore $DB, "$path~";
991 rename "$path~", $path; 1110 rename "$path~", $path;
992 cf::_exit 0 if defined $pid; 1111 cf::_exit 0 if defined $pid;
993 } 1112 }
994 } 1113 }
995 1114
998 sub db_sync() { 1117 sub db_sync() {
999 db_save if $dirty; 1118 db_save if $dirty;
1000 undef $dirty; 1119 undef $dirty;
1001 } 1120 }
1002 1121
1003 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { 1122 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1004 db_sync; 1123 db_sync;
1005 }); 1124 });
1006 1125
1007 sub db_dirty() { 1126 sub db_dirty() {
1008 $dirty = 1; 1127 $dirty = 1;
1009 $idle->start; 1128 $idle->start;
1010 } 1129 }
1011 1130
1012 sub db_get($;$) { 1131 sub db_get($;$) {
1013 @_ >= 2 1132 @_ >= 2
1014 ? $db->{$_[0]}{$_[1]} 1133 ? $DB->{$_[0]}{$_[1]}
1015 : ($db->{$_[0]} ||= { }) 1134 : ($DB->{$_[0]} ||= { })
1016 } 1135 }
1017 1136
1018 sub db_put($$;$) { 1137 sub db_put($$;$) {
1019 if (@_ >= 3) { 1138 if (@_ >= 3) {
1020 $db->{$_[0]}{$_[1]} = $_[2]; 1139 $DB->{$_[0]}{$_[1]} = $_[2];
1021 } else { 1140 } else {
1022 $db->{$_[0]} = $_[1]; 1141 $DB->{$_[0]} = $_[1];
1023 } 1142 }
1024 db_dirty; 1143 db_dirty;
1025 } 1144 }
1026 1145
1027 attach_global 1146 cf::global->attach (
1028 prio => 10000, 1147 prio => 10000,
1029 on_cleanup => sub { 1148 on_cleanup => sub {
1030 db_sync; 1149 db_sync;
1031 }, 1150 },
1032 ; 1151 );
1033} 1152}
1034 1153
1035############################################################################# 1154#############################################################################
1036# the server's main() 1155# the server's main()
1037 1156
1058 1177
1059 $msg->("reloading..."); 1178 $msg->("reloading...");
1060 1179
1061 eval { 1180 eval {
1062 # cancel all watchers 1181 # cancel all watchers
1063 $_->cancel for Event::all_watchers; 1182 for (Event::all_watchers) {
1183 $_->cancel if $_->data & WF_AUTOCANCEL;
1184 }
1064 1185
1065 # unload all extensions 1186 # unload all extensions
1066 for (@exts) { 1187 for (@exts) {
1067 $msg->("unloading <$_>"); 1188 $msg->("unloading <$_>");
1068 unload_extension $_; 1189 unload_extension $_;
1103 #Symbol::delete_package __PACKAGE__; 1224 #Symbol::delete_package __PACKAGE__;
1104 1225
1105 # reload cf.pm 1226 # reload cf.pm
1106 $msg->("reloading cf.pm"); 1227 $msg->("reloading cf.pm");
1107 require cf; 1228 require cf;
1229 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1108 1230
1109 # load config and database again 1231 # load config and database again
1110 cf::cfg_load; 1232 cf::cfg_load;
1111 cf::db_load; 1233 cf::db_load;
1112 1234
1128 warn $_[0]; 1250 warn $_[0];
1129 print "$_[0]\n"; 1251 print "$_[0]\n";
1130 }; 1252 };
1131} 1253}
1132 1254
1255register "<global>", __PACKAGE__;
1256
1133register_command "perl-reload", 0, sub { 1257register_command "perl-reload" => sub {
1134 my ($who, $arg) = @_; 1258 my ($who, $arg) = @_;
1135 1259
1136 if ($who->flag (FLAG_WIZ)) { 1260 if ($who->flag (FLAG_WIZ)) {
1137 _perl_reload { 1261 _perl_reload {
1138 warn $_[0]; 1262 warn $_[0];
1139 $who->message ($_[0]); 1263 $who->message ($_[0]);
1140 }; 1264 };
1141 } 1265 }
1142}; 1266};
1143 1267
1144register "<global>", __PACKAGE__;
1145
1146unshift @INC, $LIBDIR; 1268unshift @INC, $LIBDIR;
1147 1269
1148$TICK_WATCHER = Event->timer ( 1270$TICK_WATCHER = Event->timer (
1149 prio => 1, 1271 prio => 0,
1150 at => $NEXT_TICK || 1, 1272 at => $NEXT_TICK || 1,
1273 data => WF_AUTOCANCEL,
1151 cb => sub { 1274 cb => sub {
1152 cf::server_tick; # one server iteration 1275 cf::server_tick; # one server iteration
1153 1276
1154 my $NOW = Event::time; 1277 my $NOW = Event::time;
1155 $NEXT_TICK += $TICK; 1278 $NEXT_TICK += $TICK;
1156 1279
1157 # if we are delayed by four ticks, skip them all 1280 # if we are delayed by four ticks or more, skip them all
1158 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1281 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1159 1282
1160 $TICK_WATCHER->at ($NEXT_TICK); 1283 $TICK_WATCHER->at ($NEXT_TICK);
1161 $TICK_WATCHER->start; 1284 $TICK_WATCHER->start;
1162 }, 1285 },
1163); 1286);
1164 1287
1288IO::AIO::max_poll_time $TICK * 0.2;
1289
1290Event->io (fd => IO::AIO::poll_fileno,
1291 poll => 'r',
1292 prio => 5,
1293 data => WF_AUTOCANCEL,
1294 cb => \&IO::AIO::poll_cb);
1295
11651 12961
1166 1297

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines