ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines