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.61 by root, Sun Sep 3 22:45:56 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=head3 EVENTS AND OBJECT ATTACHMENTS 143=head2 ATTACHABLE OBJECTS
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>.
111 149
112=over 4 150=over 4
113 151
114=item $object->attach ($attachment, key => $value...) 152=item cf::CLASS::attachment $name, ...
115 153
116=item $object->detach ($attachment) 154Register an attachment by name through which attachable objects can refer
155to this attachment.
117 156
118Attach/detach a pre-registered attachment to an object.
119
120=item $player->attach ($attachment, key => $value...)
121
122=item $player->detach ($attachment)
123
124Attach/detach a pre-registered attachment to a player.
125
126=item $map->attach ($attachment, key => $value...)
127
128=item $map->detach ($attachment)
129
130Attach/detach a pre-registered attachment to a map.
131
132=item $bool = $object->attached ($name)
133
134=item $bool = $player->attached ($name)
135
136=item $bool = $map->attached ($name) 157=item $bool = $attachable->attached ($name)
137 158
138Checks wether the named attachment is currently attached to the object. 159Checks wether the named attachment is currently attached to the object.
139 160
140=item cf::attach_global ... 161=item $attachable->attach ($attachment, key => $value...)
141 162
142Attach handlers for global events. 163=item $attachable->detach ($attachment)
143 164
144This and all following C<attach_*>-functions expect any number of the 165Attach/detach a pre-registered attachment either to a specific object
145following handler/hook descriptions: 166(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167class in a static method call).
168
169You can attach to global events by using the C<cf::global> class.
170
171These method calls expect any number of the following handler/hook
172descriptions:
146 173
147=over 4 174=over 4
148 175
149=item prio => $number 176=item prio => $number
150 177
152by another C<prio> setting). Lower priority handlers get executed 179by another C<prio> setting). Lower priority handlers get executed
153earlier. 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
154registered at priority C<-1000>, so lower priorities should not be used 181registered at priority C<-1000>, so lower priorities should not be used
155unless you know what you are doing. 182unless you know what you are doing.
156 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
157=item on_I<event> => \&cb 190=item on_I<event> => \&cb
158 191
159Call the given code reference whenever the named event happens (event is 192Call the given code reference whenever the named event happens (event is
160something 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
161handlers are recognised generally depends on the type of object these 194handlers are recognised generally depends on the type of object these
170package and register them. Only handlers for eevents supported by the 203package and register them. Only handlers for eevents supported by the
171object/class are recognised. 204object/class are recognised.
172 205
173=back 206=back
174 207
175=item cf::attach_to_type $object_type, $subtype, ...
176
177Attach handlers for a specific object type (e.g. TRANSPORT) and
178subtype. If C<$subtype> is zero or undef, matches all objects of the given
179type.
180
181=item cf::attach_to_objects ...
182
183Attach handlers to all objects. Do not use this except for debugging or
184very rare events, as handlers are (obviously) called for I<all> objects in
185the game.
186
187=item cf::attach_to_players ...
188
189Attach handlers to all players.
190
191=item cf::attach_to_maps ...
192
193Attach handlers to all maps.
194
195=item cf:register_attachment $name, ...
196
197Register an attachment by name through which objects can refer to this
198attachment.
199
200=item cf:register_player_attachment $name, ...
201
202Register an attachment by name through which players can refer to this
203attachment.
204
205=item cf:register_map_attachment $name, ...
206
207Register an attachment by name through which maps can refer to this
208attachment.
209
210=cut 208=cut
211 209
212# 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
213our @CB_GLOBAL = (); # registry for all global events 211our @CB_GLOBAL = (); # registry for all global events
214our @CB_OBJECT = (); # all objects (should not be used except in emergency) 212our @CB_OBJECT = (); # all objects (should not be used except in emergency)
215our @CB_PLAYER = (); 213our @CB_PLAYER = ();
214our @CB_CLIENT = ();
216our @CB_TYPE = (); # registry for type (cf-object class) based events 215our @CB_TYPE = (); # registry for type (cf-object class) based events
217our @CB_MAP = (); 216our @CB_MAP = ();
218 217
219my %attachment; 218my %attachment;
220 219
221sub _attach_cb($\%$$$) { 220sub _attach_cb($$$$) {
222 my ($registry, $undo, $event, $prio, $cb) = @_; 221 my ($registry, $event, $prio, $cb) = @_;
223 222
224 use sort 'stable'; 223 use sort 'stable';
225 224
226 $cb = [$prio, $cb]; 225 $cb = [$prio, $cb];
227 226
228 @{$registry->[$event]} = sort 227 @{$registry->[$event]} = sort
229 { $a->[0] cmp $b->[0] } 228 { $a->[0] cmp $b->[0] }
230 @{$registry->[$event] || []}, $cb; 229 @{$registry->[$event] || []}, $cb;
231
232 push @{$undo->{cb}}, [$event, $cb];
233} 230}
234 231
235# attach handles attaching event callbacks 232# attach handles attaching event callbacks
236# 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
237# registry (== where the callback attaches to). 234# registry (== where the callback attaches to).
238sub _attach(\@$@) { 235sub _attach {
239 my ($registry, $klass, @arg) = @_; 236 my ($registry, $klass, @arg) = @_;
240 237
238 my $object_type;
241 my $prio = 0; 239 my $prio = 0;
242
243 my %undo = (
244 registry => $registry,
245 cb => [],
246 );
247
248 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;
249 241
250 while (@arg) { 242 while (@arg) {
251 my $type = shift @arg; 243 my $type = shift @arg;
252 244
253 if ($type eq "prio") { 245 if ($type eq "prio") {
254 $prio = shift @arg; 246 $prio = shift @arg;
255 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
256 } elsif ($type eq "package") { 257 } elsif ($type eq "package") {
257 my $pkg = shift @arg; 258 my $pkg = shift @arg;
258 259
259 while (my ($name, $id) = each %cb_id) { 260 while (my ($name, $id) = each %cb_id) {
260 if (my $cb = $pkg->can ($name)) { 261 if (my $cb = $pkg->can ($name)) {
261 _attach_cb $registry, %undo, $id, $prio, $cb; 262 _attach_cb $registry, $id, $prio, $cb;
262 } 263 }
263 } 264 }
264 265
265 } elsif (exists $cb_id{$type}) { 266 } elsif (exists $cb_id{$type}) {
266 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; 267 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
267 268
268 } elsif (ref $type) { 269 } elsif (ref $type) {
269 warn "attaching objects not supported, ignoring.\n"; 270 warn "attaching objects not supported, ignoring.\n";
270 271
271 } else { 272 } else {
272 shift @arg; 273 shift @arg;
273 warn "attach argument '$type' not supported, ignoring.\n"; 274 warn "attach argument '$type' not supported, ignoring.\n";
274 } 275 }
275 } 276 }
276
277 \%undo
278} 277}
279 278
280sub _attach_attachment { 279sub _object_attach {
281 my ($obj, $name, %arg) = @_; 280 my ($obj, $name, %arg) = @_;
282 281
283 return if exists $obj->{_attachment}{$name}; 282 return if exists $obj->{_attachment}{$name};
284
285 my $res;
286 283
287 if (my $attach = $attachment{$name}) { 284 if (my $attach = $attachment{$name}) {
288 my $registry = $obj->registry; 285 my $registry = $obj->registry;
289 286
290 for (@$attach) { 287 for (@$attach) {
291 my ($klass, @attach) = @$_; 288 my ($klass, @attach) = @$_;
292 $res = _attach @$registry, $klass, @attach; 289 _attach $registry, $klass, @attach;
293 } 290 }
294 291
295 $obj->{$name} = \%arg; 292 $obj->{$name} = \%arg;
296 } else { 293 } else {
297 warn "object uses attachment '$name' that is not available, postponing.\n"; 294 warn "object uses attachment '$name' that is not available, postponing.\n";
298 } 295 }
299 296
300 $obj->{_attachment}{$name} = undef; 297 $obj->{_attachment}{$name} = undef;
301
302 $res->{attachment} = $name;
303 $res
304} 298}
305 299
306*cf::object::attach = 300sub cf::attachable::attach {
307*cf::player::attach = 301 if (ref $_[0]) {
308*cf::map::attach = sub { 302 _object_attach @_;
309 my ($obj, $name, %arg) = @_; 303 } else {
310 304 _attach shift->_attach_registry, @_;
311 _attach_attachment $obj, $name, %arg; 305 }
312}; 306};
313 307
314# all those should be optimised 308# all those should be optimised
315*cf::object::detach = 309sub cf::attachable::detach {
316*cf::player::detach =
317*cf::map::detach = sub {
318 my ($obj, $name) = @_; 310 my ($obj, $name) = @_;
319 311
312 if (ref $obj) {
320 delete $obj->{_attachment}{$name}; 313 delete $obj->{_attachment}{$name};
321 reattach ($obj); 314 reattach ($obj);
315 } else {
316 Carp::croak "cannot, currently, detach class attachments";
317 }
322}; 318};
323 319
324*cf::object::attached = 320sub cf::attachable::attached {
325*cf::player::attached =
326*cf::map::attached = sub {
327 my ($obj, $name) = @_; 321 my ($obj, $name) = @_;
328 322
329 exists $obj->{_attachment}{$name} 323 exists $obj->{_attachment}{$name}
330};
331
332sub attach_global {
333 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
334} 324}
335 325
336sub attach_to_type { 326for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
337 my $type = shift; 327 eval "#line " . __LINE__ . " 'cf.pm'
338 my $subtype = shift; 328 sub cf::\L$klass\E::_attach_registry {
329 (\\\@CB_$klass, KLASS_$klass)
330 }
339 331
340 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ 332 sub cf::\L$klass\E::attachment {
341}
342
343sub attach_to_objects {
344 _attach @CB_OBJECT, KLASS_OBJECT, @_
345}
346
347sub attach_to_players {
348 _attach @CB_PLAYER, KLASS_PLAYER, @_
349}
350
351sub attach_to_maps {
352 _attach @CB_MAP, KLASS_MAP, @_
353}
354
355sub register_attachment {
356 my $name = shift; 333 my \$name = shift;
357 334
358 $attachment{$name} = [[KLASS_OBJECT, @_]];
359}
360
361sub register_player_attachment {
362 my $name = shift;
363
364 $attachment{$name} = [[KLASS_PLAYER, @_]];
365}
366
367sub register_map_attachment {
368 my $name = shift;
369
370 $attachment{$name} = [[KLASS_MAP, @_]]; 335 \$attachment{\$name} = [[KLASS_$klass, \@_]];
336 }
337 ";
338 die if $@;
371} 339}
372 340
373our $override; 341our $override;
374our @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?
375 343
389 for (@$callbacks) { 357 for (@$callbacks) {
390 eval { &{$_->[1]} }; 358 eval { &{$_->[1]} };
391 359
392 if ($@) { 360 if ($@) {
393 warn "$@"; 361 warn "$@";
394 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 362 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
395 override; 363 override;
396 } 364 }
397 365
398 return 1 if $override; 366 return 1 if $override;
399 } 367 }
404=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 372=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
405 373
406=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) 374=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407 375
408=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) 376=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
409 379
410=item $bool = $map->invoke (EVENT_MAP_XXX, ...) 380=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411 381
412Generate a global/object/player/map-specific event with the given arguments. 382Generate a global/object/player/map-specific event with the given arguments.
413 383
415removed in future versions), and there is no public API to access override 385removed in future versions), and there is no public API to access override
416results (if you must, access C<@cf::invoke_results> directly). 386results (if you must, access C<@cf::invoke_results> directly).
417 387
418=back 388=back
419 389
420=head2 methods valid for all pointers 390=cut
391
392#############################################################################
393
394=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396Attachable objects includes objects, players, clients and maps.
421 397
422=over 4 398=over 4
423 399
424=item $object->valid 400=item $object->valid
425
426=item $player->valid
427
428=item $map->valid
429 401
430Just because you have a perl object does not mean that the corresponding 402Just because you have a perl object does not mean that the corresponding
431C-level object still exists. If you try to access an object that has no 403C-level object still exists. If you try to access an object that has no
432valid C counterpart anymore you get an exception at runtime. This method 404valid C counterpart anymore you get an exception at runtime. This method
433can be used to test for existence of the C object part without causing an 405can be used to test for existence of the C object part without causing an
435 407
436=back 408=back
437 409
438=cut 410=cut
439 411
440*cf::object::valid =
441*cf::player::valid =
442*cf::map::valid = \&cf::_valid;
443
444############################################################################# 412#############################################################################
445# object support 413# object support
446 414
447sub instantiate { 415sub instantiate {
448 my ($obj, $data) = @_; 416 my ($obj, $data) = @_;
467 435
468 for my $name (keys %{ $obj->{_attachment} || {} }) { 436 for my $name (keys %{ $obj->{_attachment} || {} }) {
469 if (my $attach = $attachment{$name}) { 437 if (my $attach = $attachment{$name}) {
470 for (@$attach) { 438 for (@$attach) {
471 my ($klass, @attach) = @$_; 439 my ($klass, @attach) = @$_;
472 _attach @$registry, $klass, @attach; 440 _attach $registry, $klass, @attach;
473 } 441 }
474 } else { 442 } else {
475 warn "object uses attachment '$name' that is not available, postponing.\n"; 443 warn "object uses attachment '$name' that is not available, postponing.\n";
476 } 444 }
477 } 445 }
506 unlink $filename; 474 unlink $filename;
507 unlink "$filename.pst"; 475 unlink "$filename.pst";
508 } 476 }
509} 477}
510 478
479sub object_freezer_as_string {
480 my ($rdata, $objs) = @_;
481
482 use Data::Dumper;
483
484 $$rdata . Dumper $objs
485}
486
511sub object_thawer_load { 487sub object_thawer_load {
512 my ($filename) = @_; 488 my ($filename) = @_;
513 489
514 local $/; 490 local $/;
515 491
525 } 501 }
526 502
527 () 503 ()
528} 504}
529 505
530attach_to_objects 506cf::object->attach (
531 prio => -1000000, 507 prio => -1000000,
532 on_clone => sub { 508 on_clone => sub {
533 my ($src, $dst) = @_; 509 my ($src, $dst) = @_;
534 510
535 @{$dst->registry} = @{$src->registry}; 511 @{$dst->registry} = @{$src->registry};
537 %$dst = %$src; 513 %$dst = %$src;
538 514
539 %{$dst->{_attachment}} = %{$src->{_attachment}} 515 %{$dst->{_attachment}} = %{$src->{_attachment}}
540 if exists $src->{_attachment}; 516 if exists $src->{_attachment};
541 }, 517 },
542; 518);
543 519
544############################################################################# 520#############################################################################
545# old plug-in events 521# command handling &c
546 522
547sub inject_event { 523=item cf::register_command $name => \&callback($ob,$args);
548 my $extension = shift;
549 my $event_code = shift;
550 524
551 my $cb = $hook[$event_code]{$extension} 525Register a callback for execution when the client sends the user command
552 or return; 526$name.
553 527
554 &$cb 528=cut
555}
556
557sub inject_global_event {
558 my $event = shift;
559
560 my $cb = $hook[$event]
561 or return;
562
563 List::Util::max map &$_, values %$cb
564}
565
566sub inject_command {
567 my ($name, $obj, $params) = @_;
568
569 for my $cmd (@{ $command{$name} }) {
570 $cmd->[1]->($obj, $params);
571 }
572
573 -1
574}
575 529
576sub register_command { 530sub register_command {
577 my ($name, $time, $cb) = @_; 531 my ($name, $cb) = @_;
578 532
579 my $caller = caller; 533 my $caller = caller;
580 #warn "registering command '$name/$time' to '$caller'"; 534 #warn "registering command '$name/$time' to '$caller'";
581 535
582 push @{ $command{$name} }, [$time, $cb, $caller]; 536 push @{ $COMMAND{$name} }, [$caller, $cb];
583 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
584} 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
585 547
586sub register_extcmd { 548sub register_extcmd {
587 my ($name, $cb) = @_; 549 my ($name, $cb) = @_;
588 550
589 my $caller = caller; 551 my $caller = caller;
590 #warn "registering extcmd '$name' to '$caller'"; 552 #warn "registering extcmd '$name' to '$caller'";
591 553
592 $extcmd{$name} = [$cb, $caller]; 554 $EXTCMD{$name} = [$cb, $caller];
593} 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);
594 588
595sub register { 589sub register {
596 my ($base, $pkg) = @_; 590 my ($base, $pkg) = @_;
597 591
598 #TODO 592 #TODO
617 . "#line 1 \"$path\"\n{\n" 611 . "#line 1 \"$path\"\n{\n"
618 . (do { local $/; <$fh> }) 612 . (do { local $/; <$fh> })
619 . "\n};\n1"; 613 . "\n};\n1";
620 614
621 eval $source 615 eval $source
622 or die "$path: $@"; 616 or die $@ ? "$path: $@\n"
617 : "extension disabled.\n";
623 618
624 push @exts, $pkg; 619 push @exts, $pkg;
625 $ext_pkg{$base} = $pkg; 620 $ext_pkg{$base} = $pkg;
626 621
627# no strict 'refs'; 622# no strict 'refs';
640# for my $idx (0 .. $#PLUGIN_EVENT) { 635# for my $idx (0 .. $#PLUGIN_EVENT) {
641# delete $hook[$idx]{$pkg}; 636# delete $hook[$idx]{$pkg};
642# } 637# }
643 638
644 # remove commands 639 # remove commands
645 for my $name (keys %command) { 640 for my $name (keys %COMMAND) {
646 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 641 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
647 642
648 if (@cb) { 643 if (@cb) {
649 $command{$name} = \@cb; 644 $COMMAND{$name} = \@cb;
650 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
651 } else { 645 } else {
652 delete $command{$name};
653 delete $COMMAND{"$name\000"}; 646 delete $COMMAND{$name};
654 } 647 }
655 } 648 }
656 649
657 # remove extcmds 650 # remove extcmds
658 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 651 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
659 delete $extcmd{$name}; 652 delete $EXTCMD{$name};
660 } 653 }
661 654
662 if (my $cb = $pkg->can ("unload")) { 655 if (my $cb = $pkg->can ("unload")) {
663 eval { 656 eval {
664 $cb->($pkg); 657 $cb->($pkg);
668 661
669 Symbol::delete_package $pkg; 662 Symbol::delete_package $pkg;
670} 663}
671 664
672sub load_extensions { 665sub load_extensions {
673 my $LIBDIR = maps_directory "perl";
674
675 for my $ext (<$LIBDIR/*.ext>) { 666 for my $ext (<$LIBDIR/*.ext>) {
676 next unless -r $ext; 667 next unless -r $ext;
677 eval { 668 eval {
678 load_extension $ext; 669 load_extension $ext;
679 1 670 1
680 } or warn "$ext not loaded: $@"; 671 } or warn "$ext not loaded: $@";
681 } 672 }
682} 673}
683 674
684sub _perl_reload(&) {
685 my ($msg) = @_;
686
687 $msg->("reloading...");
688
689 eval {
690 # 1. cancel all watchers
691 $_->cancel for Event::all_watchers;
692
693 # 2. unload all extensions
694 for (@exts) {
695 $msg->("unloading <$_>");
696 unload_extension $_;
697 }
698
699 # 3. unload all modules loaded from $LIBDIR
700 while (my ($k, $v) = each %INC) {
701 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
702
703 $msg->("removing <$k>");
704 delete $INC{$k};
705
706 $k =~ s/\.pm$//;
707 $k =~ s/\//::/g;
708
709 if (my $cb = $k->can ("unload_module")) {
710 $cb->();
711 }
712
713 Symbol::delete_package $k;
714 }
715
716 # 4. get rid of safe::, as good as possible
717 Symbol::delete_package "safe::$_"
718 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
719
720 # 5. remove register_script_function callbacks
721 # TODO
722
723 # 6. unload cf.pm "a bit"
724 delete $INC{"cf.pm"};
725
726 # don't, removes xs symbols, too,
727 # and global variables created in xs
728 #Symbol::delete_package __PACKAGE__;
729
730 # 7. reload cf.pm
731 $msg->("reloading cf.pm");
732 require cf;
733
734 $msg->("load extensions");
735 cf::load_extensions;
736 };
737 $msg->($@) if $@;
738
739 $msg->("reloaded");
740};
741
742sub perl_reload() {
743 _perl_reload {
744 warn $_[0];
745 print "$_[0]\n";
746 };
747}
748
749register_command "perl-reload", 0, sub {
750 my ($who, $arg) = @_;
751
752 if ($who->flag (FLAG_WIZ)) {
753 _perl_reload {
754 warn $_[0];
755 $who->message ($_[0]);
756 };
757 }
758};
759
760#############################################################################
761# extcmd framework, basically convert ext <msg>
762# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
763
764attach_to_players
765 on_extcmd => sub {
766 my ($pl, $buf) = @_;
767
768 my $msg = eval { from_json $buf };
769
770 if (ref $msg) {
771 if (my $cb = $extcmd{$msg->{msgtype}}) {
772 if (my %reply = $cb->[0]->($pl, $msg)) {
773 $pl->ext_reply ($msg->{msgid}, %reply);
774 }
775 }
776 } else {
777 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
778 }
779
780 cf::override;
781 },
782;
783
784############################################################################# 675#############################################################################
785# load/save/clean perl data associated with a map 676# load/save/clean perl data associated with a map
786 677
787*cf::mapsupport::on_clean = sub { 678*cf::mapsupport::on_clean = sub {
788 my ($map) = @_; 679 my ($map) = @_;
791 defined $path or return; 682 defined $path or return;
792 683
793 unlink "$path.pst"; 684 unlink "$path.pst";
794}; 685};
795 686
796attach_to_maps prio => -10000, package => cf::mapsupport::; 687cf::map->attach (prio => -10000, package => cf::mapsupport::);
797 688
798############################################################################# 689#############################################################################
799# load/save perl data associated with player->ob objects 690# load/save perl data associated with player->ob objects
800 691
801sub all_objects(@) { 692sub all_objects(@) {
802 @_, map all_objects ($_->inv), @_ 693 @_, map all_objects ($_->inv), @_
803} 694}
804 695
805# TODO: compatibility cruft, remove when no longer needed 696# TODO: compatibility cruft, remove when no longer needed
806attach_to_players 697cf::player->attach (
807 on_load => sub { 698 on_load => sub {
808 my ($pl, $path) = @_; 699 my ($pl, $path) = @_;
809 700
810 for my $o (all_objects $pl->ob) { 701 for my $o (all_objects $pl->ob) {
811 if (my $value = $o->get_ob_key_value ("_perl_data")) { 702 if (my $value = $o->get_ob_key_value ("_perl_data")) {
813 704
814 %$o = %{ Storable::thaw pack "H*", $value }; 705 %$o = %{ Storable::thaw pack "H*", $value };
815 } 706 }
816 } 707 }
817 }, 708 },
818; 709);
819 710
820############################################################################# 711#############################################################################
821# core extensions - in perl 712
713=head2 CORE EXTENSIONS
714
715Functions and methods that extend core crossfire objects.
716
717=over 4
822 718
823=item cf::player::exists $login 719=item cf::player::exists $login
824 720
825Returns true when the given account exists. 721Returns true when the given account exists.
826 722
829sub cf::player::exists($) { 725sub cf::player::exists($) {
830 cf::player::find $_[0] 726 cf::player::find $_[0]
831 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;
832} 728}
833 729
834=item $player->reply ($npc, $msg[, $flags]) 730=item $player_object->reply ($npc, $msg[, $flags])
835 731
836Sends 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>
837can 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
838dialogue with the given NPC character. 734dialogue with the given NPC character.
839 735
866 $msg{msgid} = $id; 762 $msg{msgid} = $id;
867 763
868 $self->send ("ext " . to_json \%msg); 764 $self->send ("ext " . to_json \%msg);
869} 765}
870 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
871############################################################################# 785#############################################################################
872# 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
873 796
874our $safe = new Safe "safe"; 797our $safe = new Safe "safe";
875our $safe_hole = new Safe::Hole; 798our $safe_hole = new Safe::Hole;
876 799
877$SIG{FPE} = 'IGNORE'; 800$SIG{FPE} = 'IGNORE';
878 801
879$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));
880 803
881# here we export the classes and methods available to script code 804# here we export the classes and methods available to script code
882 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
883for ( 817for (
884 ["cf::object" => qw(contr pay_amount pay_player)], 818 ["cf::object" => qw(contr pay_amount pay_player map)],
885 ["cf::object::player" => qw(player)], 819 ["cf::object::player" => qw(player)],
886 ["cf::player" => qw(peaceful)], 820 ["cf::player" => qw(peaceful)],
821 ["cf::map" => qw(trigger)],
887) { 822) {
888 no strict 'refs'; 823 no strict 'refs';
889 my ($pkg, @funs) = @$_; 824 my ($pkg, @funs) = @$_;
890 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 825 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
891 for @funs; 826 for @funs;
892} 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
893 840
894sub safe_eval($;@) { 841sub safe_eval($;@) {
895 my ($code, %vars) = @_; 842 my ($code, %vars) = @_;
896 843
897 my $qcode = $code; 844 my $qcode = $code;
920 } 867 }
921 868
922 wantarray ? @res : $res[0] 869 wantarray ? @res : $res[0]
923} 870}
924 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
925sub register_script_function { 887sub register_script_function {
926 my ($fun, $cb) = @_; 888 my ($fun, $cb) = @_;
927 889
928 no strict 'refs'; 890 no strict 'refs';
929 *{"safe::$fun"} = $safe_hole->wrap ($cb); 891 *{"safe::$fun"} = $safe_hole->wrap ($cb);
930} 892}
931 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
932############################################################################# 1003#############################################################################
933# the server's main() 1004# the server's main()
934 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
935sub main { 1014sub main {
1015 cfg_load;
1016 db_load;
936 load_extensions; 1017 load_extensions;
937 Event::loop; 1018 Event::loop;
938} 1019}
939 1020
940############################################################################# 1021#############################################################################
941# initialisation 1022# initialisation
942 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
943register "<global>", __PACKAGE__; 1103register "<global>", __PACKAGE__;
944 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
945unshift @INC, $LIBDIR; 1116unshift @INC, $LIBDIR;
946 1117
947$TICK_WATCHER = Event->timer ( 1118$TICK_WATCHER = Event->timer (
948 prio => 1, 1119 prio => 0,
949 at => $NEXT_TICK || 1, 1120 at => $NEXT_TICK || 1,
1121 data => WF_AUTOCANCEL,
950 cb => sub { 1122 cb => sub {
951 cf::server_tick; # one server iteration 1123 cf::server_tick; # one server iteration
952 1124
953 my $NOW = Event::time; 1125 my $NOW = Event::time;
954 $NEXT_TICK += $TICK; 1126 $NEXT_TICK += $TICK;
955 1127
956 # if we are delayed by four ticks, skip them all 1128 # if we are delayed by four ticks or more, skip them all
957 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1129 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
958 1130
959 $TICK_WATCHER->at ($NEXT_TICK); 1131 $TICK_WATCHER->at ($NEXT_TICK);
960 $TICK_WATCHER->start; 1132 $TICK_WATCHER->start;
961 }, 1133 },
962); 1134);
963 1135
964_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);
965 1143
9661 11441
967 1145

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines