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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines