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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines