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.69 by root, Mon Sep 18 01:10:35 2006 UTC vs.
Revision 1.95 by root, Fri Dec 22 02:04:20 2006 UTC

5use Storable; 5use Storable;
6use Opcode; 6use Opcode;
7use Safe; 7use Safe;
8use Safe::Hole; 8use Safe::Hole;
9 9
10use IO::AIO ();
11use YAML::Syck ();
10use Time::HiRes; 12use Time::HiRes;
11use Event; 13use Event;
12$Event::Eval = 1; # no idea why this is required, but it is 14$Event::Eval = 1; # no idea why this is required, but it is
13 15
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1;
18
14use strict; 19use strict;
15 20
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22
23our %COMMAND = ();
24our %COMMAND_TIME = ();
25our %EXTCMD = ();
26
16_init_vars; 27_init_vars;
17 28
18our %COMMAND = ();
19our @EVENT; 29our @EVENT;
20our $LIBDIR = maps_directory "perl"; 30our $LIBDIR = datadir . "/ext";
21 31
22our $TICK = MAX_TIME * 1e-6; 32our $TICK = MAX_TIME * 1e-6;
23our $TICK_WATCHER; 33our $TICK_WATCHER;
24our $NEXT_TICK; 34our $NEXT_TICK;
35
36our %CFG;
37
38our $UPTIME; $UPTIME ||= time;
39
40#############################################################################
41
42=head2 GLOBAL VARIABLES
43
44=over 4
45
46=item $cf::UPTIME
47
48The timestamp of the server start (so not actually an uptime).
49
50=item $cf::LIBDIR
51
52The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically.
54
55=item $cf::TICK
56
57The interval between server ticks, in seconds.
58
59=item %cf::CFG
60
61Configuration for the server, loaded from C</etc/crossfire/config>, or
62from wherever your confdir points to.
63
64=back
65
66=cut
25 67
26BEGIN { 68BEGIN {
27 *CORE::GLOBAL::warn = sub { 69 *CORE::GLOBAL::warn = sub {
28 my $msg = join "", @_; 70 my $msg = join "", @_;
29 $msg .= "\n" 71 $msg .= "\n"
32 print STDERR "cfperl: $msg"; 74 print STDERR "cfperl: $msg";
33 LOG llevError, "cfperl: $msg"; 75 LOG llevError, "cfperl: $msg";
34 }; 76 };
35} 77}
36 78
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
81@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
82@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
83@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
37@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38 85
39# 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
40# within the Safe compartment. 87# within the Safe compartment.
41for 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)) {
42 no strict 'refs'; 95 no strict 'refs';
43 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 96 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44} 97}
45 98
46$Event::DIED = sub { 99$Event::DIED = sub {
48}; 101};
49 102
50my %ext_pkg; 103my %ext_pkg;
51my @exts; 104my @exts;
52my @hook; 105my @hook;
53my %command;
54my %extcmd;
55 106
56############################################################################# 107=head2 UTILITY FUNCTIONS
57# utility functions 108
109=over 4
110
111=cut
58 112
59use 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
60 120
61sub from_json($) { 121sub from_json($) {
62 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 122 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63 JSON::Syck::Load $_[0] 123 JSON::Syck::Load $_[0]
64} 124}
65 125
126=item $json = cf::to_json $ref
127
128Converts a perl data structure into its JSON representation.
129
130=cut
131
66sub to_json($) { 132sub to_json($) {
67 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68 JSON::Syck::Dump $_[0] 134 JSON::Syck::Dump $_[0]
69} 135}
70 136
137=back
138
139=cut
140
71############################################################################# 141#############################################################################
72# "new" plug-in system
73 142
74=head3 EVENTS AND OBJECT ATTACHMENTS 143=head2 ATTACHABLE OBJECTS
144
145Many objects in crossfire are so-called attachable objects. That means you can
146attach callbacks/event handlers (a collection of which is called an "attachment")
147to it. All such attachable objects support the following methods.
148
149In the following description, CLASS can be any of C<global>, C<object>
150C<player>, C<client> or C<map> (i.e. the attachable objects in
151crossfire+).
75 152
76=over 4 153=over 4
77 154
78=item $object->attach ($attachment, key => $value...)
79
80=item $object->detach ($attachment)
81
82Attach/detach a pre-registered attachment to an object.
83
84=item $player->attach ($attachment, key => $value...)
85
86=item $player->detach ($attachment)
87
88Attach/detach a pre-registered attachment to a player.
89
90=item $map->attach ($attachment, key => $value...) 155=item $attachable->attach ($attachment, key => $value...)
91 156
92=item $map->detach ($attachment) 157=item $attachable->detach ($attachment)
93 158
94Attach/detach a pre-registered attachment to a map. 159Attach/detach a pre-registered attachment to a specific object and give it
160the specified key/value pairs as arguments.
95 161
96=item $bool = $object->attached ($name) 162Example, attach a minesweeper attachment to the given object, making it a
16310x10 minesweeper game:
97 164
98=item $bool = $player->attached ($name) 165 $obj->attach (minesweeper => width => 10, height => 10);
99 166
100=item $bool = $map->attached ($name) 167=item $bool = $attachable->attached ($name)
101 168
102Checks wether the named attachment is currently attached to the object. 169Checks wether the named attachment is currently attached to the object.
103 170
104=item cf::attach_global ... 171=item cf::CLASS->attach ...
105 172
106Attach handlers for global events. 173=item cf::CLASS->detach ...
107 174
108This and all following C<attach_*>-functions expect any number of the 175Define an anonymous attachment and attach it to all objects of the given
109following handler/hook descriptions: 176CLASS. See the next function for an explanation of its arguments.
177
178You can attach to global events by using the C<cf::global> class.
179
180Example, log all player logins:
181
182 cf::player->attach (
183 on_login => sub {
184 my ($pl) = @_;
185 ...
186 },
187 );
188
189Example, attach to the jeweler skill:
190
191 cf::object->attach (
192 type => cf::SKILL,
193 subtype => cf::SK_JEWELER,
194 on_use_skill => sub {
195 my ($sk, $ob, $part, $dir, $msg) = @_;
196 ...
197 },
198 );
199
200=item cf::CLASS::attachment $name, ...
201
202Register an attachment by C<$name> through which attachable objects of the
203given CLASS can refer to this attachment.
204
205Some classes such as crossfire maps and objects can specify attachments
206that are attached at load/instantiate time, thus the need for a name.
207
208These calls expect any number of the following handler/hook descriptions:
110 209
111=over 4 210=over 4
112 211
113=item prio => $number 212=item prio => $number
114 213
116by another C<prio> setting). Lower priority handlers get executed 215by another C<prio> setting). Lower priority handlers get executed
117earlier. The default priority is C<0>, and many built-in handlers are 216earlier. The default priority is C<0>, and many built-in handlers are
118registered at priority C<-1000>, so lower priorities should not be used 217registered at priority C<-1000>, so lower priorities should not be used
119unless you know what you are doing. 218unless you know what you are doing.
120 219
220=item type => $type
221
222(Only for C<< cf::object->attach >> calls), limits the attachment to the
223given type of objects only (the additional parameter C<subtype> can be
224used to further limit to the given subtype).
225
121=item on_I<event> => \&cb 226=item on_I<event> => \&cb
122 227
123Call the given code reference whenever the named event happens (event is 228Call the given code reference whenever the named event happens (event is
124something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 229something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
125handlers are recognised generally depends on the type of object these 230handlers are recognised generally depends on the type of object these
134package and register them. Only handlers for eevents supported by the 239package and register them. Only handlers for eevents supported by the
135object/class are recognised. 240object/class are recognised.
136 241
137=back 242=back
138 243
139=item cf::attach_to_type $object_type, $subtype, ... 244Example, define an attachment called "sockpuppet" that calls the given
245event handler when a monster attacks:
140 246
141Attach handlers for a specific object type (e.g. TRANSPORT) and 247 cf::object::attachment sockpuppet =>
142subtype. If C<$subtype> is zero or undef, matches all objects of the given 248 on_skill_attack => sub {
143type. 249 my ($self, $victim) = @_;
144 250 ...
145=item cf::attach_to_objects ... 251 }
146 252 }
147Attach handlers to all objects. Do not use this except for debugging or
148very rare events, as handlers are (obviously) called for I<all> objects in
149the game.
150
151=item cf::attach_to_players ...
152
153Attach handlers to all players.
154
155=item cf::attach_to_maps ...
156
157Attach handlers to all maps.
158
159=item cf:register_attachment $name, ...
160
161Register an attachment by name through which objects can refer to this
162attachment.
163
164=item cf:register_player_attachment $name, ...
165
166Register an attachment by name through which players can refer to this
167attachment.
168
169=item cf:register_map_attachment $name, ...
170
171Register an attachment by name through which maps can refer to this
172attachment.
173 253
174=cut 254=cut
175 255
176# the following variables are defined in .xs and must not be re-created 256# the following variables are defined in .xs and must not be re-created
177our @CB_GLOBAL = (); # registry for all global events 257our @CB_GLOBAL = (); # registry for all global events
178our @CB_OBJECT = (); # all objects (should not be used except in emergency) 258our @CB_OBJECT = (); # all objects (should not be used except in emergency)
179our @CB_PLAYER = (); 259our @CB_PLAYER = ();
260our @CB_CLIENT = ();
180our @CB_TYPE = (); # registry for type (cf-object class) based events 261our @CB_TYPE = (); # registry for type (cf-object class) based events
181our @CB_MAP = (); 262our @CB_MAP = ();
182 263
183my %attachment; 264my %attachment;
184 265
185sub _attach_cb($\%$$$) { 266sub _attach_cb($$$$) {
186 my ($registry, $undo, $event, $prio, $cb) = @_; 267 my ($registry, $event, $prio, $cb) = @_;
187 268
188 use sort 'stable'; 269 use sort 'stable';
189 270
190 $cb = [$prio, $cb]; 271 $cb = [$prio, $cb];
191 272
192 @{$registry->[$event]} = sort 273 @{$registry->[$event]} = sort
193 { $a->[0] cmp $b->[0] } 274 { $a->[0] cmp $b->[0] }
194 @{$registry->[$event] || []}, $cb; 275 @{$registry->[$event] || []}, $cb;
195
196 push @{$undo->{cb}}, [$event, $cb];
197} 276}
198 277
199# attach handles attaching event callbacks 278# attach handles attaching event callbacks
200# the only thing the caller has to do is pass the correct 279# the only thing the caller has to do is pass the correct
201# registry (== where the callback attaches to). 280# registry (== where the callback attaches to).
202sub _attach(\@$@) { 281sub _attach {
203 my ($registry, $klass, @arg) = @_; 282 my ($registry, $klass, @arg) = @_;
204 283
284 my $object_type;
205 my $prio = 0; 285 my $prio = 0;
206
207 my %undo = (
208 registry => $registry,
209 cb => [],
210 );
211
212 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
213 287
214 while (@arg) { 288 while (@arg) {
215 my $type = shift @arg; 289 my $type = shift @arg;
216 290
217 if ($type eq "prio") { 291 if ($type eq "prio") {
218 $prio = shift @arg; 292 $prio = shift @arg;
219 293
294 } elsif ($type eq "type") {
295 $object_type = shift @arg;
296 $registry = $CB_TYPE[$object_type] ||= [];
297
298 } elsif ($type eq "subtype") {
299 defined $object_type or Carp::croak "subtype specified without type";
300 my $object_subtype = shift @arg;
301 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
302
220 } elsif ($type eq "package") { 303 } elsif ($type eq "package") {
221 my $pkg = shift @arg; 304 my $pkg = shift @arg;
222 305
223 while (my ($name, $id) = each %cb_id) { 306 while (my ($name, $id) = each %cb_id) {
224 if (my $cb = $pkg->can ($name)) { 307 if (my $cb = $pkg->can ($name)) {
225 _attach_cb $registry, %undo, $id, $prio, $cb; 308 _attach_cb $registry, $id, $prio, $cb;
226 } 309 }
227 } 310 }
228 311
229 } elsif (exists $cb_id{$type}) { 312 } elsif (exists $cb_id{$type}) {
230 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; 313 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
231 314
232 } elsif (ref $type) { 315 } elsif (ref $type) {
233 warn "attaching objects not supported, ignoring.\n"; 316 warn "attaching objects not supported, ignoring.\n";
234 317
235 } else { 318 } else {
236 shift @arg; 319 shift @arg;
237 warn "attach argument '$type' not supported, ignoring.\n"; 320 warn "attach argument '$type' not supported, ignoring.\n";
238 } 321 }
239 } 322 }
240
241 \%undo
242} 323}
243 324
244sub _attach_attachment { 325sub _object_attach {
245 my ($obj, $name, %arg) = @_; 326 my ($obj, $name, %arg) = @_;
246 327
247 return if exists $obj->{_attachment}{$name}; 328 return if exists $obj->{_attachment}{$name};
248
249 my $res;
250 329
251 if (my $attach = $attachment{$name}) { 330 if (my $attach = $attachment{$name}) {
252 my $registry = $obj->registry; 331 my $registry = $obj->registry;
253 332
254 for (@$attach) { 333 for (@$attach) {
255 my ($klass, @attach) = @$_; 334 my ($klass, @attach) = @$_;
256 $res = _attach @$registry, $klass, @attach; 335 _attach $registry, $klass, @attach;
257 } 336 }
258 337
259 $obj->{$name} = \%arg; 338 $obj->{$name} = \%arg;
260 } else { 339 } else {
261 warn "object uses attachment '$name' that is not available, postponing.\n"; 340 warn "object uses attachment '$name' that is not available, postponing.\n";
262 } 341 }
263 342
264 $obj->{_attachment}{$name} = undef; 343 $obj->{_attachment}{$name} = undef;
265
266 $res->{attachment} = $name;
267 $res
268} 344}
269 345
270*cf::object::attach = 346sub cf::attachable::attach {
271*cf::player::attach = 347 if (ref $_[0]) {
272*cf::map::attach = sub { 348 _object_attach @_;
273 my ($obj, $name, %arg) = @_; 349 } else {
274 350 _attach shift->_attach_registry, @_;
275 _attach_attachment $obj, $name, %arg; 351 }
276}; 352};
277 353
278# all those should be optimised 354# all those should be optimised
279*cf::object::detach = 355sub cf::attachable::detach {
280*cf::player::detach =
281*cf::map::detach = sub {
282 my ($obj, $name) = @_; 356 my ($obj, $name) = @_;
283 357
358 if (ref $obj) {
284 delete $obj->{_attachment}{$name}; 359 delete $obj->{_attachment}{$name};
285 reattach ($obj); 360 reattach ($obj);
361 } else {
362 Carp::croak "cannot, currently, detach class attachments";
363 }
286}; 364};
287 365
288*cf::object::attached = 366sub cf::attachable::attached {
289*cf::player::attached =
290*cf::map::attached = sub {
291 my ($obj, $name) = @_; 367 my ($obj, $name) = @_;
292 368
293 exists $obj->{_attachment}{$name} 369 exists $obj->{_attachment}{$name}
294};
295
296sub attach_global {
297 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
298} 370}
299 371
300sub attach_to_type { 372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
301 my $type = shift; 373 eval "#line " . __LINE__ . " 'cf.pm'
302 my $subtype = shift; 374 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass)
376 }
303 377
304 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ 378 sub cf::\L$klass\E::attachment {
305}
306
307sub attach_to_objects {
308 _attach @CB_OBJECT, KLASS_OBJECT, @_
309}
310
311sub attach_to_players {
312 _attach @CB_PLAYER, KLASS_PLAYER, @_
313}
314
315sub attach_to_maps {
316 _attach @CB_MAP, KLASS_MAP, @_
317}
318
319sub register_attachment {
320 my $name = shift; 379 my \$name = shift;
321 380
322 $attachment{$name} = [[KLASS_OBJECT, @_]];
323}
324
325sub register_player_attachment {
326 my $name = shift;
327
328 $attachment{$name} = [[KLASS_PLAYER, @_]];
329}
330
331sub register_map_attachment {
332 my $name = shift;
333
334 $attachment{$name} = [[KLASS_MAP, @_]]; 381 \$attachment{\$name} = [[KLASS_$klass, \@_]];
382 }
383 ";
384 die if $@;
335} 385}
336 386
337our $override; 387our $override;
338our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 388our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
339 389
369 419
370=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) 420=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371 421
372=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) 422=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
373 423
424=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
425
374=item $bool = $map->invoke (EVENT_MAP_XXX, ...) 426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375 427
376Generate a global/object/player/map-specific event with the given arguments. 428Generate a global/object/player/map-specific event with the given arguments.
377 429
378This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
379removed in future versions), and there is no public API to access override 431removed in future versions), and there is no public API to access override
380results (if you must, access C<@cf::invoke_results> directly). 432results (if you must, access C<@cf::invoke_results> directly).
381 433
382=back 434=back
383 435
384=head2 methods valid for all pointers 436=cut
437
438#############################################################################
439
440=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442Attachable objects includes objects, players, clients and maps.
385 443
386=over 4 444=over 4
387 445
388=item $object->valid 446=item $object->valid
389
390=item $player->valid
391
392=item $map->valid
393 447
394Just because you have a perl object does not mean that the corresponding 448Just because you have a perl object does not mean that the corresponding
395C-level object still exists. If you try to access an object that has no 449C-level object still exists. If you try to access an object that has no
396valid C counterpart anymore you get an exception at runtime. This method 450valid C counterpart anymore you get an exception at runtime. This method
397can be used to test for existence of the C object part without causing an 451can be used to test for existence of the C object part without causing an
399 453
400=back 454=back
401 455
402=cut 456=cut
403 457
404*cf::object::valid =
405*cf::player::valid =
406*cf::map::valid = \&cf::_valid;
407
408############################################################################# 458#############################################################################
409# object support 459# object support
410 460
411sub instantiate { 461sub instantiate {
412 my ($obj, $data) = @_; 462 my ($obj, $data) = @_;
431 481
432 for my $name (keys %{ $obj->{_attachment} || {} }) { 482 for my $name (keys %{ $obj->{_attachment} || {} }) {
433 if (my $attach = $attachment{$name}) { 483 if (my $attach = $attachment{$name}) {
434 for (@$attach) { 484 for (@$attach) {
435 my ($klass, @attach) = @$_; 485 my ($klass, @attach) = @$_;
436 _attach @$registry, $klass, @attach; 486 _attach $registry, $klass, @attach;
437 } 487 }
438 } else { 488 } else {
439 warn "object uses attachment '$name' that is not available, postponing.\n"; 489 warn "object uses attachment '$name' that is not available, postponing.\n";
440 } 490 }
441 } 491 }
470 unlink $filename; 520 unlink $filename;
471 unlink "$filename.pst"; 521 unlink "$filename.pst";
472 } 522 }
473} 523}
474 524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
531}
532
475sub object_thawer_load { 533sub object_thawer_load {
476 my ($filename) = @_; 534 my ($filename) = @_;
477 535
478 local $/; 536 local $/;
479 537
489 } 547 }
490 548
491 () 549 ()
492} 550}
493 551
494attach_to_objects 552cf::object->attach (
495 prio => -1000000, 553 prio => -1000000,
496 on_clone => sub { 554 on_clone => sub {
497 my ($src, $dst) = @_; 555 my ($src, $dst) = @_;
498 556
499 @{$dst->registry} = @{$src->registry}; 557 @{$dst->registry} = @{$src->registry};
501 %$dst = %$src; 559 %$dst = %$src;
502 560
503 %{$dst->{_attachment}} = %{$src->{_attachment}} 561 %{$dst->{_attachment}} = %{$src->{_attachment}}
504 if exists $src->{_attachment}; 562 if exists $src->{_attachment};
505 }, 563 },
506; 564);
507 565
508############################################################################# 566#############################################################################
509# old plug-in events 567# command handling &c
510 568
511sub inject_event { 569=item cf::register_command $name => \&callback($ob,$args);
512 my $extension = shift;
513 my $event_code = shift;
514 570
515 my $cb = $hook[$event_code]{$extension} 571Register a callback for execution when the client sends the user command
516 or return; 572$name.
517 573
518 &$cb 574=cut
519}
520
521sub inject_global_event {
522 my $event = shift;
523
524 my $cb = $hook[$event]
525 or return;
526
527 List::Util::max map &$_, values %$cb
528}
529
530sub inject_command {
531 my ($name, $obj, $params) = @_;
532
533 for my $cmd (@{ $command{$name} }) {
534 $cmd->[1]->($obj, $params);
535 }
536
537 -1
538}
539 575
540sub register_command { 576sub register_command {
541 my ($name, $time, $cb) = @_; 577 my ($name, $cb) = @_;
542 578
543 my $caller = caller; 579 my $caller = caller;
544 #warn "registering command '$name/$time' to '$caller'"; 580 #warn "registering command '$name/$time' to '$caller'";
545 581
546 push @{ $command{$name} }, [$time, $cb, $caller]; 582 push @{ $COMMAND{$name} }, [$caller, $cb];
547 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548} 583}
584
585=item cf::register_extcmd $name => \&callback($pl,$packet);
586
587Register a callbackf ro execution when the client sends an extcmd packet.
588
589If the callback returns something, it is sent back as if reply was being
590called.
591
592=cut
549 593
550sub register_extcmd { 594sub register_extcmd {
551 my ($name, $cb) = @_; 595 my ($name, $cb) = @_;
552 596
553 my $caller = caller; 597 my $caller = caller;
554 #warn "registering extcmd '$name' to '$caller'"; 598 #warn "registering extcmd '$name' to '$caller'";
555 599
556 $extcmd{$name} = [$cb, $caller]; 600 $EXTCMD{$name} = [$cb, $caller];
557} 601}
602
603cf::player->attach (
604 on_command => sub {
605 my ($pl, $name, $params) = @_;
606
607 my $cb = $COMMAND{$name}
608 or return;
609
610 for my $cmd (@$cb) {
611 $cmd->[1]->($pl->ob, $params);
612 }
613
614 cf::override;
615 },
616 on_extcmd => sub {
617 my ($pl, $buf) = @_;
618
619 my $msg = eval { from_json $buf };
620
621 if (ref $msg) {
622 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623 if (my %reply = $cb->[0]->($pl, $msg)) {
624 $pl->ext_reply ($msg->{msgid}, %reply);
625 }
626 }
627 } else {
628 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
629 }
630
631 cf::override;
632 },
633);
558 634
559sub register { 635sub register {
560 my ($base, $pkg) = @_; 636 my ($base, $pkg) = @_;
561 637
562 #TODO 638 #TODO
581 . "#line 1 \"$path\"\n{\n" 657 . "#line 1 \"$path\"\n{\n"
582 . (do { local $/; <$fh> }) 658 . (do { local $/; <$fh> })
583 . "\n};\n1"; 659 . "\n};\n1";
584 660
585 eval $source 661 eval $source
586 or die "$path: $@"; 662 or die $@ ? "$path: $@\n"
663 : "extension disabled.\n";
587 664
588 push @exts, $pkg; 665 push @exts, $pkg;
589 $ext_pkg{$base} = $pkg; 666 $ext_pkg{$base} = $pkg;
590 667
591# no strict 'refs'; 668# no strict 'refs';
604# for my $idx (0 .. $#PLUGIN_EVENT) { 681# for my $idx (0 .. $#PLUGIN_EVENT) {
605# delete $hook[$idx]{$pkg}; 682# delete $hook[$idx]{$pkg};
606# } 683# }
607 684
608 # remove commands 685 # remove commands
609 for my $name (keys %command) { 686 for my $name (keys %COMMAND) {
610 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
611 688
612 if (@cb) { 689 if (@cb) {
613 $command{$name} = \@cb; 690 $COMMAND{$name} = \@cb;
614 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615 } else { 691 } else {
616 delete $command{$name};
617 delete $COMMAND{"$name\000"}; 692 delete $COMMAND{$name};
618 } 693 }
619 } 694 }
620 695
621 # remove extcmds 696 # remove extcmds
622 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
623 delete $extcmd{$name}; 698 delete $EXTCMD{$name};
624 } 699 }
625 700
626 if (my $cb = $pkg->can ("unload")) { 701 if (my $cb = $pkg->can ("unload")) {
627 eval { 702 eval {
628 $cb->($pkg); 703 $cb->($pkg);
632 707
633 Symbol::delete_package $pkg; 708 Symbol::delete_package $pkg;
634} 709}
635 710
636sub load_extensions { 711sub load_extensions {
637 my $LIBDIR = maps_directory "perl";
638
639 for my $ext (<$LIBDIR/*.ext>) { 712 for my $ext (<$LIBDIR/*.ext>) {
640 next unless -r $ext; 713 next unless -r $ext;
641 eval { 714 eval {
642 load_extension $ext; 715 load_extension $ext;
643 1 716 1
644 } or warn "$ext not loaded: $@"; 717 } or warn "$ext not loaded: $@";
645 } 718 }
646} 719}
647 720
648############################################################################# 721#############################################################################
649# extcmd framework, basically convert ext <msg>
650# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
651
652attach_to_players
653 on_extcmd => sub {
654 my ($pl, $buf) = @_;
655
656 my $msg = eval { from_json $buf };
657
658 if (ref $msg) {
659 if (my $cb = $extcmd{$msg->{msgtype}}) {
660 if (my %reply = $cb->[0]->($pl, $msg)) {
661 $pl->ext_reply ($msg->{msgid}, %reply);
662 }
663 }
664 } else {
665 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
666 }
667
668 cf::override;
669 },
670;
671
672#############################################################################
673# load/save/clean perl data associated with a map 722# load/save/clean perl data associated with a map
674 723
675*cf::mapsupport::on_clean = sub { 724*cf::mapsupport::on_clean = sub {
676 my ($map) = @_; 725 my ($map) = @_;
677 726
679 defined $path or return; 728 defined $path or return;
680 729
681 unlink "$path.pst"; 730 unlink "$path.pst";
682}; 731};
683 732
684attach_to_maps prio => -10000, package => cf::mapsupport::; 733cf::map->attach (prio => -10000, package => cf::mapsupport::);
685 734
686############################################################################# 735#############################################################################
687# load/save perl data associated with player->ob objects 736# load/save perl data associated with player->ob objects
688 737
689sub all_objects(@) { 738sub all_objects(@) {
690 @_, map all_objects ($_->inv), @_ 739 @_, map all_objects ($_->inv), @_
691} 740}
692 741
693# TODO: compatibility cruft, remove when no longer needed 742# TODO: compatibility cruft, remove when no longer needed
694attach_to_players 743cf::player->attach (
695 on_load => sub { 744 on_load => sub {
696 my ($pl, $path) = @_; 745 my ($pl, $path) = @_;
697 746
698 for my $o (all_objects $pl->ob) { 747 for my $o (all_objects $pl->ob) {
699 if (my $value = $o->get_ob_key_value ("_perl_data")) { 748 if (my $value = $o->get_ob_key_value ("_perl_data")) {
701 750
702 %$o = %{ Storable::thaw pack "H*", $value }; 751 %$o = %{ Storable::thaw pack "H*", $value };
703 } 752 }
704 } 753 }
705 }, 754 },
706; 755);
707 756
708############################################################################# 757#############################################################################
709# core extensions - in perl 758
759=head2 CORE EXTENSIONS
760
761Functions and methods that extend core crossfire objects.
762
763=head3 cf::player
764
765=over 4
710 766
711=item cf::player::exists $login 767=item cf::player::exists $login
712 768
713Returns true when the given account exists. 769Returns true when the given account exists.
714 770
717sub cf::player::exists($) { 773sub cf::player::exists($) {
718 cf::player::find $_[0] 774 cf::player::find $_[0]
719 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 775 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
720} 776}
721 777
778=item $player->ext_reply ($msgid, $msgtype, %msg)
779
780Sends an ext reply to the player.
781
782=cut
783
784sub cf::player::ext_reply($$$%) {
785 my ($self, $id, %msg) = @_;
786
787 $msg{msgid} = $id;
788
789 $self->send ("ext " . to_json \%msg);
790}
791
792=back
793
794=head3 cf::object::player
795
796=over 4
797
722=item $player->reply ($npc, $msg[, $flags]) 798=item $player_object->reply ($npc, $msg[, $flags])
723 799
724Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 800Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
725can be C<undef>. Does the right thing when the player is currently in a 801can be C<undef>. Does the right thing when the player is currently in a
726dialogue with the given NPC character. 802dialogue with the given NPC character.
727 803
728=cut 804=cut
729 805
730# rough implementation of a future "reply" method that works 806# rough implementation of a future "reply" method that works
731# with dialog boxes. 807# with dialog boxes.
808#TODO: the first argument must go, split into a $npc->reply_to ( method
732sub cf::object::player::reply($$$;$) { 809sub cf::object::player::reply($$$;$) {
733 my ($self, $npc, $msg, $flags) = @_; 810 my ($self, $npc, $msg, $flags) = @_;
734 811
735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 812 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
736 813
740 $msg = $npc->name . " says: $msg" if $npc; 817 $msg = $npc->name . " says: $msg" if $npc;
741 $self->message ($msg, $flags); 818 $self->message ($msg, $flags);
742 } 819 }
743} 820}
744 821
745=item $player->ext_reply ($msgid, $msgtype, %msg) 822=item $player_object->may ("access")
746 823
747Sends an ext reply to the player. 824Returns wether the given player is authorized to access resource "access"
825(e.g. "command_wizcast").
748 826
749=cut 827=cut
750 828
751sub cf::player::ext_reply($$$%) { 829sub cf::object::player::may {
752 my ($self, $id, %msg) = @_; 830 my ($self, $access) = @_;
753 831
754 $msg{msgid} = $id; 832 $self->flag (cf::FLAG_WIZ) ||
755 833 (ref $cf::CFG{"may_$access"}
756 $self->send ("ext " . to_json \%msg); 834 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835 : $cf::CFG{"may_$access"})
757} 836}
758 837
759############################################################################# 838=head3 cf::client
760# map scripting support 839
840=over 4
841
842=item $client->send_drawinfo ($text, $flags)
843
844Sends a drawinfo packet to the client. Circumvents output buffering so
845should not be used under normal circumstances.
846
847=cut
848
849sub cf::client::send_drawinfo {
850 my ($self, $text, $flags) = @_;
851
852 utf8::encode $text;
853 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
854}
855
856
857=item $success = $client->query ($flags, "text", \&cb)
858
859Queues a query to the client, calling the given callback with
860the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
861C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
862
863Queries can fail, so check the return code. Or don't, as queries will become
864reliable at some point in the future.
865
866=cut
867
868sub cf::client::query {
869 my ($self, $flags, $text, $cb) = @_;
870
871 return unless $self->state == ST_PLAYING
872 || $self->state == ST_SETUP
873 || $self->state == ST_CUSTOM;
874
875 $self->state (ST_CUSTOM);
876
877 utf8::encode $text;
878 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
879
880 $self->send_packet ($self->{query_queue}[0][0])
881 if @{ $self->{query_queue} } == 1;
882}
883
884cf::client->attach (
885 on_reply => sub {
886 my ($ns, $msg) = @_;
887
888 # this weird shuffling is so that direct followup queries
889 # get handled first
890 my $queue = delete $ns->{query_queue};
891
892 (shift @$queue)->[1]->($msg);
893
894 push @{ $ns->{query_queue} }, @$queue;
895
896 if (@{ $ns->{query_queue} } == @$queue) {
897 if (@$queue) {
898 $ns->send_packet ($ns->{query_queue}[0][0]);
899 } else {
900 $ns->state (ST_PLAYING);
901 }
902 }
903 },
904);
905
906=back
907
908
909=head2 SAFE SCRIPTING
910
911Functions that provide a safe environment to compile and execute
912snippets of perl code without them endangering the safety of the server
913itself. Looping constructs, I/O operators and other built-in functionality
914is not available in the safe scripting environment, and the number of
915functions and methods that can be called is greatly reduced.
916
917=cut
761 918
762our $safe = new Safe "safe"; 919our $safe = new Safe "safe";
763our $safe_hole = new Safe::Hole; 920our $safe_hole = new Safe::Hole;
764 921
765$SIG{FPE} = 'IGNORE'; 922$SIG{FPE} = 'IGNORE';
766 923
767$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 924$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
768 925
769# here we export the classes and methods available to script code 926# here we export the classes and methods available to script code
770 927
928=pod
929
930The following fucntions and emthods are available within a safe environment:
931
932 cf::object contr pay_amount pay_player map
933 cf::object::player player
934 cf::player peaceful
935 cf::map trigger
936
937=cut
938
771for ( 939for (
772 ["cf::object" => qw(contr pay_amount pay_player)], 940 ["cf::object" => qw(contr pay_amount pay_player map)],
773 ["cf::object::player" => qw(player)], 941 ["cf::object::player" => qw(player)],
774 ["cf::player" => qw(peaceful)], 942 ["cf::player" => qw(peaceful)],
943 ["cf::map" => qw(trigger)],
775) { 944) {
776 no strict 'refs'; 945 no strict 'refs';
777 my ($pkg, @funs) = @$_; 946 my ($pkg, @funs) = @$_;
778 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 947 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
779 for @funs; 948 for @funs;
780} 949}
950
951=over 4
952
953=item @retval = safe_eval $code, [var => value, ...]
954
955Compiled and executes the given perl code snippet. additional var/value
956pairs result in temporary local (my) scalar variables of the given name
957that are available in the code snippet. Example:
958
959 my $five = safe_eval '$first + $second', first => 1, second => 4;
960
961=cut
781 962
782sub safe_eval($;@) { 963sub safe_eval($;@) {
783 my ($code, %vars) = @_; 964 my ($code, %vars) = @_;
784 965
785 my $qcode = $code; 966 my $qcode = $code;
830 1011
831 no strict 'refs'; 1012 no strict 'refs';
832 *{"safe::$fun"} = $safe_hole->wrap ($cb); 1013 *{"safe::$fun"} = $safe_hole->wrap ($cb);
833} 1014}
834 1015
1016=back
1017
1018=cut
1019
835############################################################################# 1020#############################################################################
836 1021
837=head2 EXTENSION DATABASE SUPPORT 1022=head2 EXTENSION DATABASE SUPPORT
838 1023
839Crossfire maintains a very simple database for extension use. It can 1024Crossfire maintains a very simple database for extension use. It can
873 1058
874Immediately write the database to disk I<if it is dirty>. 1059Immediately write the database to disk I<if it is dirty>.
875 1060
876=cut 1061=cut
877 1062
1063our $DB;
1064
878{ 1065{
879 my $db;
880 my $path = cf::localdir . "/database.pst"; 1066 my $path = cf::localdir . "/database.pst";
881 1067
882 sub db_load() { 1068 sub db_load() {
883 warn "loading database $path\n";#d# remove later 1069 warn "loading database $path\n";#d# remove later
884 $db = stat $path ? Storable::retrieve $path : { }; 1070 $DB = stat $path ? Storable::retrieve $path : { };
885 } 1071 }
886 1072
887 my $pid; 1073 my $pid;
888 1074
889 sub db_save() { 1075 sub db_save() {
890 warn "saving database $path\n";#d# remove later 1076 warn "saving database $path\n";#d# remove later
891 waitpid $pid, 0 if $pid; 1077 waitpid $pid, 0 if $pid;
892 if (0 == ($pid = fork)) { 1078 if (0 == ($pid = fork)) {
893 $db->{_meta}{version} = 1; 1079 $DB->{_meta}{version} = 1;
894 Storable::nstore $db, "$path~"; 1080 Storable::nstore $DB, "$path~";
895 rename "$path~", $path; 1081 rename "$path~", $path;
896 cf::_exit 0 if defined $pid; 1082 cf::_exit 0 if defined $pid;
897 } 1083 }
898 } 1084 }
899 1085
902 sub db_sync() { 1088 sub db_sync() {
903 db_save if $dirty; 1089 db_save if $dirty;
904 undef $dirty; 1090 undef $dirty;
905 } 1091 }
906 1092
907 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { 1093 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
908 db_sync; 1094 db_sync;
909 }); 1095 });
910 1096
911 sub db_dirty() { 1097 sub db_dirty() {
912 $dirty = 1; 1098 $dirty = 1;
913 $idle->start; 1099 $idle->start;
914 } 1100 }
915 1101
916 sub db_get($;$) { 1102 sub db_get($;$) {
917 @_ >= 2 1103 @_ >= 2
918 ? $db->{$_[0]}{$_[1]} 1104 ? $DB->{$_[0]}{$_[1]}
919 : ($db->{$_[0]} ||= { }) 1105 : ($DB->{$_[0]} ||= { })
920 } 1106 }
921 1107
922 sub db_put($$;$) { 1108 sub db_put($$;$) {
923 if (@_ >= 3) { 1109 if (@_ >= 3) {
924 $db->{$_[0]}{$_[1]} = $_[2]; 1110 $DB->{$_[0]}{$_[1]} = $_[2];
925 } else { 1111 } else {
926 $db->{$_[0]} = $_[1]; 1112 $DB->{$_[0]} = $_[1];
927 } 1113 }
928 db_dirty; 1114 db_dirty;
929 } 1115 }
930 1116
931 attach_global 1117 cf::global->attach (
932 prio => 10000, 1118 prio => 10000,
933 on_cleanup => sub { 1119 on_cleanup => sub {
934 db_sync; 1120 db_sync;
935 }, 1121 },
936 ; 1122 );
937} 1123}
938 1124
939############################################################################# 1125#############################################################################
940# the server's main() 1126# the server's main()
941 1127
1128sub cfg_load {
1129 open my $fh, "<:utf8", cf::confdir . "/config"
1130 or return;
1131
1132 local $/;
1133 *CFG = YAML::Syck::Load <$fh>;
1134}
1135
942sub main { 1136sub main {
1137 cfg_load;
943 db_load; 1138 db_load;
944 load_extensions; 1139 load_extensions;
945 Event::loop; 1140 Event::loop;
946} 1141}
947 1142
953 1148
954 $msg->("reloading..."); 1149 $msg->("reloading...");
955 1150
956 eval { 1151 eval {
957 # cancel all watchers 1152 # cancel all watchers
958 $_->cancel for Event::all_watchers; 1153 for (Event::all_watchers) {
1154 $_->cancel if $_->data & WF_AUTOCANCEL;
1155 }
959 1156
960 # unload all extensions 1157 # unload all extensions
961 for (@exts) { 1158 for (@exts) {
962 $msg->("unloading <$_>"); 1159 $msg->("unloading <$_>");
963 unload_extension $_; 1160 unload_extension $_;
999 1196
1000 # reload cf.pm 1197 # reload cf.pm
1001 $msg->("reloading cf.pm"); 1198 $msg->("reloading cf.pm");
1002 require cf; 1199 require cf;
1003 1200
1004 # load database again 1201 # load config and database again
1202 cf::cfg_load;
1005 cf::db_load; 1203 cf::db_load;
1006 1204
1007 # load extensions 1205 # load extensions
1008 $msg->("load extensions"); 1206 $msg->("load extensions");
1009 cf::load_extensions; 1207 cf::load_extensions;
1022 warn $_[0]; 1220 warn $_[0];
1023 print "$_[0]\n"; 1221 print "$_[0]\n";
1024 }; 1222 };
1025} 1223}
1026 1224
1225register "<global>", __PACKAGE__;
1226
1027register_command "perl-reload", 0, sub { 1227register_command "perl-reload" => sub {
1028 my ($who, $arg) = @_; 1228 my ($who, $arg) = @_;
1029 1229
1030 if ($who->flag (FLAG_WIZ)) { 1230 if ($who->flag (FLAG_WIZ)) {
1031 _perl_reload { 1231 _perl_reload {
1032 warn $_[0]; 1232 warn $_[0];
1033 $who->message ($_[0]); 1233 $who->message ($_[0]);
1034 }; 1234 };
1035 } 1235 }
1036}; 1236};
1037 1237
1038register "<global>", __PACKAGE__;
1039
1040unshift @INC, $LIBDIR; 1238unshift @INC, $LIBDIR;
1041 1239
1042$TICK_WATCHER = Event->timer ( 1240$TICK_WATCHER = Event->timer (
1043 prio => 1, 1241 prio => 0,
1044 at => $NEXT_TICK || 1, 1242 at => $NEXT_TICK || 1,
1243 data => WF_AUTOCANCEL,
1045 cb => sub { 1244 cb => sub {
1046 cf::server_tick; # one server iteration 1245 cf::server_tick; # one server iteration
1047 1246
1048 my $NOW = Event::time; 1247 my $NOW = Event::time;
1049 $NEXT_TICK += $TICK; 1248 $NEXT_TICK += $TICK;
1050 1249
1051 # if we are delayed by four ticks, skip them all 1250 # if we are delayed by four ticks or more, skip them all
1052 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1251 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1053 1252
1054 $TICK_WATCHER->at ($NEXT_TICK); 1253 $TICK_WATCHER->at ($NEXT_TICK);
1055 $TICK_WATCHER->start; 1254 $TICK_WATCHER->start;
1056 }, 1255 },
1057); 1256);
1058 1257
1258IO::AIO::max_poll_time $TICK * 0.2;
1259
1260Event->io (fd => IO::AIO::poll_fileno,
1261 poll => 'r',
1262 prio => 5,
1263 data => WF_AUTOCANCEL,
1264 cb => \&IO::AIO::poll_cb);
1265
10591 12661
1060 1267

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines