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.3 by root, Sat Feb 4 20:38:29 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;
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';
62 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};
88
89my %ext_pkg;
63my @exts; 90my @exts;
64my @hook; 91my @hook;
65my %command; 92my %command;
93my %extcmd;
66 94
67sub inject_event { 95sub inject_event {
68 my ($data) = @_; 96 my $extension = shift;
97 my $event_code = shift;
69 98
70 my $cb = $hook[$data->{event_code}] 99 my $cb = $hook[$event_code]{$extension}
71 or return; 100 or return;
72 101
73 $_->($data) for values %$cb; 102 &$cb
103}
74 104
75 () 105sub inject_global_event {
106 my $event = shift;
107
108 my $cb = $hook[$event]
109 or return;
110
111 List::Util::max map &$_, values %$cb
76} 112}
77 113
78sub inject_command { 114sub inject_command {
79 my ($name, $obj, $params) = @_; 115 my ($name, $obj, $params) = @_;
80 116
87 123
88sub register_command { 124sub register_command {
89 my ($name, $time, $cb) = @_; 125 my ($name, $time, $cb) = @_;
90 126
91 my $caller = caller; 127 my $caller = caller;
128 #warn "registering command '$name/$time' to '$caller'";
92 129
93 push @{ $command{$name} }, [$time, $cb, $caller]; 130 push @{ $command{$name} }, [$time, $cb, $caller];
94 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; 131 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
95} 132}
96 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 }
152}
153
97sub load_extension { 154sub load_extension {
98 my ($path) = @_; 155 my ($path) = @_;
99 156
100 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 157 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
158 my $base = $1;
101 my $pkg = $1; 159 my $pkg = $1;
102 $pkg =~ s/[^[:word:]]/_/g; 160 $pkg =~ s/[^[:word:]]/_/g;
103 $pkg = "cf::ext::$pkg"; 161 $pkg = "cf::ext::$pkg";
104 162
105 warn "loading '$path' into '$pkg'\n"; 163 warn "loading '$path' into '$pkg'\n";
115 173
116 eval $source 174 eval $source
117 or die "$path: $@"; 175 or die "$path: $@";
118 176
119 push @exts, $pkg; 177 push @exts, $pkg;
178 $ext_pkg{$base} = $pkg;
120 179
121 no strict 'refs'; 180# no strict 'refs';
122
123# @{"$pkg\::ISA"} = cf::ext::; 181# @{"$pkg\::ISA"} = ext::;
124 182
125 for my $idx (0 .. $#EVENT) { 183 register $base, $pkg;
126 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
127 warn "registering $EVENT[$idx] hook\n";
128 $hook[$idx]{$pkg} = $ref;
129 }
130 }
131} 184}
132 185
133sub unload_extension { 186sub unload_extension {
134 my ($pkg) = @_; 187 my ($pkg) = @_;
135 188
151 delete $command{$name}; 204 delete $command{$name};
152 delete $COMMAND{"$name\000"}; 205 delete $COMMAND{"$name\000"};
153 } 206 }
154 } 207 }
155 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
156 Symbol::delete_package $pkg; 221 Symbol::delete_package $pkg;
157} 222}
158 223
159sub load_extensions { 224sub load_extensions {
160 my $LIBDIR = maps_directory "perl"; 225 my $LIBDIR = maps_directory "perl";
166 1 231 1
167 } or warn "$ext not loaded: $@"; 232 } or warn "$ext not loaded: $@";
168 } 233 }
169} 234}
170 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
171register_command "perl-reload", 0, sub { 297register_command "perl-reload", 0, sub {
172 my ($who, $arg) = @_; 298 my ($who, $arg) = @_;
173 299
174 if ($who->flag (FLAG_WIZ)) { 300 if ($who->flag (FLAG_WIZ)) {
175 $who->message ("reloading..."); 301 _perl_reload {
302 warn $_[0];
303 $who->message ($_[0]);
304 };
305 }
306};
176 307
177 warn "reloading...\n"; 308#############################################################################
178 unload_extension $_ for @exts; 309# utility functions
179 @exts = 0;
180 load_extensions;
181 warn "reloaded\n";
182 310
183 $who->message ("reloaded"); 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 }
184 } else { 338 } else {
185 $who->message ("Intruder Alert!"); 339 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
340 }
341
186 } 342 1
343}
344
345#############################################################################
346# load/save/clean perl data associated with a map
347
348*on_mapclean = sub {
349 my ($map) = @_;
350
351 my $path = $map->tmpname;
352 defined $path or return;
353
354 unlink "$path.cfperl";
187}; 355};
356
357*on_mapin =
358*on_mapload = sub {
359 my ($map) = @_;
360
361 my $path = $map->tmpname;
362 $path = $map->path unless defined $path;
363
364 open my $fh, "<:raw", "$path.cfperl"
365 or return; # no perl data
366
367 my $data = Storable::thaw do { local $/; <$fh> };
368
369 $data->{version} <= 1
370 or return; # too new
371
372 $map->_set_obs ($data->{obs});
373};
374
375*on_mapout = sub {
376 my ($map) = @_;
377
378 my $path = $map->tmpname;
379 $path = $map->path unless defined $path;
380
381 my $obs = $map->_get_obs;
382
383 if (defined $obs) {
384 open my $fh, ">:raw", "$path.cfperl"
385 or die "$path.cfperl: $!";
386
387 stat $path;
388
389 print $fh Storable::nfreeze {
390 size => (stat _)[7],
391 time => (stat _)[9],
392 version => 1,
393 obs => $obs,
394 };
395
396 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
397 } else {
398 unlink "$path.cfperl";
399 }
400};
401
402#############################################################################
403# load/save perl data associated with player->ob objects
404
405sub all_objects(@) {
406 @_, map all_objects ($_->inv), @_
407}
408
409*on_player_load = sub {
410 my ($ob, $path) = @_;
411
412 for my $o (all_objects $ob) {
413 if (my $value = $o->get_ob_key_value ("_perl_data")) {
414 $o->set_ob_key_value ("_perl_data");
415
416 %$o = %{ Storable::thaw pack "H*", $value };
417 }
418 }
419};
420
421*on_player_save = sub {
422 my ($ob, $path) = @_;
423
424 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
425 for grep %$_, all_objects $ob;
426};
427
428#############################################################################
429# core extensions - in perl
430
431=item cf::player::exists $login
432
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];
459 } else {
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}"
518 ;
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
543
544register "<global>", __PACKAGE__;
545
546unshift @INC, $LIBDIR;
188 547
189load_extensions; 548load_extensions;
190 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
1911 5671
192 568

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines