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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines