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.1 by root, Fri Feb 3 19:49:32 2006 UTC vs.
Revision 1.43 by root, Fri Aug 25 17:11:53 2006 UTC

1package cf; 1package cf;
2 2
3use Symbol; 3use Symbol;
4use List::Util; 4use List::Util;
5use Storable;
6use Opcode;
7use Safe;
8use Safe::Hole;
9
10use Time::HiRes;
11use Event;
12$Event::Eval = 1; # no idea why this is required, but it is
5 13
6use strict; 14use strict;
7 15
8our %COMMAND; 16our %COMMAND = ();
9our @EVENT; 17our @EVENT;
18our @PLUGIN_EVENT;
10our %PROP_TYPE; 19our %PROP_TYPE;
11our %PROP_IDX; 20our %PROP_IDX;
21our $LIBDIR = maps_directory "perl";
22
23our $TICK = MAX_TIME * 1e-6;
24our $TICK_WATCHER;
25our $NEXT_TICK;
12 26
13BEGIN { 27BEGIN {
14 @EVENT = map lc, @EVENT; 28 @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
15 29
16 *CORE::GLOBAL::warn = sub { 30 *CORE::GLOBAL::warn = sub {
17 my $msg = join "", @_; 31 my $msg = join "", @_;
18 $msg .= "\n" 32 $msg .= "\n"
19 unless $msg =~ /\n$/; 33 unless $msg =~ /\n$/;
21 print STDERR "cfperl: $msg"; 35 print STDERR "cfperl: $msg";
22 LOG llevError, "cfperl: $msg"; 36 LOG llevError, "cfperl: $msg";
23 }; 37 };
24} 38}
25 39
40my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
41
26# generate property mutators 42# generate property mutators
27sub prop_gen { 43sub prop_gen {
28 my ($prefix, $class) = @_; 44 my ($prefix, $class) = @_;
29 45
30 no strict 'refs'; 46 no strict 'refs';
40 $_[0]->get_property ($type, $idx) 56 $_[0]->get_property ($type, $idx)
41 }; 57 };
42 58
43 *{"$class\::set_$sub"} = sub { 59 *{"$class\::set_$sub"} = sub {
44 $_[0]->set_property ($type, $idx, $_[1]); 60 $_[0]->set_property ($type, $idx, $_[1]);
45 }; 61 } unless $ignore_set{$prop};
46 } 62 }
47} 63}
48 64
49# auto-generate most of the API 65# auto-generate most of the API
50 66
55prop_gen MAP_PROP => "cf::map"; 71prop_gen MAP_PROP => "cf::map";
56prop_gen ARCH_PROP => "cf::arch"; 72prop_gen ARCH_PROP => "cf::arch";
57 73
58# guessed hierarchies 74# guessed hierarchies
59 75
60@cf::object::player::ISA = 'cf::object'; 76@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
61@cf::object::map::ISA = 'cf::object'; 77@safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
62 78
79# we bless all objects into (empty) derived classes to force a method lookup
80# within the Safe compartment.
81for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
82 no strict 'refs';
83 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84}
85
86$Event::DIED = sub {
87 warn "error in event callback: @_";
88};
89
90my %ext_pkg;
63my @exts; 91my @exts;
64my @hook; 92my @hook;
65my %command; 93my %command;
94my %extcmd;
95
96#############################################################################
97# "new" plug-in system
98
99=item cf::object::attach ... # NYI
100
101=item cf::attach_global ...
102
103=item cf::attach_to_type ...
104
105=item cf::attach_to_objects ...
106
107=item cf::attach_to_players ...
108
109=item cf::attach_to_maps ...
110
111 prio => $number, # lower is earlier
112 on_xxx => \&cb,
113 package => package::,
114
115=cut
116
117# the following variables are defined in .xs and must not be re-created
118our @CB_GLOBAL = (); # registry for all global events
119our @CB_OBJECT = ();
120our @CB_PLAYER = ();
121our @CB_TYPE = (); # registry for type (cf-object class) based events
122our @CB_MAP = ();
123
124sub _attach_cb($\%$$$) {
125 my ($registry, $undo, $event, $prio, $cb) = @_;
126
127 use sort 'stable';
128
129 $cb = [$prio, $cb];
130
131 @{$registry->[$event]} = sort
132 { $a->[0] cmp $b->[0] }
133 @{$registry->[$event] || []}, $cb;
134
135 push @{$undo->{cb}}, [$event, $cb];
136}
137
138# attach handles attaching event callbacks
139# the only thing the caller has to do is pass the correct
140# registry (== where the callback attaches to).
141sub _attach(\@$\@) {
142 my ($registry, $klass, $arg) = @_;
143
144 my $prio = 0;
145
146 my %undo = (
147 registry => $registry,
148 cb => [],
149 );
150
151 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
152
153 while (@$arg) {
154 my $type = shift @$arg;
155
156 if ($type eq "prio") {
157 $prio = shift @$arg;
158
159 } elsif ($type eq "package") {
160 my $pkg = shift @$arg;
161
162 while (my ($name, $id) = each %cb_id) {
163 if (my $cb = $pkg->can ($name)) {
164 _attach_cb $registry, %undo, $id, $prio, $cb;
165 }
166 }
167
168 } elsif (exists $cb_id{$type}) {
169 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;
170
171 } elsif (ref $type) {
172 warn "attaching objects not supported, ignoring.\n";
173
174 } else {
175 shift @$arg;
176 warn "attach argument '$type' not supported, ignoring.\n";
177 }
178 }
179
180 \%undo
181}
182
183sub cf::object::attach {
184 die;
185}
186
187sub attach_global {
188 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
189}
190
191sub attach_to_type {
192 my $type = shift;
193 _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
194}
195
196sub attach_to_objects {
197 _attach @CB_OBJECT, KLASS_OBJECT, @_
198}
199
200sub attach_to_players {
201 _attach @CB_PLAYER, KLASS_PLAYER, @_
202}
203
204sub attach_to_maps {
205 _attach @CB_MAP, KLASS_MAP, @_
206}
207
208our $override;
209
210sub override() {
211 $override = 1
212}
213
214sub invoke {
215 my $event = shift;
216 my $callbacks = shift;
217
218 local $override;
219
220 for (@$callbacks) {
221 eval { &{$_->[1]} };
222
223 if ($@) {
224 warn "$@";
225 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
226 override;
227 }
228
229 return 1 if $override;
230 }
231
232 0
233}
234
235#############################################################################
236# old plug-in events
66 237
67sub inject_event { 238sub inject_event {
68 my ($data) = @_; 239 my $extension = shift;
240 my $event_code = shift;
69 241
70 my $cb = $hook[$data->{event_code}] 242 my $cb = $hook[$event_code]{$extension}
71 or return; 243 or return;
72 244
73 $_->($data) for values %$cb; 245 &$cb
246}
74 247
75 () 248sub inject_global_event {
249 my $event = shift;
250
251 my $cb = $hook[$event]
252 or return;
253
254 List::Util::max map &$_, values %$cb
76} 255}
77 256
78sub inject_command { 257sub inject_command {
79 my ($name, $obj, $params) = @_; 258 my ($name, $obj, $params) = @_;
80 259
87 266
88sub register_command { 267sub register_command {
89 my ($name, $time, $cb) = @_; 268 my ($name, $time, $cb) = @_;
90 269
91 my $caller = caller; 270 my $caller = caller;
271 #warn "registering command '$name/$time' to '$caller'";
92 272
93 push @{ $command{$name} }, [$time, $cb, $caller]; 273 push @{ $command{$name} }, [$time, $cb, $caller];
94 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; 274 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
95} 275}
96 276
277sub register_extcmd {
278 my ($name, $cb) = @_;
279
280 my $caller = caller;
281 #warn "registering extcmd '$name' to '$caller'";
282
283 $extcmd{$name} = [$cb, $caller];
284}
285
286sub register {
287 my ($base, $pkg) = @_;
288
289 for my $idx (0 .. $#PLUGIN_EVENT) {
290 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
291 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
292 $hook[$idx]{$base} = $ref;
293 }
294 }
295}
296
97sub load_extension { 297sub load_extension {
98 my ($path) = @_; 298 my ($path) = @_;
99 299
100 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 300 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
301 my $base = $1;
101 my $pkg = $1; 302 my $pkg = $1;
102 $pkg =~ s/[^[:word:]]/_/g; 303 $pkg =~ s/[^[:word:]]/_/g;
103 $pkg = "cf::ext::$pkg"; 304 $pkg = "ext::$pkg";
104 305
105 warn "loading '$path' into '$pkg'\n"; 306 warn "loading '$path' into '$pkg'\n";
106 307
107 open my $fh, "<:utf8", $path 308 open my $fh, "<:utf8", $path
108 or die "$path: $!"; 309 or die "$path: $!";
115 316
116 eval $source 317 eval $source
117 or die "$path: $@"; 318 or die "$path: $@";
118 319
119 push @exts, $pkg; 320 push @exts, $pkg;
321 $ext_pkg{$base} = $pkg;
120 322
121 no strict 'refs'; 323# no strict 'refs';
122
123# @{"$pkg\::ISA"} = cf::ext::; 324# @{"$pkg\::ISA"} = ext::;
124 325
125 for my $idx (0 .. $#EVENT) { 326 register $base, $pkg;
126 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
127 warn "registering $EVENT[$idx] hook\n";
128 $hook[$idx]{$pkg} = $ref;
129 }
130 }
131} 327}
132 328
133sub unload_extension { 329sub unload_extension {
134 my ($pkg) = @_; 330 my ($pkg) = @_;
135 331
136 warn "removing extension $pkg\n"; 332 warn "removing extension $pkg\n";
137 333
138 # remove hooks 334 # remove hooks
139 for my $idx (0 .. $#EVENT) { 335 for my $idx (0 .. $#PLUGIN_EVENT) {
140 delete $hook[$idx]{$pkg}; 336 delete $hook[$idx]{$pkg};
141 } 337 }
142 338
143 # remove commands 339 # remove commands
144 for my $name (keys %command) { 340 for my $name (keys %command) {
151 delete $command{$name}; 347 delete $command{$name};
152 delete $COMMAND{"$name\000"}; 348 delete $COMMAND{"$name\000"};
153 } 349 }
154 } 350 }
155 351
352 # remove extcmds
353 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
354 delete $extcmd{$name};
355 }
356
357 if (my $cb = $pkg->can ("unload")) {
358 eval {
359 $cb->($pkg);
360 1
361 } or warn "$pkg unloaded, but with errors: $@";
362 }
363
156 Symbol::delete_package $pkg; 364 Symbol::delete_package $pkg;
157} 365}
158 366
159sub load_extensions { 367sub load_extensions {
160 my $LIBDIR = maps_directory "perl"; 368 my $LIBDIR = maps_directory "perl";
161 369
162 for my $ext (<$LIBDIR/*.ext>) { 370 for my $ext (<$LIBDIR/*.ext>) {
371 next unless -r $ext;
372 eval {
163 load_extension $ext; 373 load_extension $ext;
374 1
375 } or warn "$ext not loaded: $@";
376 }
377}
378
379sub _perl_reload(&) {
380 my ($msg) = @_;
381
382 $msg->("reloading...");
383
384 eval {
385 # 1. cancel all watchers
386 $_->cancel for Event::all_watchers;
387
388 # 2. unload all extensions
389 for (@exts) {
390 $msg->("unloading <$_>");
391 unload_extension $_;
392 }
393
394 # 3. unload all modules loaded from $LIBDIR
395 while (my ($k, $v) = each %INC) {
396 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
397
398 $msg->("removing <$k>");
399 delete $INC{$k};
400
401 $k =~ s/\.pm$//;
402 $k =~ s/\//::/g;
403
404 if (my $cb = $k->can ("unload_module")) {
405 $cb->();
406 }
407
408 Symbol::delete_package $k;
409 }
410
411 # 4. get rid of safe::, as good as possible
412 Symbol::delete_package "safe::$_"
413 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
414
415 # 5. remove register_script_function callbacks
416 # TODO
417
418 # 6. unload cf.pm "a bit"
419 delete $INC{"cf.pm"};
420
421 # don't, removes xs symbols, too,
422 # and global variables created in xs
423 #Symbol::delete_package __PACKAGE__;
424
425 # 7. reload cf.pm
426 $msg->("reloading cf.pm");
427 require cf;
164 } 428 };
429 $msg->($@) if $@;
430
431 $msg->("reloaded");
432};
433
434sub perl_reload() {
435 _perl_reload {
436 warn $_[0];
437 print "$_[0]\n";
438 };
165} 439}
166 440
167register_command "perl-reload", 0, sub { 441register_command "perl-reload", 0, sub {
168 my ($who, $arg) = @_; 442 my ($who, $arg) = @_;
169 443
170 if ($who->flag (FLAG_WIZ)) { 444 if ($who->flag (FLAG_WIZ)) {
171 warn "reloading...\n"; 445 _perl_reload {
172 unload_extension $_ for @exts; 446 warn $_[0];
173 @exts = 0; 447 $who->message ($_[0]);
174 load_extensions; 448 };
175 warn "reloaded\n";
176 } 449 }
177}; 450};
178 451
452#############################################################################
453# utility functions
454
455use JSON::Syck (); # TODO# replace by JSON::PC once working
456
457sub from_json($) {
458 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
459 JSON::Syck::Load $_[0]
460}
461
462sub to_json($) {
463 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
464 JSON::Syck::Dump $_[0]
465}
466
467#############################################################################
468# extcmd framework, basically convert ext <msg>
469# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
470
471attach_global
472 on_extcmd => sub {
473 my ($pl, $buf) = @_;
474
475 my $msg = eval { from_json $buf };
476
477 if (ref $msg) {
478 if (my $cb = $extcmd{$msg->{msgtype}}) {
479 if (my %reply = $cb->[0]->($pl, $msg)) {
480 $pl->ext_reply ($msg->{msgid}, %reply);
481 }
482 }
483 } else {
484 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
485 }
486
487 cf::override;
488 },
489;
490
491#############################################################################
492# load/save/clean perl data associated with a map
493
494*cf::mapsupport::on_clean = sub {
495 my ($map) = @_;
496
497 my $path = $map->tmpname;
498 defined $path or return;
499
500 unlink "$path.cfperl";
501};
502
503*cf::mapsupport::on_swapin =
504*cf::mapsupport::on_load = sub {
505 my ($map) = @_;
506
507 my $path = $map->tmpname;
508 $path = $map->path unless defined $path;
509
510 open my $fh, "<:raw", "$path.cfperl"
511 or return; # no perl data
512
513 my $data = Storable::thaw do { local $/; <$fh> };
514
515 $data->{version} <= 1
516 or return; # too new
517
518 $map->_set_obs ($data->{obs});
519};
520
521*cf::mapsupport::on_swapout = sub {
522 my ($map) = @_;
523
524 my $path = $map->tmpname;
525 $path = $map->path unless defined $path;
526
527 my $obs = $map->_get_obs;
528
529 if (defined $obs) {
530 open my $fh, ">:raw", "$path.cfperl"
531 or die "$path.cfperl: $!";
532
533 stat $path;
534
535 print $fh Storable::nfreeze {
536 size => (stat _)[7],
537 time => (stat _)[9],
538 version => 1,
539 obs => $obs,
540 };
541
542 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
543 } else {
544 unlink "$path.cfperl";
545 }
546};
547
548attach_to_maps prio => -10000, package => cf::mapsupport::;
549
550#############################################################################
551# load/save perl data associated with player->ob objects
552
553sub all_objects(@) {
554 @_, map all_objects ($_->inv), @_
555}
556
557attach_to_players
558 on_load => sub {
559 my ($pl, $path) = @_;
560
561 for my $o (all_objects $pl->ob) {
562 if (my $value = $o->get_ob_key_value ("_perl_data")) {
563 $o->set_ob_key_value ("_perl_data");
564
565 %$o = %{ Storable::thaw pack "H*", $value };
566 }
567 }
568 },
569 on_save => sub {
570 my ($pl, $path) = @_;
571
572 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
573 for grep %$_, all_objects $pl->ob;
574 },
575;
576
577#############################################################################
578# core extensions - in perl
579
580=item cf::player::exists $login
581
582Returns true when the given account exists.
583
584=cut
585
586sub cf::player::exists($) {
587 cf::player::find $_[0]
588 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
589}
590
591=item $player->reply ($npc, $msg[, $flags])
592
593Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
594can be C<undef>. Does the right thing when the player is currently in a
595dialogue with the given NPC character.
596
597=cut
598
599# rough implementation of a future "reply" method that works
600# with dialog boxes.
601sub cf::object::player::reply($$$;$) {
602 my ($self, $npc, $msg, $flags) = @_;
603
604 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
605
606 if ($self->{record_replies}) {
607 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
608 } else {
609 $msg = $npc->name . " says: $msg" if $npc;
610 $self->message ($msg, $flags);
611 }
612}
613
614=item $player->ext_reply ($msgid, $msgtype, %msg)
615
616Sends an ext reply to the player.
617
618=cut
619
620sub cf::player::ext_reply($$$%) {
621 my ($self, $id, %msg) = @_;
622
623 $msg{msgid} = $id;
624
625 $self->send ("ext " . to_json \%msg);
626}
627
628#############################################################################
629# map scripting support
630
631our $safe = new Safe "safe";
632our $safe_hole = new Safe::Hole;
633
634$SIG{FPE} = 'IGNORE';
635
636$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
637
638# here we export the classes and methods available to script code
639
640for (
641 ["cf::object" => qw(contr pay_amount pay_player)],
642 ["cf::object::player" => qw(player)],
643 ["cf::player" => qw(peaceful)],
644) {
645 no strict 'refs';
646 my ($pkg, @funs) = @$_;
647 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
648 for @funs;
649}
650
651sub safe_eval($;@) {
652 my ($code, %vars) = @_;
653
654 my $qcode = $code;
655 $qcode =~ s/"/‟/g; # not allowed in #line filenames
656 $qcode =~ s/\n/\\n/g;
657
658 local $_;
659 local @safe::cf::_safe_eval_args = values %vars;
660
661 my $eval =
662 "do {\n"
663 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
664 . "#line 0 \"{$qcode}\"\n"
665 . $code
666 . "\n}"
667 ;
668
669 sub_generation_inc;
670 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
671 sub_generation_inc;
672
673 if ($@) {
674 warn "$@";
675 warn "while executing safe code '$code'\n";
676 warn "with arguments " . (join " ", %vars) . "\n";
677 }
678
679 wantarray ? @res : $res[0]
680}
681
682sub register_script_function {
683 my ($fun, $cb) = @_;
684
685 no strict 'refs';
686 *{"safe::$fun"} = $safe_hole->wrap ($cb);
687}
688
689#############################################################################
690# the server's main()
691
692sub main {
693 Event::loop;
694}
695
696#############################################################################
697# initialisation
698
699register "<global>", __PACKAGE__;
700
701unshift @INC, $LIBDIR;
702
179load_extensions; 703load_extensions;
180 704
705$TICK_WATCHER = Event->timer (
706 prio => 1,
707 at => $NEXT_TICK || 1,
708 cb => sub {
709 cf::server_tick; # one server iteration
710
711 my $NOW = Event::time;
712 $NEXT_TICK += $TICK;
713
714 # if we are delayed by four ticks, skip them all
715 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
716
717 $TICK_WATCHER->at ($NEXT_TICK);
718 $TICK_WATCHER->start;
719 },
720);
721
1811 7221
182 723

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines