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.26 by root, Thu Jul 20 22:03:36 2006 UTC vs.
Revision 1.102 by root, Wed Dec 27 15:20:54 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines