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.19 by root, Sun Jul 16 17:15:39 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; 5use Storable;
6use Opcode;
7use Safe;
8use Safe::Hole;
6 9
10use Time::HiRes;
7use Event; 11use Event;
8$Event::Eval = 1; # no idea why this is required, but it is 12$Event::Eval = 1; # no idea why this is required, but it is
9 13
10use strict; 14use strict;
11 15
12our %COMMAND; 16our %COMMAND = ();
13our @EVENT; 17our @EVENT;
18our @PLUGIN_EVENT;
14our %PROP_TYPE; 19our %PROP_TYPE;
15our %PROP_IDX; 20our %PROP_IDX;
21our $LIBDIR = maps_directory "perl";
22
23our $TICK = MAX_TIME * 1e-6;
24our $TICK_WATCHER;
25our $NEXT_TICK;
16 26
17BEGIN { 27BEGIN {
18 @EVENT = map lc, @EVENT; 28 @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
19 29
20 *CORE::GLOBAL::warn = sub { 30 *CORE::GLOBAL::warn = sub {
21 my $msg = join "", @_; 31 my $msg = join "", @_;
22 $msg .= "\n" 32 $msg .= "\n"
23 unless $msg =~ /\n$/; 33 unless $msg =~ /\n$/;
… …
61prop_gen MAP_PROP => "cf::map"; 71prop_gen MAP_PROP => "cf::map";
62prop_gen ARCH_PROP => "cf::arch"; 72prop_gen ARCH_PROP => "cf::arch";
63 73
64# guessed hierarchies 74# guessed hierarchies
65 75
66@cf::object::player::ISA = 'cf::object'; 76@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
67@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}
68 85
69$Event::DIED = sub { 86$Event::DIED = sub {
70 warn "error in event callback: @_"; 87 warn "error in event callback: @_";
71}; 88};
72 89
… …
74my @exts; 91my @exts;
75my @hook; 92my @hook;
76my %command; 93my %command;
77my %extcmd; 94my %extcmd;
78 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
237
79sub inject_event { 238sub inject_event {
80 my $extension = shift; 239 my $extension = shift;
81 my $event_code = shift; 240 my $event_code = shift;
82 241
83 my $cb = $hook[$event_code]{$extension} 242 my $cb = $hook[$event_code]{$extension}
… …
125} 284}
126 285
127sub register { 286sub register {
128 my ($base, $pkg) = @_; 287 my ($base, $pkg) = @_;
129 288
130 for my $idx (0 .. $#EVENT) { 289 for my $idx (0 .. $#PLUGIN_EVENT) {
131 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { 290 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
132 #warn "registering $EVENT[$idx] hook to '$pkg'\n"; 291 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
133 $hook[$idx]{$base} = $ref; 292 $hook[$idx]{$base} = $ref;
134 } 293 }
135 } 294 }
136} 295}
137 296
… …
140 299
141 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 300 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
142 my $base = $1; 301 my $base = $1;
143 my $pkg = $1; 302 my $pkg = $1;
144 $pkg =~ s/[^[:word:]]/_/g; 303 $pkg =~ s/[^[:word:]]/_/g;
145 $pkg = "cf::ext::$pkg"; 304 $pkg = "ext::$pkg";
146 305
147 warn "loading '$path' into '$pkg'\n"; 306 warn "loading '$path' into '$pkg'\n";
148 307
149 open my $fh, "<:utf8", $path 308 open my $fh, "<:utf8", $path
150 or die "$path: $!"; 309 or die "$path: $!";
… …
160 319
161 push @exts, $pkg; 320 push @exts, $pkg;
162 $ext_pkg{$base} = $pkg; 321 $ext_pkg{$base} = $pkg;
163 322
164# no strict 'refs'; 323# no strict 'refs';
165# @{"$pkg\::ISA"} = cf::ext::; 324# @{"$pkg\::ISA"} = ext::;
166 325
167 register $base, $pkg; 326 register $base, $pkg;
168} 327}
169 328
170sub unload_extension { 329sub unload_extension {
171 my ($pkg) = @_; 330 my ($pkg) = @_;
172 331
173 warn "removing extension $pkg\n"; 332 warn "removing extension $pkg\n";
174 333
175 # remove hooks 334 # remove hooks
176 for my $idx (0 .. $#EVENT) { 335 for my $idx (0 .. $#PLUGIN_EVENT) {
177 delete $hook[$idx]{$pkg}; 336 delete $hook[$idx]{$pkg};
178 } 337 }
179 338
180 # remove commands 339 # remove commands
181 for my $name (keys %command) { 340 for my $name (keys %command) {
… …
193 # remove extcmds 352 # remove extcmds
194 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 353 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
195 delete $extcmd{$name}; 354 delete $extcmd{$name};
196 } 355 }
197 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
198 Symbol::delete_package $pkg; 364 Symbol::delete_package $pkg;
199} 365}
200 366
201sub load_extensions { 367sub load_extensions {
202 my $LIBDIR = maps_directory "perl"; 368 my $LIBDIR = maps_directory "perl";
… …
208 1 374 1
209 } or warn "$ext not loaded: $@"; 375 } or warn "$ext not loaded: $@";
210 } 376 }
211} 377}
212 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;
428 };
429 $msg->($@) if $@;
430
431 $msg->("reloaded");
432};
433
434sub perl_reload() {
435 _perl_reload {
436 warn $_[0];
437 print "$_[0]\n";
438 };
439}
440
213register_command "perl-reload", 0, sub { 441register_command "perl-reload", 0, sub {
214 my ($who, $arg) = @_; 442 my ($who, $arg) = @_;
215 443
216 if ($who->flag (FLAG_WIZ)) { 444 if ($who->flag (FLAG_WIZ)) {
217 $who->message ("reloading..."); 445 _perl_reload {
218 446 warn $_[0];
219 warn "reloading...\n"; 447 $who->message ($_[0]);
220 eval {
221 unload_extension $_ for @exts;
222 delete $INC{"cf.pm"};
223
224 # don't, removes xs symbols, too
225 #Symbol::delete_package $pkg;
226
227 require cf;
228 }; 448 };
229 warn $@ if $@;
230 $who->message ($@) if $@;
231 warn "reloaded\n";
232
233 $who->message ("reloaded");
234 } else {
235 $who->message ("Intruder Alert!");
236 } 449 }
237}; 450};
238 451
239############################################################################# 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#############################################################################
240# extcmd framework, basically convert ext <id> <pkg> arg1 args 468# extcmd framework, basically convert ext <msg>
241# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 469# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
242 470
243sub on_extcmd { 471attach_global
472 on_extcmd => sub {
244 my ($pl, $buf) = @_; 473 my ($pl, $buf) = @_;
245 474
246 my ($type) = $buf =~ s/^(\S+) // ? $1 : ""; 475 my $msg = eval { from_json $buf };
247 476
248 $extcmd{$type}[0]->($pl, $buf) 477 if (ref $msg) {
249 if $extcmd{$type}; 478 if (my $cb = $extcmd{$msg->{msgtype}}) {
250} 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;
251 490
252############################################################################# 491#############################################################################
253# load/save/clean perl data associated with a map 492# load/save/clean perl data associated with a map
254 493
255*on_mapclean = sub { 494*cf::mapsupport::on_clean = sub {
256 my ($map) = @_; 495 my ($map) = @_;
257 496
258 my $path = $map->tmpname; 497 my $path = $map->tmpname;
259 defined $path or return; 498 defined $path or return;
260 499
261 unlink "$path.cfperl"; 500 unlink "$path.cfperl";
262}; 501};
263 502
264*on_mapin = 503*cf::mapsupport::on_swapin =
265*on_mapload = sub { 504*cf::mapsupport::on_load = sub {
266 my ($map) = @_; 505 my ($map) = @_;
267 506
268 my $path = $map->tmpname; 507 my $path = $map->tmpname;
269 $path = $map->path unless defined $path; 508 $path = $map->path unless defined $path;
270 509
… …
277 or return; # too new 516 or return; # too new
278 517
279 $map->_set_obs ($data->{obs}); 518 $map->_set_obs ($data->{obs});
280}; 519};
281 520
282*on_mapout = sub { 521*cf::mapsupport::on_swapout = sub {
283 my ($map) = @_; 522 my ($map) = @_;
284 523
285 my $path = $map->tmpname; 524 my $path = $map->tmpname;
286 $path = $map->path unless defined $path; 525 $path = $map->path unless defined $path;
287 526
… …
304 } else { 543 } else {
305 unlink "$path.cfperl"; 544 unlink "$path.cfperl";
306 } 545 }
307}; 546};
308 547
548attach_to_maps prio => -10000, package => cf::mapsupport::;
549
309############################################################################# 550#############################################################################
310# load/save perl data associated with player->ob objects 551# load/save perl data associated with player->ob objects
311 552
312*on_player_load = sub { 553sub all_objects(@) {
554 @_, map all_objects ($_->inv), @_
555}
556
557attach_to_players
558 on_load => sub {
313 my ($ob, $path) = @_; 559 my ($pl, $path) = @_;
314 560
315 if (open my $fh, "<:raw", "$path.cfperl") { 561 for my $o (all_objects $pl->ob) {
316
317 #d##TODO#remove
318
319 my $data = Storable::thaw do { local $/; <$fh> };
320
321 $data->{version} <= 1
322 or return; # too new
323
324 %$ob = %{$data->{ob}};
325 return;
326 }
327
328 for my $o ($ob, $ob->inv) {
329 if (my $value = $o->get_ob_key_value ("_perl_data")) { 562 if (my $value = $o->get_ob_key_value ("_perl_data")) {
330 $o->set_ob_key_value ("_perl_data"); 563 $o->set_ob_key_value ("_perl_data");
331 564
332 %$o = %{ Storable::thaw pack "H*", $value }; 565 %$o = %{ Storable::thaw pack "H*", $value };
566 }
333 } 567 }
334 } 568 },
335}; 569 on_save => sub {
336
337*on_player_save = sub {
338 my ($ob, $path) = @_; 570 my ($pl, $path) = @_;
339 571
340 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) 572 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
341 for grep %$_, $ob, $ob->inv; 573 for grep %$_, all_objects $pl->ob;
574 },
575;
342 576
343 unlink "$path.cfperl";#d##TODO#remove 577#############################################################################
344}; 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
345 698
346register "<global>", __PACKAGE__; 699register "<global>", __PACKAGE__;
347 700
348unshift @INC, maps_directory "perl"; 701unshift @INC, $LIBDIR;
349 702
350load_extensions; 703load_extensions;
351 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
3521 7221
353 723

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines