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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines