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.47 by root, Sun Aug 27 13:02:04 2006 UTC vs.
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines