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.37 by root, Thu Aug 24 14:05:22 2006 UTC vs.
Revision 1.94 by root, Thu Dec 21 23:02:54 2006 UTC

5use Storable; 5use Storable;
6use Opcode; 6use Opcode;
7use Safe; 7use Safe;
8use Safe::Hole; 8use Safe::Hole;
9 9
10use IO::AIO ();
11use YAML::Syck ();
10use Time::HiRes; 12use Time::HiRes;
11use Event; 13use Event;
12$Event::Eval = 1; # no idea why this is required, but it is 14$Event::Eval = 1; # no idea why this is required, but it is
13 15
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1;
18
14use strict; 19use strict;
15 20
16our %COMMAND; 21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22
23our %COMMAND = ();
24our %COMMAND_TIME = ();
25our %EXTCMD = ();
26
27_init_vars;
28
17our @EVENT; 29our @EVENT;
18our %PROP_TYPE; 30our $LIBDIR = datadir . "/ext";
19our %PROP_IDX;
20our $LIBDIR = maps_directory "perl";
21 31
22our $TICK = MAX_TIME * 1e-6; 32our $TICK = MAX_TIME * 1e-6;
23our $TICK_WATCHER; 33our $TICK_WATCHER;
24our $NEXT_TICK; 34our $NEXT_TICK;
25 35
36our %CFG;
37
38our $UPTIME; $UPTIME ||= time;
39
40#############################################################################
41
42=head2 GLOBAL VARIABLES
43
44=over 4
45
46=item $cf::UPTIME
47
48The timestamp of the server start (so not actually an uptime).
49
50=item $cf::LIBDIR
51
52The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically.
54
55=item $cf::TICK
56
57The interval between server ticks, in seconds.
58
59=item %cf::CFG
60
61Configuration for the server, loaded from C</etc/crossfire/config>, or
62from wherever your confdir points to.
63
64=back
65
66=cut
67
26BEGIN { 68BEGIN {
27 @EVENT = map lc, @EVENT;
28
29 *CORE::GLOBAL::warn = sub { 69 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_; 70 my $msg = join "", @_;
31 $msg .= "\n" 71 $msg .= "\n"
32 unless $msg =~ /\n$/; 72 unless $msg =~ /\n$/;
33 73
34 print STDERR "cfperl: $msg"; 74 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 75 LOG llevError, "cfperl: $msg";
36 }; 76 };
37} 77}
38 78
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
81@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
82@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
83@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
40 85
41# generate property mutators 86# we bless all objects into (empty) derived classes to force a method lookup
42sub prop_gen { 87# within the Safe compartment.
43 my ($prefix, $class) = @_; 88for my $pkg (qw(
44 89 cf::global
90 cf::object cf::object::player
91 cf::client cf::player
92 cf::arch cf::living
93 cf::map cf::party cf::region
94)) {
45 no strict 'refs'; 95 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
66prop_gen OBJECT_PROP => "cf::object";
67# CFAPI_OBJECT_ANIMATION?
68prop_gen PLAYER_PROP => "cf::object::player";
69
70prop_gen MAP_PROP => "cf::map";
71prop_gen ARCH_PROP => "cf::arch";
72
73# guessed hierarchies
74
75@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
76@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
77
78# we bless all objects into derived classes to force a method lookup
79# within the Safe compartment.
80for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
81 no strict 'refs';
82 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 96 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
83} 97}
84 98
85$Event::DIED = sub { 99$Event::DIED = sub {
86 warn "error in event callback: @_"; 100 warn "error in event callback: @_";
87}; 101};
88 102
89my %ext_pkg; 103my %ext_pkg;
90my @exts; 104my @exts;
91my @hook; 105my @hook;
92my %command;
93my %extcmd;
94 106
95sub inject_event { 107=head2 UTILITY FUNCTIONS
96 my $extension = shift;
97 my $event_code = shift;
98 108
99 my $cb = $hook[$event_code]{$extension} 109=over 4
100 or return;
101 110
102 &$cb 111=cut
103}
104 112
105sub inject_global_event { 113use JSON::Syck (); # TODO# replace by JSON::PC once working
114
115=item $ref = cf::from_json $json
116
117Converts a JSON string into the corresponding perl data structure.
118
119=cut
120
121sub from_json($) {
122 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
123 JSON::Syck::Load $_[0]
124}
125
126=item $json = cf::to_json $ref
127
128Converts a perl data structure into its JSON representation.
129
130=cut
131
132sub to_json($) {
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134 JSON::Syck::Dump $_[0]
135}
136
137=back
138
139=cut
140
141#############################################################################
142
143=head2 ATTACHABLE OBJECTS
144
145Many objects in crossfire are so-called attachable objects. That means you can
146attach callbacks/event handlers (a collection of which is called an "attachment")
147to it. All such attachable objects support the following methods.
148
149In the following description, CLASS can be any of C<global>, C<object>
150C<player>, C<client> or C<map> (i.e. the attachable objects in
151crossfire+).
152
153=over 4
154
155=item $attachable->attach ($attachment, key => $value...)
156
157=item $attachable->detach ($attachment)
158
159Attach/detach a pre-registered attachment to a specific object and give it
160the specified key/value pairs as arguments.
161
162Example, attach a minesweeper attachment to the given object, making it a
16310x10 minesweeper game:
164
165 $obj->attach (minesweeper => width => 10, height => 10);
166
167=item $bool = $attachable->attached ($name)
168
169Checks wether the named attachment is currently attached to the object.
170
171=item cf::CLASS->attach ...
172
173=item cf::CLASS->detach ...
174
175Define an anonymous attachment and attach it to all objects of the given
176CLASS. See the next function for an explanation of its arguments.
177
178You can attach to global events by using the C<cf::global> class.
179
180Example, log all player logins:
181
182 cf::player->attach (
183 on_login => sub {
184 my ($pl) = @_;
185 ...
186 },
187 );
188
189Example, attach to the jeweler skill:
190
191 cf::object->attach (
192 type => cf::SKILL,
193 subtype => cf::SK_JEWELER,
194 on_use_skill => sub {
195 my ($sk, $ob, $part, $dir, $msg) = @_;
196 ...
197 },
198 );
199
200=item cf::CLASS::attachment $name, ...
201
202Register an attachment by C<$name> through which attachable objects of the
203given CLASS can refer to this attachment.
204
205Some classes such as crossfire maps and objects can specify attachments
206that are attached at load/instantiate time, thus the need for a name.
207
208These calls expect any number of the following handler/hook descriptions:
209
210=over 4
211
212=item prio => $number
213
214Set the priority for all following handlers/hooks (unless overwritten
215by another C<prio> setting). Lower priority handlers get executed
216earlier. The default priority is C<0>, and many built-in handlers are
217registered at priority C<-1000>, so lower priorities should not be used
218unless you know what you are doing.
219
220=item type => $type
221
222(Only for C<< cf::object->attach >> calls), limits the attachment to the
223given type of objects only (the additional parameter C<subtype> can be
224used to further limit to the given subtype).
225
226=item on_I<event> => \&cb
227
228Call the given code reference whenever the named event happens (event is
229something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
230handlers are recognised generally depends on the type of object these
231handlers attach to).
232
233See F<include/eventinc.h> for the full list of events supported, and their
234class.
235
236=item package => package::
237
238Look for sub functions of the name C<< on_I<event> >> in the given
239package and register them. Only handlers for eevents supported by the
240object/class are recognised.
241
242=back
243
244Example, define an attachment called "sockpuppet" that calls the given
245event handler when a monster attacks:
246
247 cf::object::attachment sockpuppet =>
248 on_skill_attack => sub {
249 my ($self, $victim) = @_;
250 ...
251 }
252 }
253
254=cut
255
256# the following variables are defined in .xs and must not be re-created
257our @CB_GLOBAL = (); # registry for all global events
258our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259our @CB_PLAYER = ();
260our @CB_CLIENT = ();
261our @CB_TYPE = (); # registry for type (cf-object class) based events
262our @CB_MAP = ();
263
264my %attachment;
265
266sub _attach_cb($$$$) {
267 my ($registry, $event, $prio, $cb) = @_;
268
269 use sort 'stable';
270
271 $cb = [$prio, $cb];
272
273 @{$registry->[$event]} = sort
274 { $a->[0] cmp $b->[0] }
275 @{$registry->[$event] || []}, $cb;
276}
277
278# attach handles attaching event callbacks
279# the only thing the caller has to do is pass the correct
280# registry (== where the callback attaches to).
281sub _attach {
282 my ($registry, $klass, @arg) = @_;
283
284 my $object_type;
285 my $prio = 0;
286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287
288 while (@arg) {
289 my $type = shift @arg;
290
291 if ($type eq "prio") {
292 $prio = shift @arg;
293
294 } elsif ($type eq "type") {
295 $object_type = shift @arg;
296 $registry = $CB_TYPE[$object_type] ||= [];
297
298 } elsif ($type eq "subtype") {
299 defined $object_type or Carp::croak "subtype specified without type";
300 my $object_subtype = shift @arg;
301 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
302
303 } elsif ($type eq "package") {
304 my $pkg = shift @arg;
305
306 while (my ($name, $id) = each %cb_id) {
307 if (my $cb = $pkg->can ($name)) {
308 _attach_cb $registry, $id, $prio, $cb;
309 }
310 }
311
312 } elsif (exists $cb_id{$type}) {
313 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
314
315 } elsif (ref $type) {
316 warn "attaching objects not supported, ignoring.\n";
317
318 } else {
319 shift @arg;
320 warn "attach argument '$type' not supported, ignoring.\n";
321 }
322 }
323}
324
325sub _object_attach {
326 my ($obj, $name, %arg) = @_;
327
328 return if exists $obj->{_attachment}{$name};
329
330 if (my $attach = $attachment{$name}) {
331 my $registry = $obj->registry;
332
333 for (@$attach) {
334 my ($klass, @attach) = @$_;
335 _attach $registry, $klass, @attach;
336 }
337
338 $obj->{$name} = \%arg;
339 } else {
340 warn "object uses attachment '$name' that is not available, postponing.\n";
341 }
342
343 $obj->{_attachment}{$name} = undef;
344}
345
346sub cf::attachable::attach {
347 if (ref $_[0]) {
348 _object_attach @_;
349 } else {
350 _attach shift->_attach_registry, @_;
351 }
352};
353
354# all those should be optimised
355sub cf::attachable::detach {
356 my ($obj, $name) = @_;
357
358 if (ref $obj) {
359 delete $obj->{_attachment}{$name};
360 reattach ($obj);
361 } else {
362 Carp::croak "cannot, currently, detach class attachments";
363 }
364};
365
366sub cf::attachable::attached {
367 my ($obj, $name) = @_;
368
369 exists $obj->{_attachment}{$name}
370}
371
372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
373 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass)
376 }
377
378 sub cf::\L$klass\E::attachment {
379 my \$name = shift;
380
381 \$attachment{\$name} = [[KLASS_$klass, \@_]];
382 }
383 ";
384 die if $@;
385}
386
387our $override;
388our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
389
390sub override {
391 $override = 1;
392 @invoke_results = ();
393}
394
395sub do_invoke {
106 my $event = shift; 396 my $event = shift;
397 my $callbacks = shift;
107 398
108 my $cb = $hook[$event] 399 @invoke_results = ();
109 or return;
110 400
111 List::Util::max map &$_, values %$cb 401 local $override;
112}
113 402
114sub inject_command { 403 for (@$callbacks) {
404 eval { &{$_->[1]} };
405
406 if ($@) {
407 warn "$@";
408 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
409 override;
410 }
411
412 return 1 if $override;
413 }
414
415 0
416}
417
418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
419
420=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
421
422=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424=item $bool = $client->invoke (EVENT_CLIENT_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 ATTACHABLE OBJECTS
441
442Attachable objects includes objects, players, clients and maps.
443
444=over 4
445
446=item $object->valid
447
448Just because you have a perl object does not mean that the corresponding
449C-level object still exists. If you try to access an object that has no
450valid C counterpart anymore you get an exception at runtime. This method
451can be used to test for existence of the C object part without causing an
452exception.
453
454=back
455
456=cut
457
458#############################################################################
459# object support
460
461sub instantiate {
462 my ($obj, $data) = @_;
463
464 $data = from_json $data;
465
466 for (@$data) {
115 my ($name, $obj, $params) = @_; 467 my ($name, $args) = @$_;
116 468
117 for my $cmd (@{ $command{$name} }) { 469 $obj->attach ($name, %{$args || {} });
118 $cmd->[1]->($obj, $params); 470 }
471}
472
473# basically do the same as instantiate, without calling instantiate
474sub reattach {
475 my ($obj) = @_;
476 my $registry = $obj->registry;
477
478 @$registry = ();
479
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
481
482 for my $name (keys %{ $obj->{_attachment} || {} }) {
483 if (my $attach = $attachment{$name}) {
484 for (@$attach) {
485 my ($klass, @attach) = @$_;
486 _attach $registry, $klass, @attach;
487 }
488 } else {
489 warn "object uses attachment '$name' that is not available, postponing.\n";
490 }
491 }
492}
493
494sub object_freezer_save {
495 my ($filename, $rdata, $objs) = @_;
496
497 if (length $$rdata) {
498 warn sprintf "saving %s (%d,%d)\n",
499 $filename, length $$rdata, scalar @$objs;
500
501 if (open my $fh, ">:raw", "$filename~") {
502 chmod SAVE_MODE, $fh;
503 syswrite $fh, $$rdata;
504 close $fh;
505
506 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
507 chmod SAVE_MODE, $fh;
508 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
509 close $fh;
510 rename "$filename.pst~", "$filename.pst";
511 } else {
512 unlink "$filename.pst";
513 }
514
515 rename "$filename~", $filename;
516 } else {
517 warn "FATAL: $filename~: $!\n";
518 }
519 } else {
520 unlink $filename;
521 unlink "$filename.pst";
522 }
523}
524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
531}
532
533sub object_thawer_load {
534 my ($filename) = @_;
535
536 local $/;
537
538 my $av;
539
540 #TODO: use sysread etc.
541 if (open my $data, "<:raw:perlio", $filename) {
542 $data = <$data>;
543 if (open my $pst, "<:raw:perlio", "$filename.pst") {
544 $av = eval { (Storable::thaw <$pst>)->{objs} };
545 }
546 return ($data, $av);
547 }
548
549 ()
550}
551
552cf::object->attach (
553 prio => -1000000,
554 on_clone => sub {
555 my ($src, $dst) = @_;
556
557 @{$dst->registry} = @{$src->registry};
558
559 %$dst = %$src;
560
561 %{$dst->{_attachment}} = %{$src->{_attachment}}
562 if exists $src->{_attachment};
119 } 563 },
564);
120 565
121 -1 566#############################################################################
122} 567# command handling &c
568
569=item cf::register_command $name => \&callback($ob,$args);
570
571Register a callback for execution when the client sends the user command
572$name.
573
574=cut
123 575
124sub register_command { 576sub register_command {
125 my ($name, $time, $cb) = @_; 577 my ($name, $cb) = @_;
126 578
127 my $caller = caller; 579 my $caller = caller;
128 #warn "registering command '$name/$time' to '$caller'"; 580 #warn "registering command '$name/$time' to '$caller'";
129 581
130 push @{ $command{$name} }, [$time, $cb, $caller]; 582 push @{ $COMMAND{$name} }, [$caller, $cb];
131 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
132} 583}
584
585=item cf::register_extcmd $name => \&callback($pl,$packet);
586
587Register a callbackf ro execution when the client sends an extcmd packet.
588
589If the callback returns something, it is sent back as if reply was being
590called.
591
592=cut
133 593
134sub register_extcmd { 594sub register_extcmd {
135 my ($name, $cb) = @_; 595 my ($name, $cb) = @_;
136 596
137 my $caller = caller; 597 my $caller = caller;
138 #warn "registering extcmd '$name' to '$caller'"; 598 #warn "registering extcmd '$name' to '$caller'";
139 599
140 $extcmd{$name} = [$cb, $caller]; 600 $EXTCMD{$name} = [$cb, $caller];
141} 601}
602
603cf::player->attach (
604 on_command => sub {
605 my ($pl, $name, $params) = @_;
606
607 my $cb = $COMMAND{$name}
608 or return;
609
610 for my $cmd (@$cb) {
611 $cmd->[1]->($pl->ob, $params);
612 }
613
614 cf::override;
615 },
616 on_extcmd => sub {
617 my ($pl, $buf) = @_;
618
619 my $msg = eval { from_json $buf };
620
621 if (ref $msg) {
622 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623 if (my %reply = $cb->[0]->($pl, $msg)) {
624 $pl->ext_reply ($msg->{msgid}, %reply);
625 }
626 }
627 } else {
628 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
629 }
630
631 cf::override;
632 },
633);
142 634
143sub register { 635sub register {
144 my ($base, $pkg) = @_; 636 my ($base, $pkg) = @_;
145 637
146 for my $idx (0 .. $#EVENT) { 638 #TODO
147 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
148 #warn "registering $EVENT[$idx] hook to '$pkg'\n";
149 $hook[$idx]{$base} = $ref;
150 }
151 }
152} 639}
153 640
154sub load_extension { 641sub load_extension {
155 my ($path) = @_; 642 my ($path) = @_;
156 643
157 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 644 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
158 my $base = $1; 645 my $base = $1;
159 my $pkg = $1; 646 my $pkg = $1;
160 $pkg =~ s/[^[:word:]]/_/g; 647 $pkg =~ s/[^[:word:]]/_/g;
161 $pkg = "cf::ext::$pkg"; 648 $pkg = "ext::$pkg";
162 649
163 warn "loading '$path' into '$pkg'\n"; 650 warn "loading '$path' into '$pkg'\n";
164 651
165 open my $fh, "<:utf8", $path 652 open my $fh, "<:utf8", $path
166 or die "$path: $!"; 653 or die "$path: $!";
170 . "#line 1 \"$path\"\n{\n" 657 . "#line 1 \"$path\"\n{\n"
171 . (do { local $/; <$fh> }) 658 . (do { local $/; <$fh> })
172 . "\n};\n1"; 659 . "\n};\n1";
173 660
174 eval $source 661 eval $source
175 or die "$path: $@"; 662 or die $@ ? "$path: $@\n"
663 : "extension disabled.\n";
176 664
177 push @exts, $pkg; 665 push @exts, $pkg;
178 $ext_pkg{$base} = $pkg; 666 $ext_pkg{$base} = $pkg;
179 667
180# no strict 'refs'; 668# no strict 'refs';
187 my ($pkg) = @_; 675 my ($pkg) = @_;
188 676
189 warn "removing extension $pkg\n"; 677 warn "removing extension $pkg\n";
190 678
191 # remove hooks 679 # remove hooks
680 #TODO
192 for my $idx (0 .. $#EVENT) { 681# for my $idx (0 .. $#PLUGIN_EVENT) {
193 delete $hook[$idx]{$pkg}; 682# delete $hook[$idx]{$pkg};
194 } 683# }
195 684
196 # remove commands 685 # remove commands
197 for my $name (keys %command) { 686 for my $name (keys %COMMAND) {
198 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
199 688
200 if (@cb) { 689 if (@cb) {
201 $command{$name} = \@cb; 690 $COMMAND{$name} = \@cb;
202 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
203 } else { 691 } else {
204 delete $command{$name};
205 delete $COMMAND{"$name\000"}; 692 delete $COMMAND{$name};
206 } 693 }
207 } 694 }
208 695
209 # remove extcmds 696 # remove extcmds
210 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
211 delete $extcmd{$name}; 698 delete $EXTCMD{$name};
212 } 699 }
213 700
214 if (my $cb = $pkg->can ("on_unload")) { 701 if (my $cb = $pkg->can ("unload")) {
215 eval { 702 eval {
216 $cb->($pkg); 703 $cb->($pkg);
217 1 704 1
218 } or warn "$pkg unloaded, but with errors: $@"; 705 } or warn "$pkg unloaded, but with errors: $@";
219 } 706 }
220 707
221 Symbol::delete_package $pkg; 708 Symbol::delete_package $pkg;
222} 709}
223 710
224sub load_extensions { 711sub load_extensions {
225 my $LIBDIR = maps_directory "perl";
226
227 for my $ext (<$LIBDIR/*.ext>) { 712 for my $ext (<$LIBDIR/*.ext>) {
228 next unless -r $ext; 713 next unless -r $ext;
229 eval { 714 eval {
230 load_extension $ext; 715 load_extension $ext;
231 1 716 1
232 } or warn "$ext not loaded: $@"; 717 } or warn "$ext not loaded: $@";
233 } 718 }
234} 719}
235 720
236sub _perl_reload(&) {
237 my ($msg) = @_;
238
239 $msg->("reloading...");
240
241 eval {
242 # 1. cancel all watchers
243 $_->cancel for Event::all_watchers;
244
245 # 2. unload all extensions
246 for (@exts) {
247 $msg->("unloading <$_>");
248 unload_extension $_;
249 }
250
251 # 3. unload all modules loaded from $LIBDIR
252 while (my ($k, $v) = each %INC) {
253 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
254
255 $msg->("removing <$k>");
256 delete $INC{$k};
257
258 $k =~ s/\.pm$//;
259 $k =~ s/\//::/g;
260
261 if (my $cb = $k->can ("unload_module")) {
262 $cb->();
263 }
264
265 Symbol::delete_package $k;
266 }
267
268 # 4. get rid of ext::, as good as possible
269 Symbol::delete_package "ext::$_"
270 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
271
272 # 5. remove register_script_function callbacks
273 # TODO
274
275 # 6. unload cf.pm "a bit"
276 delete $INC{"cf.pm"};
277
278 # don't, removes xs symbols, too
279 #Symbol::delete_package __PACKAGE__;
280
281 # 7. reload cf.pm
282 $msg->("reloading cf.pm");
283 require cf;
284 };
285 $msg->($@) if $@;
286
287 $msg->("reloaded");
288};
289
290sub perl_reload() {
291 _perl_reload {
292 warn $_[0];
293 print "$_[0]\n";
294 };
295}
296
297register_command "perl-reload", 0, sub {
298 my ($who, $arg) = @_;
299
300 if ($who->flag (FLAG_WIZ)) {
301 _perl_reload {
302 warn $_[0];
303 $who->message ($_[0]);
304 };
305 }
306};
307
308#############################################################################
309# utility functions
310
311use JSON::Syck (); # TODO# replace by JSON::PC once working
312
313sub from_json($) {
314 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
315 JSON::Syck::Load $_[0]
316}
317
318sub to_json($) {
319 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
320 JSON::Syck::Dump $_[0]
321}
322
323#############################################################################
324# extcmd framework, basically convert ext <msg>
325# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
326
327sub on_extcmd {
328 my ($pl, $buf) = @_;
329
330 my $msg = eval { from_json $buf };
331
332 if (ref $msg) {
333 if (my $cb = $extcmd{$msg->{msgtype}}) {
334 if (my %reply = $cb->[0]->($pl, $msg)) {
335 $pl->ext_reply ($msg->{msgid}, %reply);
336 }
337 }
338 } else {
339 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
340 }
341
342 1
343}
344
345############################################################################# 721#############################################################################
346# load/save/clean perl data associated with a map 722# load/save/clean perl data associated with a map
347 723
348*on_mapclean = sub { 724*cf::mapsupport::on_clean = sub {
349 my ($map) = @_; 725 my ($map) = @_;
350 726
351 my $path = $map->tmpname; 727 my $path = $map->tmpname;
352 defined $path or return; 728 defined $path or return;
353 729
354 unlink "$path.cfperl"; 730 unlink "$path.pst";
355}; 731};
356 732
357*on_mapin = 733cf::map->attach (prio => -10000, package => cf::mapsupport::);
358*on_mapload = sub {
359 my ($map) = @_;
360
361 my $path = $map->tmpname;
362 $path = $map->path unless defined $path;
363
364 open my $fh, "<:raw", "$path.cfperl"
365 or return; # no perl data
366
367 my $data = Storable::thaw do { local $/; <$fh> };
368
369 $data->{version} <= 1
370 or return; # too new
371
372 $map->_set_obs ($data->{obs});
373};
374
375*on_mapout = sub {
376 my ($map) = @_;
377
378 my $path = $map->tmpname;
379 $path = $map->path unless defined $path;
380
381 my $obs = $map->_get_obs;
382
383 if (defined $obs) {
384 open my $fh, ">:raw", "$path.cfperl"
385 or die "$path.cfperl: $!";
386
387 stat $path;
388
389 print $fh Storable::nfreeze {
390 size => (stat _)[7],
391 time => (stat _)[9],
392 version => 1,
393 obs => $obs,
394 };
395
396 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
397 } else {
398 unlink "$path.cfperl";
399 }
400};
401 734
402############################################################################# 735#############################################################################
403# load/save perl data associated with player->ob objects 736# load/save perl data associated with player->ob objects
404 737
405sub all_objects(@) { 738sub all_objects(@) {
406 @_, map all_objects ($_->inv), @_ 739 @_, map all_objects ($_->inv), @_
407} 740}
408 741
409*on_player_load = sub { 742# TODO: compatibility cruft, remove when no longer needed
743cf::player->attach (
744 on_load => sub {
410 my ($ob, $path) = @_; 745 my ($pl, $path) = @_;
411 746
412 for my $o (all_objects $ob) { 747 for my $o (all_objects $pl->ob) {
413 if (my $value = $o->get_ob_key_value ("_perl_data")) { 748 if (my $value = $o->get_ob_key_value ("_perl_data")) {
414 $o->set_ob_key_value ("_perl_data"); 749 $o->set_ob_key_value ("_perl_data");
415 750
416 %$o = %{ Storable::thaw pack "H*", $value }; 751 %$o = %{ Storable::thaw pack "H*", $value };
417 } 752 }
753 }
418 } 754 },
419}; 755);
420
421*on_player_save = sub {
422 my ($ob, $path) = @_;
423
424 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
425 for grep %$_, all_objects $ob;
426};
427 756
428############################################################################# 757#############################################################################
429# core extensions - in perl 758
759=head2 CORE EXTENSIONS
760
761Functions and methods that extend core crossfire objects.
762
763=over 4
430 764
431=item cf::player::exists $login 765=item cf::player::exists $login
432 766
433Returns true when the given account exists. 767Returns true when the given account exists.
434 768
437sub cf::player::exists($) { 771sub cf::player::exists($) {
438 cf::player::find $_[0] 772 cf::player::find $_[0]
439 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 773 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
440} 774}
441 775
442=item $player->reply ($npc, $msg[, $flags]) 776=item $player_object->reply ($npc, $msg[, $flags])
443 777
444Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 778Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
445can be C<undef>. Does the right thing when the player is currently in a 779can be C<undef>. Does the right thing when the player is currently in a
446dialogue with the given NPC character. 780dialogue with the given NPC character.
447 781
474 $msg{msgid} = $id; 808 $msg{msgid} = $id;
475 809
476 $self->send ("ext " . to_json \%msg); 810 $self->send ("ext " . to_json \%msg);
477} 811}
478 812
813=item $player_object->may ("access")
814
815Returns wether the given player is authorized to access resource "access"
816(e.g. "command_wizcast").
817
818=cut
819
820sub cf::object::player::may {
821 my ($self, $access) = @_;
822
823 $self->flag (cf::FLAG_WIZ) ||
824 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"})
827}
828
829=cut
830
479############################################################################# 831#############################################################################
480# map scripting support
481 832
833=head2 SAFE SCRIPTING
834
835Functions that provide a safe environment to compile and execute
836snippets of perl code without them endangering the safety of the server
837itself. Looping constructs, I/O operators and other built-in functionality
838is not available in the safe scripting environment, and the number of
839functions and methods that can be called is greatly reduced.
840
841=cut
842
482our $safe = new Safe "ext"; 843our $safe = new Safe "safe";
483our $safe_hole = new Safe::Hole; 844our $safe_hole = new Safe::Hole;
484 845
485$SIG{FPE} = 'IGNORE'; 846$SIG{FPE} = 'IGNORE';
486 847
487$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 848$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
488 849
489# here we export the classes and methods available to script code 850# here we export the classes and methods available to script code
490 851
852=pod
853
854The following fucntions and emthods are available within a safe environment:
855
856 cf::object contr pay_amount pay_player map
857 cf::object::player player
858 cf::player peaceful
859 cf::map trigger
860
861=cut
862
491for ( 863for (
492 ["cf::object" => qw(contr pay_amount pay_player)], 864 ["cf::object" => qw(contr pay_amount pay_player map)],
493 ["cf::object::player" => qw(player)], 865 ["cf::object::player" => qw(player)],
494 ["cf::player" => qw(peaceful)], 866 ["cf::player" => qw(peaceful)],
867 ["cf::map" => qw(trigger)],
495) { 868) {
496 no strict 'refs'; 869 no strict 'refs';
497 my ($pkg, @funs) = @$_; 870 my ($pkg, @funs) = @$_;
498 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 871 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
499 for @funs; 872 for @funs;
500} 873}
874
875=over 4
876
877=item @retval = safe_eval $code, [var => value, ...]
878
879Compiled and executes the given perl code snippet. additional var/value
880pairs result in temporary local (my) scalar variables of the given name
881that are available in the code snippet. Example:
882
883 my $five = safe_eval '$first + $second', first => 1, second => 4;
884
885=cut
501 886
502sub safe_eval($;@) { 887sub safe_eval($;@) {
503 my ($code, %vars) = @_; 888 my ($code, %vars) = @_;
504 889
505 my $qcode = $code; 890 my $qcode = $code;
506 $qcode =~ s/"/‟/g; # not allowed in #line filenames 891 $qcode =~ s/"/‟/g; # not allowed in #line filenames
507 $qcode =~ s/\n/\\n/g; 892 $qcode =~ s/\n/\\n/g;
508 893
509 local $_; 894 local $_;
510 local @ext::cf::_safe_eval_args = values %vars; 895 local @safe::cf::_safe_eval_args = values %vars;
511 896
512 $code = 897 my $eval =
513 "do {\n" 898 "do {\n"
514 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 899 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
515 . "#line 0 \"{$qcode}\"\n" 900 . "#line 0 \"{$qcode}\"\n"
516 . $code 901 . $code
517 . "\n}" 902 . "\n}"
518 ; 903 ;
519 904
520 sub_generation_inc; 905 sub_generation_inc;
521 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 906 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
522 sub_generation_inc; 907 sub_generation_inc;
523 908
909 if ($@) {
910 warn "$@";
911 warn "while executing safe code '$code'\n";
912 warn "with arguments " . (join " ", %vars) . "\n";
913 }
914
524 wantarray ? @res : $res[0] 915 wantarray ? @res : $res[0]
525} 916}
917
918=item cf::register_script_function $function => $cb
919
920Register a function that can be called from within map/npc scripts. The
921function should be reasonably secure and should be put into a package name
922like the extension.
923
924Example: register a function that gets called whenever a map script calls
925C<rent::overview>, as used by the C<rent> extension.
926
927 cf::register_script_function "rent::overview" => sub {
928 ...
929 };
930
931=cut
526 932
527sub register_script_function { 933sub register_script_function {
528 my ($fun, $cb) = @_; 934 my ($fun, $cb) = @_;
529 935
530 no strict 'refs'; 936 no strict 'refs';
531 *{"ext::$fun"} = $safe_hole->wrap ($cb); 937 *{"safe::$fun"} = $safe_hole->wrap ($cb);
938}
939
940=back
941
942=cut
943
944#############################################################################
945
946=head2 EXTENSION DATABASE SUPPORT
947
948Crossfire maintains a very simple database for extension use. It can
949currently store anything that can be serialised using Storable, which
950excludes objects.
951
952The parameter C<$family> should best start with the name of the extension
953using it, it should be unique.
954
955=over 4
956
957=item $hashref = cf::db_get $family
958
959Return a hashref for use by the extension C<$family>, which can be
960modified. After modifications, you have to call C<cf::db_dirty> or
961C<cf::db_sync>.
962
963=item $value = cf::db_get $family => $key
964
965Returns a single value from the database
966
967=item cf::db_put $family => $hashref
968
969Stores the given family hashref into the database. Updates are delayed, if
970you want the data to be synced to disk immediately, use C<cf::db_sync>.
971
972=item cf::db_put $family => $key => $value
973
974Stores the given C<$value> in the family hash. Updates are delayed, if you
975want the data to be synced to disk immediately, use C<cf::db_sync>.
976
977=item cf::db_dirty
978
979Marks the database as dirty, to be updated at a later time.
980
981=item cf::db_sync
982
983Immediately write the database to disk I<if it is dirty>.
984
985=cut
986
987our $DB;
988
989{
990 my $path = cf::localdir . "/database.pst";
991
992 sub db_load() {
993 warn "loading database $path\n";#d# remove later
994 $DB = stat $path ? Storable::retrieve $path : { };
995 }
996
997 my $pid;
998
999 sub db_save() {
1000 warn "saving database $path\n";#d# remove later
1001 waitpid $pid, 0 if $pid;
1002 if (0 == ($pid = fork)) {
1003 $DB->{_meta}{version} = 1;
1004 Storable::nstore $DB, "$path~";
1005 rename "$path~", $path;
1006 cf::_exit 0 if defined $pid;
1007 }
1008 }
1009
1010 my $dirty;
1011
1012 sub db_sync() {
1013 db_save if $dirty;
1014 undef $dirty;
1015 }
1016
1017 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1018 db_sync;
1019 });
1020
1021 sub db_dirty() {
1022 $dirty = 1;
1023 $idle->start;
1024 }
1025
1026 sub db_get($;$) {
1027 @_ >= 2
1028 ? $DB->{$_[0]}{$_[1]}
1029 : ($DB->{$_[0]} ||= { })
1030 }
1031
1032 sub db_put($$;$) {
1033 if (@_ >= 3) {
1034 $DB->{$_[0]}{$_[1]} = $_[2];
1035 } else {
1036 $DB->{$_[0]} = $_[1];
1037 }
1038 db_dirty;
1039 }
1040
1041 cf::global->attach (
1042 prio => 10000,
1043 on_cleanup => sub {
1044 db_sync;
1045 },
1046 );
532} 1047}
533 1048
534############################################################################# 1049#############################################################################
535# the server's main() 1050# the server's main()
536 1051
537sub run { 1052sub cfg_load {
1053 open my $fh, "<:utf8", cf::confdir . "/config"
1054 or return;
1055
1056 local $/;
1057 *CFG = YAML::Syck::Load <$fh>;
1058}
1059
1060sub main {
1061 cfg_load;
1062 db_load;
1063 load_extensions;
538 Event::loop; 1064 Event::loop;
539} 1065}
540 1066
541############################################################################# 1067#############################################################################
542# initialisation 1068# initialisation
543 1069
1070sub _perl_reload(&) {
1071 my ($msg) = @_;
1072
1073 $msg->("reloading...");
1074
1075 eval {
1076 # cancel all watchers
1077 for (Event::all_watchers) {
1078 $_->cancel if $_->data & WF_AUTOCANCEL;
1079 }
1080
1081 # unload all extensions
1082 for (@exts) {
1083 $msg->("unloading <$_>");
1084 unload_extension $_;
1085 }
1086
1087 # unload all modules loaded from $LIBDIR
1088 while (my ($k, $v) = each %INC) {
1089 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090
1091 $msg->("removing <$k>");
1092 delete $INC{$k};
1093
1094 $k =~ s/\.pm$//;
1095 $k =~ s/\//::/g;
1096
1097 if (my $cb = $k->can ("unload_module")) {
1098 $cb->();
1099 }
1100
1101 Symbol::delete_package $k;
1102 }
1103
1104 # sync database to disk
1105 cf::db_sync;
1106
1107 # get rid of safe::, as good as possible
1108 Symbol::delete_package "safe::$_"
1109 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1110
1111 # remove register_script_function callbacks
1112 # TODO
1113
1114 # unload cf.pm "a bit"
1115 delete $INC{"cf.pm"};
1116
1117 # don't, removes xs symbols, too,
1118 # and global variables created in xs
1119 #Symbol::delete_package __PACKAGE__;
1120
1121 # reload cf.pm
1122 $msg->("reloading cf.pm");
1123 require cf;
1124
1125 # load config and database again
1126 cf::cfg_load;
1127 cf::db_load;
1128
1129 # load extensions
1130 $msg->("load extensions");
1131 cf::load_extensions;
1132
1133 # reattach attachments to objects
1134 $msg->("reattach");
1135 _global_reattach;
1136 };
1137 $msg->($@) if $@;
1138
1139 $msg->("reloaded");
1140};
1141
1142sub perl_reload() {
1143 _perl_reload {
1144 warn $_[0];
1145 print "$_[0]\n";
1146 };
1147}
1148
544register "<global>", __PACKAGE__; 1149register "<global>", __PACKAGE__;
545 1150
1151register_command "perl-reload" => sub {
1152 my ($who, $arg) = @_;
1153
1154 if ($who->flag (FLAG_WIZ)) {
1155 _perl_reload {
1156 warn $_[0];
1157 $who->message ($_[0]);
1158 };
1159 }
1160};
1161
546unshift @INC, $LIBDIR; 1162unshift @INC, $LIBDIR;
547 1163
548load_extensions;
549
550$TICK_WATCHER = Event->timer ( 1164$TICK_WATCHER = Event->timer (
551 prio => 1, 1165 prio => 0,
552 at => $NEXT_TICK || 1, 1166 at => $NEXT_TICK || 1,
1167 data => WF_AUTOCANCEL,
553 cb => sub { 1168 cb => sub {
554 cf::server_tick; # one server iteration 1169 cf::server_tick; # one server iteration
555 1170
556 my $NOW = Event::time; 1171 my $NOW = Event::time;
557 $NEXT_TICK += $TICK; 1172 $NEXT_TICK += $TICK;
558 1173
559 # if we are delayed by four ticks, skip them all 1174 # if we are delayed by four ticks or more, skip them all
560 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1175 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
561 1176
562 $TICK_WATCHER->at ($NEXT_TICK); 1177 $TICK_WATCHER->at ($NEXT_TICK);
563 $TICK_WATCHER->start; 1178 $TICK_WATCHER->start;
564 }, 1179 },
565); 1180);
566 1181
1182IO::AIO::max_poll_time $TICK * 0.2;
1183
1184Event->io (fd => IO::AIO::poll_fileno,
1185 poll => 'r',
1186 prio => 5,
1187 data => WF_AUTOCANCEL,
1188 cb => \&IO::AIO::poll_cb);
1189
5671 11901
568 1191

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines