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.39 by root, Fri Aug 25 13:24:50 2006 UTC vs.
Revision 1.90 by root, Sat Dec 16 04:22:13 2006 UTC

5use Storable; 5use Storable;
6use Opcode; 6use Opcode;
7use Safe; 7use Safe;
8use Safe::Hole; 8use Safe::Hole;
9 9
10use IO::AIO ();
11use YAML::Syck ();
10use Time::HiRes; 12use Time::HiRes;
11use Event; 13use Event;
12$Event::Eval = 1; # no idea why this is required, but it is 14$Event::Eval = 1; # no idea why this is required, but it is
13 15
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1;
18
14use strict; 19use strict;
15 20
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22
16our %COMMAND = (); 23our %COMMAND = ();
24our %COMMAND_TIME = ();
25our %EXTCMD = ();
26
27_init_vars;
28
17our @EVENT; 29our @EVENT;
18our @PLUGIN_EVENT; 30our $LIBDIR = datadir . "/ext";
19our %PROP_TYPE;
20our %PROP_IDX;
21our $LIBDIR = maps_directory "perl";
22 31
23our $TICK = MAX_TIME * 1e-6; 32our $TICK = MAX_TIME * 1e-6;
24our $TICK_WATCHER; 33our $TICK_WATCHER;
25our $NEXT_TICK; 34our $NEXT_TICK;
26 35
36our %CFG;
37
38our $UPTIME; $UPTIME ||= time;
39
40#############################################################################
41
42=head2 GLOBAL VARIABLES
43
44=over 4
45
46=item $cf::UPTIME
47
48The timestamp of the server start (so not actually an uptime).
49
50=item $cf::LIBDIR
51
52The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically.
54
55=item $cf::TICK
56
57The interval between server ticks, in seconds.
58
59=item %cf::CFG
60
61Configuration for the server, loaded from C</etc/crossfire/config>, or
62from wherever your confdir points to.
63
64=back
65
66=cut
67
27BEGIN { 68BEGIN {
28 @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30 *CORE::GLOBAL::warn = sub { 69 *CORE::GLOBAL::warn = sub {
31 my $msg = join "", @_; 70 my $msg = join "", @_;
32 $msg .= "\n" 71 $msg .= "\n"
33 unless $msg =~ /\n$/; 72 unless $msg =~ /\n$/;
34 73
35 print STDERR "cfperl: $msg"; 74 print STDERR "cfperl: $msg";
36 LOG llevError, "cfperl: $msg"; 75 LOG llevError, "cfperl: $msg";
37 }; 76 };
38} 77}
39 78
40my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 79@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
41 80
42# generate property mutators 81# we bless all objects into (empty) derived classes to force a method lookup
43sub prop_gen { 82# within the Safe compartment.
44 my ($prefix, $class) = @_; 83for my $pkg (qw(
45 84 cf::object cf::object::player
85 cf::client cf::player
86 cf::arch cf::living
87 cf::map cf::party cf::region
88)) {
46 no strict 'refs'; 89 no strict 'refs';
47
48 for my $prop (keys %PROP_TYPE) {
49 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
50 my $sub = lc $1;
51
52 my $type = $PROP_TYPE{$prop};
53 my $idx = $PROP_IDX {$prop};
54
55 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
56 $_[0]->get_property ($type, $idx)
57 };
58
59 *{"$class\::set_$sub"} = sub {
60 $_[0]->set_property ($type, $idx, $_[1]);
61 } unless $ignore_set{$prop};
62 }
63}
64
65# auto-generate most of the API
66
67prop_gen OBJECT_PROP => "cf::object";
68# CFAPI_OBJECT_ANIMATION?
69prop_gen PLAYER_PROP => "cf::object::player";
70
71prop_gen MAP_PROP => "cf::map";
72prop_gen ARCH_PROP => "cf::arch";
73
74# guessed hierarchies
75
76@ext::cf::object::player::ISA = @cf::object::player::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; 90 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84} 91}
85 92
86$Event::DIED = sub { 93$Event::DIED = sub {
87 warn "error in event callback: @_"; 94 warn "error in event callback: @_";
88}; 95};
89 96
90my %ext_pkg; 97my %ext_pkg;
91my @exts; 98my @exts;
92my @hook; 99my @hook;
93my %command; 100
94my %extcmd; 101=head2 UTILITY FUNCTIONS
102
103=over 4
104
105=cut
106
107use JSON::Syck (); # TODO# replace by JSON::PC once working
108
109=item $ref = cf::from_json $json
110
111Converts a JSON string into the corresponding perl data structure.
112
113=cut
114
115sub from_json($) {
116 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
117 JSON::Syck::Load $_[0]
118}
119
120=item $json = cf::to_json $ref
121
122Converts a perl data structure into its JSON representation.
123
124=cut
125
126sub to_json($) {
127 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128 JSON::Syck::Dump $_[0]
129}
130
131=back
132
133=cut
95 134
96############################################################################# 135#############################################################################
97# "new" plug-in system
98 136
99=item cf::object::attach ... # NYI 137=head2 EVENTS AND OBJECT ATTACHMENTS
100 138
139=over 4
140
141=item $object->attach ($attachment, key => $value...)
142
143=item $object->detach ($attachment)
144
145Attach/detach a pre-registered attachment to an object.
146
147=item $player->attach ($attachment, key => $value...)
148
149=item $player->detach ($attachment)
150
151Attach/detach a pre-registered attachment to a player.
152
153=item $map->attach ($attachment, key => $value...)
154
155=item $map->detach ($attachment)
156
157Attach/detach a pre-registered attachment to a map.
158
159=item $bool = $object->attached ($name)
160
161=item $bool = $player->attached ($name)
162
163=item $bool = $map->attached ($name)
164
165Checks wether the named attachment is currently attached to the object.
166
101=item cf::attach_global ... # NYI 167=item cf::attach_global ...
102 168
103=item cf::attach_to_type ... # NYI 169Attach handlers for global events.
104 170
171This and all following C<attach_*>-functions expect any number of the
172following handler/hook descriptions:
173
174=over 4
175
176=item prio => $number
177
178Set the priority for all following handlers/hooks (unless overwritten
179by another C<prio> setting). Lower priority handlers get executed
180earlier. The default priority is C<0>, and many built-in handlers are
181registered at priority C<-1000>, so lower priorities should not be used
182unless you know what you are doing.
183
184=item on_I<event> => \&cb
185
186Call the given code reference whenever the named event happens (event is
187something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
188handlers are recognised generally depends on the type of object these
189handlers attach to).
190
191See F<include/eventinc.h> for the full list of events supported, and their
192class.
193
194=item package => package::
195
196Look for sub functions of the name C<< on_I<event> >> in the given
197package and register them. Only handlers for eevents supported by the
198object/class are recognised.
199
200=back
201
202=item cf::attach_to_type $object_type, $subtype, ...
203
204Attach handlers for a specific object type (e.g. TRANSPORT) and
205subtype. If C<$subtype> is zero or undef, matches all objects of the given
206type.
207
105=item cf::attach_to_objects ... # NYI 208=item cf::attach_to_objects ...
106 209
210Attach handlers to all objects. Do not use this except for debugging or
211very rare events, as handlers are (obviously) called for I<all> objects in
212the game.
213
107=item cf::attach_to_players ... # NYI 214=item cf::attach_to_players ...
108 215
216Attach handlers to all players.
217
109=item cf::attach_to_maps ... # NYI 218=item cf::attach_to_maps ...
110 219
111 prio => $number, # higehr is earlier 220Attach handlers to all maps.
112 on_xxx => \&cb,
113 package => package::,
114 221
115=cut 222=item cf:register_attachment $name, ...
116 223
117our %CB_CLASS = (); # registry for class-based events 224Register an attachment by name through which objects can refer to this
225attachment.
226
227=item cf:register_player_attachment $name, ...
228
229Register an attachment by name through which players can refer to this
230attachment.
231
232=item cf:register_map_attachment $name, ...
233
234Register an attachment by name through which maps can refer to this
235attachment.
236
237=cut
238
239# the following variables are defined in .xs and must not be re-created
118our @CB_GLOBAL = (); # registry for all global events 240our @CB_GLOBAL = (); # registry for all global events
241our @CB_OBJECT = (); # all objects (should not be used except in emergency)
242our @CB_PLAYER = ();
119our @CB_TYPE = (); # registry for type (cf-object class) based events 243our @CB_TYPE = (); # registry for type (cf-object class) based events
244our @CB_MAP = ();
245
246my %attachment;
120 247
121sub _attach_cb($\%$$$) { 248sub _attach_cb($\%$$$) {
122 my ($registry, $undo, $event, $prio, $cb) = @_; 249 my ($registry, $undo, $event, $prio, $cb) = @_;
123 250
124 use sort 'stable'; 251 use sort 'stable';
133} 260}
134 261
135# attach handles attaching event callbacks 262# attach handles attaching event callbacks
136# the only thing the caller has to do is pass the correct 263# the only thing the caller has to do is pass the correct
137# registry (== where the callback attaches to). 264# registry (== where the callback attaches to).
138sub _attach(\@$\@) { 265sub _attach(\@$@) {
139 my ($registry, $klass, $arg) = @_; 266 my ($registry, $klass, @arg) = @_;
140 267
141 my $prio = 0; 268 my $prio = 0;
142 269
143 my %undo = ( 270 my %undo = (
144 registry => $registry, 271 registry => $registry,
145 cb => [], 272 cb => [],
146 ); 273 );
147 274
148 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 275 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
149 276
150 while (@$arg) { 277 while (@arg) {
151 my $type = shift @$arg; 278 my $type = shift @arg;
152 279
153 if ($type eq "prio") { 280 if ($type eq "prio") {
154 $prio = shift @$arg; 281 $prio = shift @arg;
155 282
156 } elsif ($type eq "package") { 283 } elsif ($type eq "package") {
157 my $pkg = shift @$arg; 284 my $pkg = shift @arg;
158 285
159 while (my ($name, $id) = each %cb_id) { 286 while (my ($name, $id) = each %cb_id) {
160 if (my $cb = $pkg->can ($name)) { 287 if (my $cb = $pkg->can ($name)) {
161 _attach_cb $registry, %undo, $id, $prio, $cb; 288 _attach_cb $registry, %undo, $id, $prio, $cb;
162 } 289 }
163 } 290 }
164 291
165 } elsif (exists $cb_id{$type}) { 292 } elsif (exists $cb_id{$type}) {
166 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg; 293 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
167 294
168 } elsif (ref $type) { 295 } elsif (ref $type) {
169 warn "attaching objects not supported, ignoring.\n"; 296 warn "attaching objects not supported, ignoring.\n";
170 297
171 } else { 298 } else {
172 shift @$arg; 299 shift @arg;
173 warn "attach argument '$type' not supported, ignoring.\n"; 300 warn "attach argument '$type' not supported, ignoring.\n";
174 } 301 }
175 } 302 }
176 303
177 \%undo 304 \%undo
178} 305}
179 306
307sub _attach_attachment {
308 my ($obj, $name, %arg) = @_;
309
310 return if exists $obj->{_attachment}{$name};
311
312 my $res;
313
314 if (my $attach = $attachment{$name}) {
315 my $registry = $obj->registry;
316
317 for (@$attach) {
318 my ($klass, @attach) = @$_;
319 $res = _attach @$registry, $klass, @attach;
320 }
321
322 $obj->{$name} = \%arg;
323 } else {
324 warn "object uses attachment '$name' that is not available, postponing.\n";
325 }
326
327 $obj->{_attachment}{$name} = undef;
328
329 $res->{attachment} = $name;
330 $res
331}
332
180sub cf::object::attach { 333*cf::object::attach =
181 die; 334*cf::player::attach =
182} 335*cf::map::attach = sub {
336 my ($obj, $name, %arg) = @_;
337
338 _attach_attachment $obj, $name, %arg;
339};
340
341# all those should be optimised
342*cf::object::detach =
343*cf::player::detach =
344*cf::map::detach = sub {
345 my ($obj, $name) = @_;
346
347 delete $obj->{_attachment}{$name};
348 reattach ($obj);
349};
350
351*cf::object::attached =
352*cf::player::attached =
353*cf::map::attached = sub {
354 my ($obj, $name) = @_;
355
356 exists $obj->{_attachment}{$name}
357};
183 358
184sub attach_global { 359sub attach_global {
185 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 360 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
186} 361}
187 362
188sub attach_type { 363sub attach_to_type {
189 my $type = shift; 364 my $type = shift;
190 _attach @{$CB_TYPE[$type]}, KLASS_MAP, @_ 365 my $subtype = shift;
366
367 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
191} 368}
192 369
193sub attach_to_objects { 370sub attach_to_objects {
194 _attach @{$CB_CLASS{cf::object::wrap::}}, KLASS_OBJECT, @_ 371 _attach @CB_OBJECT, KLASS_OBJECT, @_
195} 372}
196 373
197sub attach_to_players { 374sub attach_to_players {
198 _attach @{$CB_CLASS{cf::player::wrap::}}, KLASS_PLAYER, @_ 375 _attach @CB_PLAYER, KLASS_PLAYER, @_
199} 376}
200 377
201sub attach_to_maps { 378sub attach_to_maps {
202 _attach @{$CB_CLASS{cf::map::wrap::}}, KLASS_MAP, @_ 379 _attach @CB_MAP, KLASS_MAP, @_
380}
381
382sub register_attachment {
383 my $name = shift;
384
385 $attachment{$name} = [[KLASS_OBJECT, @_]];
386}
387
388sub register_player_attachment {
389 my $name = shift;
390
391 $attachment{$name} = [[KLASS_PLAYER, @_]];
392}
393
394sub register_map_attachment {
395 my $name = shift;
396
397 $attachment{$name} = [[KLASS_MAP, @_]];
203} 398}
204 399
205our $override; 400our $override;
401our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
206 402
207sub override() { 403sub override {
208 $override = 1 404 $override = 1;
405 @invoke_results = ();
209} 406}
210 407
211sub invoke { 408sub do_invoke {
212 my $event = shift; 409 my $event = shift;
410 my $callbacks = shift;
213 411
214 my @cb; 412 @invoke_results = ();
215
216 if (my $ref = ref $_[0]) {
217 # 1. object-specific (NYI)
218 # 2. class-specific
219 push @cb, @{$CB_CLASS{$ref}[$event] || []};
220 }
221
222 # global
223 push @cb, @{$CB_GLOBAL[$event] || []};
224
225# warn "invoke id $EVENT[$event][0], args <@_> <=> @cb\n";#d#
226 413
227 local $override; 414 local $override;
228 415
229 for (@cb) { 416 for (@$callbacks) {
230 eval { &{$_->[1]} }; 417 eval { &{$_->[1]} };
231 418
232 if ($@) { 419 if ($@) {
233 warn "$@"; 420 warn "$@";
234 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 421 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
235 override; 422 override;
236 } 423 }
237 424
238 return 1 if $override; 425 return 1 if $override;
239 } 426 }
240 427
241 0 428 0
242} 429}
243 430
431=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
432
433=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
434
435=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
436
437=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
438
439Generate a global/object/player/map-specific event with the given arguments.
440
441This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
442removed in future versions), and there is no public API to access override
443results (if you must, access C<@cf::invoke_results> directly).
444
445=back
446
447=cut
448
244############################################################################# 449#############################################################################
245# old plug-in events
246 450
247sub inject_event { 451=head2 METHODS VALID FOR ALL CORE OBJECTS
248 my $extension = shift;
249 my $event_code = shift;
250 452
251 my $cb = $hook[$event_code]{$extension} 453=over 4
252 or return;
253 454
254 &$cb 455=item $object->valid, $player->valid, $map->valid
255}
256 456
257sub inject_global_event { 457Just because you have a perl object does not mean that the corresponding
258 my $event = shift; 458C-level object still exists. If you try to access an object that has no
459valid C counterpart anymore you get an exception at runtime. This method
460can be used to test for existence of the C object part without causing an
461exception.
259 462
260 my $cb = $hook[$event] 463=back
261 or return;
262 464
263 List::Util::max map &$_, values %$cb 465=cut
264}
265 466
266sub inject_command { 467*cf::object::valid =
468*cf::player::valid =
469*cf::map::valid = \&cf::_valid;
470
471#############################################################################
472# object support
473
474sub instantiate {
475 my ($obj, $data) = @_;
476
477 $data = from_json $data;
478
479 for (@$data) {
267 my ($name, $obj, $params) = @_; 480 my ($name, $args) = @$_;
268 481
269 for my $cmd (@{ $command{$name} }) { 482 $obj->attach ($name, %{$args || {} });
270 $cmd->[1]->($obj, $params); 483 }
484}
485
486# basically do the same as instantiate, without calling instantiate
487sub reattach {
488 my ($obj) = @_;
489 my $registry = $obj->registry;
490
491 @$registry = ();
492
493 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494
495 for my $name (keys %{ $obj->{_attachment} || {} }) {
496 if (my $attach = $attachment{$name}) {
497 for (@$attach) {
498 my ($klass, @attach) = @$_;
499 _attach @$registry, $klass, @attach;
500 }
501 } else {
502 warn "object uses attachment '$name' that is not available, postponing.\n";
503 }
504 }
505}
506
507sub object_freezer_save {
508 my ($filename, $rdata, $objs) = @_;
509
510 if (length $$rdata) {
511 warn sprintf "saving %s (%d,%d)\n",
512 $filename, length $$rdata, scalar @$objs;
513
514 if (open my $fh, ">:raw", "$filename~") {
515 chmod SAVE_MODE, $fh;
516 syswrite $fh, $$rdata;
517 close $fh;
518
519 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520 chmod SAVE_MODE, $fh;
521 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
522 close $fh;
523 rename "$filename.pst~", "$filename.pst";
524 } else {
525 unlink "$filename.pst";
526 }
527
528 rename "$filename~", $filename;
529 } else {
530 warn "FATAL: $filename~: $!\n";
531 }
532 } else {
533 unlink $filename;
534 unlink "$filename.pst";
535 }
536}
537
538sub object_freezer_as_string {
539 my ($rdata, $objs) = @_;
540
541 use Data::Dumper;
542
543 $$rdata . Dumper $objs
544}
545
546sub object_thawer_load {
547 my ($filename) = @_;
548
549 local $/;
550
551 my $av;
552
553 #TODO: use sysread etc.
554 if (open my $data, "<:raw:perlio", $filename) {
555 $data = <$data>;
556 if (open my $pst, "<:raw:perlio", "$filename.pst") {
557 $av = eval { (Storable::thaw <$pst>)->{objs} };
558 }
559 return ($data, $av);
560 }
561
562 ()
563}
564
565attach_to_objects
566 prio => -1000000,
567 on_clone => sub {
568 my ($src, $dst) = @_;
569
570 @{$dst->registry} = @{$src->registry};
571
572 %$dst = %$src;
573
574 %{$dst->{_attachment}} = %{$src->{_attachment}}
575 if exists $src->{_attachment};
271 } 576 },
577;
272 578
273 -1 579#############################################################################
274} 580# command handling &c
581
582=item cf::register_command $name => \&callback($ob,$args);
583
584Register a callback for execution when the client sends the user command
585$name.
586
587=cut
275 588
276sub register_command { 589sub register_command {
277 my ($name, $time, $cb) = @_; 590 my ($name, $cb) = @_;
278 591
279 my $caller = caller; 592 my $caller = caller;
280 #warn "registering command '$name/$time' to '$caller'"; 593 #warn "registering command '$name/$time' to '$caller'";
281 594
282 push @{ $command{$name} }, [$time, $cb, $caller]; 595 push @{ $COMMAND{$name} }, [$caller, $cb];
283 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
284} 596}
597
598=item cf::register_extcmd $name => \&callback($pl,$packet);
599
600Register a callbackf ro execution when the client sends an extcmd packet.
601
602If the callback returns something, it is sent back as if reply was being
603called.
604
605=cut
285 606
286sub register_extcmd { 607sub register_extcmd {
287 my ($name, $cb) = @_; 608 my ($name, $cb) = @_;
288 609
289 my $caller = caller; 610 my $caller = caller;
290 #warn "registering extcmd '$name' to '$caller'"; 611 #warn "registering extcmd '$name' to '$caller'";
291 612
292 $extcmd{$name} = [$cb, $caller]; 613 $EXTCMD{$name} = [$cb, $caller];
293} 614}
615
616attach_to_players
617 on_command => sub {
618 my ($pl, $name, $params) = @_;
619
620 my $cb = $COMMAND{$name}
621 or return;
622
623 for my $cmd (@$cb) {
624 $cmd->[1]->($pl->ob, $params);
625 }
626
627 cf::override;
628 },
629 on_extcmd => sub {
630 my ($pl, $buf) = @_;
631
632 my $msg = eval { from_json $buf };
633
634 if (ref $msg) {
635 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
636 if (my %reply = $cb->[0]->($pl, $msg)) {
637 $pl->ext_reply ($msg->{msgid}, %reply);
638 }
639 }
640 } else {
641 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642 }
643
644 cf::override;
645 },
646;
294 647
295sub register { 648sub register {
296 my ($base, $pkg) = @_; 649 my ($base, $pkg) = @_;
297 650
298 for my $idx (0 .. $#PLUGIN_EVENT) { 651 #TODO
299 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
300 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
301 $hook[$idx]{$base} = $ref;
302 }
303 }
304} 652}
305 653
306sub load_extension { 654sub load_extension {
307 my ($path) = @_; 655 my ($path) = @_;
308 656
309 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 657 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
310 my $base = $1; 658 my $base = $1;
311 my $pkg = $1; 659 my $pkg = $1;
312 $pkg =~ s/[^[:word:]]/_/g; 660 $pkg =~ s/[^[:word:]]/_/g;
313 $pkg = "cf::ext::$pkg"; 661 $pkg = "ext::$pkg";
314 662
315 warn "loading '$path' into '$pkg'\n"; 663 warn "loading '$path' into '$pkg'\n";
316 664
317 open my $fh, "<:utf8", $path 665 open my $fh, "<:utf8", $path
318 or die "$path: $!"; 666 or die "$path: $!";
322 . "#line 1 \"$path\"\n{\n" 670 . "#line 1 \"$path\"\n{\n"
323 . (do { local $/; <$fh> }) 671 . (do { local $/; <$fh> })
324 . "\n};\n1"; 672 . "\n};\n1";
325 673
326 eval $source 674 eval $source
327 or die "$path: $@"; 675 or die $@ ? "$path: $@\n"
676 : "extension disabled.\n";
328 677
329 push @exts, $pkg; 678 push @exts, $pkg;
330 $ext_pkg{$base} = $pkg; 679 $ext_pkg{$base} = $pkg;
331 680
332# no strict 'refs'; 681# no strict 'refs';
339 my ($pkg) = @_; 688 my ($pkg) = @_;
340 689
341 warn "removing extension $pkg\n"; 690 warn "removing extension $pkg\n";
342 691
343 # remove hooks 692 # remove hooks
693 #TODO
344 for my $idx (0 .. $#PLUGIN_EVENT) { 694# for my $idx (0 .. $#PLUGIN_EVENT) {
345 delete $hook[$idx]{$pkg}; 695# delete $hook[$idx]{$pkg};
346 } 696# }
347 697
348 # remove commands 698 # remove commands
349 for my $name (keys %command) { 699 for my $name (keys %COMMAND) {
350 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 700 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
351 701
352 if (@cb) { 702 if (@cb) {
353 $command{$name} = \@cb; 703 $COMMAND{$name} = \@cb;
354 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
355 } else { 704 } else {
356 delete $command{$name};
357 delete $COMMAND{"$name\000"}; 705 delete $COMMAND{$name};
358 } 706 }
359 } 707 }
360 708
361 # remove extcmds 709 # remove extcmds
362 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 710 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
363 delete $extcmd{$name}; 711 delete $EXTCMD{$name};
364 } 712 }
365 713
366 if (my $cb = $pkg->can ("on_unload")) { 714 if (my $cb = $pkg->can ("unload")) {
367 eval { 715 eval {
368 $cb->($pkg); 716 $cb->($pkg);
369 1 717 1
370 } or warn "$pkg unloaded, but with errors: $@"; 718 } or warn "$pkg unloaded, but with errors: $@";
371 } 719 }
372 720
373 Symbol::delete_package $pkg; 721 Symbol::delete_package $pkg;
374} 722}
375 723
376sub load_extensions { 724sub load_extensions {
377 my $LIBDIR = maps_directory "perl";
378
379 for my $ext (<$LIBDIR/*.ext>) { 725 for my $ext (<$LIBDIR/*.ext>) {
380 next unless -r $ext; 726 next unless -r $ext;
381 eval { 727 eval {
382 load_extension $ext; 728 load_extension $ext;
383 1 729 1
384 } or warn "$ext not loaded: $@"; 730 } or warn "$ext not loaded: $@";
385 } 731 }
386} 732}
387 733
388sub _perl_reload(&) {
389 my ($msg) = @_;
390
391 $msg->("reloading...");
392
393 eval {
394 # 1. cancel all watchers
395 $_->cancel for Event::all_watchers;
396
397 # 2. unload all extensions
398 for (@exts) {
399 $msg->("unloading <$_>");
400 unload_extension $_;
401 }
402
403 # 3. unload all modules loaded from $LIBDIR
404 while (my ($k, $v) = each %INC) {
405 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
406
407 $msg->("removing <$k>");
408 delete $INC{$k};
409
410 $k =~ s/\.pm$//;
411 $k =~ s/\//::/g;
412
413 if (my $cb = $k->can ("unload_module")) {
414 $cb->();
415 }
416
417 Symbol::delete_package $k;
418 }
419
420 # 4. get rid of ext::, as good as possible
421 Symbol::delete_package "ext::$_"
422 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
423
424 # 5. remove register_script_function callbacks
425 # TODO
426
427 # 6. unload cf.pm "a bit"
428 delete $INC{"cf.pm"};
429
430 # don't, removes xs symbols, too
431 #Symbol::delete_package __PACKAGE__;
432
433 # 7. reload cf.pm
434 $msg->("reloading cf.pm");
435 require cf;
436 };
437 $msg->($@) if $@;
438
439 $msg->("reloaded");
440};
441
442sub perl_reload() {
443 _perl_reload {
444 warn $_[0];
445 print "$_[0]\n";
446 };
447}
448
449register_command "perl-reload", 0, sub {
450 my ($who, $arg) = @_;
451
452 if ($who->flag (FLAG_WIZ)) {
453 _perl_reload {
454 warn $_[0];
455 $who->message ($_[0]);
456 };
457 }
458};
459
460#############################################################################
461# utility functions
462
463use JSON::Syck (); # TODO# replace by JSON::PC once working
464
465sub from_json($) {
466 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
467 JSON::Syck::Load $_[0]
468}
469
470sub to_json($) {
471 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
472 JSON::Syck::Dump $_[0]
473}
474
475#############################################################################
476# extcmd framework, basically convert ext <msg>
477# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
478
479sub on_extcmd {
480 my ($pl, $buf) = @_;
481
482 my $msg = eval { from_json $buf };
483
484 if (ref $msg) {
485 if (my $cb = $extcmd{$msg->{msgtype}}) {
486 if (my %reply = $cb->[0]->($pl, $msg)) {
487 $pl->ext_reply ($msg->{msgid}, %reply);
488 }
489 }
490 } else {
491 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
492 }
493
494 1
495}
496
497############################################################################# 734#############################################################################
498# load/save/clean perl data associated with a map 735# load/save/clean perl data associated with a map
499 736
500*cf::mapsupport::on_clean = sub { 737*cf::mapsupport::on_clean = sub {
501 my ($map) = @_; 738 my ($map) = @_;
502 739
503 my $path = $map->tmpname; 740 my $path = $map->tmpname;
504 defined $path or return; 741 defined $path or return;
505 742
506 unlink "$path.cfperl"; 743 unlink "$path.pst";
507};
508
509*cf::mapsupport::on_swapin =
510*cf::mapsupport::on_load = sub {
511 my ($map) = @_;
512
513 my $path = $map->tmpname;
514 $path = $map->path unless defined $path;
515
516 open my $fh, "<:raw", "$path.cfperl"
517 or return; # no perl data
518
519 my $data = Storable::thaw do { local $/; <$fh> };
520
521 $data->{version} <= 1
522 or return; # too new
523
524 $map->_set_obs ($data->{obs});
525};
526
527*cf::mapsupport::on_swapout = sub {
528 my ($map) = @_;
529
530 my $path = $map->tmpname;
531 $path = $map->path unless defined $path;
532
533 my $obs = $map->_get_obs;
534
535 if (defined $obs) {
536 open my $fh, ">:raw", "$path.cfperl"
537 or die "$path.cfperl: $!";
538
539 stat $path;
540
541 print $fh Storable::nfreeze {
542 size => (stat _)[7],
543 time => (stat _)[9],
544 version => 1,
545 obs => $obs,
546 };
547
548 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
549 } else {
550 unlink "$path.cfperl";
551 }
552}; 744};
553 745
554attach_to_maps prio => -10000, package => cf::mapsupport::; 746attach_to_maps prio => -10000, package => cf::mapsupport::;
555 747
556############################################################################# 748#############################################################################
558 750
559sub all_objects(@) { 751sub all_objects(@) {
560 @_, map all_objects ($_->inv), @_ 752 @_, map all_objects ($_->inv), @_
561} 753}
562 754
755# TODO: compatibility cruft, remove when no longer needed
563attach_to_players 756attach_to_players
564 on_load => sub { 757 on_load => sub {
565 my ($pl, $path) = @_; 758 my ($pl, $path) = @_;
566 759
567 for my $o (all_objects $pl->ob) { 760 for my $o (all_objects $pl->ob) {
570 763
571 %$o = %{ Storable::thaw pack "H*", $value }; 764 %$o = %{ Storable::thaw pack "H*", $value };
572 } 765 }
573 } 766 }
574 }, 767 },
575 on_save => sub {
576 my ($pl, $path) = @_;
577
578 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
579 for grep %$_, all_objects $pl->ob;
580 },
581; 768;
582 769
583############################################################################# 770#############################################################################
584# core extensions - in perl 771
772=head2 CORE EXTENSIONS
773
774Functions and methods that extend core crossfire objects.
775
776=over 4
585 777
586=item cf::player::exists $login 778=item cf::player::exists $login
587 779
588Returns true when the given account exists. 780Returns true when the given account exists.
589 781
592sub cf::player::exists($) { 784sub cf::player::exists($) {
593 cf::player::find $_[0] 785 cf::player::find $_[0]
594 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 786 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
595} 787}
596 788
597=item $player->reply ($npc, $msg[, $flags]) 789=item $player_object->reply ($npc, $msg[, $flags])
598 790
599Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 791Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
600can be C<undef>. Does the right thing when the player is currently in a 792can be C<undef>. Does the right thing when the player is currently in a
601dialogue with the given NPC character. 793dialogue with the given NPC character.
602 794
629 $msg{msgid} = $id; 821 $msg{msgid} = $id;
630 822
631 $self->send ("ext " . to_json \%msg); 823 $self->send ("ext " . to_json \%msg);
632} 824}
633 825
826=item $player_object->may ("access")
827
828Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast").
830
831=cut
832
833sub cf::object::player::may {
834 my ($self, $access) = @_;
835
836 $self->flag (cf::FLAG_WIZ) ||
837 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"})
840}
841
842=cut
843
634############################################################################# 844#############################################################################
635# map scripting support
636 845
846=head2 SAFE SCRIPTING
847
848Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server
850itself. Looping constructs, I/O operators and other built-in functionality
851is not available in the safe scripting environment, and the number of
852functions and methods that can be called is greatly reduced.
853
854=cut
855
637our $safe = new Safe "ext"; 856our $safe = new Safe "safe";
638our $safe_hole = new Safe::Hole; 857our $safe_hole = new Safe::Hole;
639 858
640$SIG{FPE} = 'IGNORE'; 859$SIG{FPE} = 'IGNORE';
641 860
642$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 861$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
643 862
644# here we export the classes and methods available to script code 863# here we export the classes and methods available to script code
864
865=pod
866
867The following fucntions and emthods are available within a safe environment:
868
869 cf::object contr pay_amount pay_player
870 cf::object::player player
871 cf::player peaceful
872
873=cut
645 874
646for ( 875for (
647 ["cf::object" => qw(contr pay_amount pay_player)], 876 ["cf::object" => qw(contr pay_amount pay_player)],
648 ["cf::object::player" => qw(player)], 877 ["cf::object::player" => qw(player)],
649 ["cf::player" => qw(peaceful)], 878 ["cf::player" => qw(peaceful)],
650) { 879) {
651 no strict 'refs'; 880 no strict 'refs';
652 my ($pkg, @funs) = @$_; 881 my ($pkg, @funs) = @$_;
653 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
654 for @funs; 883 for @funs;
655} 884}
885
886=over 4
887
888=item @retval = safe_eval $code, [var => value, ...]
889
890Compiled and executes the given perl code snippet. additional var/value
891pairs result in temporary local (my) scalar variables of the given name
892that are available in the code snippet. Example:
893
894 my $five = safe_eval '$first + $second', first => 1, second => 4;
895
896=cut
656 897
657sub safe_eval($;@) { 898sub safe_eval($;@) {
658 my ($code, %vars) = @_; 899 my ($code, %vars) = @_;
659 900
660 my $qcode = $code; 901 my $qcode = $code;
661 $qcode =~ s/"/‟/g; # not allowed in #line filenames 902 $qcode =~ s/"/‟/g; # not allowed in #line filenames
662 $qcode =~ s/\n/\\n/g; 903 $qcode =~ s/\n/\\n/g;
663 904
664 local $_; 905 local $_;
665 local @ext::cf::_safe_eval_args = values %vars; 906 local @safe::cf::_safe_eval_args = values %vars;
666 907
667 $code = 908 my $eval =
668 "do {\n" 909 "do {\n"
669 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 910 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
670 . "#line 0 \"{$qcode}\"\n" 911 . "#line 0 \"{$qcode}\"\n"
671 . $code 912 . $code
672 . "\n}" 913 . "\n}"
673 ; 914 ;
674 915
675 sub_generation_inc; 916 sub_generation_inc;
676 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 917 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
677 sub_generation_inc; 918 sub_generation_inc;
678 919
920 if ($@) {
921 warn "$@";
922 warn "while executing safe code '$code'\n";
923 warn "with arguments " . (join " ", %vars) . "\n";
924 }
925
679 wantarray ? @res : $res[0] 926 wantarray ? @res : $res[0]
680} 927}
928
929=item cf::register_script_function $function => $cb
930
931Register a function that can be called from within map/npc scripts. The
932function should be reasonably secure and should be put into a package name
933like the extension.
934
935Example: register a function that gets called whenever a map script calls
936C<rent::overview>, as used by the C<rent> extension.
937
938 cf::register_script_function "rent::overview" => sub {
939 ...
940 };
941
942=cut
681 943
682sub register_script_function { 944sub register_script_function {
683 my ($fun, $cb) = @_; 945 my ($fun, $cb) = @_;
684 946
685 no strict 'refs'; 947 no strict 'refs';
686 *{"ext::$fun"} = $safe_hole->wrap ($cb); 948 *{"safe::$fun"} = $safe_hole->wrap ($cb);
949}
950
951=back
952
953=cut
954
955#############################################################################
956
957=head2 EXTENSION DATABASE SUPPORT
958
959Crossfire maintains a very simple database for extension use. It can
960currently store anything that can be serialised using Storable, which
961excludes objects.
962
963The parameter C<$family> should best start with the name of the extension
964using it, it should be unique.
965
966=over 4
967
968=item $hashref = cf::db_get $family
969
970Return a hashref for use by the extension C<$family>, which can be
971modified. After modifications, you have to call C<cf::db_dirty> or
972C<cf::db_sync>.
973
974=item $value = cf::db_get $family => $key
975
976Returns a single value from the database
977
978=item cf::db_put $family => $hashref
979
980Stores the given family hashref into the database. Updates are delayed, if
981you want the data to be synced to disk immediately, use C<cf::db_sync>.
982
983=item cf::db_put $family => $key => $value
984
985Stores the given C<$value> in the family hash. Updates are delayed, if you
986want the data to be synced to disk immediately, use C<cf::db_sync>.
987
988=item cf::db_dirty
989
990Marks the database as dirty, to be updated at a later time.
991
992=item cf::db_sync
993
994Immediately write the database to disk I<if it is dirty>.
995
996=cut
997
998our $DB;
999
1000{
1001 my $path = cf::localdir . "/database.pst";
1002
1003 sub db_load() {
1004 warn "loading database $path\n";#d# remove later
1005 $DB = stat $path ? Storable::retrieve $path : { };
1006 }
1007
1008 my $pid;
1009
1010 sub db_save() {
1011 warn "saving database $path\n";#d# remove later
1012 waitpid $pid, 0 if $pid;
1013 if (0 == ($pid = fork)) {
1014 $DB->{_meta}{version} = 1;
1015 Storable::nstore $DB, "$path~";
1016 rename "$path~", $path;
1017 cf::_exit 0 if defined $pid;
1018 }
1019 }
1020
1021 my $dirty;
1022
1023 sub db_sync() {
1024 db_save if $dirty;
1025 undef $dirty;
1026 }
1027
1028 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1029 db_sync;
1030 });
1031
1032 sub db_dirty() {
1033 $dirty = 1;
1034 $idle->start;
1035 }
1036
1037 sub db_get($;$) {
1038 @_ >= 2
1039 ? $DB->{$_[0]}{$_[1]}
1040 : ($DB->{$_[0]} ||= { })
1041 }
1042
1043 sub db_put($$;$) {
1044 if (@_ >= 3) {
1045 $DB->{$_[0]}{$_[1]} = $_[2];
1046 } else {
1047 $DB->{$_[0]} = $_[1];
1048 }
1049 db_dirty;
1050 }
1051
1052 attach_global
1053 prio => 10000,
1054 on_cleanup => sub {
1055 db_sync;
1056 },
1057 ;
687} 1058}
688 1059
689############################################################################# 1060#############################################################################
690# the server's main() 1061# the server's main()
691 1062
1063sub cfg_load {
1064 open my $fh, "<:utf8", cf::confdir . "/config"
1065 or return;
1066
1067 local $/;
1068 *CFG = YAML::Syck::Load <$fh>;
1069}
1070
692sub main { 1071sub main {
1072 cfg_load;
1073 db_load;
1074 load_extensions;
693 Event::loop; 1075 Event::loop;
694} 1076}
695 1077
696############################################################################# 1078#############################################################################
697# initialisation 1079# initialisation
698 1080
1081sub _perl_reload(&) {
1082 my ($msg) = @_;
1083
1084 $msg->("reloading...");
1085
1086 eval {
1087 # cancel all watchers
1088 for (Event::all_watchers) {
1089 $_->cancel if $_->data & WF_AUTOCANCEL;
1090 }
1091
1092 # unload all extensions
1093 for (@exts) {
1094 $msg->("unloading <$_>");
1095 unload_extension $_;
1096 }
1097
1098 # unload all modules loaded from $LIBDIR
1099 while (my ($k, $v) = each %INC) {
1100 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101
1102 $msg->("removing <$k>");
1103 delete $INC{$k};
1104
1105 $k =~ s/\.pm$//;
1106 $k =~ s/\//::/g;
1107
1108 if (my $cb = $k->can ("unload_module")) {
1109 $cb->();
1110 }
1111
1112 Symbol::delete_package $k;
1113 }
1114
1115 # sync database to disk
1116 cf::db_sync;
1117
1118 # get rid of safe::, as good as possible
1119 Symbol::delete_package "safe::$_"
1120 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1121
1122 # remove register_script_function callbacks
1123 # TODO
1124
1125 # unload cf.pm "a bit"
1126 delete $INC{"cf.pm"};
1127
1128 # don't, removes xs symbols, too,
1129 # and global variables created in xs
1130 #Symbol::delete_package __PACKAGE__;
1131
1132 # reload cf.pm
1133 $msg->("reloading cf.pm");
1134 require cf;
1135
1136 # load config and database again
1137 cf::cfg_load;
1138 cf::db_load;
1139
1140 # load extensions
1141 $msg->("load extensions");
1142 cf::load_extensions;
1143
1144 # reattach attachments to objects
1145 $msg->("reattach");
1146 _global_reattach;
1147 };
1148 $msg->($@) if $@;
1149
1150 $msg->("reloaded");
1151};
1152
1153sub perl_reload() {
1154 _perl_reload {
1155 warn $_[0];
1156 print "$_[0]\n";
1157 };
1158}
1159
699register "<global>", __PACKAGE__; 1160register "<global>", __PACKAGE__;
700 1161
1162register_command "perl-reload" => sub {
1163 my ($who, $arg) = @_;
1164
1165 if ($who->flag (FLAG_WIZ)) {
1166 _perl_reload {
1167 warn $_[0];
1168 $who->message ($_[0]);
1169 };
1170 }
1171};
1172
701unshift @INC, $LIBDIR; 1173unshift @INC, $LIBDIR;
702 1174
703load_extensions;
704
705$TICK_WATCHER = Event->timer ( 1175$TICK_WATCHER = Event->timer (
706 prio => 1, 1176 prio => 0,
707 at => $NEXT_TICK || 1, 1177 at => $NEXT_TICK || 1,
1178 data => WF_AUTOCANCEL,
708 cb => sub { 1179 cb => sub {
709 cf::server_tick; # one server iteration 1180 cf::server_tick; # one server iteration
710 1181
711 my $NOW = Event::time; 1182 my $NOW = Event::time;
712 $NEXT_TICK += $TICK; 1183 $NEXT_TICK += $TICK;
713 1184
714 # if we are delayed by four ticks, skip them all 1185 # if we are delayed by four ticks or more, skip them all
715 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1186 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
716 1187
717 $TICK_WATCHER->at ($NEXT_TICK); 1188 $TICK_WATCHER->at ($NEXT_TICK);
718 $TICK_WATCHER->start; 1189 $TICK_WATCHER->start;
719 }, 1190 },
720); 1191);
721 1192
1193IO::AIO::max_poll_time $TICK * 0.2;
1194
1195Event->io (fd => IO::AIO::poll_fileno,
1196 poll => 'r',
1197 prio => 5,
1198 data => WF_AUTOCANCEL,
1199 cb => \&IO::AIO::poll_cb);
1200
7221 12011
723 1202

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines