… | |
… | |
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 | |
|
|
114 | =cut |
|
|
115 | |
107 | ############################################################################# |
116 | ############################################################################# |
108 | # "new" plug-in system |
117 | |
|
|
118 | =head2 EVENTS AND OBJECT ATTACHMENTS |
|
|
119 | |
|
|
120 | =over 4 |
109 | |
121 | |
110 | =item $object->attach ($attachment, key => $value...) |
122 | =item $object->attach ($attachment, key => $value...) |
111 | |
123 | |
112 | =item $object->detach ($attachment) |
124 | =item $object->detach ($attachment) |
113 | |
125 | |
… | |
… | |
122 | =item $map->attach ($attachment, key => $value...) |
134 | =item $map->attach ($attachment, key => $value...) |
123 | |
135 | |
124 | =item $map->detach ($attachment) |
136 | =item $map->detach ($attachment) |
125 | |
137 | |
126 | Attach/detach a pre-registered attachment to a map. |
138 | Attach/detach a pre-registered attachment to a map. |
|
|
139 | |
|
|
140 | =item $bool = $object->attached ($name) |
|
|
141 | |
|
|
142 | =item $bool = $player->attached ($name) |
|
|
143 | |
|
|
144 | =item $bool = $map->attached ($name) |
|
|
145 | |
|
|
146 | Checks wether the named attachment is currently attached to the object. |
127 | |
147 | |
128 | =item cf::attach_global ... |
148 | =item cf::attach_global ... |
129 | |
149 | |
130 | Attach handlers for global events. |
150 | Attach handlers for global events. |
131 | |
151 | |
… | |
… | |
181 | Attach handlers to all maps. |
201 | Attach handlers to all maps. |
182 | |
202 | |
183 | =item cf:register_attachment $name, ... |
203 | =item cf:register_attachment $name, ... |
184 | |
204 | |
185 | Register an attachment by name through which objects can refer to this |
205 | Register an attachment by name through which objects can refer to this |
|
|
206 | attachment. |
|
|
207 | |
|
|
208 | =item cf:register_player_attachment $name, ... |
|
|
209 | |
|
|
210 | Register an attachment by name through which players can refer to this |
186 | attachment. |
211 | attachment. |
187 | |
212 | |
188 | =item cf:register_map_attachment $name, ... |
213 | =item cf:register_map_attachment $name, ... |
189 | |
214 | |
190 | Register an attachment by name through which maps can refer to this |
215 | Register an attachment by name through which maps can refer to this |
… | |
… | |
261 | } |
286 | } |
262 | |
287 | |
263 | sub _attach_attachment { |
288 | sub _attach_attachment { |
264 | my ($obj, $name, %arg) = @_; |
289 | my ($obj, $name, %arg) = @_; |
265 | |
290 | |
|
|
291 | return if exists $obj->{_attachment}{$name}; |
|
|
292 | |
266 | my $res; |
293 | my $res; |
267 | |
294 | |
268 | if (my $attach = $attachment{$name}) { |
295 | if (my $attach = $attachment{$name}) { |
269 | my $registry = $obj->registry; |
296 | my $registry = $obj->registry; |
270 | |
297 | |
… | |
… | |
282 | |
309 | |
283 | $res->{attachment} = $name; |
310 | $res->{attachment} = $name; |
284 | $res |
311 | $res |
285 | } |
312 | } |
286 | |
313 | |
287 | sub cf::object::attach { |
314 | *cf::object::attach = |
|
|
315 | *cf::player::attach = |
|
|
316 | *cf::map::attach = sub { |
288 | my ($obj, $name, %arg) = @_; |
317 | my ($obj, $name, %arg) = @_; |
289 | |
318 | |
290 | _attach_attachment $obj, $name, %arg; |
319 | _attach_attachment $obj, $name, %arg; |
291 | } |
320 | }; |
292 | |
321 | |
293 | sub cf::player::attach { |
322 | # all those should be optimised |
294 | my ($obj, $name, %arg) = @_; |
|
|
295 | |
|
|
296 | _attach_attachment $obj, $name, %arg; |
|
|
297 | } |
|
|
298 | |
|
|
299 | sub cf::map::attach { |
|
|
300 | my ($obj, $name, %arg) = @_; |
|
|
301 | |
|
|
302 | _attach_attachment $obj, $name, %arg; |
|
|
303 | } |
|
|
304 | |
|
|
305 | sub cf::object::detach { |
323 | *cf::object::detach = |
|
|
324 | *cf::player::detach = |
|
|
325 | *cf::map::detach = sub { |
306 | my ($obj, $name) = @_; |
326 | my ($obj, $name) = @_; |
307 | die;#d# |
327 | |
308 | } |
328 | delete $obj->{_attachment}{$name}; |
309 | sub cf::player::detach { |
329 | reattach ($obj); |
|
|
330 | }; |
|
|
331 | |
|
|
332 | *cf::object::attached = |
|
|
333 | *cf::player::attached = |
|
|
334 | *cf::map::attached = sub { |
310 | my ($obj, $name) = @_; |
335 | my ($obj, $name) = @_; |
311 | die;#d# |
336 | |
312 | } |
337 | exists $obj->{_attachment}{$name} |
313 | sub cf::map::detach { |
338 | }; |
314 | my ($obj, $name) = @_; |
|
|
315 | die;#d# |
|
|
316 | } |
|
|
317 | |
339 | |
318 | sub attach_global { |
340 | sub attach_global { |
319 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
341 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
320 | } |
342 | } |
321 | |
343 | |
… | |
… | |
342 | my $name = shift; |
364 | my $name = shift; |
343 | |
365 | |
344 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
366 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
345 | } |
367 | } |
346 | |
368 | |
|
|
369 | sub register_player_attachment { |
|
|
370 | my $name = shift; |
|
|
371 | |
|
|
372 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
373 | } |
|
|
374 | |
347 | sub register_map_attachment { |
375 | sub register_map_attachment { |
348 | my $name = shift; |
376 | my $name = shift; |
349 | |
377 | |
350 | $attachment{$name} = [[KLASS_MAP, @_]]; |
378 | $attachment{$name} = [[KLASS_MAP, @_]]; |
351 | } |
379 | } |
… | |
… | |
369 | for (@$callbacks) { |
397 | for (@$callbacks) { |
370 | eval { &{$_->[1]} }; |
398 | eval { &{$_->[1]} }; |
371 | |
399 | |
372 | if ($@) { |
400 | if ($@) { |
373 | warn "$@"; |
401 | warn "$@"; |
374 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
402 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
375 | override; |
403 | override; |
376 | } |
404 | } |
377 | |
405 | |
378 | return 1 if $override; |
406 | return 1 if $override; |
379 | } |
407 | } |
380 | |
408 | |
381 | 0 |
409 | 0 |
382 | } |
410 | } |
|
|
411 | |
|
|
412 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
|
|
413 | |
|
|
414 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
415 | |
|
|
416 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
417 | |
|
|
418 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
419 | |
|
|
420 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
421 | |
|
|
422 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
423 | removed in future versions), and there is no public API to access override |
|
|
424 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
425 | |
|
|
426 | =back |
|
|
427 | |
|
|
428 | =cut |
|
|
429 | |
|
|
430 | ############################################################################# |
|
|
431 | |
|
|
432 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
|
|
433 | |
|
|
434 | =over 4 |
|
|
435 | |
|
|
436 | =item $object->valid, $player->valid, $map->valid |
|
|
437 | |
|
|
438 | Just because you have a perl object does not mean that the corresponding |
|
|
439 | C-level object still exists. If you try to access an object that has no |
|
|
440 | valid C counterpart anymore you get an exception at runtime. This method |
|
|
441 | can be used to test for existence of the C object part without causing an |
|
|
442 | exception. |
|
|
443 | |
|
|
444 | =back |
|
|
445 | |
|
|
446 | =cut |
|
|
447 | |
|
|
448 | *cf::object::valid = |
|
|
449 | *cf::player::valid = |
|
|
450 | *cf::map::valid = \&cf::_valid; |
383 | |
451 | |
384 | ############################################################################# |
452 | ############################################################################# |
385 | # object support |
453 | # object support |
386 | |
454 | |
387 | sub instantiate { |
455 | sub instantiate { |
… | |
… | |
416 | } |
484 | } |
417 | } |
485 | } |
418 | } |
486 | } |
419 | |
487 | |
420 | sub object_freezer_save { |
488 | sub object_freezer_save { |
421 | my ($filename, $objs) = @_; |
489 | my ($filename, $rdata, $objs) = @_; |
422 | |
490 | |
423 | if (@$objs) { |
491 | if (length $$rdata) { |
|
|
492 | warn sprintf "saving %s (%d,%d)\n", |
|
|
493 | $filename, length $$rdata, scalar @$objs; |
|
|
494 | |
424 | open my $fh, ">:raw", "$filename.pst~"; |
495 | if (open my $fh, ">:raw", "$filename~") { |
|
|
496 | chmod SAVE_MODE, $fh; |
|
|
497 | syswrite $fh, $$rdata; |
|
|
498 | close $fh; |
|
|
499 | |
|
|
500 | if (@$objs && open my $fh, ">:raw", "$filename.pst~") { |
|
|
501 | chmod SAVE_MODE, $fh; |
425 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
502 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
426 | close $fh; |
503 | close $fh; |
427 | chmod SAVE_MODE, "$filename.pst~"; |
|
|
428 | rename "$filename.pst~", "$filename.pst"; |
504 | rename "$filename.pst~", "$filename.pst"; |
|
|
505 | } else { |
|
|
506 | unlink "$filename.pst"; |
|
|
507 | } |
|
|
508 | |
|
|
509 | rename "$filename~", $filename; |
|
|
510 | } else { |
|
|
511 | warn "FATAL: $filename~: $!\n"; |
|
|
512 | } |
429 | } else { |
513 | } else { |
|
|
514 | unlink $filename; |
430 | unlink "$filename.pst"; |
515 | unlink "$filename.pst"; |
431 | } |
516 | } |
432 | |
|
|
433 | chmod SAVE_MODE, "$filename~"; |
|
|
434 | rename "$filename~", $filename; |
|
|
435 | } |
517 | } |
436 | |
518 | |
437 | sub object_thawer_load { |
519 | sub object_thawer_load { |
438 | my ($filename) = @_; |
520 | my ($filename) = @_; |
439 | |
521 | |
|
|
522 | local $/; |
|
|
523 | |
|
|
524 | my $av; |
|
|
525 | |
|
|
526 | #TODO: use sysread etc. |
|
|
527 | if (open my $data, "<:raw:perlio", $filename) { |
|
|
528 | $data = <$data>; |
440 | open my $fh, "<:raw:perlio", "$filename.pst" |
529 | if (open my $pst, "<:raw:perlio", "$filename.pst") { |
441 | or return; |
530 | $av = eval { (Storable::thaw <$pst>)->{objs} }; |
|
|
531 | } |
|
|
532 | return ($data, $av); |
|
|
533 | } |
442 | |
534 | |
443 | eval { local $/; (Storable::thaw <$fh>)->{objs} } |
535 | () |
444 | } |
536 | } |
445 | |
537 | |
446 | attach_to_objects |
538 | attach_to_objects |
447 | prio => -1000000, |
539 | prio => -1000000, |
448 | on_clone => sub { |
540 | on_clone => sub { |
… | |
… | |
594 | load_extension $ext; |
686 | load_extension $ext; |
595 | 1 |
687 | 1 |
596 | } or warn "$ext not loaded: $@"; |
688 | } or warn "$ext not loaded: $@"; |
597 | } |
689 | } |
598 | } |
690 | } |
599 | |
|
|
600 | sub _perl_reload(&) { |
|
|
601 | my ($msg) = @_; |
|
|
602 | |
|
|
603 | $msg->("reloading..."); |
|
|
604 | |
|
|
605 | eval { |
|
|
606 | # 1. cancel all watchers |
|
|
607 | $_->cancel for Event::all_watchers; |
|
|
608 | |
|
|
609 | # 2. unload all extensions |
|
|
610 | for (@exts) { |
|
|
611 | $msg->("unloading <$_>"); |
|
|
612 | unload_extension $_; |
|
|
613 | } |
|
|
614 | |
|
|
615 | # 3. unload all modules loaded from $LIBDIR |
|
|
616 | while (my ($k, $v) = each %INC) { |
|
|
617 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
618 | |
|
|
619 | $msg->("removing <$k>"); |
|
|
620 | delete $INC{$k}; |
|
|
621 | |
|
|
622 | $k =~ s/\.pm$//; |
|
|
623 | $k =~ s/\//::/g; |
|
|
624 | |
|
|
625 | if (my $cb = $k->can ("unload_module")) { |
|
|
626 | $cb->(); |
|
|
627 | } |
|
|
628 | |
|
|
629 | Symbol::delete_package $k; |
|
|
630 | } |
|
|
631 | |
|
|
632 | # 4. get rid of safe::, as good as possible |
|
|
633 | Symbol::delete_package "safe::$_" |
|
|
634 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
635 | |
|
|
636 | # 5. remove register_script_function callbacks |
|
|
637 | # TODO |
|
|
638 | |
|
|
639 | # 6. unload cf.pm "a bit" |
|
|
640 | delete $INC{"cf.pm"}; |
|
|
641 | |
|
|
642 | # don't, removes xs symbols, too, |
|
|
643 | # and global variables created in xs |
|
|
644 | #Symbol::delete_package __PACKAGE__; |
|
|
645 | |
|
|
646 | # 7. reload cf.pm |
|
|
647 | $msg->("reloading cf.pm"); |
|
|
648 | require cf; |
|
|
649 | }; |
|
|
650 | $msg->($@) if $@; |
|
|
651 | |
|
|
652 | $msg->("reloaded"); |
|
|
653 | }; |
|
|
654 | |
|
|
655 | sub perl_reload() { |
|
|
656 | _perl_reload { |
|
|
657 | warn $_[0]; |
|
|
658 | print "$_[0]\n"; |
|
|
659 | }; |
|
|
660 | } |
|
|
661 | |
|
|
662 | register_command "perl-reload", 0, sub { |
|
|
663 | my ($who, $arg) = @_; |
|
|
664 | |
|
|
665 | if ($who->flag (FLAG_WIZ)) { |
|
|
666 | _perl_reload { |
|
|
667 | warn $_[0]; |
|
|
668 | $who->message ($_[0]); |
|
|
669 | }; |
|
|
670 | } |
|
|
671 | }; |
|
|
672 | |
691 | |
673 | ############################################################################# |
692 | ############################################################################# |
674 | # extcmd framework, basically convert ext <msg> |
693 | # extcmd framework, basically convert ext <msg> |
675 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
694 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
676 | |
695 | |
… | |
… | |
704 | defined $path or return; |
723 | defined $path or return; |
705 | |
724 | |
706 | unlink "$path.pst"; |
725 | unlink "$path.pst"; |
707 | }; |
726 | }; |
708 | |
727 | |
709 | # old style persistent data, TODO: remove #d# |
|
|
710 | *cf::mapsupport::on_swapin = |
|
|
711 | *cf::mapsupport::on_load = sub { |
|
|
712 | my ($map) = @_; |
|
|
713 | |
|
|
714 | my $path = $map->tmpname; |
|
|
715 | $path = $map->path unless defined $path; |
|
|
716 | |
|
|
717 | open my $fh, "<:raw", "$path.cfperl" |
|
|
718 | or return; # no perl data |
|
|
719 | |
|
|
720 | my $data = Storable::thaw do { local $/; <$fh> }; |
|
|
721 | |
|
|
722 | $data->{version} <= 1 |
|
|
723 | or return; # too new |
|
|
724 | |
|
|
725 | $map->_set_obs ($data->{obs}); |
|
|
726 | $map->invoke (EVENT_MAP_UPGRADE); |
|
|
727 | }; |
|
|
728 | |
|
|
729 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
728 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
730 | |
729 | |
731 | ############################################################################# |
730 | ############################################################################# |
732 | # load/save perl data associated with player->ob objects |
731 | # load/save perl data associated with player->ob objects |
733 | |
732 | |
734 | sub all_objects(@) { |
733 | sub all_objects(@) { |
735 | @_, map all_objects ($_->inv), @_ |
734 | @_, map all_objects ($_->inv), @_ |
736 | } |
735 | } |
737 | |
736 | |
|
|
737 | # TODO: compatibility cruft, remove when no longer needed |
738 | attach_to_players |
738 | attach_to_players |
739 | on_load => sub { |
739 | on_load => sub { |
740 | my ($pl, $path) = @_; |
740 | my ($pl, $path) = @_; |
741 | |
741 | |
742 | for my $o (all_objects $pl->ob) { |
742 | for my $o (all_objects $pl->ob) { |
… | |
… | |
748 | } |
748 | } |
749 | }, |
749 | }, |
750 | ; |
750 | ; |
751 | |
751 | |
752 | ############################################################################# |
752 | ############################################################################# |
753 | # core extensions - in perl |
753 | |
|
|
754 | =head2 CORE EXTENSIONS |
|
|
755 | |
|
|
756 | Functions and methods that extend core crossfire objects. |
|
|
757 | |
|
|
758 | =over 4 |
754 | |
759 | |
755 | =item cf::player::exists $login |
760 | =item cf::player::exists $login |
756 | |
761 | |
757 | Returns true when the given account exists. |
762 | Returns true when the given account exists. |
758 | |
763 | |
… | |
… | |
798 | $msg{msgid} = $id; |
803 | $msg{msgid} = $id; |
799 | |
804 | |
800 | $self->send ("ext " . to_json \%msg); |
805 | $self->send ("ext " . to_json \%msg); |
801 | } |
806 | } |
802 | |
807 | |
|
|
808 | =back |
|
|
809 | |
|
|
810 | =cut |
|
|
811 | |
803 | ############################################################################# |
812 | ############################################################################# |
804 | # map scripting support |
813 | |
|
|
814 | =head2 SAFE SCRIPTING |
|
|
815 | |
|
|
816 | Functions that provide a safe environment to compile and execute |
|
|
817 | snippets of perl code without them endangering the safety of the server |
|
|
818 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
819 | is not available in the safe scripting environment, and the number of |
|
|
820 | functions and methods that cna be called is greatly reduced. |
|
|
821 | |
|
|
822 | =cut |
805 | |
823 | |
806 | our $safe = new Safe "safe"; |
824 | our $safe = new Safe "safe"; |
807 | our $safe_hole = new Safe::Hole; |
825 | our $safe_hole = new Safe::Hole; |
808 | |
826 | |
809 | $SIG{FPE} = 'IGNORE'; |
827 | $SIG{FPE} = 'IGNORE'; |
810 | |
828 | |
811 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
829 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
812 | |
830 | |
813 | # here we export the classes and methods available to script code |
831 | # here we export the classes and methods available to script code |
|
|
832 | |
|
|
833 | =pod |
|
|
834 | |
|
|
835 | The following fucntions and emthods are available within a safe environment: |
|
|
836 | |
|
|
837 | cf::object contr pay_amount pay_player |
|
|
838 | cf::object::player player |
|
|
839 | cf::player peaceful |
|
|
840 | |
|
|
841 | =cut |
814 | |
842 | |
815 | for ( |
843 | for ( |
816 | ["cf::object" => qw(contr pay_amount pay_player)], |
844 | ["cf::object" => qw(contr pay_amount pay_player)], |
817 | ["cf::object::player" => qw(player)], |
845 | ["cf::object::player" => qw(player)], |
818 | ["cf::player" => qw(peaceful)], |
846 | ["cf::player" => qw(peaceful)], |
… | |
… | |
821 | my ($pkg, @funs) = @$_; |
849 | my ($pkg, @funs) = @$_; |
822 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
850 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
823 | for @funs; |
851 | for @funs; |
824 | } |
852 | } |
825 | |
853 | |
|
|
854 | =over 4 |
|
|
855 | |
|
|
856 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
857 | |
|
|
858 | Compiled and executes the given perl code snippet. additional var/value |
|
|
859 | pairs result in temporary local (my) scalar variables of the given name |
|
|
860 | that are available in the code snippet. Example: |
|
|
861 | |
|
|
862 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
863 | |
|
|
864 | =cut |
|
|
865 | |
826 | sub safe_eval($;@) { |
866 | sub safe_eval($;@) { |
827 | my ($code, %vars) = @_; |
867 | my ($code, %vars) = @_; |
828 | |
868 | |
829 | my $qcode = $code; |
869 | my $qcode = $code; |
830 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
870 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
… | |
… | |
852 | } |
892 | } |
853 | |
893 | |
854 | wantarray ? @res : $res[0] |
894 | wantarray ? @res : $res[0] |
855 | } |
895 | } |
856 | |
896 | |
|
|
897 | =item cf::register_script_function $function => $cb |
|
|
898 | |
|
|
899 | Register a function that can be called from within map/npc scripts. The |
|
|
900 | function should be reasonably secure and should be put into a package name |
|
|
901 | like the extension. |
|
|
902 | |
|
|
903 | Example: register a function that gets called whenever a map script calls |
|
|
904 | C<rent::overview>, as used by the C<rent> extension. |
|
|
905 | |
|
|
906 | cf::register_script_function "rent::overview" => sub { |
|
|
907 | ... |
|
|
908 | }; |
|
|
909 | |
|
|
910 | =cut |
|
|
911 | |
857 | sub register_script_function { |
912 | sub register_script_function { |
858 | my ($fun, $cb) = @_; |
913 | my ($fun, $cb) = @_; |
859 | |
914 | |
860 | no strict 'refs'; |
915 | no strict 'refs'; |
861 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
916 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
862 | } |
917 | } |
863 | |
918 | |
|
|
919 | =back |
|
|
920 | |
|
|
921 | =cut |
|
|
922 | |
|
|
923 | ############################################################################# |
|
|
924 | |
|
|
925 | =head2 EXTENSION DATABASE SUPPORT |
|
|
926 | |
|
|
927 | Crossfire maintains a very simple database for extension use. It can |
|
|
928 | currently store anything that can be serialised using Storable, which |
|
|
929 | excludes objects. |
|
|
930 | |
|
|
931 | The parameter C<$family> should best start with the name of the extension |
|
|
932 | using it, it should be unique. |
|
|
933 | |
|
|
934 | =over 4 |
|
|
935 | |
|
|
936 | =item $hashref = cf::db_get $family |
|
|
937 | |
|
|
938 | Return a hashref for use by the extension C<$family>, which can be |
|
|
939 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
940 | C<cf::db_sync>. |
|
|
941 | |
|
|
942 | =item $value = cf::db_get $family => $key |
|
|
943 | |
|
|
944 | Returns a single value from the database |
|
|
945 | |
|
|
946 | =item cf::db_put $family => $hashref |
|
|
947 | |
|
|
948 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
949 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
950 | |
|
|
951 | =item cf::db_put $family => $key => $value |
|
|
952 | |
|
|
953 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
954 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
955 | |
|
|
956 | =item cf::db_dirty |
|
|
957 | |
|
|
958 | Marks the database as dirty, to be updated at a later time. |
|
|
959 | |
|
|
960 | =item cf::db_sync |
|
|
961 | |
|
|
962 | Immediately write the database to disk I<if it is dirty>. |
|
|
963 | |
|
|
964 | =cut |
|
|
965 | |
|
|
966 | { |
|
|
967 | my $db; |
|
|
968 | my $path = cf::localdir . "/database.pst"; |
|
|
969 | |
|
|
970 | sub db_load() { |
|
|
971 | warn "loading database $path\n";#d# remove later |
|
|
972 | $db = stat $path ? Storable::retrieve $path : { }; |
|
|
973 | } |
|
|
974 | |
|
|
975 | my $pid; |
|
|
976 | |
|
|
977 | sub db_save() { |
|
|
978 | warn "saving database $path\n";#d# remove later |
|
|
979 | waitpid $pid, 0 if $pid; |
|
|
980 | if (0 == ($pid = fork)) { |
|
|
981 | $db->{_meta}{version} = 1; |
|
|
982 | Storable::nstore $db, "$path~"; |
|
|
983 | rename "$path~", $path; |
|
|
984 | cf::_exit 0 if defined $pid; |
|
|
985 | } |
|
|
986 | } |
|
|
987 | |
|
|
988 | my $dirty; |
|
|
989 | |
|
|
990 | sub db_sync() { |
|
|
991 | db_save if $dirty; |
|
|
992 | undef $dirty; |
|
|
993 | } |
|
|
994 | |
|
|
995 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
|
|
996 | db_sync; |
|
|
997 | }); |
|
|
998 | |
|
|
999 | sub db_dirty() { |
|
|
1000 | $dirty = 1; |
|
|
1001 | $idle->start; |
|
|
1002 | } |
|
|
1003 | |
|
|
1004 | sub db_get($;$) { |
|
|
1005 | @_ >= 2 |
|
|
1006 | ? $db->{$_[0]}{$_[1]} |
|
|
1007 | : ($db->{$_[0]} ||= { }) |
|
|
1008 | } |
|
|
1009 | |
|
|
1010 | sub db_put($$;$) { |
|
|
1011 | if (@_ >= 3) { |
|
|
1012 | $db->{$_[0]}{$_[1]} = $_[2]; |
|
|
1013 | } else { |
|
|
1014 | $db->{$_[0]} = $_[1]; |
|
|
1015 | } |
|
|
1016 | db_dirty; |
|
|
1017 | } |
|
|
1018 | |
|
|
1019 | attach_global |
|
|
1020 | prio => 10000, |
|
|
1021 | on_cleanup => sub { |
|
|
1022 | db_sync; |
|
|
1023 | }, |
|
|
1024 | ; |
|
|
1025 | } |
|
|
1026 | |
864 | ############################################################################# |
1027 | ############################################################################# |
865 | # the server's main() |
1028 | # the server's main() |
866 | |
1029 | |
867 | sub main { |
1030 | sub main { |
|
|
1031 | db_load; |
|
|
1032 | load_extensions; |
868 | Event::loop; |
1033 | Event::loop; |
869 | } |
1034 | } |
870 | |
1035 | |
871 | ############################################################################# |
1036 | ############################################################################# |
872 | # initialisation |
1037 | # initialisation |
873 | |
1038 | |
|
|
1039 | sub _perl_reload(&) { |
|
|
1040 | my ($msg) = @_; |
|
|
1041 | |
|
|
1042 | $msg->("reloading..."); |
|
|
1043 | |
|
|
1044 | eval { |
|
|
1045 | # cancel all watchers |
|
|
1046 | $_->cancel for Event::all_watchers; |
|
|
1047 | |
|
|
1048 | # unload all extensions |
|
|
1049 | for (@exts) { |
|
|
1050 | $msg->("unloading <$_>"); |
|
|
1051 | unload_extension $_; |
|
|
1052 | } |
|
|
1053 | |
|
|
1054 | # unload all modules loaded from $LIBDIR |
|
|
1055 | while (my ($k, $v) = each %INC) { |
|
|
1056 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
1057 | |
|
|
1058 | $msg->("removing <$k>"); |
|
|
1059 | delete $INC{$k}; |
|
|
1060 | |
|
|
1061 | $k =~ s/\.pm$//; |
|
|
1062 | $k =~ s/\//::/g; |
|
|
1063 | |
|
|
1064 | if (my $cb = $k->can ("unload_module")) { |
|
|
1065 | $cb->(); |
|
|
1066 | } |
|
|
1067 | |
|
|
1068 | Symbol::delete_package $k; |
|
|
1069 | } |
|
|
1070 | |
|
|
1071 | # sync database to disk |
|
|
1072 | cf::db_sync; |
|
|
1073 | |
|
|
1074 | # get rid of safe::, as good as possible |
|
|
1075 | Symbol::delete_package "safe::$_" |
|
|
1076 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
1077 | |
|
|
1078 | # remove register_script_function callbacks |
|
|
1079 | # TODO |
|
|
1080 | |
|
|
1081 | # unload cf.pm "a bit" |
|
|
1082 | delete $INC{"cf.pm"}; |
|
|
1083 | |
|
|
1084 | # don't, removes xs symbols, too, |
|
|
1085 | # and global variables created in xs |
|
|
1086 | #Symbol::delete_package __PACKAGE__; |
|
|
1087 | |
|
|
1088 | # reload cf.pm |
|
|
1089 | $msg->("reloading cf.pm"); |
|
|
1090 | require cf; |
|
|
1091 | |
|
|
1092 | # load database again |
|
|
1093 | cf::db_load; |
|
|
1094 | |
|
|
1095 | # load extensions |
|
|
1096 | $msg->("load extensions"); |
|
|
1097 | cf::load_extensions; |
|
|
1098 | |
|
|
1099 | # reattach attachments to objects |
|
|
1100 | $msg->("reattach"); |
|
|
1101 | _global_reattach; |
|
|
1102 | }; |
|
|
1103 | $msg->($@) if $@; |
|
|
1104 | |
|
|
1105 | $msg->("reloaded"); |
|
|
1106 | }; |
|
|
1107 | |
|
|
1108 | sub perl_reload() { |
|
|
1109 | _perl_reload { |
|
|
1110 | warn $_[0]; |
|
|
1111 | print "$_[0]\n"; |
|
|
1112 | }; |
|
|
1113 | } |
|
|
1114 | |
|
|
1115 | register_command "perl-reload", 0, sub { |
|
|
1116 | my ($who, $arg) = @_; |
|
|
1117 | |
|
|
1118 | if ($who->flag (FLAG_WIZ)) { |
|
|
1119 | _perl_reload { |
|
|
1120 | warn $_[0]; |
|
|
1121 | $who->message ($_[0]); |
|
|
1122 | }; |
|
|
1123 | } |
|
|
1124 | }; |
|
|
1125 | |
874 | register "<global>", __PACKAGE__; |
1126 | register "<global>", __PACKAGE__; |
875 | |
1127 | |
876 | unshift @INC, $LIBDIR; |
1128 | unshift @INC, $LIBDIR; |
877 | |
|
|
878 | load_extensions; |
|
|
879 | |
1129 | |
880 | $TICK_WATCHER = Event->timer ( |
1130 | $TICK_WATCHER = Event->timer ( |
881 | prio => 1, |
1131 | prio => 1, |
882 | at => $NEXT_TICK || 1, |
1132 | at => $NEXT_TICK || 1, |
883 | cb => sub { |
1133 | cb => sub { |
… | |
… | |
892 | $TICK_WATCHER->at ($NEXT_TICK); |
1142 | $TICK_WATCHER->at ($NEXT_TICK); |
893 | $TICK_WATCHER->start; |
1143 | $TICK_WATCHER->start; |
894 | }, |
1144 | }, |
895 | ); |
1145 | ); |
896 | |
1146 | |
897 | _reload_2; |
|
|
898 | |
|
|
899 | 1 |
1147 | 1 |
900 | |
1148 | |