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.48 by root, Sun Aug 27 15:24:22 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
16_reload_1; 21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
17 22
18our %COMMAND = (); 23our %COMMAND = ();
24our %COMMAND_TIME = ();
25our %EXTCMD = ();
26
27_init_vars;
28
19our @EVENT; 29our @EVENT;
20our %PROP_TYPE; 30our $LIBDIR = datadir . "/ext";
21our %PROP_IDX;
22our $LIBDIR = maps_directory "perl";
23 31
24our $TICK = MAX_TIME * 1e-6; 32our $TICK = MAX_TIME * 1e-6;
25our $TICK_WATCHER; 33our $TICK_WATCHER;
26our $NEXT_TICK; 34our $NEXT_TICK;
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
27 67
28BEGIN { 68BEGIN {
29 *CORE::GLOBAL::warn = sub { 69 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_; 70 my $msg = join "", @_;
31 $msg .= "\n" 71 $msg .= "\n"
34 print STDERR "cfperl: $msg"; 74 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 75 LOG llevError, "cfperl: $msg";
36 }; 76 };
37} 77}
38 78
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
40 80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
41# generate property mutators 81@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
42sub prop_gen { 82@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
43 my ($prefix, $class) = @_; 83@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
44
45 no strict 'refs';
46
47 for my $prop (keys %PROP_TYPE) {
48 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
49 my $sub = lc $1;
50
51 my $type = $PROP_TYPE{$prop};
52 my $idx = $PROP_IDX {$prop};
53
54 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55 $_[0]->get_property ($type, $idx)
56 };
57
58 *{"$class\::set_$sub"} = sub {
59 $_[0]->set_property ($type, $idx, $_[1]);
60 } unless $ignore_set{$prop};
61 }
62}
63
64# auto-generate most of the API
65
66prop_gen OBJECT_PROP => "cf::object";
67# CFAPI_OBJECT_ANIMATION?
68prop_gen PLAYER_PROP => "cf::object::player";
69
70prop_gen MAP_PROP => "cf::map";
71prop_gen ARCH_PROP => "cf::arch";
72
73@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74 85
75# 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
76# within the Safe compartment. 87# within the Safe compartment.
77for my $pkg (qw(cf::object 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)) {
78 no strict 'refs'; 95 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 96 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80} 97}
81 98
82$Event::DIED = sub { 99$Event::DIED = sub {
84}; 101};
85 102
86my %ext_pkg; 103my %ext_pkg;
87my @exts; 104my @exts;
88my @hook; 105my @hook;
89my %command;
90my %extcmd;
91 106
92############################################################################# 107=head2 UTILITY FUNCTIONS
93# utility functions 108
109=over 4
110
111=cut
94 112
95use JSON::Syck (); # TODO# replace by JSON::PC once working 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
96 120
97sub from_json($) { 121sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 122 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0] 123 JSON::Syck::Load $_[0]
100} 124}
101 125
126=item $json = cf::to_json $ref
127
128Converts a perl data structure into its JSON representation.
129
130=cut
131
102sub to_json($) { 132sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0] 134 JSON::Syck::Dump $_[0]
105} 135}
106 136
137=back
138
139=cut
140
107############################################################################# 141#############################################################################
108# "new" plug-in system
109 142
143=head2 ATTACHABLE OBJECTS
144
145Many objects in crossfire are so-called attachable objects. That means you can
146attach callbacks/event handlers (a collection of which is called an "attachment")
147to it. All such attachable objects support the following methods.
148
149In the following description, CLASS can be any of C<global>, C<object>
150C<player>, C<client> or C<map> (i.e. the attachable objects in
151crossfire+).
152
153=over 4
154
110=item $object->attach ($attachment, key => $value...) 155=item $attachable->attach ($attachment, key => $value...)
111 156
112Attach a pre-registered attachment to an object. 157=item $attachable->detach ($attachment)
113 158
114=item $player->attach ($attachment, key => $value...) 159Attach/detach a pre-registered attachment to a specific object and give it
160the specified key/value pairs as arguments.
115 161
116Attach a pre-registered attachment to a player. 162Example, attach a minesweeper attachment to the given object, making it a
16310x10 minesweeper game:
117 164
118=item $map->attach ($attachment, key => $value...) # not yet persistent 165 $obj->attach (minesweeper => width => 10, height => 10);
119 166
120Attach a pre-registered attachment to a map. 167=item $bool = $attachable->attached ($name)
121 168
122=item cf::attach_global ... 169Checks wether the named attachment is currently attached to the object.
123 170
124Attach handlers for global events. 171=item cf::CLASS->attach ...
125 172
126This and all following C<attach_*>-functions expect any number of the 173=item cf::CLASS->detach ...
127following handler/hook descriptions: 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:
128 209
129=over 4 210=over 4
130 211
131=item prio => $number 212=item prio => $number
132 213
134by another C<prio> setting). Lower priority handlers get executed 215by another C<prio> setting). Lower priority handlers get executed
135earlier. The default priority is C<0>, and many built-in handlers are 216earlier. The default priority is C<0>, and many built-in handlers are
136registered at priority C<-1000>, so lower priorities should not be used 217registered at priority C<-1000>, so lower priorities should not be used
137unless you know what you are doing. 218unless you know what you are doing.
138 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
139=item on_I<event> => \&cb 226=item on_I<event> => \&cb
140 227
141Call the given code reference whenever the named event happens (event is 228Call the given code reference whenever the named event happens (event is
142something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 229something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
143handlers are recognised generally depends on the type of object these 230handlers are recognised generally depends on the type of object these
152package and register them. Only handlers for eevents supported by the 239package and register them. Only handlers for eevents supported by the
153object/class are recognised. 240object/class are recognised.
154 241
155=back 242=back
156 243
157=item cf::attach_to_type $object_type, $subtype, ... 244Example, define an attachment called "sockpuppet" that calls the given
245event handler when a monster attacks:
158 246
159Attach handlers for a specific object type (e.g. TRANSPORT) and 247 cf::object::attachment sockpuppet =>
160subtype. If C<$subtype> is zero or undef, matches all objects of the given 248 on_skill_attack => sub {
161type. 249 my ($self, $victim) = @_;
162 250 ...
163=item cf::attach_to_objects ... 251 }
164 252 }
165Attach handlers to all objects. Do not use this except for debugging or
166very rare events, as handlers are (obviously) called for I<all> objects in
167the game.
168
169=item cf::attach_to_players ...
170
171Attach handlers to all players.
172
173=item cf::attach_to_maps ...
174
175Attach handlers to all maps.
176
177=item cf:register_attachment $name, ...
178 253
179=cut 254=cut
180 255
181# 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
182our @CB_GLOBAL = (); # registry for all global events 257our @CB_GLOBAL = (); # registry for all global events
183our @CB_OBJECT = (); # all objects (should not be used except in emergency) 258our @CB_OBJECT = (); # all objects (should not be used except in emergency)
184our @CB_PLAYER = (); 259our @CB_PLAYER = ();
260our @CB_CLIENT = ();
185our @CB_TYPE = (); # registry for type (cf-object class) based events 261our @CB_TYPE = (); # registry for type (cf-object class) based events
186our @CB_MAP = (); 262our @CB_MAP = ();
187 263
188my %attachment; 264my %attachment;
189 265
190sub _attach_cb($\%$$$) { 266sub _attach_cb($$$$) {
191 my ($registry, $undo, $event, $prio, $cb) = @_; 267 my ($registry, $event, $prio, $cb) = @_;
192 268
193 use sort 'stable'; 269 use sort 'stable';
194 270
195 $cb = [$prio, $cb]; 271 $cb = [$prio, $cb];
196 272
197 @{$registry->[$event]} = sort 273 @{$registry->[$event]} = sort
198 { $a->[0] cmp $b->[0] } 274 { $a->[0] cmp $b->[0] }
199 @{$registry->[$event] || []}, $cb; 275 @{$registry->[$event] || []}, $cb;
200
201 push @{$undo->{cb}}, [$event, $cb];
202} 276}
203 277
204# attach handles attaching event callbacks 278# attach handles attaching event callbacks
205# 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
206# registry (== where the callback attaches to). 280# registry (== where the callback attaches to).
207sub _attach(\@$@) { 281sub _attach {
208 my ($registry, $klass, @arg) = @_; 282 my ($registry, $klass, @arg) = @_;
209 283
284 my $object_type;
210 my $prio = 0; 285 my $prio = 0;
211
212 my %undo = (
213 registry => $registry,
214 cb => [],
215 );
216
217 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;
218 287
219 while (@arg) { 288 while (@arg) {
220 my $type = shift @arg; 289 my $type = shift @arg;
221 290
222 if ($type eq "prio") { 291 if ($type eq "prio") {
223 $prio = shift @arg; 292 $prio = shift @arg;
224 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] ||= [];
302
225 } elsif ($type eq "package") { 303 } elsif ($type eq "package") {
226 my $pkg = shift @arg; 304 my $pkg = shift @arg;
227 305
228 while (my ($name, $id) = each %cb_id) { 306 while (my ($name, $id) = each %cb_id) {
229 if (my $cb = $pkg->can ($name)) { 307 if (my $cb = $pkg->can ($name)) {
230 _attach_cb $registry, %undo, $id, $prio, $cb; 308 _attach_cb $registry, $id, $prio, $cb;
231 } 309 }
232 } 310 }
233 311
234 } elsif (exists $cb_id{$type}) { 312 } elsif (exists $cb_id{$type}) {
235 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; 313 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
236 314
237 } elsif (ref $type) { 315 } elsif (ref $type) {
238 warn "attaching objects not supported, ignoring.\n"; 316 warn "attaching objects not supported, ignoring.\n";
239 317
240 } else { 318 } else {
241 shift @arg; 319 shift @arg;
242 warn "attach argument '$type' not supported, ignoring.\n"; 320 warn "attach argument '$type' not supported, ignoring.\n";
243 } 321 }
244 } 322 }
245
246 \%undo
247} 323}
248 324
249sub _attach_attachment { 325sub _object_attach {
250 my ($obj, $name, %arg) = @_; 326 my ($obj, $name, %arg) = @_;
251 327
252 my $res; 328 return if exists $obj->{_attachment}{$name};
253 329
254 if (my $attach = $attachment{$name}) { 330 if (my $attach = $attachment{$name}) {
255 my $registry = $obj->registry; 331 my $registry = $obj->registry;
256 332
257 for (@$attach) { 333 for (@$attach) {
258 my ($klass, @attach) = @$_; 334 my ($klass, @attach) = @$_;
259 $res = _attach @$registry, $klass, @attach; 335 _attach $registry, $klass, @attach;
260 } 336 }
261 337
262 $obj->{$name} = \%arg; 338 $obj->{$name} = \%arg;
263 } else { 339 } else {
264 warn "object uses attachment '$name' that is not available, postponing.\n"; 340 warn "object uses attachment '$name' that is not available, postponing.\n";
265 } 341 }
266 342
267 push @{$obj->{_attachment}}, $name; 343 $obj->{_attachment}{$name} = undef;
268
269 $res->{attachment} = $name;
270 $res
271} 344}
272 345
273sub cf::object::attach { 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 {
274 my ($obj, $name, %arg) = @_; 356 my ($obj, $name) = @_;
275 357
276 _attach_attachment $obj, $name, %arg; 358 if (ref $obj) {
277} 359 delete $obj->{_attachment}{$name};
360 reattach ($obj);
361 } else {
362 Carp::croak "cannot, currently, detach class attachments";
363 }
364};
278 365
279sub cf::player::attach { 366sub cf::attachable::attached {
280 my ($obj, $name, %arg) = @_; 367 my ($obj, $name) = @_;
281 368
282 _attach_attachment KLASS_PLAYER, $obj, $name, %arg; 369 exists $obj->{_attachment}{$name}
283} 370}
284 371
285sub cf::map::attach { 372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
286 my ($obj, $name, %arg) = @_; 373 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass)
376 }
287 377
288 _attach_attachment KLASS_MAP, $obj, $name, %arg; 378 sub cf::\L$klass\E::attachment {
289}
290
291sub attach_global {
292 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
293}
294
295sub attach_to_type {
296 my $type = shift;
297 my $subtype = shift;
298
299 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
300}
301
302sub attach_to_objects {
303 _attach @CB_OBJECT, KLASS_OBJECT, @_
304}
305
306sub attach_to_players {
307 _attach @CB_PLAYER, KLASS_PLAYER, @_
308}
309
310sub attach_to_maps {
311 _attach @CB_MAP, KLASS_MAP, @_
312}
313
314sub register_attachment {
315 my $name = shift; 379 my \$name = shift;
316 380
317 $attachment{$name} = [[KLASS_OBJECT, @_]]; 381 \$attachment{\$name} = [[KLASS_$klass, \@_]];
382 }
383 ";
384 die if $@;
318} 385}
319 386
320our $override; 387our $override;
321our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 388our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322 389
336 for (@$callbacks) { 403 for (@$callbacks) {
337 eval { &{$_->[1]} }; 404 eval { &{$_->[1]} };
338 405
339 if ($@) { 406 if ($@) {
340 warn "$@"; 407 warn "$@";
341 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 408 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342 override; 409 override;
343 } 410 }
344 411
345 return 1 if $override; 412 return 1 if $override;
346 } 413 }
347 414
348 0 415 0
349} 416}
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
438#############################################################################
439
440=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442Attachable objects includes objects, players, clients and maps.
443
444=over 4
445
446=item $object->valid
447
448Just because you have a perl object does not mean that the corresponding
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.
453
454=back
455
456=cut
350 457
351############################################################################# 458#############################################################################
352# object support 459# object support
353 460
354sub instantiate { 461sub instantiate {
356 463
357 $data = from_json $data; 464 $data = from_json $data;
358 465
359 for (@$data) { 466 for (@$data) {
360 my ($name, $args) = @$_; 467 my ($name, $args) = @$_;
468
361 attach $obj, $name, %{$args || {} }; 469 $obj->attach ($name, %{$args || {} });
362 } 470 }
363} 471}
364 472
365# basically do the same as instantiate, without calling instantiate 473# basically do the same as instantiate, without calling instantiate
366sub reattach { 474sub reattach {
367 my ($obj) = @_; 475 my ($obj) = @_;
368 my $registry = $obj->registry; 476 my $registry = $obj->registry;
369 477
370 @$registry = (); 478 @$registry = ();
371 479
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
481
372 for my $name (@{ $obj->{_attachment} }) { 482 for my $name (keys %{ $obj->{_attachment} || {} }) {
373 if (my $attach = $attachment{$name}) { 483 if (my $attach = $attachment{$name}) {
374 for (@$attach) { 484 for (@$attach) {
375 my ($klass, @attach) = @$_; 485 my ($klass, @attach) = @$_;
376 _attach @$registry, $klass, @attach; 486 _attach $registry, $klass, @attach;
377 } 487 }
378 } else { 488 } else {
379 warn "object uses attachment '$name' that is not available, postponing.\n"; 489 warn "object uses attachment '$name' that is not available, postponing.\n";
380 } 490 }
381 } 491 }
382} 492}
383 493
384sub object_freezer_save { 494sub object_freezer_save {
385 my ($filename, $objs) = @_; 495 my ($filename, $rdata, $objs) = @_;
386 496
387 $filename .= ".pst"; 497 if (length $$rdata) {
498 warn sprintf "saving %s (%d,%d)\n",
499 $filename, length $$rdata, scalar @$objs;
388 500
389 if (@$objs) {
390 open my $fh, ">:raw", "$filename~"; 501 if (open my $fh, ">:raw", "$filename~") {
391 chmod $fh, SAVE_MODE; 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;
392 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 508 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
393 close $fh; 509 close $fh;
510 rename "$filename.pst~", "$filename.pst";
511 } else {
512 unlink "$filename.pst";
513 }
514
394 rename "$filename~", $filename; 515 rename "$filename~", $filename;
516 } else {
517 warn "FATAL: $filename~: $!\n";
518 }
395 } else { 519 } else {
396 unlink $filename; 520 unlink $filename;
521 unlink "$filename.pst";
397 } 522 }
523}
524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
398} 531}
399 532
400sub object_thawer_load { 533sub object_thawer_load {
401 my ($filename) = @_; 534 my ($filename) = @_;
402 535
536 local $/;
537
538 my $av;
539
540 #TODO: use sysread etc.
541 if (open my $data, "<:raw:perlio", $filename) {
542 $data = <$data>;
403 open my $fh, "<:raw:perlio", "$filename.pst" 543 if (open my $pst, "<:raw:perlio", "$filename.pst") {
404 or return; 544 $av = eval { (Storable::thaw <$pst>)->{objs} };
545 }
546 return ($data, $av);
547 }
405 548
406 eval { local $/; (Storable::thaw <$fh>)->{objs} } 549 ()
407} 550}
408 551
409attach_to_objects 552cf::object->attach (
410 prio => -1000000, 553 prio => -1000000,
411 on_clone => sub { 554 on_clone => sub {
412 my ($src, $dst) = @_; 555 my ($src, $dst) = @_;
413 556
414 @{$dst->registry} = @{$src->registry}; 557 @{$dst->registry} = @{$src->registry};
415 558
416 %$dst = %$src; 559 %$dst = %$src;
417 560
418 $dst->{_attachment} = [@{ $src->{_attachment} }] 561 %{$dst->{_attachment}} = %{$src->{_attachment}}
419 if exists $src->{_attachment}; 562 if exists $src->{_attachment};
420 }, 563 },
421; 564);
422 565
423############################################################################# 566#############################################################################
424# old plug-in events 567# command handling &c
425 568
426sub inject_event { 569=item cf::register_command $name => \&callback($ob,$args);
427 my $extension = shift;
428 my $event_code = shift;
429 570
430 my $cb = $hook[$event_code]{$extension} 571Register a callback for execution when the client sends the user command
431 or return; 572$name.
432 573
433 &$cb 574=cut
434}
435
436sub inject_global_event {
437 my $event = shift;
438
439 my $cb = $hook[$event]
440 or return;
441
442 List::Util::max map &$_, values %$cb
443}
444
445sub inject_command {
446 my ($name, $obj, $params) = @_;
447
448 for my $cmd (@{ $command{$name} }) {
449 $cmd->[1]->($obj, $params);
450 }
451
452 -1
453}
454 575
455sub register_command { 576sub register_command {
456 my ($name, $time, $cb) = @_; 577 my ($name, $cb) = @_;
457 578
458 my $caller = caller; 579 my $caller = caller;
459 #warn "registering command '$name/$time' to '$caller'"; 580 #warn "registering command '$name/$time' to '$caller'";
460 581
461 push @{ $command{$name} }, [$time, $cb, $caller]; 582 push @{ $COMMAND{$name} }, [$caller, $cb];
462 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
463} 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
464 593
465sub register_extcmd { 594sub register_extcmd {
466 my ($name, $cb) = @_; 595 my ($name, $cb) = @_;
467 596
468 my $caller = caller; 597 my $caller = caller;
469 #warn "registering extcmd '$name' to '$caller'"; 598 #warn "registering extcmd '$name' to '$caller'";
470 599
471 $extcmd{$name} = [$cb, $caller]; 600 $EXTCMD{$name} = [$cb, $caller];
472} 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);
473 634
474sub register { 635sub register {
475 my ($base, $pkg) = @_; 636 my ($base, $pkg) = @_;
476 637
477 #TODO 638 #TODO
496 . "#line 1 \"$path\"\n{\n" 657 . "#line 1 \"$path\"\n{\n"
497 . (do { local $/; <$fh> }) 658 . (do { local $/; <$fh> })
498 . "\n};\n1"; 659 . "\n};\n1";
499 660
500 eval $source 661 eval $source
501 or die "$path: $@"; 662 or die $@ ? "$path: $@\n"
663 : "extension disabled.\n";
502 664
503 push @exts, $pkg; 665 push @exts, $pkg;
504 $ext_pkg{$base} = $pkg; 666 $ext_pkg{$base} = $pkg;
505 667
506# no strict 'refs'; 668# no strict 'refs';
519# for my $idx (0 .. $#PLUGIN_EVENT) { 681# for my $idx (0 .. $#PLUGIN_EVENT) {
520# delete $hook[$idx]{$pkg}; 682# delete $hook[$idx]{$pkg};
521# } 683# }
522 684
523 # remove commands 685 # remove commands
524 for my $name (keys %command) { 686 for my $name (keys %COMMAND) {
525 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
526 688
527 if (@cb) { 689 if (@cb) {
528 $command{$name} = \@cb; 690 $COMMAND{$name} = \@cb;
529 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
530 } else { 691 } else {
531 delete $command{$name};
532 delete $COMMAND{"$name\000"}; 692 delete $COMMAND{$name};
533 } 693 }
534 } 694 }
535 695
536 # remove extcmds 696 # remove extcmds
537 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
538 delete $extcmd{$name}; 698 delete $EXTCMD{$name};
539 } 699 }
540 700
541 if (my $cb = $pkg->can ("unload")) { 701 if (my $cb = $pkg->can ("unload")) {
542 eval { 702 eval {
543 $cb->($pkg); 703 $cb->($pkg);
547 707
548 Symbol::delete_package $pkg; 708 Symbol::delete_package $pkg;
549} 709}
550 710
551sub load_extensions { 711sub load_extensions {
552 my $LIBDIR = maps_directory "perl";
553
554 for my $ext (<$LIBDIR/*.ext>) { 712 for my $ext (<$LIBDIR/*.ext>) {
555 next unless -r $ext; 713 next unless -r $ext;
556 eval { 714 eval {
557 load_extension $ext; 715 load_extension $ext;
558 1 716 1
559 } or warn "$ext not loaded: $@"; 717 } or warn "$ext not loaded: $@";
560 } 718 }
561} 719}
562 720
563sub _perl_reload(&) {
564 my ($msg) = @_;
565
566 $msg->("reloading...");
567
568 eval {
569 # 1. cancel all watchers
570 $_->cancel for Event::all_watchers;
571
572 # 2. unload all extensions
573 for (@exts) {
574 $msg->("unloading <$_>");
575 unload_extension $_;
576 }
577
578 # 3. unload all modules loaded from $LIBDIR
579 while (my ($k, $v) = each %INC) {
580 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
581
582 $msg->("removing <$k>");
583 delete $INC{$k};
584
585 $k =~ s/\.pm$//;
586 $k =~ s/\//::/g;
587
588 if (my $cb = $k->can ("unload_module")) {
589 $cb->();
590 }
591
592 Symbol::delete_package $k;
593 }
594
595 # 4. get rid of safe::, as good as possible
596 Symbol::delete_package "safe::$_"
597 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
598
599 # 5. remove register_script_function callbacks
600 # TODO
601
602 # 6. unload cf.pm "a bit"
603 delete $INC{"cf.pm"};
604
605 # don't, removes xs symbols, too,
606 # and global variables created in xs
607 #Symbol::delete_package __PACKAGE__;
608
609 # 7. reload cf.pm
610 $msg->("reloading cf.pm");
611 require cf;
612 };
613 $msg->($@) if $@;
614
615 $msg->("reloaded");
616};
617
618sub perl_reload() {
619 _perl_reload {
620 warn $_[0];
621 print "$_[0]\n";
622 };
623}
624
625register_command "perl-reload", 0, sub {
626 my ($who, $arg) = @_;
627
628 if ($who->flag (FLAG_WIZ)) {
629 _perl_reload {
630 warn $_[0];
631 $who->message ($_[0]);
632 };
633 }
634};
635
636#############################################################################
637# extcmd framework, basically convert ext <msg>
638# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
639
640attach_to_players
641 on_extcmd => sub {
642 my ($pl, $buf) = @_;
643
644 my $msg = eval { from_json $buf };
645
646 if (ref $msg) {
647 if (my $cb = $extcmd{$msg->{msgtype}}) {
648 if (my %reply = $cb->[0]->($pl, $msg)) {
649 $pl->ext_reply ($msg->{msgid}, %reply);
650 }
651 }
652 } else {
653 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
654 }
655
656 cf::override;
657 },
658;
659
660############################################################################# 721#############################################################################
661# load/save/clean perl data associated with a map 722# load/save/clean perl data associated with a map
662 723
663*cf::mapsupport::on_clean = sub { 724*cf::mapsupport::on_clean = sub {
664 my ($map) = @_; 725 my ($map) = @_;
665 726
666 my $path = $map->tmpname; 727 my $path = $map->tmpname;
667 defined $path or return; 728 defined $path or return;
668 729
669 unlink "$path.cfperl";
670 unlink "$path.pst"; 730 unlink "$path.pst";
671}; 731};
672 732
673*cf::mapsupport::on_swapin =
674*cf::mapsupport::on_load = sub {
675 my ($map) = @_;
676
677 my $path = $map->tmpname;
678 $path = $map->path unless defined $path;
679
680 open my $fh, "<:raw", "$path.cfperl"
681 or return; # no perl data
682
683 my $data = Storable::thaw do { local $/; <$fh> };
684
685 $data->{version} <= 1
686 or return; # too new
687
688 $map->_set_obs ($data->{obs});
689};
690
691attach_to_maps prio => -10000, package => cf::mapsupport::; 733cf::map->attach (prio => -10000, package => cf::mapsupport::);
692 734
693############################################################################# 735#############################################################################
694# load/save perl data associated with player->ob objects 736# load/save perl data associated with player->ob objects
695 737
696sub all_objects(@) { 738sub all_objects(@) {
697 @_, map all_objects ($_->inv), @_ 739 @_, map all_objects ($_->inv), @_
698} 740}
699 741
700attach_to_players 742# TODO: compatibility cruft, remove when no longer needed
743cf::player->attach (
701 on_load => sub { 744 on_load => sub {
702 my ($pl, $path) = @_; 745 my ($pl, $path) = @_;
703 746
704 for my $o (all_objects $pl->ob) { 747 for my $o (all_objects $pl->ob) {
705 if (my $value = $o->get_ob_key_value ("_perl_data")) { 748 if (my $value = $o->get_ob_key_value ("_perl_data")) {
707 750
708 %$o = %{ Storable::thaw pack "H*", $value }; 751 %$o = %{ Storable::thaw pack "H*", $value };
709 } 752 }
710 } 753 }
711 }, 754 },
712; 755);
713 756
714############################################################################# 757#############################################################################
715# core extensions - in perl 758
759=head2 CORE EXTENSIONS
760
761Functions and methods that extend core crossfire objects.
762
763=over 4
716 764
717=item cf::player::exists $login 765=item cf::player::exists $login
718 766
719Returns true when the given account exists. 767Returns true when the given account exists.
720 768
723sub cf::player::exists($) { 771sub cf::player::exists($) {
724 cf::player::find $_[0] 772 cf::player::find $_[0]
725 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;
726} 774}
727 775
728=item $player->reply ($npc, $msg[, $flags]) 776=item $player_object->reply ($npc, $msg[, $flags])
729 777
730Sends 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>
731can 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
732dialogue with the given NPC character. 780dialogue with the given NPC character.
733 781
760 $msg{msgid} = $id; 808 $msg{msgid} = $id;
761 809
762 $self->send ("ext " . to_json \%msg); 810 $self->send ("ext " . to_json \%msg);
763} 811}
764 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
765############################################################################# 831#############################################################################
766# 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
767 842
768our $safe = new Safe "safe"; 843our $safe = new Safe "safe";
769our $safe_hole = new Safe::Hole; 844our $safe_hole = new Safe::Hole;
770 845
771$SIG{FPE} = 'IGNORE'; 846$SIG{FPE} = 'IGNORE';
772 847
773$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));
774 849
775# here we export the classes and methods available to script code 850# here we export the classes and methods available to script code
776 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
777for ( 863for (
778 ["cf::object" => qw(contr pay_amount pay_player)], 864 ["cf::object" => qw(contr pay_amount pay_player map)],
779 ["cf::object::player" => qw(player)], 865 ["cf::object::player" => qw(player)],
780 ["cf::player" => qw(peaceful)], 866 ["cf::player" => qw(peaceful)],
867 ["cf::map" => qw(trigger)],
781) { 868) {
782 no strict 'refs'; 869 no strict 'refs';
783 my ($pkg, @funs) = @$_; 870 my ($pkg, @funs) = @$_;
784 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 871 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
785 for @funs; 872 for @funs;
786} 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
787 886
788sub safe_eval($;@) { 887sub safe_eval($;@) {
789 my ($code, %vars) = @_; 888 my ($code, %vars) = @_;
790 889
791 my $qcode = $code; 890 my $qcode = $code;
814 } 913 }
815 914
816 wantarray ? @res : $res[0] 915 wantarray ? @res : $res[0]
817} 916}
818 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
819sub register_script_function { 933sub register_script_function {
820 my ($fun, $cb) = @_; 934 my ($fun, $cb) = @_;
821 935
822 no strict 'refs'; 936 no strict 'refs';
823 *{"safe::$fun"} = $safe_hole->wrap ($cb); 937 *{"safe::$fun"} = $safe_hole->wrap ($cb);
824} 938}
825 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
826############################################################################# 1049#############################################################################
827# the server's main() 1050# the server's main()
828 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
829sub main { 1060sub main {
1061 cfg_load;
1062 db_load;
1063 load_extensions;
830 Event::loop; 1064 Event::loop;
831} 1065}
832 1066
833############################################################################# 1067#############################################################################
834# initialisation 1068# initialisation
835 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
836register "<global>", __PACKAGE__; 1149register "<global>", __PACKAGE__;
837 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
838unshift @INC, $LIBDIR; 1162unshift @INC, $LIBDIR;
839 1163
840load_extensions;
841
842$TICK_WATCHER = Event->timer ( 1164$TICK_WATCHER = Event->timer (
843 prio => 1, 1165 prio => 0,
844 at => $NEXT_TICK || 1, 1166 at => $NEXT_TICK || 1,
1167 data => WF_AUTOCANCEL,
845 cb => sub { 1168 cb => sub {
846 cf::server_tick; # one server iteration 1169 cf::server_tick; # one server iteration
847 1170
848 my $NOW = Event::time; 1171 my $NOW = Event::time;
849 $NEXT_TICK += $TICK; 1172 $NEXT_TICK += $TICK;
850 1173
851 # if we are delayed by four ticks, skip them all 1174 # if we are delayed by four ticks or more, skip them all
852 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1175 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
853 1176
854 $TICK_WATCHER->at ($NEXT_TICK); 1177 $TICK_WATCHER->at ($NEXT_TICK);
855 $TICK_WATCHER->start; 1178 $TICK_WATCHER->start;
856 }, 1179 },
857); 1180);
858 1181
859_reload_2; 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);
860 1189
8611 11901
862 1191

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines