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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines