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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines