ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.35
Committed: Thu Aug 24 13:35:48 2006 UTC (17 years, 9 months ago) by root
Branch: MAIN
Changes since 1.34: +21 -15 lines
Log Message:
allow perl-reload changing ticks

File Contents

# User Rev Content
1 root 1.1 package cf;
2    
3     use Symbol;
4     use List::Util;
5 root 1.6 use Storable;
6 root 1.23 use Opcode;
7     use Safe;
8     use Safe::Hole;
9 root 1.19
10 root 1.32 use Time::HiRes;
11 root 1.18 use Event;
12 root 1.19 $Event::Eval = 1; # no idea why this is required, but it is
13 root 1.1
14     use strict;
15    
16     our %COMMAND;
17     our @EVENT;
18     our %PROP_TYPE;
19     our %PROP_IDX;
20 root 1.27 our $LIBDIR = maps_directory "perl";
21 root 1.1
22 root 1.35 our $TICK = MAX_TIME * 1e-6;
23     our $TICK_WATCHER;
24     our $NEXT_TICK;
25    
26 root 1.1 BEGIN {
27     @EVENT = map lc, @EVENT;
28    
29     *CORE::GLOBAL::warn = sub {
30     my $msg = join "", @_;
31     $msg .= "\n"
32     unless $msg =~ /\n$/;
33    
34     print STDERR "cfperl: $msg";
35     LOG llevError, "cfperl: $msg";
36     };
37     }
38    
39 root 1.9 my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40    
41 root 1.1 # generate property mutators
42     sub prop_gen {
43     my ($prefix, $class) = @_;
44    
45     no strict 'refs';
46    
47     for my $prop (keys %PROP_TYPE) {
48     $prop =~ /^\Q$prefix\E_(.*$)/ or next;
49     my $sub = lc $1;
50    
51     my $type = $PROP_TYPE{$prop};
52     my $idx = $PROP_IDX {$prop};
53    
54     *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55     $_[0]->get_property ($type, $idx)
56     };
57    
58     *{"$class\::set_$sub"} = sub {
59     $_[0]->set_property ($type, $idx, $_[1]);
60 root 1.9 } unless $ignore_set{$prop};
61 root 1.1 }
62     }
63    
64     # auto-generate most of the API
65    
66     prop_gen OBJECT_PROP => "cf::object";
67     # CFAPI_OBJECT_ANIMATION?
68     prop_gen PLAYER_PROP => "cf::object::player";
69    
70     prop_gen MAP_PROP => "cf::map";
71     prop_gen ARCH_PROP => "cf::arch";
72    
73     # guessed hierarchies
74    
75 root 1.25 @ext::cf::object::player::ISA = @cf::object::player::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.
80 elmex 1.30 for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
81 root 1.25 no strict 'refs';
82     @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
83     }
84 root 1.1
85 root 1.18 $Event::DIED = sub {
86     warn "error in event callback: @_";
87     };
88    
89 root 1.5 my %ext_pkg;
90 root 1.1 my @exts;
91     my @hook;
92     my %command;
93 root 1.15 my %extcmd;
94 root 1.1
95     sub inject_event {
96 root 1.14 my $extension = shift;
97     my $event_code = shift;
98 root 1.1
99 root 1.14 my $cb = $hook[$event_code]{$extension}
100 root 1.5 or return;
101    
102 root 1.14 &$cb
103 root 1.5 }
104    
105     sub inject_global_event {
106 root 1.12 my $event = shift;
107 root 1.5
108 root 1.12 my $cb = $hook[$event]
109 root 1.1 or return;
110    
111 root 1.12 List::Util::max map &$_, values %$cb
112 root 1.1 }
113    
114     sub inject_command {
115     my ($name, $obj, $params) = @_;
116    
117     for my $cmd (@{ $command{$name} }) {
118     $cmd->[1]->($obj, $params);
119     }
120    
121     -1
122     }
123    
124     sub register_command {
125     my ($name, $time, $cb) = @_;
126    
127     my $caller = caller;
128 root 1.16 #warn "registering command '$name/$time' to '$caller'";
129 root 1.4
130 root 1.1 push @{ $command{$name} }, [$time, $cb, $caller];
131     $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
132     }
133    
134 root 1.16 sub 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    
143 root 1.6 sub register {
144     my ($base, $pkg) = @_;
145    
146     for my $idx (0 .. $#EVENT) {
147     if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
148 root 1.16 #warn "registering $EVENT[$idx] hook to '$pkg'\n";
149 root 1.6 $hook[$idx]{$base} = $ref;
150     }
151     }
152     }
153    
154 root 1.1 sub load_extension {
155     my ($path) = @_;
156    
157     $path =~ /([^\/\\]+)\.ext$/ or die "$path";
158 root 1.5 my $base = $1;
159 root 1.1 my $pkg = $1;
160     $pkg =~ s/[^[:word:]]/_/g;
161     $pkg = "cf::ext::$pkg";
162    
163     warn "loading '$path' into '$pkg'\n";
164    
165     open my $fh, "<:utf8", $path
166     or die "$path: $!";
167    
168     my $source =
169     "package $pkg; use strict; use utf8;\n"
170     . "#line 1 \"$path\"\n{\n"
171     . (do { local $/; <$fh> })
172     . "\n};\n1";
173    
174     eval $source
175     or die "$path: $@";
176    
177     push @exts, $pkg;
178 root 1.5 $ext_pkg{$base} = $pkg;
179 root 1.1
180 root 1.6 # no strict 'refs';
181 root 1.23 # @{"$pkg\::ISA"} = ext::;
182 root 1.1
183 root 1.6 register $base, $pkg;
184 root 1.1 }
185    
186     sub unload_extension {
187     my ($pkg) = @_;
188    
189     warn "removing extension $pkg\n";
190    
191     # remove hooks
192     for my $idx (0 .. $#EVENT) {
193     delete $hook[$idx]{$pkg};
194     }
195    
196     # remove commands
197     for my $name (keys %command) {
198     my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
199    
200     if (@cb) {
201     $command{$name} = \@cb;
202     $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
203     } else {
204     delete $command{$name};
205     delete $COMMAND{"$name\000"};
206     }
207     }
208    
209 root 1.15 # remove extcmds
210 root 1.16 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
211     delete $extcmd{$name};
212 root 1.15 }
213    
214 elmex 1.31 if (my $cb = $pkg->can ("on_unload")) {
215     eval {
216     $cb->($pkg);
217     1
218     } or warn "$pkg unloaded, but with errors: $@";
219     }
220    
221 root 1.1 Symbol::delete_package $pkg;
222     }
223    
224     sub load_extensions {
225     my $LIBDIR = maps_directory "perl";
226    
227     for my $ext (<$LIBDIR/*.ext>) {
228 root 1.3 next unless -r $ext;
229 root 1.2 eval {
230     load_extension $ext;
231     1
232     } or warn "$ext not loaded: $@";
233 root 1.1 }
234     }
235    
236     register_command "perl-reload", 0, sub {
237     my ($who, $arg) = @_;
238    
239     if ($who->flag (FLAG_WIZ)) {
240 root 1.3 $who->message ("reloading...");
241    
242 root 1.1 warn "reloading...\n";
243 root 1.4 eval {
244 root 1.27 # 1. cancel all watchers
245 root 1.20 $_->cancel for Event::all_watchers;
246    
247 root 1.27 # 2. unload all extensions
248     for (@exts) {
249     $who->message ("unloading <$_>");
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"
278 root 1.4 delete $INC{"cf.pm"};
279    
280     # don't, removes xs symbols, too
281 root 1.21 #Symbol::delete_package __PACKAGE__;
282 root 1.4
283 root 1.27 # 7. reload cf.pm
284     $who->message ("reloading cf.pm");
285 root 1.4 require cf;
286     };
287     warn $@ if $@;
288     $who->message ($@) if $@;
289 root 1.1 warn "reloaded\n";
290 root 1.3
291     $who->message ("reloaded");
292     } else {
293     $who->message ("Intruder Alert!");
294 root 1.1 }
295     };
296    
297 root 1.8 #############################################################################
298 root 1.28 # utility functions
299    
300     use JSON::Syck (); # TODO# replace by JSON::PC once working
301    
302     sub from_json($) {
303 root 1.29 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
304 root 1.28 JSON::Syck::Load $_[0]
305     }
306    
307     sub to_json($) {
308 root 1.29 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
309 root 1.28 JSON::Syck::Dump $_[0]
310     }
311    
312     #############################################################################
313     # extcmd framework, basically convert ext <msg>
314 root 1.15 # into pkg::->on_extcmd_arg1 (...) while shortcutting a few
315    
316     sub on_extcmd {
317     my ($pl, $buf) = @_;
318    
319 root 1.28 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 root 1.15
331 root 1.28 1
332 root 1.15 }
333    
334     #############################################################################
335 root 1.8 # load/save/clean perl data associated with a map
336    
337 root 1.7 *on_mapclean = sub {
338 root 1.13 my ($map) = @_;
339 root 1.7
340     my $path = $map->tmpname;
341     defined $path or return;
342    
343     unlink "$path.cfperl";
344     };
345    
346 root 1.6 *on_mapin =
347     *on_mapload = sub {
348 root 1.13 my ($map) = @_;
349 root 1.6
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 root 1.13 my ($map) = @_;
366 root 1.6
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 root 1.8 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    
394 root 1.33 sub all_objects(@) {
395     @_, map all_objects ($_->inv), @_
396     }
397    
398 root 1.8 *on_player_load = sub {
399 root 1.13 my ($ob, $path) = @_;
400 root 1.8
401 root 1.33 for my $o (all_objects $ob) {
402 root 1.11 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 root 1.8 };
409    
410     *on_player_save = sub {
411 root 1.13 my ($ob, $path) = @_;
412 root 1.8
413 root 1.11 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
414 root 1.33 for grep %$_, all_objects $ob;
415 root 1.6 };
416    
417 root 1.22 #############################################################################
418     # core extensions - in perl
419    
420 root 1.23 =item cf::player::exists $login
421    
422     Returns true when the given account exists.
423    
424     =cut
425    
426     sub 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 root 1.28 =item $player->reply ($npc, $msg[, $flags])
432    
433     Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
434     can be C<undef>. Does the right thing when the player is currently in a
435     dialogue with the given NPC character.
436    
437     =cut
438    
439 root 1.22 # rough implementation of a future "reply" method that works
440     # with dialog boxes.
441 root 1.23 sub cf::object::player::reply($$$;$) {
442     my ($self, $npc, $msg, $flags) = @_;
443    
444     $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
445 root 1.22
446 root 1.24 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 root 1.22 }
453    
454 root 1.28 =item $player->ext_reply ($msgid, $msgtype, %msg)
455    
456     Sends an ext reply to the player.
457    
458     =cut
459    
460     sub 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 root 1.22 #############################################################################
469 root 1.23 # map scripting support
470    
471     our $safe = new Safe "ext";
472     our $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 root 1.25 # here we export the classes and methods available to script code
479    
480     for (
481 root 1.27 ["cf::object" => qw(contr pay_amount pay_player)],
482 root 1.25 ["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 root 1.23
491     sub 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 root 1.25 $code =
502 root 1.23 "do {\n"
503     . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
504     . "#line 0 \"{$qcode}\"\n"
505     . $code
506     . "\n}"
507 root 1.25 ;
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 root 1.23 }
515    
516     sub register_script_function {
517     my ($fun, $cb) = @_;
518    
519     no strict 'refs';
520     *{"ext::$fun"} = $safe_hole->wrap ($cb);
521     }
522    
523     #############################################################################
524 root 1.34 # the server's main()
525    
526     sub run {
527     Event::loop;
528     }
529    
530     #############################################################################
531 root 1.22 # initialisation
532    
533 root 1.6 register "<global>", __PACKAGE__;
534    
535 root 1.27 unshift @INC, $LIBDIR;
536 root 1.17
537 root 1.1 load_extensions;
538    
539 root 1.35 $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    
556 root 1.1 1
557