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.8 by root, Thu Mar 16 21:08:16 2006 UTC vs.
Revision 1.44 by root, Sat Aug 26 08:44:06 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines