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.5 by root, Wed Feb 8 03:46:15 2006 UTC vs.
Revision 1.35 by root, Thu Aug 24 13:35:48 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;
10our %PROP_TYPE; 18our %PROP_TYPE;
11our %PROP_IDX; 19our %PROP_IDX;
20our $LIBDIR = maps_directory "perl";
21
22our $TICK = MAX_TIME * 1e-6;
23our $TICK_WATCHER;
24our $NEXT_TICK;
12 25
13BEGIN { 26BEGIN {
14 @EVENT = map lc, @EVENT; 27 @EVENT = map lc, @EVENT;
15 28
16 *CORE::GLOBAL::warn = sub { 29 *CORE::GLOBAL::warn = sub {
21 print STDERR "cfperl: $msg"; 34 print STDERR "cfperl: $msg";
22 LOG llevError, "cfperl: $msg"; 35 LOG llevError, "cfperl: $msg";
23 }; 36 };
24} 37}
25 38
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40
26# generate property mutators 41# generate property mutators
27sub prop_gen { 42sub prop_gen {
28 my ($prefix, $class) = @_; 43 my ($prefix, $class) = @_;
29 44
30 no strict 'refs'; 45 no strict 'refs';
40 $_[0]->get_property ($type, $idx) 55 $_[0]->get_property ($type, $idx)
41 }; 56 };
42 57
43 *{"$class\::set_$sub"} = sub { 58 *{"$class\::set_$sub"} = sub {
44 $_[0]->set_property ($type, $idx, $_[1]); 59 $_[0]->set_property ($type, $idx, $_[1]);
45 }; 60 } unless $ignore_set{$prop};
46 } 61 }
47} 62}
48 63
49# auto-generate most of the API 64# auto-generate most of the API
50 65
55prop_gen MAP_PROP => "cf::map"; 70prop_gen MAP_PROP => "cf::map";
56prop_gen ARCH_PROP => "cf::arch"; 71prop_gen ARCH_PROP => "cf::arch";
57 72
58# guessed hierarchies 73# guessed hierarchies
59 74
60@cf::object::player::ISA = 'cf::object'; 75@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
61@cf::object::map::ISA = 'cf::object'; 76@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
77
78# we bless all objects into derived classes to force a method lookup
79# within the Safe compartment.
80for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
81 no strict 'refs';
82 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
83}
84
85$Event::DIED = sub {
86 warn "error in event callback: @_";
87};
62 88
63my %ext_pkg; 89my %ext_pkg;
64my @exts; 90my @exts;
65my @hook; 91my @hook;
66my %command; 92my %command;
93my %extcmd;
67 94
68sub inject_event { 95sub inject_event {
69 my ($data) = @_; 96 my $extension = shift;
97 my $event_code = shift;
70 98
71 my $cb = $hook[$data->{event_code}]{$data->{extension}} 99 my $cb = $hook[$event_code]{$extension}
72 or return; 100 or return;
73 101
74 $cb->($data) 102 &$cb
75} 103}
76 104
77sub inject_global_event { 105sub inject_global_event {
78 my ($data) = @_; 106 my $event = shift;
79 107
80 my $cb = $hook[$data->{event_code}] 108 my $cb = $hook[$event]
81 or return; 109 or return;
82 110
83 $_->($data) for values %$cb; 111 List::Util::max map &$_, values %$cb
84
85 ()
86} 112}
87 113
88sub inject_command { 114sub inject_command {
89 my ($name, $obj, $params) = @_; 115 my ($name, $obj, $params) = @_;
90 116
97 123
98sub register_command { 124sub register_command {
99 my ($name, $time, $cb) = @_; 125 my ($name, $time, $cb) = @_;
100 126
101 my $caller = caller; 127 my $caller = caller;
102
103 warn "registering command '$name/$time' to '$caller'"; 128 #warn "registering command '$name/$time' to '$caller'";
104 129
105 push @{ $command{$name} }, [$time, $cb, $caller]; 130 push @{ $command{$name} }, [$time, $cb, $caller];
106 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; 131 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
132}
133
134sub register_extcmd {
135 my ($name, $cb) = @_;
136
137 my $caller = caller;
138 #warn "registering extcmd '$name' to '$caller'";
139
140 $extcmd{$name} = [$cb, $caller];
141}
142
143sub register {
144 my ($base, $pkg) = @_;
145
146 for my $idx (0 .. $#EVENT) {
147 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
148 #warn "registering $EVENT[$idx] hook to '$pkg'\n";
149 $hook[$idx]{$base} = $ref;
150 }
151 }
107} 152}
108 153
109sub load_extension { 154sub load_extension {
110 my ($path) = @_; 155 my ($path) = @_;
111 156
130 or die "$path: $@"; 175 or die "$path: $@";
131 176
132 push @exts, $pkg; 177 push @exts, $pkg;
133 $ext_pkg{$base} = $pkg; 178 $ext_pkg{$base} = $pkg;
134 179
135 no strict 'refs'; 180# no strict 'refs';
136
137# @{"$pkg\::ISA"} = cf::ext::; 181# @{"$pkg\::ISA"} = ext::;
138 182
139 for my $idx (0 .. $#EVENT) { 183 register $base, $pkg;
140 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
141 warn "registering $EVENT[$idx] hook\n";
142 $hook[$idx]{$base} = $ref;
143 }
144 }
145} 184}
146 185
147sub unload_extension { 186sub unload_extension {
148 my ($pkg) = @_; 187 my ($pkg) = @_;
149 188
165 delete $command{$name}; 204 delete $command{$name};
166 delete $COMMAND{"$name\000"}; 205 delete $COMMAND{"$name\000"};
167 } 206 }
168 } 207 }
169 208
209 # remove extcmds
210 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
211 delete $extcmd{$name};
212 }
213
214 if (my $cb = $pkg->can ("on_unload")) {
215 eval {
216 $cb->($pkg);
217 1
218 } or warn "$pkg unloaded, but with errors: $@";
219 }
220
170 Symbol::delete_package $pkg; 221 Symbol::delete_package $pkg;
171} 222}
172 223
173sub load_extensions { 224sub load_extensions {
174 my $LIBDIR = maps_directory "perl"; 225 my $LIBDIR = maps_directory "perl";
188 if ($who->flag (FLAG_WIZ)) { 239 if ($who->flag (FLAG_WIZ)) {
189 $who->message ("reloading..."); 240 $who->message ("reloading...");
190 241
191 warn "reloading...\n"; 242 warn "reloading...\n";
192 eval { 243 eval {
244 # 1. cancel all watchers
245 $_->cancel for Event::all_watchers;
246
247 # 2. unload all extensions
248 for (@exts) {
249 $who->message ("unloading <$_>");
193 unload_extension $_ for @exts; 250 unload_extension $_;
251 }
252
253 # 3. unload all modules loaded from $LIBDIR
254 while (my ($k, $v) = each %INC) {
255 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
256
257 $who->message ("removing <$k>");
258 delete $INC{$k};
259
260 $k =~ s/\.pm$//;
261 $k =~ s/\//::/g;
262
263 if (my $cb = $k->can ("unload_module")) {
264 $cb->();
265 }
266
267 Symbol::delete_package $k;
268 }
269
270 # 4. get rid of ext::, as good as possible
271 Symbol::delete_package "ext::$_"
272 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
273
274 # 5. remove register_script_function callbacks
275 # TODO
276
277 # 6. unload cf.pm "a bit"
194 delete $INC{"cf.pm"}; 278 delete $INC{"cf.pm"};
195 279
196 # don't, removes xs symbols, too 280 # don't, removes xs symbols, too
197 #Symbol::delete_package $pkg; 281 #Symbol::delete_package __PACKAGE__;
198 282
283 # 7. reload cf.pm
284 $who->message ("reloading cf.pm");
199 require cf; 285 require cf;
200 }; 286 };
201 warn $@ if $@; 287 warn $@ if $@;
202 $who->message ($@) if $@; 288 $who->message ($@) if $@;
203 warn "reloaded\n"; 289 warn "reloaded\n";
206 } else { 292 } else {
207 $who->message ("Intruder Alert!"); 293 $who->message ("Intruder Alert!");
208 } 294 }
209}; 295};
210 296
297#############################################################################
298# utility functions
299
300use JSON::Syck (); # TODO# replace by JSON::PC once working
301
302sub from_json($) {
303 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
304 JSON::Syck::Load $_[0]
305}
306
307sub to_json($) {
308 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
309 JSON::Syck::Dump $_[0]
310}
311
312#############################################################################
313# extcmd framework, basically convert ext <msg>
314# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
315
316sub on_extcmd {
317 my ($pl, $buf) = @_;
318
319 my $msg = eval { from_json $buf };
320
321 if (ref $msg) {
322 if (my $cb = $extcmd{$msg->{msgtype}}) {
323 if (my %reply = $cb->[0]->($pl, $msg)) {
324 $pl->ext_reply ($msg->{msgid}, %reply);
325 }
326 }
327 } else {
328 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
329 }
330
331 1
332}
333
334#############################################################################
335# load/save/clean perl data associated with a map
336
337*on_mapclean = sub {
338 my ($map) = @_;
339
340 my $path = $map->tmpname;
341 defined $path or return;
342
343 unlink "$path.cfperl";
344};
345
346*on_mapin =
347*on_mapload = sub {
348 my ($map) = @_;
349
350 my $path = $map->tmpname;
351 $path = $map->path unless defined $path;
352
353 open my $fh, "<:raw", "$path.cfperl"
354 or return; # no perl data
355
356 my $data = Storable::thaw do { local $/; <$fh> };
357
358 $data->{version} <= 1
359 or return; # too new
360
361 $map->_set_obs ($data->{obs});
362};
363
364*on_mapout = sub {
365 my ($map) = @_;
366
367 my $path = $map->tmpname;
368 $path = $map->path unless defined $path;
369
370 my $obs = $map->_get_obs;
371
372 if (defined $obs) {
373 open my $fh, ">:raw", "$path.cfperl"
374 or die "$path.cfperl: $!";
375
376 stat $path;
377
378 print $fh Storable::nfreeze {
379 size => (stat _)[7],
380 time => (stat _)[9],
381 version => 1,
382 obs => $obs,
383 };
384
385 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
386 } else {
387 unlink "$path.cfperl";
388 }
389};
390
391#############################################################################
392# load/save perl data associated with player->ob objects
393
394sub all_objects(@) {
395 @_, map all_objects ($_->inv), @_
396}
397
398*on_player_load = sub {
399 my ($ob, $path) = @_;
400
401 for my $o (all_objects $ob) {
402 if (my $value = $o->get_ob_key_value ("_perl_data")) {
403 $o->set_ob_key_value ("_perl_data");
404
405 %$o = %{ Storable::thaw pack "H*", $value };
406 }
407 }
408};
409
410*on_player_save = sub {
411 my ($ob, $path) = @_;
412
413 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
414 for grep %$_, all_objects $ob;
415};
416
417#############################################################################
418# core extensions - in perl
419
420=item cf::player::exists $login
421
422Returns true when the given account exists.
423
424=cut
425
426sub cf::player::exists($) {
427 cf::player::find $_[0]
428 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
429}
430
431=item $player->reply ($npc, $msg[, $flags])
432
433Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
434can be C<undef>. Does the right thing when the player is currently in a
435dialogue with the given NPC character.
436
437=cut
438
439# rough implementation of a future "reply" method that works
440# with dialog boxes.
441sub cf::object::player::reply($$$;$) {
442 my ($self, $npc, $msg, $flags) = @_;
443
444 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
445
446 if ($self->{record_replies}) {
447 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
448 } else {
449 $msg = $npc->name . " says: $msg" if $npc;
450 $self->message ($msg, $flags);
451 }
452}
453
454=item $player->ext_reply ($msgid, $msgtype, %msg)
455
456Sends an ext reply to the player.
457
458=cut
459
460sub cf::player::ext_reply($$$%) {
461 my ($self, $id, %msg) = @_;
462
463 $msg{msgid} = $id;
464
465 $self->send ("ext " . to_json \%msg);
466}
467
468#############################################################################
469# map scripting support
470
471our $safe = new Safe "ext";
472our $safe_hole = new Safe::Hole;
473
474$SIG{FPE} = 'IGNORE';
475
476$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
477
478# here we export the classes and methods available to script code
479
480for (
481 ["cf::object" => qw(contr pay_amount pay_player)],
482 ["cf::object::player" => qw(player)],
483 ["cf::player" => qw(peaceful)],
484) {
485 no strict 'refs';
486 my ($pkg, @funs) = @$_;
487 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
488 for @funs;
489}
490
491sub safe_eval($;@) {
492 my ($code, %vars) = @_;
493
494 my $qcode = $code;
495 $qcode =~ s/"/‟/g; # not allowed in #line filenames
496 $qcode =~ s/\n/\\n/g;
497
498 local $_;
499 local @ext::cf::_safe_eval_args = values %vars;
500
501 $code =
502 "do {\n"
503 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
504 . "#line 0 \"{$qcode}\"\n"
505 . $code
506 . "\n}"
507 ;
508
509 sub_generation_inc;
510 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);
511 sub_generation_inc;
512
513 wantarray ? @res : $res[0]
514}
515
516sub register_script_function {
517 my ($fun, $cb) = @_;
518
519 no strict 'refs';
520 *{"ext::$fun"} = $safe_hole->wrap ($cb);
521}
522
523#############################################################################
524# the server's main()
525
526sub run {
527 Event::loop;
528}
529
530#############################################################################
531# initialisation
532
533register "<global>", __PACKAGE__;
534
535unshift @INC, $LIBDIR;
536
211load_extensions; 537load_extensions;
212 538
539$TICK_WATCHER = Event->timer (
540 prio => 1,
541 at => $NEXT_TICK || 1,
542 cb => sub {
543 cf::server_tick; # one server iteration
544
545 my $NOW = Event::time;
546 $NEXT_TICK += $TICK;
547
548 # if we are delayed by > 0.25 second, skip ticks
549 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + .25;
550
551 $TICK_WATCHER->at ($NEXT_TICK);
552 $TICK_WATCHER->start;
553 },
554);
555
2131 5561
214 557

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines