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.60 by root, Thu Aug 31 06:23:19 2006 UTC vs.
Revision 1.94 by root, Thu Dec 21 23:02:54 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
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+).
111 152
112=over 4 153=over 4
113 154
114=item $object->attach ($attachment, key => $value...)
115
116=item $object->detach ($attachment)
117
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...) 155=item $attachable->attach ($attachment, key => $value...)
127 156
128=item $map->detach ($attachment) 157=item $attachable->detach ($attachment)
129 158
130Attach/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.
131 161
132=item $bool = $object->attached ($name) 162Example, attach a minesweeper attachment to the given object, making it a
16310x10 minesweeper game:
133 164
134=item $bool = $player->attached ($name) 165 $obj->attach (minesweeper => width => 10, height => 10);
135 166
136=item $bool = $map->attached ($name) 167=item $bool = $attachable->attached ($name)
137 168
138Checks wether the named attachment is currently attached to the object. 169Checks wether the named attachment is currently attached to the object.
139 170
140=item cf::attach_global ... 171=item cf::CLASS->attach ...
141 172
142Attach handlers for global events. 173=item cf::CLASS->detach ...
143 174
144This and all following C<attach_*>-functions expect any number of the 175Define an anonymous attachment and attach it to all objects of the given
145following 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:
146 209
147=over 4 210=over 4
148 211
149=item prio => $number 212=item prio => $number
150 213
152by another C<prio> setting). Lower priority handlers get executed 215by another C<prio> setting). Lower priority handlers get executed
153earlier. 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
154registered at priority C<-1000>, so lower priorities should not be used 217registered at priority C<-1000>, so lower priorities should not be used
155unless you know what you are doing. 218unless you know what you are doing.
156 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
157=item on_I<event> => \&cb 226=item on_I<event> => \&cb
158 227
159Call the given code reference whenever the named event happens (event is 228Call 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 229something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
161handlers are recognised generally depends on the type of object these 230handlers are recognised generally depends on the type of object these
170package and register them. Only handlers for eevents supported by the 239package and register them. Only handlers for eevents supported by the
171object/class are recognised. 240object/class are recognised.
172 241
173=back 242=back
174 243
175=item cf::attach_to_type $object_type, $subtype, ... 244Example, define an attachment called "sockpuppet" that calls the given
245event handler when a monster attacks:
176 246
177Attach handlers for a specific object type (e.g. TRANSPORT) and 247 cf::object::attachment sockpuppet =>
178subtype. If C<$subtype> is zero or undef, matches all objects of the given 248 on_skill_attack => sub {
179type. 249 my ($self, $victim) = @_;
180 250 ...
181=item cf::attach_to_objects ... 251 }
182 252 }
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 253
210=cut 254=cut
211 255
212# 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
213our @CB_GLOBAL = (); # registry for all global events 257our @CB_GLOBAL = (); # registry for all global events
214our @CB_OBJECT = (); # all objects (should not be used except in emergency) 258our @CB_OBJECT = (); # all objects (should not be used except in emergency)
215our @CB_PLAYER = (); 259our @CB_PLAYER = ();
260our @CB_CLIENT = ();
216our @CB_TYPE = (); # registry for type (cf-object class) based events 261our @CB_TYPE = (); # registry for type (cf-object class) based events
217our @CB_MAP = (); 262our @CB_MAP = ();
218 263
219my %attachment; 264my %attachment;
220 265
221sub _attach_cb($\%$$$) { 266sub _attach_cb($$$$) {
222 my ($registry, $undo, $event, $prio, $cb) = @_; 267 my ($registry, $event, $prio, $cb) = @_;
223 268
224 use sort 'stable'; 269 use sort 'stable';
225 270
226 $cb = [$prio, $cb]; 271 $cb = [$prio, $cb];
227 272
228 @{$registry->[$event]} = sort 273 @{$registry->[$event]} = sort
229 { $a->[0] cmp $b->[0] } 274 { $a->[0] cmp $b->[0] }
230 @{$registry->[$event] || []}, $cb; 275 @{$registry->[$event] || []}, $cb;
231
232 push @{$undo->{cb}}, [$event, $cb];
233} 276}
234 277
235# attach handles attaching event callbacks 278# attach handles attaching event callbacks
236# 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
237# registry (== where the callback attaches to). 280# registry (== where the callback attaches to).
238sub _attach(\@$@) { 281sub _attach {
239 my ($registry, $klass, @arg) = @_; 282 my ($registry, $klass, @arg) = @_;
240 283
284 my $object_type;
241 my $prio = 0; 285 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; 286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
249 287
250 while (@arg) { 288 while (@arg) {
251 my $type = shift @arg; 289 my $type = shift @arg;
252 290
253 if ($type eq "prio") { 291 if ($type eq "prio") {
254 $prio = shift @arg; 292 $prio = shift @arg;
255 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
256 } elsif ($type eq "package") { 303 } elsif ($type eq "package") {
257 my $pkg = shift @arg; 304 my $pkg = shift @arg;
258 305
259 while (my ($name, $id) = each %cb_id) { 306 while (my ($name, $id) = each %cb_id) {
260 if (my $cb = $pkg->can ($name)) { 307 if (my $cb = $pkg->can ($name)) {
261 _attach_cb $registry, %undo, $id, $prio, $cb; 308 _attach_cb $registry, $id, $prio, $cb;
262 } 309 }
263 } 310 }
264 311
265 } elsif (exists $cb_id{$type}) { 312 } elsif (exists $cb_id{$type}) {
266 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; 313 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
267 314
268 } elsif (ref $type) { 315 } elsif (ref $type) {
269 warn "attaching objects not supported, ignoring.\n"; 316 warn "attaching objects not supported, ignoring.\n";
270 317
271 } else { 318 } else {
272 shift @arg; 319 shift @arg;
273 warn "attach argument '$type' not supported, ignoring.\n"; 320 warn "attach argument '$type' not supported, ignoring.\n";
274 } 321 }
275 } 322 }
276
277 \%undo
278} 323}
279 324
280sub _attach_attachment { 325sub _object_attach {
281 my ($obj, $name, %arg) = @_; 326 my ($obj, $name, %arg) = @_;
282 327
283 return if exists $obj->{_attachment}{$name}; 328 return if exists $obj->{_attachment}{$name};
284
285 my $res;
286 329
287 if (my $attach = $attachment{$name}) { 330 if (my $attach = $attachment{$name}) {
288 my $registry = $obj->registry; 331 my $registry = $obj->registry;
289 332
290 for (@$attach) { 333 for (@$attach) {
291 my ($klass, @attach) = @$_; 334 my ($klass, @attach) = @$_;
292 $res = _attach @$registry, $klass, @attach; 335 _attach $registry, $klass, @attach;
293 } 336 }
294 337
295 $obj->{$name} = \%arg; 338 $obj->{$name} = \%arg;
296 } else { 339 } else {
297 warn "object uses attachment '$name' that is not available, postponing.\n"; 340 warn "object uses attachment '$name' that is not available, postponing.\n";
298 } 341 }
299 342
300 $obj->{_attachment}{$name} = undef; 343 $obj->{_attachment}{$name} = undef;
301
302 $res->{attachment} = $name;
303 $res
304} 344}
305 345
306*cf::object::attach = 346sub cf::attachable::attach {
307*cf::player::attach = 347 if (ref $_[0]) {
308*cf::map::attach = sub { 348 _object_attach @_;
309 my ($obj, $name, %arg) = @_; 349 } else {
310 350 _attach shift->_attach_registry, @_;
311 _attach_attachment $obj, $name, %arg; 351 }
312}; 352};
313 353
314# all those should be optimised 354# all those should be optimised
315*cf::object::detach = 355sub cf::attachable::detach {
316*cf::player::detach =
317*cf::map::detach = sub {
318 my ($obj, $name) = @_; 356 my ($obj, $name) = @_;
319 357
358 if (ref $obj) {
320 delete $obj->{_attachment}{$name}; 359 delete $obj->{_attachment}{$name};
321 reattach ($obj); 360 reattach ($obj);
361 } else {
362 Carp::croak "cannot, currently, detach class attachments";
363 }
322}; 364};
323 365
324*cf::object::attached = 366sub cf::attachable::attached {
325*cf::player::attached =
326*cf::map::attached = sub {
327 my ($obj, $name) = @_; 367 my ($obj, $name) = @_;
328 368
329 exists $obj->{_attachment}{$name} 369 exists $obj->{_attachment}{$name}
330};
331
332sub attach_global {
333 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
334} 370}
335 371
336sub attach_to_type { 372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
337 my $type = shift; 373 eval "#line " . __LINE__ . " 'cf.pm'
338 my $subtype = shift; 374 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass)
376 }
339 377
340 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ 378 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; 379 my \$name = shift;
357 380
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, @_]]; 381 \$attachment{\$name} = [[KLASS_$klass, \@_]];
382 }
383 ";
384 die if $@;
371} 385}
372 386
373our $override; 387our $override;
374our @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?
375 389
389 for (@$callbacks) { 403 for (@$callbacks) {
390 eval { &{$_->[1]} }; 404 eval { &{$_->[1]} };
391 405
392 if ($@) { 406 if ($@) {
393 warn "$@"; 407 warn "$@";
394 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 408 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
395 override; 409 override;
396 } 410 }
397 411
398 return 1 if $override; 412 return 1 if $override;
399 } 413 }
404=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
405 419
406=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) 420=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407 421
408=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) 422=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
409 425
410=item $bool = $map->invoke (EVENT_MAP_XXX, ...) 426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411 427
412Generate a global/object/player/map-specific event with the given arguments. 428Generate a global/object/player/map-specific event with the given arguments.
413 429
415removed 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
416results (if you must, access C<@cf::invoke_results> directly). 432results (if you must, access C<@cf::invoke_results> directly).
417 433
418=back 434=back
419 435
420=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.
421 443
422=over 4 444=over 4
423 445
424=item $object->valid 446=item $object->valid
425
426=item $player->valid
427
428=item $map->valid
429 447
430Just 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
431C-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
432valid C counterpart anymore you get an exception at runtime. This method 450valid 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 451can be used to test for existence of the C object part without causing an
435 453
436=back 454=back
437 455
438=cut 456=cut
439 457
440*cf::object::valid =
441*cf::player::valid =
442*cf::map::valid = \&cf::_valid;
443
444############################################################################# 458#############################################################################
445# object support 459# object support
446 460
447sub instantiate { 461sub instantiate {
448 my ($obj, $data) = @_; 462 my ($obj, $data) = @_;
467 481
468 for my $name (keys %{ $obj->{_attachment} || {} }) { 482 for my $name (keys %{ $obj->{_attachment} || {} }) {
469 if (my $attach = $attachment{$name}) { 483 if (my $attach = $attachment{$name}) {
470 for (@$attach) { 484 for (@$attach) {
471 my ($klass, @attach) = @$_; 485 my ($klass, @attach) = @$_;
472 _attach @$registry, $klass, @attach; 486 _attach $registry, $klass, @attach;
473 } 487 }
474 } else { 488 } else {
475 warn "object uses attachment '$name' that is not available, postponing.\n"; 489 warn "object uses attachment '$name' that is not available, postponing.\n";
476 } 490 }
477 } 491 }
506 unlink $filename; 520 unlink $filename;
507 unlink "$filename.pst"; 521 unlink "$filename.pst";
508 } 522 }
509} 523}
510 524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
531}
532
511sub object_thawer_load { 533sub object_thawer_load {
512 my ($filename) = @_; 534 my ($filename) = @_;
513 535
536 local $/;
537
538 my $av;
539
540 #TODO: use sysread etc.
541 if (open my $data, "<:raw:perlio", $filename) {
542 $data = <$data>;
514 open my $fh, "<:raw:perlio", "$filename.pst" 543 if (open my $pst, "<:raw:perlio", "$filename.pst") {
515 or return; 544 $av = eval { (Storable::thaw <$pst>)->{objs} };
545 }
546 return ($data, $av);
547 }
516 548
517 eval { local $/; (Storable::thaw <$fh>)->{objs} } 549 ()
518} 550}
519 551
520attach_to_objects 552cf::object->attach (
521 prio => -1000000, 553 prio => -1000000,
522 on_clone => sub { 554 on_clone => sub {
523 my ($src, $dst) = @_; 555 my ($src, $dst) = @_;
524 556
525 @{$dst->registry} = @{$src->registry}; 557 @{$dst->registry} = @{$src->registry};
527 %$dst = %$src; 559 %$dst = %$src;
528 560
529 %{$dst->{_attachment}} = %{$src->{_attachment}} 561 %{$dst->{_attachment}} = %{$src->{_attachment}}
530 if exists $src->{_attachment}; 562 if exists $src->{_attachment};
531 }, 563 },
532; 564);
533 565
534############################################################################# 566#############################################################################
535# old plug-in events 567# command handling &c
536 568
537sub inject_event { 569=item cf::register_command $name => \&callback($ob,$args);
538 my $extension = shift;
539 my $event_code = shift;
540 570
541 my $cb = $hook[$event_code]{$extension} 571Register a callback for execution when the client sends the user command
542 or return; 572$name.
543 573
544 &$cb 574=cut
545}
546
547sub inject_global_event {
548 my $event = shift;
549
550 my $cb = $hook[$event]
551 or return;
552
553 List::Util::max map &$_, values %$cb
554}
555
556sub inject_command {
557 my ($name, $obj, $params) = @_;
558
559 for my $cmd (@{ $command{$name} }) {
560 $cmd->[1]->($obj, $params);
561 }
562
563 -1
564}
565 575
566sub register_command { 576sub register_command {
567 my ($name, $time, $cb) = @_; 577 my ($name, $cb) = @_;
568 578
569 my $caller = caller; 579 my $caller = caller;
570 #warn "registering command '$name/$time' to '$caller'"; 580 #warn "registering command '$name/$time' to '$caller'";
571 581
572 push @{ $command{$name} }, [$time, $cb, $caller]; 582 push @{ $COMMAND{$name} }, [$caller, $cb];
573 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
574} 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
575 593
576sub register_extcmd { 594sub register_extcmd {
577 my ($name, $cb) = @_; 595 my ($name, $cb) = @_;
578 596
579 my $caller = caller; 597 my $caller = caller;
580 #warn "registering extcmd '$name' to '$caller'"; 598 #warn "registering extcmd '$name' to '$caller'";
581 599
582 $extcmd{$name} = [$cb, $caller]; 600 $EXTCMD{$name} = [$cb, $caller];
583} 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);
584 634
585sub register { 635sub register {
586 my ($base, $pkg) = @_; 636 my ($base, $pkg) = @_;
587 637
588 #TODO 638 #TODO
607 . "#line 1 \"$path\"\n{\n" 657 . "#line 1 \"$path\"\n{\n"
608 . (do { local $/; <$fh> }) 658 . (do { local $/; <$fh> })
609 . "\n};\n1"; 659 . "\n};\n1";
610 660
611 eval $source 661 eval $source
612 or die "$path: $@"; 662 or die $@ ? "$path: $@\n"
663 : "extension disabled.\n";
613 664
614 push @exts, $pkg; 665 push @exts, $pkg;
615 $ext_pkg{$base} = $pkg; 666 $ext_pkg{$base} = $pkg;
616 667
617# no strict 'refs'; 668# no strict 'refs';
630# for my $idx (0 .. $#PLUGIN_EVENT) { 681# for my $idx (0 .. $#PLUGIN_EVENT) {
631# delete $hook[$idx]{$pkg}; 682# delete $hook[$idx]{$pkg};
632# } 683# }
633 684
634 # remove commands 685 # remove commands
635 for my $name (keys %command) { 686 for my $name (keys %COMMAND) {
636 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
637 688
638 if (@cb) { 689 if (@cb) {
639 $command{$name} = \@cb; 690 $COMMAND{$name} = \@cb;
640 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
641 } else { 691 } else {
642 delete $command{$name};
643 delete $COMMAND{"$name\000"}; 692 delete $COMMAND{$name};
644 } 693 }
645 } 694 }
646 695
647 # remove extcmds 696 # remove extcmds
648 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
649 delete $extcmd{$name}; 698 delete $EXTCMD{$name};
650 } 699 }
651 700
652 if (my $cb = $pkg->can ("unload")) { 701 if (my $cb = $pkg->can ("unload")) {
653 eval { 702 eval {
654 $cb->($pkg); 703 $cb->($pkg);
658 707
659 Symbol::delete_package $pkg; 708 Symbol::delete_package $pkg;
660} 709}
661 710
662sub load_extensions { 711sub load_extensions {
663 my $LIBDIR = maps_directory "perl";
664
665 for my $ext (<$LIBDIR/*.ext>) { 712 for my $ext (<$LIBDIR/*.ext>) {
666 next unless -r $ext; 713 next unless -r $ext;
667 eval { 714 eval {
668 load_extension $ext; 715 load_extension $ext;
669 1 716 1
670 } or warn "$ext not loaded: $@"; 717 } or warn "$ext not loaded: $@";
671 } 718 }
672} 719}
673 720
674sub _perl_reload(&) {
675 my ($msg) = @_;
676
677 $msg->("reloading...");
678
679 eval {
680 # 1. cancel all watchers
681 $_->cancel for Event::all_watchers;
682
683 # 2. unload all extensions
684 for (@exts) {
685 $msg->("unloading <$_>");
686 unload_extension $_;
687 }
688
689 # 3. unload all modules loaded from $LIBDIR
690 while (my ($k, $v) = each %INC) {
691 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
692
693 $msg->("removing <$k>");
694 delete $INC{$k};
695
696 $k =~ s/\.pm$//;
697 $k =~ s/\//::/g;
698
699 if (my $cb = $k->can ("unload_module")) {
700 $cb->();
701 }
702
703 Symbol::delete_package $k;
704 }
705
706 # 4. get rid of safe::, as good as possible
707 Symbol::delete_package "safe::$_"
708 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
709
710 # 5. remove register_script_function callbacks
711 # TODO
712
713 # 6. unload cf.pm "a bit"
714 delete $INC{"cf.pm"};
715
716 # don't, removes xs symbols, too,
717 # and global variables created in xs
718 #Symbol::delete_package __PACKAGE__;
719
720 # 7. reload cf.pm
721 $msg->("reloading cf.pm");
722 require cf;
723 };
724 $msg->($@) if $@;
725
726 $msg->("reloaded");
727};
728
729sub perl_reload() {
730 _perl_reload {
731 warn $_[0];
732 print "$_[0]\n";
733 };
734}
735
736register_command "perl-reload", 0, sub {
737 my ($who, $arg) = @_;
738
739 if ($who->flag (FLAG_WIZ)) {
740 _perl_reload {
741 warn $_[0];
742 $who->message ($_[0]);
743 };
744 }
745};
746
747#############################################################################
748# extcmd framework, basically convert ext <msg>
749# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
750
751attach_to_players
752 on_extcmd => sub {
753 my ($pl, $buf) = @_;
754
755 my $msg = eval { from_json $buf };
756
757 if (ref $msg) {
758 if (my $cb = $extcmd{$msg->{msgtype}}) {
759 if (my %reply = $cb->[0]->($pl, $msg)) {
760 $pl->ext_reply ($msg->{msgid}, %reply);
761 }
762 }
763 } else {
764 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
765 }
766
767 cf::override;
768 },
769;
770
771############################################################################# 721#############################################################################
772# load/save/clean perl data associated with a map 722# load/save/clean perl data associated with a map
773 723
774*cf::mapsupport::on_clean = sub { 724*cf::mapsupport::on_clean = sub {
775 my ($map) = @_; 725 my ($map) = @_;
778 defined $path or return; 728 defined $path or return;
779 729
780 unlink "$path.pst"; 730 unlink "$path.pst";
781}; 731};
782 732
783attach_to_maps prio => -10000, package => cf::mapsupport::; 733cf::map->attach (prio => -10000, package => cf::mapsupport::);
784 734
785############################################################################# 735#############################################################################
786# load/save perl data associated with player->ob objects 736# load/save perl data associated with player->ob objects
787 737
788sub all_objects(@) { 738sub all_objects(@) {
789 @_, map all_objects ($_->inv), @_ 739 @_, map all_objects ($_->inv), @_
790} 740}
791 741
792# TODO: compatibility cruft, remove when no longer needed 742# TODO: compatibility cruft, remove when no longer needed
793attach_to_players 743cf::player->attach (
794 on_load => sub { 744 on_load => sub {
795 my ($pl, $path) = @_; 745 my ($pl, $path) = @_;
796 746
797 for my $o (all_objects $pl->ob) { 747 for my $o (all_objects $pl->ob) {
798 if (my $value = $o->get_ob_key_value ("_perl_data")) { 748 if (my $value = $o->get_ob_key_value ("_perl_data")) {
800 750
801 %$o = %{ Storable::thaw pack "H*", $value }; 751 %$o = %{ Storable::thaw pack "H*", $value };
802 } 752 }
803 } 753 }
804 }, 754 },
805; 755);
806 756
807############################################################################# 757#############################################################################
808# core extensions - in perl 758
759=head2 CORE EXTENSIONS
760
761Functions and methods that extend core crossfire objects.
762
763=over 4
809 764
810=item cf::player::exists $login 765=item cf::player::exists $login
811 766
812Returns true when the given account exists. 767Returns true when the given account exists.
813 768
816sub cf::player::exists($) { 771sub cf::player::exists($) {
817 cf::player::find $_[0] 772 cf::player::find $_[0]
818 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 773 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
819} 774}
820 775
821=item $player->reply ($npc, $msg[, $flags]) 776=item $player_object->reply ($npc, $msg[, $flags])
822 777
823Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 778Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
824can be C<undef>. Does the right thing when the player is currently in a 779can be C<undef>. Does the right thing when the player is currently in a
825dialogue with the given NPC character. 780dialogue with the given NPC character.
826 781
853 $msg{msgid} = $id; 808 $msg{msgid} = $id;
854 809
855 $self->send ("ext " . to_json \%msg); 810 $self->send ("ext " . to_json \%msg);
856} 811}
857 812
813=item $player_object->may ("access")
814
815Returns wether the given player is authorized to access resource "access"
816(e.g. "command_wizcast").
817
818=cut
819
820sub cf::object::player::may {
821 my ($self, $access) = @_;
822
823 $self->flag (cf::FLAG_WIZ) ||
824 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"})
827}
828
829=cut
830
858############################################################################# 831#############################################################################
859# map scripting support 832
833=head2 SAFE SCRIPTING
834
835Functions that provide a safe environment to compile and execute
836snippets of perl code without them endangering the safety of the server
837itself. Looping constructs, I/O operators and other built-in functionality
838is not available in the safe scripting environment, and the number of
839functions and methods that can be called is greatly reduced.
840
841=cut
860 842
861our $safe = new Safe "safe"; 843our $safe = new Safe "safe";
862our $safe_hole = new Safe::Hole; 844our $safe_hole = new Safe::Hole;
863 845
864$SIG{FPE} = 'IGNORE'; 846$SIG{FPE} = 'IGNORE';
865 847
866$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 848$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
867 849
868# here we export the classes and methods available to script code 850# here we export the classes and methods available to script code
869 851
852=pod
853
854The following fucntions and emthods are available within a safe environment:
855
856 cf::object contr pay_amount pay_player map
857 cf::object::player player
858 cf::player peaceful
859 cf::map trigger
860
861=cut
862
870for ( 863for (
871 ["cf::object" => qw(contr pay_amount pay_player)], 864 ["cf::object" => qw(contr pay_amount pay_player map)],
872 ["cf::object::player" => qw(player)], 865 ["cf::object::player" => qw(player)],
873 ["cf::player" => qw(peaceful)], 866 ["cf::player" => qw(peaceful)],
867 ["cf::map" => qw(trigger)],
874) { 868) {
875 no strict 'refs'; 869 no strict 'refs';
876 my ($pkg, @funs) = @$_; 870 my ($pkg, @funs) = @$_;
877 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 871 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
878 for @funs; 872 for @funs;
879} 873}
874
875=over 4
876
877=item @retval = safe_eval $code, [var => value, ...]
878
879Compiled and executes the given perl code snippet. additional var/value
880pairs result in temporary local (my) scalar variables of the given name
881that are available in the code snippet. Example:
882
883 my $five = safe_eval '$first + $second', first => 1, second => 4;
884
885=cut
880 886
881sub safe_eval($;@) { 887sub safe_eval($;@) {
882 my ($code, %vars) = @_; 888 my ($code, %vars) = @_;
883 889
884 my $qcode = $code; 890 my $qcode = $code;
907 } 913 }
908 914
909 wantarray ? @res : $res[0] 915 wantarray ? @res : $res[0]
910} 916}
911 917
918=item cf::register_script_function $function => $cb
919
920Register a function that can be called from within map/npc scripts. The
921function should be reasonably secure and should be put into a package name
922like the extension.
923
924Example: register a function that gets called whenever a map script calls
925C<rent::overview>, as used by the C<rent> extension.
926
927 cf::register_script_function "rent::overview" => sub {
928 ...
929 };
930
931=cut
932
912sub register_script_function { 933sub register_script_function {
913 my ($fun, $cb) = @_; 934 my ($fun, $cb) = @_;
914 935
915 no strict 'refs'; 936 no strict 'refs';
916 *{"safe::$fun"} = $safe_hole->wrap ($cb); 937 *{"safe::$fun"} = $safe_hole->wrap ($cb);
917} 938}
918 939
940=back
941
942=cut
943
944#############################################################################
945
946=head2 EXTENSION DATABASE SUPPORT
947
948Crossfire maintains a very simple database for extension use. It can
949currently store anything that can be serialised using Storable, which
950excludes objects.
951
952The parameter C<$family> should best start with the name of the extension
953using it, it should be unique.
954
955=over 4
956
957=item $hashref = cf::db_get $family
958
959Return a hashref for use by the extension C<$family>, which can be
960modified. After modifications, you have to call C<cf::db_dirty> or
961C<cf::db_sync>.
962
963=item $value = cf::db_get $family => $key
964
965Returns a single value from the database
966
967=item cf::db_put $family => $hashref
968
969Stores the given family hashref into the database. Updates are delayed, if
970you want the data to be synced to disk immediately, use C<cf::db_sync>.
971
972=item cf::db_put $family => $key => $value
973
974Stores the given C<$value> in the family hash. Updates are delayed, if you
975want the data to be synced to disk immediately, use C<cf::db_sync>.
976
977=item cf::db_dirty
978
979Marks the database as dirty, to be updated at a later time.
980
981=item cf::db_sync
982
983Immediately write the database to disk I<if it is dirty>.
984
985=cut
986
987our $DB;
988
989{
990 my $path = cf::localdir . "/database.pst";
991
992 sub db_load() {
993 warn "loading database $path\n";#d# remove later
994 $DB = stat $path ? Storable::retrieve $path : { };
995 }
996
997 my $pid;
998
999 sub db_save() {
1000 warn "saving database $path\n";#d# remove later
1001 waitpid $pid, 0 if $pid;
1002 if (0 == ($pid = fork)) {
1003 $DB->{_meta}{version} = 1;
1004 Storable::nstore $DB, "$path~";
1005 rename "$path~", $path;
1006 cf::_exit 0 if defined $pid;
1007 }
1008 }
1009
1010 my $dirty;
1011
1012 sub db_sync() {
1013 db_save if $dirty;
1014 undef $dirty;
1015 }
1016
1017 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1018 db_sync;
1019 });
1020
1021 sub db_dirty() {
1022 $dirty = 1;
1023 $idle->start;
1024 }
1025
1026 sub db_get($;$) {
1027 @_ >= 2
1028 ? $DB->{$_[0]}{$_[1]}
1029 : ($DB->{$_[0]} ||= { })
1030 }
1031
1032 sub db_put($$;$) {
1033 if (@_ >= 3) {
1034 $DB->{$_[0]}{$_[1]} = $_[2];
1035 } else {
1036 $DB->{$_[0]} = $_[1];
1037 }
1038 db_dirty;
1039 }
1040
1041 cf::global->attach (
1042 prio => 10000,
1043 on_cleanup => sub {
1044 db_sync;
1045 },
1046 );
1047}
1048
919############################################################################# 1049#############################################################################
920# the server's main() 1050# the server's main()
921 1051
1052sub cfg_load {
1053 open my $fh, "<:utf8", cf::confdir . "/config"
1054 or return;
1055
1056 local $/;
1057 *CFG = YAML::Syck::Load <$fh>;
1058}
1059
922sub main { 1060sub main {
1061 cfg_load;
1062 db_load;
1063 load_extensions;
923 Event::loop; 1064 Event::loop;
924} 1065}
925 1066
926############################################################################# 1067#############################################################################
927# initialisation 1068# initialisation
928 1069
1070sub _perl_reload(&) {
1071 my ($msg) = @_;
1072
1073 $msg->("reloading...");
1074
1075 eval {
1076 # cancel all watchers
1077 for (Event::all_watchers) {
1078 $_->cancel if $_->data & WF_AUTOCANCEL;
1079 }
1080
1081 # unload all extensions
1082 for (@exts) {
1083 $msg->("unloading <$_>");
1084 unload_extension $_;
1085 }
1086
1087 # unload all modules loaded from $LIBDIR
1088 while (my ($k, $v) = each %INC) {
1089 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090
1091 $msg->("removing <$k>");
1092 delete $INC{$k};
1093
1094 $k =~ s/\.pm$//;
1095 $k =~ s/\//::/g;
1096
1097 if (my $cb = $k->can ("unload_module")) {
1098 $cb->();
1099 }
1100
1101 Symbol::delete_package $k;
1102 }
1103
1104 # sync database to disk
1105 cf::db_sync;
1106
1107 # get rid of safe::, as good as possible
1108 Symbol::delete_package "safe::$_"
1109 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1110
1111 # remove register_script_function callbacks
1112 # TODO
1113
1114 # unload cf.pm "a bit"
1115 delete $INC{"cf.pm"};
1116
1117 # don't, removes xs symbols, too,
1118 # and global variables created in xs
1119 #Symbol::delete_package __PACKAGE__;
1120
1121 # reload cf.pm
1122 $msg->("reloading cf.pm");
1123 require cf;
1124
1125 # load config and database again
1126 cf::cfg_load;
1127 cf::db_load;
1128
1129 # load extensions
1130 $msg->("load extensions");
1131 cf::load_extensions;
1132
1133 # reattach attachments to objects
1134 $msg->("reattach");
1135 _global_reattach;
1136 };
1137 $msg->($@) if $@;
1138
1139 $msg->("reloaded");
1140};
1141
1142sub perl_reload() {
1143 _perl_reload {
1144 warn $_[0];
1145 print "$_[0]\n";
1146 };
1147}
1148
929register "<global>", __PACKAGE__; 1149register "<global>", __PACKAGE__;
930 1150
1151register_command "perl-reload" => sub {
1152 my ($who, $arg) = @_;
1153
1154 if ($who->flag (FLAG_WIZ)) {
1155 _perl_reload {
1156 warn $_[0];
1157 $who->message ($_[0]);
1158 };
1159 }
1160};
1161
931unshift @INC, $LIBDIR; 1162unshift @INC, $LIBDIR;
932 1163
933load_extensions;
934
935$TICK_WATCHER = Event->timer ( 1164$TICK_WATCHER = Event->timer (
936 prio => 1, 1165 prio => 0,
937 at => $NEXT_TICK || 1, 1166 at => $NEXT_TICK || 1,
1167 data => WF_AUTOCANCEL,
938 cb => sub { 1168 cb => sub {
939 cf::server_tick; # one server iteration 1169 cf::server_tick; # one server iteration
940 1170
941 my $NOW = Event::time; 1171 my $NOW = Event::time;
942 $NEXT_TICK += $TICK; 1172 $NEXT_TICK += $TICK;
943 1173
944 # if we are delayed by four ticks, skip them all 1174 # if we are delayed by four ticks or more, skip them all
945 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1175 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
946 1176
947 $TICK_WATCHER->at ($NEXT_TICK); 1177 $TICK_WATCHER->at ($NEXT_TICK);
948 $TICK_WATCHER->start; 1178 $TICK_WATCHER->start;
949 }, 1179 },
950); 1180);
951 1181
952_reload_2; 1182IO::AIO::max_poll_time $TICK * 0.2;
1183
1184Event->io (fd => IO::AIO::poll_fileno,
1185 poll => 'r',
1186 prio => 5,
1187 data => WF_AUTOCANCEL,
1188 cb => \&IO::AIO::poll_cb);
953 1189
9541 11901
955 1191

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines