| … | |
… | |
| 11 | use Event; |
11 | use Event; |
| 12 | $Event::Eval = 1; # no idea why this is required, but it is |
12 | $Event::Eval = 1; # no idea why this is required, but it is |
| 13 | |
13 | |
| 14 | use strict; |
14 | use strict; |
| 15 | |
15 | |
| 16 | _reload_1; |
16 | _init_vars; |
| 17 | |
17 | |
| 18 | our %COMMAND = (); |
18 | our %COMMAND = (); |
| 19 | our @EVENT; |
19 | our @EVENT; |
| 20 | our %PROP_TYPE; |
|
|
| 21 | our %PROP_IDX; |
|
|
| 22 | our $LIBDIR = maps_directory "perl"; |
20 | our $LIBDIR = maps_directory "perl"; |
| 23 | |
21 | |
| 24 | our $TICK = MAX_TIME * 1e-6; |
22 | our $TICK = MAX_TIME * 1e-6; |
| 25 | our $TICK_WATCHER; |
23 | our $TICK_WATCHER; |
| 26 | our $NEXT_TICK; |
24 | our $NEXT_TICK; |
|
|
25 | |
|
|
26 | our %CFG; |
|
|
27 | |
|
|
28 | ############################################################################# |
|
|
29 | |
|
|
30 | =head2 GLOBAL VARIABLES |
|
|
31 | |
|
|
32 | =over 4 |
|
|
33 | |
|
|
34 | =item $cf::LIBDIR |
|
|
35 | |
|
|
36 | The perl library directory, where extensions and cf-specific modules can |
|
|
37 | be found. It will be added to C<@INC> automatically. |
|
|
38 | |
|
|
39 | =item $cf::TICK |
|
|
40 | |
|
|
41 | The interval between server ticks, in seconds. |
|
|
42 | |
|
|
43 | =item %cf::CFG |
|
|
44 | |
|
|
45 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
|
|
46 | from wherever your confdir points to. |
|
|
47 | |
|
|
48 | =back |
|
|
49 | |
|
|
50 | =cut |
| 27 | |
51 | |
| 28 | BEGIN { |
52 | BEGIN { |
| 29 | *CORE::GLOBAL::warn = sub { |
53 | *CORE::GLOBAL::warn = sub { |
| 30 | my $msg = join "", @_; |
54 | my $msg = join "", @_; |
| 31 | $msg .= "\n" |
55 | $msg .= "\n" |
| … | |
… | |
| 34 | print STDERR "cfperl: $msg"; |
58 | print STDERR "cfperl: $msg"; |
| 35 | LOG llevError, "cfperl: $msg"; |
59 | LOG llevError, "cfperl: $msg"; |
| 36 | }; |
60 | }; |
| 37 | } |
61 | } |
| 38 | |
62 | |
| 39 | my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
|
|
| 40 | |
|
|
| 41 | # generate property mutators |
|
|
| 42 | sub prop_gen { |
|
|
| 43 | my ($prefix, $class) = @_; |
|
|
| 44 | |
|
|
| 45 | no strict 'refs'; |
|
|
| 46 | |
|
|
| 47 | for my $prop (keys %PROP_TYPE) { |
|
|
| 48 | $prop =~ /^\Q$prefix\E_(.*$)/ or next; |
|
|
| 49 | my $sub = lc $1; |
|
|
| 50 | |
|
|
| 51 | my $type = $PROP_TYPE{$prop}; |
|
|
| 52 | my $idx = $PROP_IDX {$prop}; |
|
|
| 53 | |
|
|
| 54 | *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { |
|
|
| 55 | $_[0]->get_property ($type, $idx) |
|
|
| 56 | }; |
|
|
| 57 | |
|
|
| 58 | *{"$class\::set_$sub"} = sub { |
|
|
| 59 | $_[0]->set_property ($type, $idx, $_[1]); |
|
|
| 60 | } unless $ignore_set{$prop}; |
|
|
| 61 | } |
|
|
| 62 | } |
|
|
| 63 | |
|
|
| 64 | # auto-generate most of the API |
|
|
| 65 | |
|
|
| 66 | prop_gen OBJECT_PROP => "cf::object"; |
|
|
| 67 | # CFAPI_OBJECT_ANIMATION? |
|
|
| 68 | prop_gen PLAYER_PROP => "cf::object::player"; |
|
|
| 69 | |
|
|
| 70 | prop_gen MAP_PROP => "cf::map"; |
|
|
| 71 | prop_gen ARCH_PROP => "cf::arch"; |
|
|
| 72 | |
|
|
| 73 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
63 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
| 74 | |
64 | |
| 75 | # we bless all objects into (empty) derived classes to force a method lookup |
65 | # we bless all objects into (empty) derived classes to force a method lookup |
| 76 | # within the Safe compartment. |
66 | # within the Safe compartment. |
| 77 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
67 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
| … | |
… | |
| 87 | my @exts; |
77 | my @exts; |
| 88 | my @hook; |
78 | my @hook; |
| 89 | my %command; |
79 | my %command; |
| 90 | my %extcmd; |
80 | my %extcmd; |
| 91 | |
81 | |
| 92 | ############################################################################# |
82 | =head2 UTILITY FUNCTIONS |
| 93 | # utility functions |
83 | |
|
|
84 | =over 4 |
|
|
85 | |
|
|
86 | =cut |
| 94 | |
87 | |
| 95 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
88 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
89 | |
|
|
90 | =item $ref = cf::from_json $json |
|
|
91 | |
|
|
92 | Converts a JSON string into the corresponding perl data structure. |
|
|
93 | |
|
|
94 | =cut |
| 96 | |
95 | |
| 97 | sub from_json($) { |
96 | sub from_json($) { |
| 98 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
97 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
| 99 | JSON::Syck::Load $_[0] |
98 | JSON::Syck::Load $_[0] |
| 100 | } |
99 | } |
| 101 | |
100 | |
|
|
101 | =item $json = cf::to_json $ref |
|
|
102 | |
|
|
103 | Converts a perl data structure into its JSON representation. |
|
|
104 | |
|
|
105 | =cut |
|
|
106 | |
| 102 | sub to_json($) { |
107 | sub to_json($) { |
| 103 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
108 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
| 104 | JSON::Syck::Dump $_[0] |
109 | JSON::Syck::Dump $_[0] |
| 105 | } |
110 | } |
| 106 | |
111 | |
|
|
112 | =back |
|
|
113 | |
| 107 | ############################################################################# |
114 | ############################################################################# |
| 108 | # "new" plug-in system |
115 | |
|
|
116 | =head2 EVENTS AND OBJECT ATTACHMENTS |
|
|
117 | |
|
|
118 | =over 4 |
| 109 | |
119 | |
| 110 | =item $object->attach ($attachment, key => $value...) |
120 | =item $object->attach ($attachment, key => $value...) |
| 111 | |
121 | |
| 112 | =item $object->detach ($attachment) |
122 | =item $object->detach ($attachment) |
| 113 | |
123 | |
| … | |
… | |
| 122 | =item $map->attach ($attachment, key => $value...) |
132 | =item $map->attach ($attachment, key => $value...) |
| 123 | |
133 | |
| 124 | =item $map->detach ($attachment) |
134 | =item $map->detach ($attachment) |
| 125 | |
135 | |
| 126 | Attach/detach a pre-registered attachment to a map. |
136 | Attach/detach a pre-registered attachment to a map. |
|
|
137 | |
|
|
138 | =item $bool = $object->attached ($name) |
|
|
139 | |
|
|
140 | =item $bool = $player->attached ($name) |
|
|
141 | |
|
|
142 | =item $bool = $map->attached ($name) |
|
|
143 | |
|
|
144 | Checks wether the named attachment is currently attached to the object. |
| 127 | |
145 | |
| 128 | =item cf::attach_global ... |
146 | =item cf::attach_global ... |
| 129 | |
147 | |
| 130 | Attach handlers for global events. |
148 | Attach handlers for global events. |
| 131 | |
149 | |
| … | |
… | |
| 181 | Attach handlers to all maps. |
199 | Attach handlers to all maps. |
| 182 | |
200 | |
| 183 | =item cf:register_attachment $name, ... |
201 | =item cf:register_attachment $name, ... |
| 184 | |
202 | |
| 185 | Register an attachment by name through which objects can refer to this |
203 | Register an attachment by name through which objects can refer to this |
|
|
204 | attachment. |
|
|
205 | |
|
|
206 | =item cf:register_player_attachment $name, ... |
|
|
207 | |
|
|
208 | Register an attachment by name through which players can refer to this |
| 186 | attachment. |
209 | attachment. |
| 187 | |
210 | |
| 188 | =item cf:register_map_attachment $name, ... |
211 | =item cf:register_map_attachment $name, ... |
| 189 | |
212 | |
| 190 | Register an attachment by name through which maps can refer to this |
213 | Register an attachment by name through which maps can refer to this |
| … | |
… | |
| 261 | } |
284 | } |
| 262 | |
285 | |
| 263 | sub _attach_attachment { |
286 | sub _attach_attachment { |
| 264 | my ($obj, $name, %arg) = @_; |
287 | my ($obj, $name, %arg) = @_; |
| 265 | |
288 | |
|
|
289 | return if exists $obj->{_attachment}{$name}; |
|
|
290 | |
| 266 | my $res; |
291 | my $res; |
| 267 | |
292 | |
| 268 | if (my $attach = $attachment{$name}) { |
293 | if (my $attach = $attachment{$name}) { |
| 269 | my $registry = $obj->registry; |
294 | my $registry = $obj->registry; |
| 270 | |
295 | |
| … | |
… | |
| 288 | *cf::player::attach = |
313 | *cf::player::attach = |
| 289 | *cf::map::attach = sub { |
314 | *cf::map::attach = sub { |
| 290 | my ($obj, $name, %arg) = @_; |
315 | my ($obj, $name, %arg) = @_; |
| 291 | |
316 | |
| 292 | _attach_attachment $obj, $name, %arg; |
317 | _attach_attachment $obj, $name, %arg; |
| 293 | } |
318 | }; |
| 294 | |
319 | |
| 295 | # all those should be optimised |
320 | # all those should be optimised |
| 296 | *cf::object::detach = |
321 | *cf::object::detach = |
| 297 | *cf::player::detach = |
322 | *cf::player::detach = |
| 298 | *cf::map::detach = sub { |
323 | *cf::map::detach = sub { |
| 299 | my ($obj, $name) = @_; |
324 | my ($obj, $name) = @_; |
| 300 | |
325 | |
| 301 | delete $obj->{_attachment}{$name}; |
326 | delete $obj->{_attachment}{$name}; |
| 302 | reattach $obj; |
327 | reattach ($obj); |
|
|
328 | }; |
|
|
329 | |
|
|
330 | *cf::object::attached = |
|
|
331 | *cf::player::attached = |
|
|
332 | *cf::map::attached = sub { |
|
|
333 | my ($obj, $name) = @_; |
|
|
334 | |
|
|
335 | exists $obj->{_attachment}{$name} |
| 303 | }; |
336 | }; |
| 304 | |
337 | |
| 305 | sub attach_global { |
338 | sub attach_global { |
| 306 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
339 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
| 307 | } |
340 | } |
| … | |
… | |
| 329 | my $name = shift; |
362 | my $name = shift; |
| 330 | |
363 | |
| 331 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
364 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
| 332 | } |
365 | } |
| 333 | |
366 | |
|
|
367 | sub register_player_attachment { |
|
|
368 | my $name = shift; |
|
|
369 | |
|
|
370 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
371 | } |
|
|
372 | |
| 334 | sub register_map_attachment { |
373 | sub register_map_attachment { |
| 335 | my $name = shift; |
374 | my $name = shift; |
| 336 | |
375 | |
| 337 | $attachment{$name} = [[KLASS_MAP, @_]]; |
376 | $attachment{$name} = [[KLASS_MAP, @_]]; |
| 338 | } |
377 | } |
| … | |
… | |
| 356 | for (@$callbacks) { |
395 | for (@$callbacks) { |
| 357 | eval { &{$_->[1]} }; |
396 | eval { &{$_->[1]} }; |
| 358 | |
397 | |
| 359 | if ($@) { |
398 | if ($@) { |
| 360 | warn "$@"; |
399 | warn "$@"; |
| 361 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
400 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
| 362 | override; |
401 | override; |
| 363 | } |
402 | } |
| 364 | |
403 | |
| 365 | return 1 if $override; |
404 | return 1 if $override; |
| 366 | } |
405 | } |
| 367 | |
406 | |
| 368 | 0 |
407 | 0 |
| 369 | } |
408 | } |
|
|
409 | |
|
|
410 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
|
|
411 | |
|
|
412 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
413 | |
|
|
414 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
415 | |
|
|
416 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
417 | |
|
|
418 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
419 | |
|
|
420 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
421 | removed in future versions), and there is no public API to access override |
|
|
422 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
423 | |
|
|
424 | =back |
|
|
425 | |
|
|
426 | ############################################################################# |
|
|
427 | |
|
|
428 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
|
|
429 | |
|
|
430 | =over 4 |
|
|
431 | |
|
|
432 | =item $object->valid, $player->valid, $map->valid |
|
|
433 | |
|
|
434 | Just because you have a perl object does not mean that the corresponding |
|
|
435 | C-level object still exists. If you try to access an object that has no |
|
|
436 | valid C counterpart anymore you get an exception at runtime. This method |
|
|
437 | can be used to test for existence of the C object part without causing an |
|
|
438 | exception. |
|
|
439 | |
|
|
440 | =back |
|
|
441 | |
|
|
442 | =cut |
|
|
443 | |
|
|
444 | *cf::object::valid = |
|
|
445 | *cf::player::valid = |
|
|
446 | *cf::map::valid = \&cf::_valid; |
| 370 | |
447 | |
| 371 | ############################################################################# |
448 | ############################################################################# |
| 372 | # object support |
449 | # object support |
| 373 | |
450 | |
| 374 | sub instantiate { |
451 | sub instantiate { |
| … | |
… | |
| 403 | } |
480 | } |
| 404 | } |
481 | } |
| 405 | } |
482 | } |
| 406 | |
483 | |
| 407 | sub object_freezer_save { |
484 | sub object_freezer_save { |
| 408 | my ($filename, $objs) = @_; |
485 | my ($filename, $rdata, $objs) = @_; |
| 409 | |
486 | |
| 410 | if (@$objs) { |
487 | if (length $$rdata) { |
|
|
488 | warn sprintf "saving %s (%d,%d)\n", |
|
|
489 | $filename, length $$rdata, scalar @$objs; |
|
|
490 | |
| 411 | open my $fh, ">:raw", "$filename.pst~"; |
491 | if (open my $fh, ">:raw", "$filename~") { |
|
|
492 | chmod SAVE_MODE, $fh; |
|
|
493 | syswrite $fh, $$rdata; |
|
|
494 | close $fh; |
|
|
495 | |
|
|
496 | if (@$objs && open my $fh, ">:raw", "$filename.pst~") { |
|
|
497 | chmod SAVE_MODE, $fh; |
| 412 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
498 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
| 413 | close $fh; |
499 | close $fh; |
| 414 | chmod SAVE_MODE, "$filename.pst~"; |
|
|
| 415 | rename "$filename.pst~", "$filename.pst"; |
500 | rename "$filename.pst~", "$filename.pst"; |
|
|
501 | } else { |
|
|
502 | unlink "$filename.pst"; |
|
|
503 | } |
|
|
504 | |
|
|
505 | rename "$filename~", $filename; |
|
|
506 | } else { |
|
|
507 | warn "FATAL: $filename~: $!\n"; |
|
|
508 | } |
| 416 | } else { |
509 | } else { |
|
|
510 | unlink $filename; |
| 417 | unlink "$filename.pst"; |
511 | unlink "$filename.pst"; |
| 418 | } |
512 | } |
| 419 | |
|
|
| 420 | chmod SAVE_MODE, "$filename~"; |
|
|
| 421 | rename "$filename~", $filename; |
|
|
| 422 | } |
513 | } |
| 423 | |
514 | |
| 424 | sub object_thawer_load { |
515 | sub object_thawer_load { |
| 425 | my ($filename) = @_; |
516 | my ($filename) = @_; |
| 426 | |
517 | |
|
|
518 | local $/; |
|
|
519 | |
|
|
520 | my $av; |
|
|
521 | |
|
|
522 | #TODO: use sysread etc. |
|
|
523 | if (open my $data, "<:raw:perlio", $filename) { |
|
|
524 | $data = <$data>; |
| 427 | open my $fh, "<:raw:perlio", "$filename.pst" |
525 | if (open my $pst, "<:raw:perlio", "$filename.pst") { |
| 428 | or return; |
526 | $av = eval { (Storable::thaw <$pst>)->{objs} }; |
|
|
527 | } |
|
|
528 | return ($data, $av); |
|
|
529 | } |
| 429 | |
530 | |
| 430 | eval { local $/; (Storable::thaw <$fh>)->{objs} } |
531 | () |
| 431 | } |
532 | } |
| 432 | |
533 | |
| 433 | attach_to_objects |
534 | attach_to_objects |
| 434 | prio => -1000000, |
535 | prio => -1000000, |
| 435 | on_clone => sub { |
536 | on_clone => sub { |
| … | |
… | |
| 581 | load_extension $ext; |
682 | load_extension $ext; |
| 582 | 1 |
683 | 1 |
| 583 | } or warn "$ext not loaded: $@"; |
684 | } or warn "$ext not loaded: $@"; |
| 584 | } |
685 | } |
| 585 | } |
686 | } |
| 586 | |
|
|
| 587 | sub _perl_reload(&) { |
|
|
| 588 | my ($msg) = @_; |
|
|
| 589 | |
|
|
| 590 | $msg->("reloading..."); |
|
|
| 591 | |
|
|
| 592 | eval { |
|
|
| 593 | # 1. cancel all watchers |
|
|
| 594 | $_->cancel for Event::all_watchers; |
|
|
| 595 | |
|
|
| 596 | # 2. unload all extensions |
|
|
| 597 | for (@exts) { |
|
|
| 598 | $msg->("unloading <$_>"); |
|
|
| 599 | unload_extension $_; |
|
|
| 600 | } |
|
|
| 601 | |
|
|
| 602 | # 3. unload all modules loaded from $LIBDIR |
|
|
| 603 | while (my ($k, $v) = each %INC) { |
|
|
| 604 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
| 605 | |
|
|
| 606 | $msg->("removing <$k>"); |
|
|
| 607 | delete $INC{$k}; |
|
|
| 608 | |
|
|
| 609 | $k =~ s/\.pm$//; |
|
|
| 610 | $k =~ s/\//::/g; |
|
|
| 611 | |
|
|
| 612 | if (my $cb = $k->can ("unload_module")) { |
|
|
| 613 | $cb->(); |
|
|
| 614 | } |
|
|
| 615 | |
|
|
| 616 | Symbol::delete_package $k; |
|
|
| 617 | } |
|
|
| 618 | |
|
|
| 619 | # 4. get rid of safe::, as good as possible |
|
|
| 620 | Symbol::delete_package "safe::$_" |
|
|
| 621 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
| 622 | |
|
|
| 623 | # 5. remove register_script_function callbacks |
|
|
| 624 | # TODO |
|
|
| 625 | |
|
|
| 626 | # 6. unload cf.pm "a bit" |
|
|
| 627 | delete $INC{"cf.pm"}; |
|
|
| 628 | |
|
|
| 629 | # don't, removes xs symbols, too, |
|
|
| 630 | # and global variables created in xs |
|
|
| 631 | #Symbol::delete_package __PACKAGE__; |
|
|
| 632 | |
|
|
| 633 | # 7. reload cf.pm |
|
|
| 634 | $msg->("reloading cf.pm"); |
|
|
| 635 | require cf; |
|
|
| 636 | }; |
|
|
| 637 | $msg->($@) if $@; |
|
|
| 638 | |
|
|
| 639 | $msg->("reloaded"); |
|
|
| 640 | }; |
|
|
| 641 | |
|
|
| 642 | sub perl_reload() { |
|
|
| 643 | _perl_reload { |
|
|
| 644 | warn $_[0]; |
|
|
| 645 | print "$_[0]\n"; |
|
|
| 646 | }; |
|
|
| 647 | } |
|
|
| 648 | |
|
|
| 649 | register_command "perl-reload", 0, sub { |
|
|
| 650 | my ($who, $arg) = @_; |
|
|
| 651 | |
|
|
| 652 | if ($who->flag (FLAG_WIZ)) { |
|
|
| 653 | _perl_reload { |
|
|
| 654 | warn $_[0]; |
|
|
| 655 | $who->message ($_[0]); |
|
|
| 656 | }; |
|
|
| 657 | } |
|
|
| 658 | }; |
|
|
| 659 | |
687 | |
| 660 | ############################################################################# |
688 | ############################################################################# |
| 661 | # extcmd framework, basically convert ext <msg> |
689 | # extcmd framework, basically convert ext <msg> |
| 662 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
690 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
| 663 | |
691 | |
| … | |
… | |
| 691 | defined $path or return; |
719 | defined $path or return; |
| 692 | |
720 | |
| 693 | unlink "$path.pst"; |
721 | unlink "$path.pst"; |
| 694 | }; |
722 | }; |
| 695 | |
723 | |
| 696 | # old style persistent data, TODO: remove #d# |
|
|
| 697 | *cf::mapsupport::on_swapin = |
|
|
| 698 | *cf::mapsupport::on_load = sub { |
|
|
| 699 | my ($map) = @_; |
|
|
| 700 | |
|
|
| 701 | my $path = $map->tmpname; |
|
|
| 702 | $path = $map->path unless defined $path; |
|
|
| 703 | |
|
|
| 704 | open my $fh, "<:raw", "$path.cfperl" |
|
|
| 705 | or return; # no perl data |
|
|
| 706 | |
|
|
| 707 | my $data = Storable::thaw do { local $/; <$fh> }; |
|
|
| 708 | |
|
|
| 709 | $data->{version} <= 1 |
|
|
| 710 | or return; # too new |
|
|
| 711 | |
|
|
| 712 | $map->_set_obs ($data->{obs}); |
|
|
| 713 | $map->invoke (EVENT_MAP_UPGRADE); |
|
|
| 714 | }; |
|
|
| 715 | |
|
|
| 716 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
724 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
| 717 | |
725 | |
| 718 | ############################################################################# |
726 | ############################################################################# |
| 719 | # load/save perl data associated with player->ob objects |
727 | # load/save perl data associated with player->ob objects |
| 720 | |
728 | |
| 721 | sub all_objects(@) { |
729 | sub all_objects(@) { |
| 722 | @_, map all_objects ($_->inv), @_ |
730 | @_, map all_objects ($_->inv), @_ |
| 723 | } |
731 | } |
| 724 | |
732 | |
|
|
733 | # TODO: compatibility cruft, remove when no longer needed |
| 725 | attach_to_players |
734 | attach_to_players |
| 726 | on_load => sub { |
735 | on_load => sub { |
| 727 | my ($pl, $path) = @_; |
736 | my ($pl, $path) = @_; |
| 728 | |
737 | |
| 729 | for my $o (all_objects $pl->ob) { |
738 | for my $o (all_objects $pl->ob) { |
| … | |
… | |
| 735 | } |
744 | } |
| 736 | }, |
745 | }, |
| 737 | ; |
746 | ; |
| 738 | |
747 | |
| 739 | ############################################################################# |
748 | ############################################################################# |
| 740 | # core extensions - in perl |
749 | |
|
|
750 | =head2 CORE EXTENSIONS |
|
|
751 | |
|
|
752 | Functions and methods that extend core crossfire objects. |
|
|
753 | |
|
|
754 | =over 4 |
| 741 | |
755 | |
| 742 | =item cf::player::exists $login |
756 | =item cf::player::exists $login |
| 743 | |
757 | |
| 744 | Returns true when the given account exists. |
758 | Returns true when the given account exists. |
| 745 | |
759 | |
| … | |
… | |
| 785 | $msg{msgid} = $id; |
799 | $msg{msgid} = $id; |
| 786 | |
800 | |
| 787 | $self->send ("ext " . to_json \%msg); |
801 | $self->send ("ext " . to_json \%msg); |
| 788 | } |
802 | } |
| 789 | |
803 | |
|
|
804 | =back |
|
|
805 | |
|
|
806 | =cut |
|
|
807 | |
| 790 | ############################################################################# |
808 | ############################################################################# |
| 791 | # map scripting support |
809 | |
|
|
810 | =head2 SAFE SCRIPTING |
|
|
811 | |
|
|
812 | Functions that provide a safe environment to compile and execute |
|
|
813 | snippets of perl code without them endangering the safety of the server |
|
|
814 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
815 | is not available in the safe scripting environment, and the number of |
|
|
816 | functions and methods that cna be called is greatly reduced. |
|
|
817 | |
|
|
818 | =cut |
| 792 | |
819 | |
| 793 | our $safe = new Safe "safe"; |
820 | our $safe = new Safe "safe"; |
| 794 | our $safe_hole = new Safe::Hole; |
821 | our $safe_hole = new Safe::Hole; |
| 795 | |
822 | |
| 796 | $SIG{FPE} = 'IGNORE'; |
823 | $SIG{FPE} = 'IGNORE'; |
| 797 | |
824 | |
| 798 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
825 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
| 799 | |
826 | |
| 800 | # here we export the classes and methods available to script code |
827 | # here we export the classes and methods available to script code |
|
|
828 | |
|
|
829 | =pod |
|
|
830 | |
|
|
831 | The following fucntions and emthods are available within a safe environment: |
|
|
832 | |
|
|
833 | cf::object contr pay_amount pay_player |
|
|
834 | cf::object::player player |
|
|
835 | cf::player peaceful |
|
|
836 | |
|
|
837 | =cut |
| 801 | |
838 | |
| 802 | for ( |
839 | for ( |
| 803 | ["cf::object" => qw(contr pay_amount pay_player)], |
840 | ["cf::object" => qw(contr pay_amount pay_player)], |
| 804 | ["cf::object::player" => qw(player)], |
841 | ["cf::object::player" => qw(player)], |
| 805 | ["cf::player" => qw(peaceful)], |
842 | ["cf::player" => qw(peaceful)], |
| … | |
… | |
| 808 | my ($pkg, @funs) = @$_; |
845 | my ($pkg, @funs) = @$_; |
| 809 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
846 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
| 810 | for @funs; |
847 | for @funs; |
| 811 | } |
848 | } |
| 812 | |
849 | |
|
|
850 | =over 4 |
|
|
851 | |
|
|
852 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
853 | |
|
|
854 | Compiled and executes the given perl code snippet. additional var/value |
|
|
855 | pairs result in temporary local (my) scalar variables of the given name |
|
|
856 | that are available in the code snippet. Example: |
|
|
857 | |
|
|
858 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
859 | |
|
|
860 | =cut |
|
|
861 | |
| 813 | sub safe_eval($;@) { |
862 | sub safe_eval($;@) { |
| 814 | my ($code, %vars) = @_; |
863 | my ($code, %vars) = @_; |
| 815 | |
864 | |
| 816 | my $qcode = $code; |
865 | my $qcode = $code; |
| 817 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
866 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
| … | |
… | |
| 839 | } |
888 | } |
| 840 | |
889 | |
| 841 | wantarray ? @res : $res[0] |
890 | wantarray ? @res : $res[0] |
| 842 | } |
891 | } |
| 843 | |
892 | |
|
|
893 | =item cf::register_script_function $function => $cb |
|
|
894 | |
|
|
895 | Register a function that can be called from within map/npc scripts. The |
|
|
896 | function should be reasonably secure and should be put into a package name |
|
|
897 | like the extension. |
|
|
898 | |
|
|
899 | Example: register a function that gets called whenever a map script calls |
|
|
900 | C<rent::overview>, as used by the C<rent> extension. |
|
|
901 | |
|
|
902 | cf::register_script_function "rent::overview" => sub { |
|
|
903 | ... |
|
|
904 | }; |
|
|
905 | |
|
|
906 | =cut |
|
|
907 | |
| 844 | sub register_script_function { |
908 | sub register_script_function { |
| 845 | my ($fun, $cb) = @_; |
909 | my ($fun, $cb) = @_; |
| 846 | |
910 | |
| 847 | no strict 'refs'; |
911 | no strict 'refs'; |
| 848 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
912 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
| 849 | } |
913 | } |
| 850 | |
914 | |
|
|
915 | =back |
|
|
916 | |
|
|
917 | ############################################################################# |
|
|
918 | |
|
|
919 | =head2 EXTENSION DATABASE SUPPORT |
|
|
920 | |
|
|
921 | Crossfire maintains a very simple database for extension use. It can |
|
|
922 | currently store anything that can be serialised using Storable, which |
|
|
923 | excludes objects. |
|
|
924 | |
|
|
925 | The parameter C<$family> should best start with the name of the extension |
|
|
926 | using it, it should be unique. |
|
|
927 | |
|
|
928 | =over 4 |
|
|
929 | |
|
|
930 | =item $hashref = cf::db_get $family |
|
|
931 | |
|
|
932 | Return a hashref for use by the extension C<$family>, which can be |
|
|
933 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
934 | C<cf::db_sync>. |
|
|
935 | |
|
|
936 | =item $value = cf::db_get $family => $key |
|
|
937 | |
|
|
938 | Returns a single value from the database |
|
|
939 | |
|
|
940 | =item cf::db_put $family => $hashref |
|
|
941 | |
|
|
942 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
943 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
944 | |
|
|
945 | =item cf::db_put $family => $key => $value |
|
|
946 | |
|
|
947 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
948 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
949 | |
|
|
950 | =item cf::db_dirty |
|
|
951 | |
|
|
952 | Marks the database as dirty, to be updated at a later time. |
|
|
953 | |
|
|
954 | =item cf::db_sync |
|
|
955 | |
|
|
956 | Immediately write the database to disk I<if it is dirty>. |
|
|
957 | |
|
|
958 | =cut |
|
|
959 | |
|
|
960 | { |
|
|
961 | my $db; |
|
|
962 | my $path = cf::localdir . "/database.pst"; |
|
|
963 | |
|
|
964 | sub db_load() { |
|
|
965 | warn "loading database $path\n";#d# remove later |
|
|
966 | $db = stat $path ? Storable::retrieve $path : { }; |
|
|
967 | } |
|
|
968 | |
|
|
969 | my $pid; |
|
|
970 | |
|
|
971 | sub db_save() { |
|
|
972 | warn "saving database $path\n";#d# remove later |
|
|
973 | waitpid $pid, 0 if $pid; |
|
|
974 | if (0 == ($pid = fork)) { |
|
|
975 | $db->{_meta}{version} = 1; |
|
|
976 | Storable::nstore $db, "$path~"; |
|
|
977 | rename "$path~", $path; |
|
|
978 | cf::_exit 0 if defined $pid; |
|
|
979 | } |
|
|
980 | } |
|
|
981 | |
|
|
982 | my $dirty; |
|
|
983 | |
|
|
984 | sub db_sync() { |
|
|
985 | db_save if $dirty; |
|
|
986 | undef $dirty; |
|
|
987 | } |
|
|
988 | |
|
|
989 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
|
|
990 | db_sync; |
|
|
991 | }); |
|
|
992 | |
|
|
993 | sub db_dirty() { |
|
|
994 | $dirty = 1; |
|
|
995 | $idle->start; |
|
|
996 | } |
|
|
997 | |
|
|
998 | sub db_get($;$) { |
|
|
999 | @_ >= 2 |
|
|
1000 | ? $db->{$_[0]}{$_[1]} |
|
|
1001 | : ($db->{$_[0]} ||= { }) |
|
|
1002 | } |
|
|
1003 | |
|
|
1004 | sub db_put($$;$) { |
|
|
1005 | if (@_ >= 3) { |
|
|
1006 | $db->{$_[0]}{$_[1]} = $_[2]; |
|
|
1007 | } else { |
|
|
1008 | $db->{$_[0]} = $_[1]; |
|
|
1009 | } |
|
|
1010 | db_dirty; |
|
|
1011 | } |
|
|
1012 | |
|
|
1013 | attach_global |
|
|
1014 | prio => 10000, |
|
|
1015 | on_cleanup => sub { |
|
|
1016 | db_sync; |
|
|
1017 | }, |
|
|
1018 | ; |
|
|
1019 | } |
|
|
1020 | |
| 851 | ############################################################################# |
1021 | ############################################################################# |
| 852 | # the server's main() |
1022 | # the server's main() |
| 853 | |
1023 | |
| 854 | sub main { |
1024 | sub main { |
|
|
1025 | db_load; |
|
|
1026 | load_extensions; |
| 855 | Event::loop; |
1027 | Event::loop; |
| 856 | } |
1028 | } |
| 857 | |
1029 | |
| 858 | ############################################################################# |
1030 | ############################################################################# |
| 859 | # initialisation |
1031 | # initialisation |
| 860 | |
1032 | |
|
|
1033 | sub _perl_reload(&) { |
|
|
1034 | my ($msg) = @_; |
|
|
1035 | |
|
|
1036 | $msg->("reloading..."); |
|
|
1037 | |
|
|
1038 | eval { |
|
|
1039 | # cancel all watchers |
|
|
1040 | $_->cancel for Event::all_watchers; |
|
|
1041 | |
|
|
1042 | # unload all extensions |
|
|
1043 | for (@exts) { |
|
|
1044 | $msg->("unloading <$_>"); |
|
|
1045 | unload_extension $_; |
|
|
1046 | } |
|
|
1047 | |
|
|
1048 | # unload all modules loaded from $LIBDIR |
|
|
1049 | while (my ($k, $v) = each %INC) { |
|
|
1050 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
1051 | |
|
|
1052 | $msg->("removing <$k>"); |
|
|
1053 | delete $INC{$k}; |
|
|
1054 | |
|
|
1055 | $k =~ s/\.pm$//; |
|
|
1056 | $k =~ s/\//::/g; |
|
|
1057 | |
|
|
1058 | if (my $cb = $k->can ("unload_module")) { |
|
|
1059 | $cb->(); |
|
|
1060 | } |
|
|
1061 | |
|
|
1062 | Symbol::delete_package $k; |
|
|
1063 | } |
|
|
1064 | |
|
|
1065 | # sync database to disk |
|
|
1066 | cf::db_sync; |
|
|
1067 | |
|
|
1068 | # get rid of safe::, as good as possible |
|
|
1069 | Symbol::delete_package "safe::$_" |
|
|
1070 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
1071 | |
|
|
1072 | # remove register_script_function callbacks |
|
|
1073 | # TODO |
|
|
1074 | |
|
|
1075 | # unload cf.pm "a bit" |
|
|
1076 | delete $INC{"cf.pm"}; |
|
|
1077 | |
|
|
1078 | # don't, removes xs symbols, too, |
|
|
1079 | # and global variables created in xs |
|
|
1080 | #Symbol::delete_package __PACKAGE__; |
|
|
1081 | |
|
|
1082 | # reload cf.pm |
|
|
1083 | $msg->("reloading cf.pm"); |
|
|
1084 | require cf; |
|
|
1085 | |
|
|
1086 | # load database again |
|
|
1087 | cf::db_load; |
|
|
1088 | |
|
|
1089 | # load extensions |
|
|
1090 | $msg->("load extensions"); |
|
|
1091 | cf::load_extensions; |
|
|
1092 | |
|
|
1093 | # reattach attachments to objects |
|
|
1094 | $msg->("reattach"); |
|
|
1095 | _global_reattach; |
|
|
1096 | }; |
|
|
1097 | $msg->($@) if $@; |
|
|
1098 | |
|
|
1099 | $msg->("reloaded"); |
|
|
1100 | }; |
|
|
1101 | |
|
|
1102 | sub perl_reload() { |
|
|
1103 | _perl_reload { |
|
|
1104 | warn $_[0]; |
|
|
1105 | print "$_[0]\n"; |
|
|
1106 | }; |
|
|
1107 | } |
|
|
1108 | |
|
|
1109 | register_command "perl-reload", 0, sub { |
|
|
1110 | my ($who, $arg) = @_; |
|
|
1111 | |
|
|
1112 | if ($who->flag (FLAG_WIZ)) { |
|
|
1113 | _perl_reload { |
|
|
1114 | warn $_[0]; |
|
|
1115 | $who->message ($_[0]); |
|
|
1116 | }; |
|
|
1117 | } |
|
|
1118 | }; |
|
|
1119 | |
| 861 | register "<global>", __PACKAGE__; |
1120 | register "<global>", __PACKAGE__; |
| 862 | |
1121 | |
| 863 | unshift @INC, $LIBDIR; |
1122 | unshift @INC, $LIBDIR; |
| 864 | |
|
|
| 865 | load_extensions; |
|
|
| 866 | |
1123 | |
| 867 | $TICK_WATCHER = Event->timer ( |
1124 | $TICK_WATCHER = Event->timer ( |
| 868 | prio => 1, |
1125 | prio => 1, |
| 869 | at => $NEXT_TICK || 1, |
1126 | at => $NEXT_TICK || 1, |
| 870 | cb => sub { |
1127 | cb => sub { |
| … | |
… | |
| 879 | $TICK_WATCHER->at ($NEXT_TICK); |
1136 | $TICK_WATCHER->at ($NEXT_TICK); |
| 880 | $TICK_WATCHER->start; |
1137 | $TICK_WATCHER->start; |
| 881 | }, |
1138 | }, |
| 882 | ); |
1139 | ); |
| 883 | |
1140 | |
| 884 | _reload_2; |
|
|
| 885 | |
|
|
| 886 | 1 |
1141 | 1 |
| 887 | |
1142 | |
