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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines