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.22 by root, Wed Jul 19 08:50:42 2006 UTC vs.
Revision 1.38 by root, Thu Aug 24 17:29:30 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@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
67@cf::object::map::ISA = 'cf::object'; 77@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78
79# we bless all objects into 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 @{"ext::$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
125} 142}
126 143
127sub register { 144sub register {
128 my ($base, $pkg) = @_; 145 my ($base, $pkg) = @_;
129 146
130 for my $idx (0 .. $#EVENT) { 147 for my $idx (0 .. $#PLUGIN_EVENT) {
131 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { 148 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
132 #warn "registering $EVENT[$idx] hook to '$pkg'\n"; 149 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
133 $hook[$idx]{$base} = $ref; 150 $hook[$idx]{$base} = $ref;
134 } 151 }
135 } 152 }
136} 153}
137 154
160 177
161 push @exts, $pkg; 178 push @exts, $pkg;
162 $ext_pkg{$base} = $pkg; 179 $ext_pkg{$base} = $pkg;
163 180
164# no strict 'refs'; 181# no strict 'refs';
165# @{"$pkg\::ISA"} = cf::ext::; 182# @{"$pkg\::ISA"} = ext::;
166 183
167 register $base, $pkg; 184 register $base, $pkg;
168} 185}
169 186
170sub unload_extension { 187sub unload_extension {
171 my ($pkg) = @_; 188 my ($pkg) = @_;
172 189
173 warn "removing extension $pkg\n"; 190 warn "removing extension $pkg\n";
174 191
175 if (my $cb = $pkg->can ("on_unload")) {
176 $cb->($pkg);
177 }
178
179 # remove hooks 192 # remove hooks
180 for my $idx (0 .. $#EVENT) { 193 for my $idx (0 .. $#PLUGIN_EVENT) {
181 delete $hook[$idx]{$pkg}; 194 delete $hook[$idx]{$pkg};
182 } 195 }
183 196
184 # remove commands 197 # remove commands
185 for my $name (keys %command) { 198 for my $name (keys %command) {
197 # remove extcmds 210 # remove extcmds
198 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 211 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
199 delete $extcmd{$name}; 212 delete $extcmd{$name};
200 } 213 }
201 214
215 if (my $cb = $pkg->can ("on_unload")) {
216 eval {
217 $cb->($pkg);
218 1
219 } or warn "$pkg unloaded, but with errors: $@";
220 }
221
202 Symbol::delete_package $pkg; 222 Symbol::delete_package $pkg;
203} 223}
204 224
205sub load_extensions { 225sub load_extensions {
206 my $LIBDIR = maps_directory "perl"; 226 my $LIBDIR = maps_directory "perl";
212 1 232 1
213 } or warn "$ext not loaded: $@"; 233 } or warn "$ext not loaded: $@";
214 } 234 }
215} 235}
216 236
237sub _perl_reload(&) {
238 my ($msg) = @_;
239
240 $msg->("reloading...");
241
242 eval {
243 # 1. cancel all watchers
244 $_->cancel for Event::all_watchers;
245
246 # 2. unload all extensions
247 for (@exts) {
248 $msg->("unloading <$_>");
249 unload_extension $_;
250 }
251
252 # 3. unload all modules loaded from $LIBDIR
253 while (my ($k, $v) = each %INC) {
254 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
255
256 $msg->("removing <$k>");
257 delete $INC{$k};
258
259 $k =~ s/\.pm$//;
260 $k =~ s/\//::/g;
261
262 if (my $cb = $k->can ("unload_module")) {
263 $cb->();
264 }
265
266 Symbol::delete_package $k;
267 }
268
269 # 4. get rid of ext::, as good as possible
270 Symbol::delete_package "ext::$_"
271 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
272
273 # 5. remove register_script_function callbacks
274 # TODO
275
276 # 6. unload cf.pm "a bit"
277 delete $INC{"cf.pm"};
278
279 # don't, removes xs symbols, too
280 #Symbol::delete_package __PACKAGE__;
281
282 # 7. reload cf.pm
283 $msg->("reloading cf.pm");
284 require cf;
285 };
286 $msg->($@) if $@;
287
288 $msg->("reloaded");
289};
290
291sub perl_reload() {
292 _perl_reload {
293 warn $_[0];
294 print "$_[0]\n";
295 };
296}
297
217register_command "perl-reload", 0, sub { 298register_command "perl-reload", 0, sub {
218 my ($who, $arg) = @_; 299 my ($who, $arg) = @_;
219 300
220 if ($who->flag (FLAG_WIZ)) { 301 if ($who->flag (FLAG_WIZ)) {
221 $who->message ("reloading..."); 302 _perl_reload {
222 303 warn $_[0];
223 warn "reloading...\n"; 304 $who->message ($_[0]);
224 eval {
225 $_->cancel for Event::all_watchers;
226
227 unload_extension $_ for @exts;
228 delete $INC{"cf.pm"};
229
230 # don't, removes xs symbols, too
231 #Symbol::delete_package __PACKAGE__;
232
233 require cf;
234 }; 305 };
235 warn $@ if $@;
236 $who->message ($@) if $@;
237 warn "reloaded\n";
238
239 $who->message ("reloaded");
240 } else {
241 $who->message ("Intruder Alert!");
242 } 306 }
243}; 307};
244 308
245############################################################################# 309#############################################################################
310# utility functions
311
312use JSON::Syck (); # TODO# replace by JSON::PC once working
313
314sub from_json($) {
315 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
316 JSON::Syck::Load $_[0]
317}
318
319sub to_json($) {
320 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
321 JSON::Syck::Dump $_[0]
322}
323
324#############################################################################
246# extcmd framework, basically convert ext <id> <pkg> arg1 args 325# extcmd framework, basically convert ext <msg>
247# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 326# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
248 327
249sub on_extcmd { 328sub on_extcmd {
250 my ($pl, $buf) = @_; 329 my ($pl, $buf) = @_;
251 330
252 my ($type) = $buf =~ s/^(\S+) // ? $1 : ""; 331 my $msg = eval { from_json $buf };
253 332
254 $extcmd{$type}[0]->($pl, $buf) 333 if (ref $msg) {
255 if $extcmd{$type}; 334 if (my $cb = $extcmd{$msg->{msgtype}}) {
335 if (my %reply = $cb->[0]->($pl, $msg)) {
336 $pl->ext_reply ($msg->{msgid}, %reply);
337 }
338 }
339 } else {
340 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
341 }
342
343 1
256} 344}
257 345
258############################################################################# 346#############################################################################
259# load/save/clean perl data associated with a map 347# load/save/clean perl data associated with a map
260 348
313}; 401};
314 402
315############################################################################# 403#############################################################################
316# load/save perl data associated with player->ob objects 404# load/save perl data associated with player->ob objects
317 405
406sub all_objects(@) {
407 @_, map all_objects ($_->inv), @_
408}
409
318*on_player_load = sub { 410*on_player_load = sub {
319 my ($ob, $path) = @_; 411 my ($ob, $path) = @_;
320 412
321 if (open my $fh, "<:raw", "$path.cfperl") { 413 for my $o (all_objects $ob) {
322
323 #d##TODO#remove
324
325 my $data = Storable::thaw do { local $/; <$fh> };
326
327 $data->{version} <= 1
328 or return; # too new
329
330 %$ob = %{$data->{ob}};
331 return;
332 }
333
334 for my $o ($ob, $ob->inv) {
335 if (my $value = $o->get_ob_key_value ("_perl_data")) { 414 if (my $value = $o->get_ob_key_value ("_perl_data")) {
336 $o->set_ob_key_value ("_perl_data"); 415 $o->set_ob_key_value ("_perl_data");
337 416
338 %$o = %{ Storable::thaw pack "H*", $value }; 417 %$o = %{ Storable::thaw pack "H*", $value };
339 } 418 }
342 421
343*on_player_save = sub { 422*on_player_save = sub {
344 my ($ob, $path) = @_; 423 my ($ob, $path) = @_;
345 424
346 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) 425 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
347 for grep %$_, $ob, $ob->inv; 426 for grep %$_, all_objects $ob;
348
349 unlink "$path.cfperl";#d##TODO#remove
350}; 427};
351 428
352############################################################################# 429#############################################################################
353# core extensions - in perl 430# core extensions - in perl
431
432=item cf::player::exists $login
433
434Returns true when the given account exists.
435
436=cut
437
438sub cf::player::exists($) {
439 cf::player::find $_[0]
440 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
441}
442
443=item $player->reply ($npc, $msg[, $flags])
444
445Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
446can be C<undef>. Does the right thing when the player is currently in a
447dialogue with the given NPC character.
448
449=cut
354 450
355# rough implementation of a future "reply" method that works 451# rough implementation of a future "reply" method that works
356# with dialog boxes. 452# with dialog boxes.
357sub cf::object::player::reply($$;$) { 453sub cf::object::player::reply($$$;$) {
358 my ($self, $msg, $flags) = @_; 454 my ($self, $npc, $msg, $flags) = @_;
359 455
360 $flags = cf::NDI_WHITE unless @_ >= 3; 456 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
361 457
458 if ($self->{record_replies}) {
459 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
460 } else {
461 $msg = $npc->name . " says: $msg" if $npc;
362 $self->message ($msg, $flags); 462 $self->message ($msg, $flags);
463 }
464}
465
466=item $player->ext_reply ($msgid, $msgtype, %msg)
467
468Sends an ext reply to the player.
469
470=cut
471
472sub cf::player::ext_reply($$$%) {
473 my ($self, $id, %msg) = @_;
474
475 $msg{msgid} = $id;
476
477 $self->send ("ext " . to_json \%msg);
478}
479
480#############################################################################
481# map scripting support
482
483our $safe = new Safe "ext";
484our $safe_hole = new Safe::Hole;
485
486$SIG{FPE} = 'IGNORE';
487
488$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
489
490# here we export the classes and methods available to script code
491
492for (
493 ["cf::object" => qw(contr pay_amount pay_player)],
494 ["cf::object::player" => qw(player)],
495 ["cf::player" => qw(peaceful)],
496) {
497 no strict 'refs';
498 my ($pkg, @funs) = @$_;
499 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
500 for @funs;
501}
502
503sub safe_eval($;@) {
504 my ($code, %vars) = @_;
505
506 my $qcode = $code;
507 $qcode =~ s/"/‟/g; # not allowed in #line filenames
508 $qcode =~ s/\n/\\n/g;
509
510 local $_;
511 local @ext::cf::_safe_eval_args = values %vars;
512
513 $code =
514 "do {\n"
515 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
516 . "#line 0 \"{$qcode}\"\n"
517 . $code
518 . "\n}"
519 ;
520
521 sub_generation_inc;
522 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);
523 sub_generation_inc;
524
525 wantarray ? @res : $res[0]
526}
527
528sub register_script_function {
529 my ($fun, $cb) = @_;
530
531 no strict 'refs';
532 *{"ext::$fun"} = $safe_hole->wrap ($cb);
533}
534
535#############################################################################
536# the server's main()
537
538sub run {
539 Event::loop;
363} 540}
364 541
365############################################################################# 542#############################################################################
366# initialisation 543# initialisation
367 544
368register "<global>", __PACKAGE__; 545register "<global>", __PACKAGE__;
369 546
370unshift @INC, maps_directory "perl"; 547unshift @INC, $LIBDIR;
371 548
372load_extensions; 549load_extensions;
373 550
551$TICK_WATCHER = Event->timer (
552 prio => 1,
553 at => $NEXT_TICK || 1,
554 cb => sub {
555 cf::server_tick; # one server iteration
556
557 my $NOW = Event::time;
558 $NEXT_TICK += $TICK;
559
560 # if we are delayed by four ticks, skip them all
561 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
562
563 $TICK_WATCHER->at ($NEXT_TICK);
564 $TICK_WATCHER->start;
565 },
566);
567
3741 5681
375 569

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines