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.34 by root, Thu Aug 24 13:13:49 2006 UTC vs.
Revision 1.95 by root, Fri Dec 22 02:04:20 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; 31
20our $LIBDIR = maps_directory "perl"; 32our $TICK = MAX_TIME * 1e-6;
33our $TICK_WATCHER;
34our $NEXT_TICK;
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
21 67
22BEGIN { 68BEGIN {
23 @EVENT = map lc, @EVENT;
24
25 *CORE::GLOBAL::warn = sub { 69 *CORE::GLOBAL::warn = sub {
26 my $msg = join "", @_; 70 my $msg = join "", @_;
27 $msg .= "\n" 71 $msg .= "\n"
28 unless $msg =~ /\n$/; 72 unless $msg =~ /\n$/;
29 73
30 print STDERR "cfperl: $msg"; 74 print STDERR "cfperl: $msg";
31 LOG llevError, "cfperl: $msg"; 75 LOG llevError, "cfperl: $msg";
32 }; 76 };
33} 77}
34 78
35my %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';
36 85
37# generate property mutators 86# we bless all objects into (empty) derived classes to force a method lookup
38sub prop_gen { 87# within the Safe compartment.
39 my ($prefix, $class) = @_; 88for my $pkg (qw(
40 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)) {
41 no strict 'refs'; 95 no strict 'refs';
42
43 for my $prop (keys %PROP_TYPE) {
44 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
45 my $sub = lc $1;
46
47 my $type = $PROP_TYPE{$prop};
48 my $idx = $PROP_IDX {$prop};
49
50 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
51 $_[0]->get_property ($type, $idx)
52 };
53
54 *{"$class\::set_$sub"} = sub {
55 $_[0]->set_property ($type, $idx, $_[1]);
56 } unless $ignore_set{$prop};
57 }
58}
59
60# auto-generate most of the API
61
62prop_gen OBJECT_PROP => "cf::object";
63# CFAPI_OBJECT_ANIMATION?
64prop_gen PLAYER_PROP => "cf::object::player";
65
66prop_gen MAP_PROP => "cf::map";
67prop_gen ARCH_PROP => "cf::arch";
68
69# guessed hierarchies
70
71@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
72@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
73
74# we bless all objects into derived classes to force a method lookup
75# within the Safe compartment.
76for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
77 no strict 'refs';
78 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 96 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79} 97}
80 98
81$Event::DIED = sub { 99$Event::DIED = sub {
82 warn "error in event callback: @_"; 100 warn "error in event callback: @_";
83}; 101};
84 102
85my %ext_pkg; 103my %ext_pkg;
86my @exts; 104my @exts;
87my @hook; 105my @hook;
88my %command;
89my %extcmd;
90 106
91sub inject_event { 107=head2 UTILITY FUNCTIONS
92 my $extension = shift;
93 my $event_code = shift;
94 108
95 my $cb = $hook[$event_code]{$extension} 109=over 4
96 or return;
97 110
98 &$cb 111=cut
99}
100 112
101sub 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 {
102 my $event = shift; 396 my $event = shift;
397 my $callbacks = shift;
103 398
104 my $cb = $hook[$event] 399 @invoke_results = ();
105 or return;
106 400
107 List::Util::max map &$_, values %$cb 401 local $override;
108}
109 402
110sub 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) {
111 my ($name, $obj, $params) = @_; 467 my ($name, $args) = @$_;
112 468
113 for my $cmd (@{ $command{$name} }) { 469 $obj->attach ($name, %{$args || {} });
114 $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};
115 } 563 },
564);
116 565
117 -1 566#############################################################################
118} 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
119 575
120sub register_command { 576sub register_command {
121 my ($name, $time, $cb) = @_; 577 my ($name, $cb) = @_;
122 578
123 my $caller = caller; 579 my $caller = caller;
124 #warn "registering command '$name/$time' to '$caller'"; 580 #warn "registering command '$name/$time' to '$caller'";
125 581
126 push @{ $command{$name} }, [$time, $cb, $caller]; 582 push @{ $COMMAND{$name} }, [$caller, $cb];
127 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
128} 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
129 593
130sub register_extcmd { 594sub register_extcmd {
131 my ($name, $cb) = @_; 595 my ($name, $cb) = @_;
132 596
133 my $caller = caller; 597 my $caller = caller;
134 #warn "registering extcmd '$name' to '$caller'"; 598 #warn "registering extcmd '$name' to '$caller'";
135 599
136 $extcmd{$name} = [$cb, $caller]; 600 $EXTCMD{$name} = [$cb, $caller];
137} 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);
138 634
139sub register { 635sub register {
140 my ($base, $pkg) = @_; 636 my ($base, $pkg) = @_;
141 637
142 for my $idx (0 .. $#EVENT) { 638 #TODO
143 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
144 #warn "registering $EVENT[$idx] hook to '$pkg'\n";
145 $hook[$idx]{$base} = $ref;
146 }
147 }
148} 639}
149 640
150sub load_extension { 641sub load_extension {
151 my ($path) = @_; 642 my ($path) = @_;
152 643
153 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 644 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
154 my $base = $1; 645 my $base = $1;
155 my $pkg = $1; 646 my $pkg = $1;
156 $pkg =~ s/[^[:word:]]/_/g; 647 $pkg =~ s/[^[:word:]]/_/g;
157 $pkg = "cf::ext::$pkg"; 648 $pkg = "ext::$pkg";
158 649
159 warn "loading '$path' into '$pkg'\n"; 650 warn "loading '$path' into '$pkg'\n";
160 651
161 open my $fh, "<:utf8", $path 652 open my $fh, "<:utf8", $path
162 or die "$path: $!"; 653 or die "$path: $!";
166 . "#line 1 \"$path\"\n{\n" 657 . "#line 1 \"$path\"\n{\n"
167 . (do { local $/; <$fh> }) 658 . (do { local $/; <$fh> })
168 . "\n};\n1"; 659 . "\n};\n1";
169 660
170 eval $source 661 eval $source
171 or die "$path: $@"; 662 or die $@ ? "$path: $@\n"
663 : "extension disabled.\n";
172 664
173 push @exts, $pkg; 665 push @exts, $pkg;
174 $ext_pkg{$base} = $pkg; 666 $ext_pkg{$base} = $pkg;
175 667
176# no strict 'refs'; 668# no strict 'refs';
183 my ($pkg) = @_; 675 my ($pkg) = @_;
184 676
185 warn "removing extension $pkg\n"; 677 warn "removing extension $pkg\n";
186 678
187 # remove hooks 679 # remove hooks
680 #TODO
188 for my $idx (0 .. $#EVENT) { 681# for my $idx (0 .. $#PLUGIN_EVENT) {
189 delete $hook[$idx]{$pkg}; 682# delete $hook[$idx]{$pkg};
190 } 683# }
191 684
192 # remove commands 685 # remove commands
193 for my $name (keys %command) { 686 for my $name (keys %COMMAND) {
194 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
195 688
196 if (@cb) { 689 if (@cb) {
197 $command{$name} = \@cb; 690 $COMMAND{$name} = \@cb;
198 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
199 } else { 691 } else {
200 delete $command{$name};
201 delete $COMMAND{"$name\000"}; 692 delete $COMMAND{$name};
202 } 693 }
203 } 694 }
204 695
205 # remove extcmds 696 # remove extcmds
206 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
207 delete $extcmd{$name}; 698 delete $EXTCMD{$name};
208 } 699 }
209 700
210 if (my $cb = $pkg->can ("on_unload")) { 701 if (my $cb = $pkg->can ("unload")) {
211 eval { 702 eval {
212 $cb->($pkg); 703 $cb->($pkg);
213 1 704 1
214 } or warn "$pkg unloaded, but with errors: $@"; 705 } or warn "$pkg unloaded, but with errors: $@";
215 } 706 }
216 707
217 Symbol::delete_package $pkg; 708 Symbol::delete_package $pkg;
218} 709}
219 710
220sub load_extensions { 711sub load_extensions {
221 my $LIBDIR = maps_directory "perl";
222
223 for my $ext (<$LIBDIR/*.ext>) { 712 for my $ext (<$LIBDIR/*.ext>) {
224 next unless -r $ext; 713 next unless -r $ext;
225 eval { 714 eval {
226 load_extension $ext; 715 load_extension $ext;
227 1 716 1
228 } or warn "$ext not loaded: $@"; 717 } or warn "$ext not loaded: $@";
229 } 718 }
230} 719}
231 720
232register_command "perl-reload", 0, sub {
233 my ($who, $arg) = @_;
234
235 if ($who->flag (FLAG_WIZ)) {
236 $who->message ("reloading...");
237
238 warn "reloading...\n";
239 eval {
240 # 1. cancel all watchers
241 $_->cancel for Event::all_watchers;
242
243 # 2. unload all extensions
244 for (@exts) {
245 $who->message ("unloading <$_>");
246 unload_extension $_;
247 }
248
249 # 3. unload all modules loaded from $LIBDIR
250 while (my ($k, $v) = each %INC) {
251 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
252
253 $who->message ("removing <$k>");
254 delete $INC{$k};
255
256 $k =~ s/\.pm$//;
257 $k =~ s/\//::/g;
258
259 if (my $cb = $k->can ("unload_module")) {
260 $cb->();
261 }
262
263 Symbol::delete_package $k;
264 }
265
266 # 4. get rid of ext::, as good as possible
267 Symbol::delete_package "ext::$_"
268 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
269
270 # 5. remove register_script_function callbacks
271 # TODO
272
273 # 6. unload cf.pm "a bit"
274 delete $INC{"cf.pm"};
275
276 # don't, removes xs symbols, too
277 #Symbol::delete_package __PACKAGE__;
278
279 # 7. reload cf.pm
280 $who->message ("reloading cf.pm");
281 require cf;
282 };
283 warn $@ if $@;
284 $who->message ($@) if $@;
285 warn "reloaded\n";
286
287 $who->message ("reloaded");
288 } else {
289 $who->message ("Intruder Alert!");
290 }
291};
292
293#############################################################################
294# utility functions
295
296use JSON::Syck (); # TODO# replace by JSON::PC once working
297
298sub from_json($) {
299 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
300 JSON::Syck::Load $_[0]
301}
302
303sub to_json($) {
304 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
305 JSON::Syck::Dump $_[0]
306}
307
308#############################################################################
309# extcmd framework, basically convert ext <msg>
310# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
311
312sub on_extcmd {
313 my ($pl, $buf) = @_;
314
315 my $msg = eval { from_json $buf };
316
317 if (ref $msg) {
318 if (my $cb = $extcmd{$msg->{msgtype}}) {
319 if (my %reply = $cb->[0]->($pl, $msg)) {
320 $pl->ext_reply ($msg->{msgid}, %reply);
321 }
322 }
323 } else {
324 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
325 }
326
327 1
328}
329
330############################################################################# 721#############################################################################
331# load/save/clean perl data associated with a map 722# load/save/clean perl data associated with a map
332 723
333*on_mapclean = sub { 724*cf::mapsupport::on_clean = sub {
334 my ($map) = @_; 725 my ($map) = @_;
335 726
336 my $path = $map->tmpname; 727 my $path = $map->tmpname;
337 defined $path or return; 728 defined $path or return;
338 729
339 unlink "$path.cfperl"; 730 unlink "$path.pst";
340}; 731};
341 732
342*on_mapin = 733cf::map->attach (prio => -10000, package => cf::mapsupport::);
343*on_mapload = sub {
344 my ($map) = @_;
345
346 my $path = $map->tmpname;
347 $path = $map->path unless defined $path;
348
349 open my $fh, "<:raw", "$path.cfperl"
350 or return; # no perl data
351
352 my $data = Storable::thaw do { local $/; <$fh> };
353
354 $data->{version} <= 1
355 or return; # too new
356
357 $map->_set_obs ($data->{obs});
358};
359
360*on_mapout = sub {
361 my ($map) = @_;
362
363 my $path = $map->tmpname;
364 $path = $map->path unless defined $path;
365
366 my $obs = $map->_get_obs;
367
368 if (defined $obs) {
369 open my $fh, ">:raw", "$path.cfperl"
370 or die "$path.cfperl: $!";
371
372 stat $path;
373
374 print $fh Storable::nfreeze {
375 size => (stat _)[7],
376 time => (stat _)[9],
377 version => 1,
378 obs => $obs,
379 };
380
381 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
382 } else {
383 unlink "$path.cfperl";
384 }
385};
386 734
387############################################################################# 735#############################################################################
388# load/save perl data associated with player->ob objects 736# load/save perl data associated with player->ob objects
389 737
390sub all_objects(@) { 738sub all_objects(@) {
391 @_, map all_objects ($_->inv), @_ 739 @_, map all_objects ($_->inv), @_
392} 740}
393 741
394*on_player_load = sub { 742# TODO: compatibility cruft, remove when no longer needed
743cf::player->attach (
744 on_load => sub {
395 my ($ob, $path) = @_; 745 my ($pl, $path) = @_;
396 746
397 for my $o (all_objects $ob) { 747 for my $o (all_objects $pl->ob) {
398 if (my $value = $o->get_ob_key_value ("_perl_data")) { 748 if (my $value = $o->get_ob_key_value ("_perl_data")) {
399 $o->set_ob_key_value ("_perl_data"); 749 $o->set_ob_key_value ("_perl_data");
400 750
401 %$o = %{ Storable::thaw pack "H*", $value }; 751 %$o = %{ Storable::thaw pack "H*", $value };
402 } 752 }
753 }
403 } 754 },
404}; 755);
405
406*on_player_save = sub {
407 my ($ob, $path) = @_;
408
409 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
410 for grep %$_, all_objects $ob;
411};
412 756
413############################################################################# 757#############################################################################
414# core extensions - in perl 758
759=head2 CORE EXTENSIONS
760
761Functions and methods that extend core crossfire objects.
762
763=head3 cf::player
764
765=over 4
415 766
416=item cf::player::exists $login 767=item cf::player::exists $login
417 768
418Returns true when the given account exists. 769Returns true when the given account exists.
419 770
422sub cf::player::exists($) { 773sub cf::player::exists($) {
423 cf::player::find $_[0] 774 cf::player::find $_[0]
424 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 775 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
425} 776}
426 777
778=item $player->ext_reply ($msgid, $msgtype, %msg)
779
780Sends an ext reply to the player.
781
782=cut
783
784sub cf::player::ext_reply($$$%) {
785 my ($self, $id, %msg) = @_;
786
787 $msg{msgid} = $id;
788
789 $self->send ("ext " . to_json \%msg);
790}
791
792=back
793
794=head3 cf::object::player
795
796=over 4
797
427=item $player->reply ($npc, $msg[, $flags]) 798=item $player_object->reply ($npc, $msg[, $flags])
428 799
429Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 800Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
430can be C<undef>. Does the right thing when the player is currently in a 801can be C<undef>. Does the right thing when the player is currently in a
431dialogue with the given NPC character. 802dialogue with the given NPC character.
432 803
433=cut 804=cut
434 805
435# rough implementation of a future "reply" method that works 806# rough implementation of a future "reply" method that works
436# with dialog boxes. 807# with dialog boxes.
808#TODO: the first argument must go, split into a $npc->reply_to ( method
437sub cf::object::player::reply($$$;$) { 809sub cf::object::player::reply($$$;$) {
438 my ($self, $npc, $msg, $flags) = @_; 810 my ($self, $npc, $msg, $flags) = @_;
439 811
440 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 812 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
441 813
445 $msg = $npc->name . " says: $msg" if $npc; 817 $msg = $npc->name . " says: $msg" if $npc;
446 $self->message ($msg, $flags); 818 $self->message ($msg, $flags);
447 } 819 }
448} 820}
449 821
450=item $player->ext_reply ($msgid, $msgtype, %msg) 822=item $player_object->may ("access")
451 823
452Sends an ext reply to the player. 824Returns wether the given player is authorized to access resource "access"
825(e.g. "command_wizcast").
453 826
454=cut 827=cut
455 828
456sub cf::player::ext_reply($$$%) { 829sub cf::object::player::may {
457 my ($self, $id, %msg) = @_; 830 my ($self, $access) = @_;
458 831
459 $msg{msgid} = $id; 832 $self->flag (cf::FLAG_WIZ) ||
460 833 (ref $cf::CFG{"may_$access"}
461 $self->send ("ext " . to_json \%msg); 834 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835 : $cf::CFG{"may_$access"})
462} 836}
463 837
464############################################################################# 838=head3 cf::client
465# map scripting support
466 839
840=over 4
841
842=item $client->send_drawinfo ($text, $flags)
843
844Sends a drawinfo packet to the client. Circumvents output buffering so
845should not be used under normal circumstances.
846
847=cut
848
849sub cf::client::send_drawinfo {
850 my ($self, $text, $flags) = @_;
851
852 utf8::encode $text;
853 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
854}
855
856
857=item $success = $client->query ($flags, "text", \&cb)
858
859Queues a query to the client, calling the given callback with
860the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
861C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
862
863Queries can fail, so check the return code. Or don't, as queries will become
864reliable at some point in the future.
865
866=cut
867
868sub cf::client::query {
869 my ($self, $flags, $text, $cb) = @_;
870
871 return unless $self->state == ST_PLAYING
872 || $self->state == ST_SETUP
873 || $self->state == ST_CUSTOM;
874
875 $self->state (ST_CUSTOM);
876
877 utf8::encode $text;
878 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
879
880 $self->send_packet ($self->{query_queue}[0][0])
881 if @{ $self->{query_queue} } == 1;
882}
883
884cf::client->attach (
885 on_reply => sub {
886 my ($ns, $msg) = @_;
887
888 # this weird shuffling is so that direct followup queries
889 # get handled first
890 my $queue = delete $ns->{query_queue};
891
892 (shift @$queue)->[1]->($msg);
893
894 push @{ $ns->{query_queue} }, @$queue;
895
896 if (@{ $ns->{query_queue} } == @$queue) {
897 if (@$queue) {
898 $ns->send_packet ($ns->{query_queue}[0][0]);
899 } else {
900 $ns->state (ST_PLAYING);
901 }
902 }
903 },
904);
905
906=back
907
908
909=head2 SAFE SCRIPTING
910
911Functions that provide a safe environment to compile and execute
912snippets of perl code without them endangering the safety of the server
913itself. Looping constructs, I/O operators and other built-in functionality
914is not available in the safe scripting environment, and the number of
915functions and methods that can be called is greatly reduced.
916
917=cut
918
467our $safe = new Safe "ext"; 919our $safe = new Safe "safe";
468our $safe_hole = new Safe::Hole; 920our $safe_hole = new Safe::Hole;
469 921
470$SIG{FPE} = 'IGNORE'; 922$SIG{FPE} = 'IGNORE';
471 923
472$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 924$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
473 925
474# here we export the classes and methods available to script code 926# here we export the classes and methods available to script code
475 927
928=pod
929
930The following fucntions and emthods are available within a safe environment:
931
932 cf::object contr pay_amount pay_player map
933 cf::object::player player
934 cf::player peaceful
935 cf::map trigger
936
937=cut
938
476for ( 939for (
477 ["cf::object" => qw(contr pay_amount pay_player)], 940 ["cf::object" => qw(contr pay_amount pay_player map)],
478 ["cf::object::player" => qw(player)], 941 ["cf::object::player" => qw(player)],
479 ["cf::player" => qw(peaceful)], 942 ["cf::player" => qw(peaceful)],
943 ["cf::map" => qw(trigger)],
480) { 944) {
481 no strict 'refs'; 945 no strict 'refs';
482 my ($pkg, @funs) = @$_; 946 my ($pkg, @funs) = @$_;
483 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 947 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
484 for @funs; 948 for @funs;
485} 949}
950
951=over 4
952
953=item @retval = safe_eval $code, [var => value, ...]
954
955Compiled and executes the given perl code snippet. additional var/value
956pairs result in temporary local (my) scalar variables of the given name
957that are available in the code snippet. Example:
958
959 my $five = safe_eval '$first + $second', first => 1, second => 4;
960
961=cut
486 962
487sub safe_eval($;@) { 963sub safe_eval($;@) {
488 my ($code, %vars) = @_; 964 my ($code, %vars) = @_;
489 965
490 my $qcode = $code; 966 my $qcode = $code;
491 $qcode =~ s/"/‟/g; # not allowed in #line filenames 967 $qcode =~ s/"/‟/g; # not allowed in #line filenames
492 $qcode =~ s/\n/\\n/g; 968 $qcode =~ s/\n/\\n/g;
493 969
494 local $_; 970 local $_;
495 local @ext::cf::_safe_eval_args = values %vars; 971 local @safe::cf::_safe_eval_args = values %vars;
496 972
497 $code = 973 my $eval =
498 "do {\n" 974 "do {\n"
499 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 975 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
500 . "#line 0 \"{$qcode}\"\n" 976 . "#line 0 \"{$qcode}\"\n"
501 . $code 977 . $code
502 . "\n}" 978 . "\n}"
503 ; 979 ;
504 980
505 sub_generation_inc; 981 sub_generation_inc;
506 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 982 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
507 sub_generation_inc; 983 sub_generation_inc;
508 984
985 if ($@) {
986 warn "$@";
987 warn "while executing safe code '$code'\n";
988 warn "with arguments " . (join " ", %vars) . "\n";
989 }
990
509 wantarray ? @res : $res[0] 991 wantarray ? @res : $res[0]
510} 992}
993
994=item cf::register_script_function $function => $cb
995
996Register a function that can be called from within map/npc scripts. The
997function should be reasonably secure and should be put into a package name
998like the extension.
999
1000Example: register a function that gets called whenever a map script calls
1001C<rent::overview>, as used by the C<rent> extension.
1002
1003 cf::register_script_function "rent::overview" => sub {
1004 ...
1005 };
1006
1007=cut
511 1008
512sub register_script_function { 1009sub register_script_function {
513 my ($fun, $cb) = @_; 1010 my ($fun, $cb) = @_;
514 1011
515 no strict 'refs'; 1012 no strict 'refs';
516 *{"ext::$fun"} = $safe_hole->wrap ($cb); 1013 *{"safe::$fun"} = $safe_hole->wrap ($cb);
1014}
1015
1016=back
1017
1018=cut
1019
1020#############################################################################
1021
1022=head2 EXTENSION DATABASE SUPPORT
1023
1024Crossfire maintains a very simple database for extension use. It can
1025currently store anything that can be serialised using Storable, which
1026excludes objects.
1027
1028The parameter C<$family> should best start with the name of the extension
1029using it, it should be unique.
1030
1031=over 4
1032
1033=item $hashref = cf::db_get $family
1034
1035Return a hashref for use by the extension C<$family>, which can be
1036modified. After modifications, you have to call C<cf::db_dirty> or
1037C<cf::db_sync>.
1038
1039=item $value = cf::db_get $family => $key
1040
1041Returns a single value from the database
1042
1043=item cf::db_put $family => $hashref
1044
1045Stores the given family hashref into the database. Updates are delayed, if
1046you want the data to be synced to disk immediately, use C<cf::db_sync>.
1047
1048=item cf::db_put $family => $key => $value
1049
1050Stores the given C<$value> in the family hash. Updates are delayed, if you
1051want the data to be synced to disk immediately, use C<cf::db_sync>.
1052
1053=item cf::db_dirty
1054
1055Marks the database as dirty, to be updated at a later time.
1056
1057=item cf::db_sync
1058
1059Immediately write the database to disk I<if it is dirty>.
1060
1061=cut
1062
1063our $DB;
1064
1065{
1066 my $path = cf::localdir . "/database.pst";
1067
1068 sub db_load() {
1069 warn "loading database $path\n";#d# remove later
1070 $DB = stat $path ? Storable::retrieve $path : { };
1071 }
1072
1073 my $pid;
1074
1075 sub db_save() {
1076 warn "saving database $path\n";#d# remove later
1077 waitpid $pid, 0 if $pid;
1078 if (0 == ($pid = fork)) {
1079 $DB->{_meta}{version} = 1;
1080 Storable::nstore $DB, "$path~";
1081 rename "$path~", $path;
1082 cf::_exit 0 if defined $pid;
1083 }
1084 }
1085
1086 my $dirty;
1087
1088 sub db_sync() {
1089 db_save if $dirty;
1090 undef $dirty;
1091 }
1092
1093 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1094 db_sync;
1095 });
1096
1097 sub db_dirty() {
1098 $dirty = 1;
1099 $idle->start;
1100 }
1101
1102 sub db_get($;$) {
1103 @_ >= 2
1104 ? $DB->{$_[0]}{$_[1]}
1105 : ($DB->{$_[0]} ||= { })
1106 }
1107
1108 sub db_put($$;$) {
1109 if (@_ >= 3) {
1110 $DB->{$_[0]}{$_[1]} = $_[2];
1111 } else {
1112 $DB->{$_[0]} = $_[1];
1113 }
1114 db_dirty;
1115 }
1116
1117 cf::global->attach (
1118 prio => 10000,
1119 on_cleanup => sub {
1120 db_sync;
1121 },
1122 );
517} 1123}
518 1124
519############################################################################# 1125#############################################################################
520# the server's main() 1126# the server's main()
521 1127
522sub run { 1128sub cfg_load {
523 my $tick = MAX_TIME * 1e-6; 1129 open my $fh, "<:utf8", cf::confdir . "/config"
524 my $next = Event::time; 1130 or return;
525 my $timer = Event->timer (at => $next, cb => sub {
526 cf::server_tick; # one server iteration
527 1131
528 $next += $tick; 1132 local $/;
529 my $NOW = Event::time; 1133 *CFG = YAML::Syck::Load <$fh>;
1134}
530 1135
531 # if we are delayd by > 0.25 second, skip ticks 1136sub main {
532 $next = $NOW if $NOW >= $next + .25; 1137 cfg_load;
533 1138 db_load;
534 $_[0]->w->at ($next); 1139 load_extensions;
535 $_[0]->w->start;
536 });
537
538 Event::loop; 1140 Event::loop;
539} 1141}
540 1142
541############################################################################# 1143#############################################################################
542# initialisation 1144# initialisation
543 1145
1146sub _perl_reload(&) {
1147 my ($msg) = @_;
1148
1149 $msg->("reloading...");
1150
1151 eval {
1152 # cancel all watchers
1153 for (Event::all_watchers) {
1154 $_->cancel if $_->data & WF_AUTOCANCEL;
1155 }
1156
1157 # unload all extensions
1158 for (@exts) {
1159 $msg->("unloading <$_>");
1160 unload_extension $_;
1161 }
1162
1163 # unload all modules loaded from $LIBDIR
1164 while (my ($k, $v) = each %INC) {
1165 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1166
1167 $msg->("removing <$k>");
1168 delete $INC{$k};
1169
1170 $k =~ s/\.pm$//;
1171 $k =~ s/\//::/g;
1172
1173 if (my $cb = $k->can ("unload_module")) {
1174 $cb->();
1175 }
1176
1177 Symbol::delete_package $k;
1178 }
1179
1180 # sync database to disk
1181 cf::db_sync;
1182
1183 # get rid of safe::, as good as possible
1184 Symbol::delete_package "safe::$_"
1185 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1186
1187 # remove register_script_function callbacks
1188 # TODO
1189
1190 # unload cf.pm "a bit"
1191 delete $INC{"cf.pm"};
1192
1193 # don't, removes xs symbols, too,
1194 # and global variables created in xs
1195 #Symbol::delete_package __PACKAGE__;
1196
1197 # reload cf.pm
1198 $msg->("reloading cf.pm");
1199 require cf;
1200
1201 # load config and database again
1202 cf::cfg_load;
1203 cf::db_load;
1204
1205 # load extensions
1206 $msg->("load extensions");
1207 cf::load_extensions;
1208
1209 # reattach attachments to objects
1210 $msg->("reattach");
1211 _global_reattach;
1212 };
1213 $msg->($@) if $@;
1214
1215 $msg->("reloaded");
1216};
1217
1218sub perl_reload() {
1219 _perl_reload {
1220 warn $_[0];
1221 print "$_[0]\n";
1222 };
1223}
1224
544register "<global>", __PACKAGE__; 1225register "<global>", __PACKAGE__;
545 1226
1227register_command "perl-reload" => sub {
1228 my ($who, $arg) = @_;
1229
1230 if ($who->flag (FLAG_WIZ)) {
1231 _perl_reload {
1232 warn $_[0];
1233 $who->message ($_[0]);
1234 };
1235 }
1236};
1237
546unshift @INC, $LIBDIR; 1238unshift @INC, $LIBDIR;
547 1239
548load_extensions; 1240$TICK_WATCHER = Event->timer (
1241 prio => 0,
1242 at => $NEXT_TICK || 1,
1243 data => WF_AUTOCANCEL,
1244 cb => sub {
1245 cf::server_tick; # one server iteration
1246
1247 my $NOW = Event::time;
1248 $NEXT_TICK += $TICK;
1249
1250 # if we are delayed by four ticks or more, skip them all
1251 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1252
1253 $TICK_WATCHER->at ($NEXT_TICK);
1254 $TICK_WATCHER->start;
1255 },
1256);
1257
1258IO::AIO::max_poll_time $TICK * 0.2;
1259
1260Event->io (fd => IO::AIO::poll_fileno,
1261 poll => 'r',
1262 prio => 5,
1263 data => WF_AUTOCANCEL,
1264 cb => \&IO::AIO::poll_cb);
549 1265
5501 12661
551 1267

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines