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.46 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines