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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines