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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines