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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines