ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.273
Committed: Mon Jun 4 12:19:08 2007 UTC (16 years, 11 months ago) by root
Branch: MAIN
Changes since 1.272: +2 -2 lines
Log Message:
rename arch->name to arch->archname for preparation of subclassing object

File Contents

# User Rev Content
1 root 1.1 package cf;
2    
3 root 1.96 use utf8;
4     use strict;
5    
6 root 1.1 use Symbol;
7     use List::Util;
8 root 1.250 use Socket;
9 root 1.6 use Storable;
10 root 1.224 use Event;
11 root 1.23 use Opcode;
12     use Safe;
13     use Safe::Hole;
14 root 1.19
15 root 1.244 use Coro 3.61 ();
16 root 1.224 use Coro::State;
17 root 1.250 use Coro::Handle;
18 root 1.96 use Coro::Event;
19     use Coro::Timer;
20     use Coro::Signal;
21     use Coro::Semaphore;
22 root 1.105 use Coro::AIO;
23 root 1.237 use Coro::Storable;
24 root 1.96
25 root 1.206 use BDB ();
26 root 1.154 use Data::Dumper;
27 root 1.108 use Digest::MD5;
28 root 1.105 use Fcntl;
29 root 1.227 use YAML::Syck ();
30 root 1.145 use IO::AIO 2.32 ();
31 root 1.32 use Time::HiRes;
32 root 1.208 use Compress::LZF;
33    
34 root 1.227 # configure various modules to our taste
35     #
36 root 1.237 $Storable::canonical = 1; # reduce rsync transfers
37 root 1.224 Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38 root 1.208 Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39 root 1.227
40 root 1.224 $Event::Eval = 1; # no idea why this is required, but it is
41 root 1.1
42 root 1.72 # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
43     $YAML::Syck::ImplicitUnicode = 1;
44    
45 root 1.139 $Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
46 root 1.1
47 root 1.227 sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
48    
49 root 1.85 our %COMMAND = ();
50     our %COMMAND_TIME = ();
51 root 1.159
52     our @EXTS = (); # list of extension package names
53 root 1.85 our %EXTCMD = ();
54 root 1.159 our %EXT_CORO = (); # coroutines bound to extensions
55 root 1.161 our %EXT_MAP = (); # pluggable maps
56 root 1.85
57 root 1.223 our $RELOAD; # number of reloads so far
58 root 1.1 our @EVENT;
59 root 1.253
60     our $CONFDIR = confdir;
61     our $DATADIR = datadir;
62     our $LIBDIR = "$DATADIR/ext";
63     our $PODDIR = "$DATADIR/pod";
64     our $MAPDIR = "$DATADIR/" . mapdir;
65     our $LOCALDIR = localdir;
66     our $TMPDIR = "$LOCALDIR/" . tmpdir;
67     our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68     our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69     our $RANDOMDIR = "$LOCALDIR/random";
70     our $BDBDIR = "$LOCALDIR/db";
71 root 1.1
72 root 1.245 our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
73 root 1.35 our $TICK_WATCHER;
74 root 1.168 our $AIO_POLL_WATCHER;
75 root 1.214 our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
76 root 1.35 our $NEXT_TICK;
77 root 1.103 our $NOW;
78 root 1.205 our $USE_FSYNC = 1; # use fsync to write maps - default off
79 root 1.35
80 root 1.206 our $BDB_POLL_WATCHER;
81     our $DB_ENV;
82    
83 root 1.70 our %CFG;
84    
85 root 1.84 our $UPTIME; $UPTIME ||= time;
86 root 1.103 our $RUNTIME;
87    
88 root 1.143 our %PLAYER; # all users
89     our %MAP; # all maps
90 root 1.166 our $LINK_MAP; # the special {link} map, which is always available
91 root 1.103
92 root 1.166 # used to convert map paths into valid unix filenames by replacing / by ∕
93     our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94    
95 root 1.265 our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96     our $LOADAVG; # same thing, but with alpha-smoothing
97     our $tick_start; # for load detecting purposes
98    
99 root 1.103 binmode STDOUT;
100     binmode STDERR;
101    
102     # read virtual server time, if available
103 root 1.253 unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
104     open my $fh, "<", "$LOCALDIR/runtime"
105 root 1.103 or die "unable to read runtime file: $!";
106     $RUNTIME = <$fh> + 0.;
107     }
108    
109 root 1.253 mkdir $_
110     for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
111 root 1.103
112 root 1.131 our $EMERGENCY_POSITION;
113 root 1.110
114 root 1.199 sub cf::map::normalise;
115    
116 root 1.70 #############################################################################
117    
118     =head2 GLOBAL VARIABLES
119    
120     =over 4
121    
122 root 1.83 =item $cf::UPTIME
123    
124     The timestamp of the server start (so not actually an uptime).
125    
126 root 1.103 =item $cf::RUNTIME
127    
128     The time this server has run, starts at 0 and is increased by $cf::TICK on
129     every server tick.
130    
131 root 1.253 =item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132     $cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133     $cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
134    
135     Various directories - "/etc", read-only install directory, perl-library
136     directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137     unique-items directory, player file directory, random maps directory and
138     database environment.
139 root 1.70
140 root 1.103 =item $cf::NOW
141    
142     The time of the last (current) server tick.
143    
144 root 1.70 =item $cf::TICK
145    
146     The interval between server ticks, in seconds.
147    
148 root 1.265 =item $cf::LOADAVG
149    
150     The current CPU load on the server (alpha-smoothed), as a value between 0
151     (none) and 1 (overloaded), indicating how much time is spent on processing
152     objects per tick. Healthy values are < 0.5.
153    
154     =item $cf::LOAD
155    
156     The raw value load value from the last tick.
157    
158 root 1.70 =item %cf::CFG
159    
160     Configuration for the server, loaded from C</etc/crossfire/config>, or
161     from wherever your confdir points to.
162    
163 root 1.239 =item cf::wait_for_tick, cf::wait_for_tick_begin
164 root 1.155
165 root 1.239 These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166     returns directly I<after> the tick processing (and consequently, can only wake one process
167     per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 root 1.155
169 root 1.70 =back
170    
171     =cut
172    
173 root 1.1 BEGIN {
174     *CORE::GLOBAL::warn = sub {
175     my $msg = join "", @_;
176 root 1.103
177 root 1.1 $msg .= "\n"
178     unless $msg =~ /\n$/;
179    
180 root 1.255 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181 root 1.250
182     utf8::encode $msg;
183 root 1.146 LOG llevError, $msg;
184 root 1.1 };
185     }
186    
187 root 1.93 @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188     @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189     @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190     @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191     @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192 root 1.273 @safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
193     @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
194 root 1.25
195 root 1.41 # we bless all objects into (empty) derived classes to force a method lookup
196 root 1.25 # within the Safe compartment.
197 root 1.86 for my $pkg (qw(
198 root 1.100 cf::global cf::attachable
199 root 1.86 cf::object cf::object::player
200 root 1.89 cf::client cf::player
201 root 1.86 cf::arch cf::living
202     cf::map cf::party cf::region
203     )) {
204 root 1.25 no strict 'refs';
205 root 1.41 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
206 root 1.25 }
207 root 1.1
208 root 1.18 $Event::DIED = sub {
209     warn "error in event callback: @_";
210     };
211    
212 root 1.70 =head2 UTILITY FUNCTIONS
213    
214     =over 4
215    
216 root 1.154 =item dumpval $ref
217    
218 root 1.70 =cut
219 root 1.44
220 root 1.154 sub dumpval {
221     eval {
222     local $SIG{__DIE__};
223     my $d;
224     if (1) {
225     $d = new Data::Dumper([$_[0]], ["*var"]);
226     $d->Terse(1);
227     $d->Indent(2);
228     $d->Quotekeys(0);
229     $d->Useqq(1);
230     #$d->Bless(...);
231     $d->Seen($_[1]) if @_ > 1;
232     $d = $d->Dump();
233     }
234     $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235     $d
236     } || "[unable to dump $_[0]: '$@']";
237     }
238    
239 root 1.227 use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240 root 1.44
241 root 1.70 =item $ref = cf::from_json $json
242    
243     Converts a JSON string into the corresponding perl data structure.
244    
245     =item $json = cf::to_json $ref
246    
247     Converts a perl data structure into its JSON representation.
248    
249 root 1.120 =item cf::lock_wait $string
250    
251     Wait until the given lock is available. See cf::lock_acquire.
252    
253     =item my $lock = cf::lock_acquire $string
254    
255     Wait until the given lock is available and then acquires it and returns
256 root 1.135 a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257 root 1.120 for example when the coroutine gets canceled), the lock is automatically
258     returned.
259    
260 root 1.133 Lock names should begin with a unique identifier (for example, cf::map::find
261     uses map_find and cf::map::load uses map_load).
262 root 1.120
263 root 1.253 =item $locked = cf::lock_active $string
264    
265     Return true if the lock is currently active, i.e. somebody has locked it.
266    
267 root 1.120 =cut
268    
269     our %LOCK;
270    
271     sub lock_wait($) {
272     my ($key) = @_;
273    
274     # wait for lock, if any
275     while ($LOCK{$key}) {
276     push @{ $LOCK{$key} }, $Coro::current;
277     Coro::schedule;
278     }
279     }
280    
281     sub lock_acquire($) {
282     my ($key) = @_;
283    
284     # wait, to be sure we are not locked
285     lock_wait $key;
286    
287     $LOCK{$key} = [];
288    
289 root 1.135 Coro::guard {
290 root 1.120 # wake up all waiters, to be on the safe side
291     $_->ready for @{ delete $LOCK{$key} };
292     }
293     }
294    
295 root 1.253 sub lock_active($) {
296     my ($key) = @_;
297    
298     ! ! $LOCK{$key}
299     }
300    
301 root 1.133 sub freeze_mainloop {
302     return unless $TICK_WATCHER->is_active;
303    
304 root 1.168 my $guard = Coro::guard {
305     $TICK_WATCHER->start;
306     };
307 root 1.133 $TICK_WATCHER->stop;
308     $guard
309     }
310    
311 root 1.140 =item cf::async { BLOCK }
312    
313     Currently the same as Coro::async_pool, meaning you cannot use
314     C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315     thing you are allowed to do is call C<prio> on it.
316    
317     =cut
318    
319     BEGIN { *async = \&Coro::async_pool }
320    
321 root 1.106 =item cf::sync_job { BLOCK }
322    
323     The design of crossfire+ requires that the main coro ($Coro::main) is
324     always able to handle events or runnable, as crossfire+ is only partly
325     reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
326    
327     If it must be done, put the blocking parts into C<sync_job>. This will run
328     the given BLOCK in another coroutine while waiting for the result. The
329     server will be frozen during this time, so the block should either finish
330     fast or be very important.
331    
332     =cut
333    
334 root 1.105 sub sync_job(&) {
335     my ($job) = @_;
336    
337     if ($Coro::current == $Coro::main) {
338 root 1.265 my $time = Event::time;
339    
340 root 1.112 # this is the main coro, too bad, we have to block
341     # till the operation succeeds, freezing the server :/
342    
343 root 1.110 # TODO: use suspend/resume instead
344 root 1.112 # (but this is cancel-safe)
345 root 1.133 my $freeze_guard = freeze_mainloop;
346 root 1.112
347     my $busy = 1;
348     my @res;
349    
350 root 1.140 (async {
351 root 1.112 @res = eval { $job->() };
352     warn $@ if $@;
353     undef $busy;
354     })->prio (Coro::PRIO_MAX);
355    
356 root 1.105 while ($busy) {
357 root 1.141 Coro::cede or Event::one_event;
358 root 1.105 }
359 root 1.112
360 root 1.265 $time = Event::time - $time;
361    
362 root 1.266 LOG llevError | logBacktrace, Carp::longmess "long sync job"
363     if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
364 root 1.265
365     $tick_start += $time; # do not account sync jobs to server load
366    
367 root 1.112 wantarray ? @res : $res[0]
368 root 1.105 } else {
369 root 1.112 # we are in another coroutine, how wonderful, everything just works
370    
371     $job->()
372 root 1.105 }
373     }
374    
375 root 1.140 =item $coro = cf::async_ext { BLOCK }
376 root 1.103
377 root 1.159 Like async, but this coro is automatically being canceled when the
378 root 1.140 extension calling this is being unloaded.
379 root 1.103
380     =cut
381    
382 root 1.140 sub async_ext(&) {
383 root 1.103 my $cb = shift;
384    
385 root 1.140 my $coro = &Coro::async ($cb);
386 root 1.103
387     $coro->on_destroy (sub {
388     delete $EXT_CORO{$coro+0};
389     });
390     $EXT_CORO{$coro+0} = $coro;
391    
392     $coro
393     }
394    
395 root 1.108 sub write_runtime {
396 root 1.264 my $runtime = "$LOCALDIR/runtime";
397    
398     # first touch the runtime file to show we are still running:
399     # the fsync below can take a very very long time.
400    
401 root 1.271 IO::AIO::aio_utime $runtime, undef, undef;
402 root 1.264
403 root 1.219 my $guard = cf::lock_acquire "write_runtime";
404    
405 root 1.108 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
406     or return;
407    
408 root 1.186 my $value = $cf::RUNTIME + 90 + 10;
409     # 10 is the runtime save interval, for a monotonic clock
410     # 60 allows for the watchdog to kill the server.
411    
412 root 1.108 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413     and return;
414    
415 root 1.204 # always fsync - this file is important
416 root 1.108 aio_fsync $fh
417     and return;
418    
419 root 1.264 # touch it again to show we are up-to-date
420 root 1.271 aio_utime $fh, undef, undef;
421 root 1.264
422 root 1.108 close $fh
423     or return;
424    
425     aio_rename "$runtime~", $runtime
426     and return;
427    
428 root 1.265 warn "runtime file written.\n";#d#
429 root 1.263
430 root 1.108 1
431     }
432    
433 root 1.230 =item cf::datalog type => key => value, ...
434    
435     Log a datalog packet of the given type with the given key-value pairs.
436    
437     =cut
438    
439     sub datalog($@) {
440     my ($type, %kv) = @_;
441     warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
442     }
443    
444 root 1.70 =back
445    
446 root 1.71 =cut
447    
448 root 1.44 #############################################################################
449 root 1.39
450 root 1.93 =head2 ATTACHABLE OBJECTS
451    
452 root 1.94 Many objects in crossfire are so-called attachable objects. That means you can
453     attach callbacks/event handlers (a collection of which is called an "attachment")
454     to it. All such attachable objects support the following methods.
455    
456     In the following description, CLASS can be any of C<global>, C<object>
457     C<player>, C<client> or C<map> (i.e. the attachable objects in
458     crossfire+).
459 root 1.55
460     =over 4
461    
462 root 1.94 =item $attachable->attach ($attachment, key => $value...)
463    
464     =item $attachable->detach ($attachment)
465    
466     Attach/detach a pre-registered attachment to a specific object and give it
467     the specified key/value pairs as arguments.
468    
469     Example, attach a minesweeper attachment to the given object, making it a
470     10x10 minesweeper game:
471 root 1.46
472 root 1.94 $obj->attach (minesweeper => width => 10, height => 10);
473 root 1.53
474 root 1.93 =item $bool = $attachable->attached ($name)
475 root 1.46
476 root 1.93 Checks wether the named attachment is currently attached to the object.
477 root 1.46
478 root 1.94 =item cf::CLASS->attach ...
479 root 1.46
480 root 1.94 =item cf::CLASS->detach ...
481 root 1.92
482 root 1.94 Define an anonymous attachment and attach it to all objects of the given
483     CLASS. See the next function for an explanation of its arguments.
484 root 1.92
485 root 1.93 You can attach to global events by using the C<cf::global> class.
486 root 1.92
487 root 1.94 Example, log all player logins:
488    
489     cf::player->attach (
490     on_login => sub {
491     my ($pl) = @_;
492     ...
493     },
494     );
495    
496     Example, attach to the jeweler skill:
497    
498     cf::object->attach (
499     type => cf::SKILL,
500     subtype => cf::SK_JEWELER,
501     on_use_skill => sub {
502     my ($sk, $ob, $part, $dir, $msg) = @_;
503     ...
504     },
505     );
506    
507     =item cf::CLASS::attachment $name, ...
508    
509     Register an attachment by C<$name> through which attachable objects of the
510     given CLASS can refer to this attachment.
511    
512     Some classes such as crossfire maps and objects can specify attachments
513     that are attached at load/instantiate time, thus the need for a name.
514    
515     These calls expect any number of the following handler/hook descriptions:
516 root 1.46
517     =over 4
518    
519     =item prio => $number
520    
521     Set the priority for all following handlers/hooks (unless overwritten
522     by another C<prio> setting). Lower priority handlers get executed
523     earlier. The default priority is C<0>, and many built-in handlers are
524     registered at priority C<-1000>, so lower priorities should not be used
525     unless you know what you are doing.
526    
527 root 1.93 =item type => $type
528    
529     (Only for C<< cf::object->attach >> calls), limits the attachment to the
530     given type of objects only (the additional parameter C<subtype> can be
531     used to further limit to the given subtype).
532    
533 root 1.46 =item on_I<event> => \&cb
534    
535     Call the given code reference whenever the named event happens (event is
536     something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
537     handlers are recognised generally depends on the type of object these
538     handlers attach to).
539    
540     See F<include/eventinc.h> for the full list of events supported, and their
541     class.
542    
543     =item package => package::
544    
545     Look for sub functions of the name C<< on_I<event> >> in the given
546     package and register them. Only handlers for eevents supported by the
547     object/class are recognised.
548    
549     =back
550    
551 root 1.94 Example, define an attachment called "sockpuppet" that calls the given
552     event handler when a monster attacks:
553    
554     cf::object::attachment sockpuppet =>
555     on_skill_attack => sub {
556     my ($self, $victim) = @_;
557     ...
558     }
559     }
560    
561 root 1.96 =item $attachable->valid
562    
563     Just because you have a perl object does not mean that the corresponding
564     C-level object still exists. If you try to access an object that has no
565     valid C counterpart anymore you get an exception at runtime. This method
566     can be used to test for existence of the C object part without causing an
567     exception.
568    
569 root 1.39 =cut
570    
571 root 1.40 # the following variables are defined in .xs and must not be re-created
572 root 1.100 our @CB_GLOBAL = (); # registry for all global events
573     our @CB_ATTACHABLE = (); # registry for all attachables
574     our @CB_OBJECT = (); # all objects (should not be used except in emergency)
575     our @CB_PLAYER = ();
576     our @CB_CLIENT = ();
577     our @CB_TYPE = (); # registry for type (cf-object class) based events
578     our @CB_MAP = ();
579 root 1.39
580 root 1.45 my %attachment;
581    
582 root 1.170 sub cf::attachable::thawer_merge {
583     # simply override everything except _meta
584     local $_[0]{_meta};
585     %{$_[0]} = %{$_[1]};
586     }
587    
588 root 1.93 sub _attach_cb($$$$) {
589     my ($registry, $event, $prio, $cb) = @_;
590 root 1.39
591     use sort 'stable';
592    
593     $cb = [$prio, $cb];
594    
595     @{$registry->[$event]} = sort
596     { $a->[0] cmp $b->[0] }
597     @{$registry->[$event] || []}, $cb;
598     }
599    
600 root 1.100 # hack
601     my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
602    
603 root 1.39 # attach handles attaching event callbacks
604     # the only thing the caller has to do is pass the correct
605     # registry (== where the callback attaches to).
606 root 1.93 sub _attach {
607 root 1.45 my ($registry, $klass, @arg) = @_;
608 root 1.39
609 root 1.93 my $object_type;
610 root 1.39 my $prio = 0;
611     my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
612    
613 root 1.100 #TODO: get rid of this hack
614     if ($attachable_klass{$klass}) {
615     %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
616     }
617    
618 root 1.45 while (@arg) {
619     my $type = shift @arg;
620 root 1.39
621     if ($type eq "prio") {
622 root 1.45 $prio = shift @arg;
623 root 1.39
624 root 1.93 } elsif ($type eq "type") {
625     $object_type = shift @arg;
626     $registry = $CB_TYPE[$object_type] ||= [];
627    
628     } elsif ($type eq "subtype") {
629     defined $object_type or Carp::croak "subtype specified without type";
630     my $object_subtype = shift @arg;
631 root 1.267 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
632 root 1.93
633 root 1.39 } elsif ($type eq "package") {
634 root 1.45 my $pkg = shift @arg;
635 root 1.39
636     while (my ($name, $id) = each %cb_id) {
637     if (my $cb = $pkg->can ($name)) {
638 root 1.93 _attach_cb $registry, $id, $prio, $cb;
639 root 1.39 }
640     }
641    
642     } elsif (exists $cb_id{$type}) {
643 root 1.93 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
644 root 1.39
645     } elsif (ref $type) {
646     warn "attaching objects not supported, ignoring.\n";
647    
648     } else {
649 root 1.45 shift @arg;
650 root 1.39 warn "attach argument '$type' not supported, ignoring.\n";
651     }
652     }
653     }
654    
655 root 1.93 sub _object_attach {
656 root 1.48 my ($obj, $name, %arg) = @_;
657 root 1.46
658 root 1.55 return if exists $obj->{_attachment}{$name};
659    
660 root 1.46 if (my $attach = $attachment{$name}) {
661     my $registry = $obj->registry;
662    
663 root 1.47 for (@$attach) {
664     my ($klass, @attach) = @$_;
665 root 1.93 _attach $registry, $klass, @attach;
666 root 1.47 }
667 root 1.46
668 root 1.48 $obj->{$name} = \%arg;
669 root 1.46 } else {
670     warn "object uses attachment '$name' that is not available, postponing.\n";
671     }
672    
673 root 1.50 $obj->{_attachment}{$name} = undef;
674 root 1.46 }
675    
676 root 1.93 sub cf::attachable::attach {
677     if (ref $_[0]) {
678     _object_attach @_;
679     } else {
680     _attach shift->_attach_registry, @_;
681     }
682 root 1.267 _recalc_want;
683 root 1.55 };
684 root 1.46
685 root 1.54 # all those should be optimised
686 root 1.93 sub cf::attachable::detach {
687 root 1.54 my ($obj, $name) = @_;
688 root 1.46
689 root 1.93 if (ref $obj) {
690     delete $obj->{_attachment}{$name};
691     reattach ($obj);
692     } else {
693     Carp::croak "cannot, currently, detach class attachments";
694     }
695 root 1.267 _recalc_want;
696 root 1.55 };
697    
698 root 1.93 sub cf::attachable::attached {
699 root 1.55 my ($obj, $name) = @_;
700    
701     exists $obj->{_attachment}{$name}
702 root 1.39 }
703    
704 root 1.100 for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
705 root 1.93 eval "#line " . __LINE__ . " 'cf.pm'
706     sub cf::\L$klass\E::_attach_registry {
707     (\\\@CB_$klass, KLASS_$klass)
708     }
709 root 1.45
710 root 1.93 sub cf::\L$klass\E::attachment {
711     my \$name = shift;
712 root 1.39
713 root 1.93 \$attachment{\$name} = [[KLASS_$klass, \@_]];
714     }
715     ";
716     die if $@;
717 root 1.52 }
718    
719 root 1.39 our $override;
720 root 1.45 our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 root 1.39
722 root 1.45 sub override {
723     $override = 1;
724     @invoke_results = ();
725 root 1.39 }
726    
727 root 1.45 sub do_invoke {
728 root 1.39 my $event = shift;
729 root 1.40 my $callbacks = shift;
730 root 1.39
731 root 1.45 @invoke_results = ();
732    
733 root 1.39 local $override;
734    
735 root 1.40 for (@$callbacks) {
736 root 1.39 eval { &{$_->[1]} };
737    
738     if ($@) {
739     warn "$@";
740 root 1.64 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
741 root 1.39 override;
742     }
743    
744     return 1 if $override;
745     }
746    
747     0
748     }
749    
750 root 1.96 =item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
751 root 1.55
752 root 1.96 =item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
753 root 1.55
754 root 1.96 Generate an object-specific event with the given arguments.
755 root 1.55
756 root 1.96 This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757 root 1.55 removed in future versions), and there is no public API to access override
758     results (if you must, access C<@cf::invoke_results> directly).
759    
760     =back
761    
762 root 1.71 =cut
763    
764 root 1.70 #############################################################################
765 root 1.45 # object support
766    
767 root 1.102 sub reattach {
768     # basically do the same as instantiate, without calling instantiate
769     my ($obj) = @_;
770    
771 root 1.169 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
772    
773 root 1.102 my $registry = $obj->registry;
774    
775     @$registry = ();
776    
777     delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
778    
779     for my $name (keys %{ $obj->{_attachment} || {} }) {
780     if (my $attach = $attachment{$name}) {
781     for (@$attach) {
782     my ($klass, @attach) = @$_;
783     _attach $registry, $klass, @attach;
784     }
785     } else {
786     warn "object uses attachment '$name' that is not available, postponing.\n";
787     }
788     }
789     }
790    
791 root 1.100 cf::attachable->attach (
792     prio => -1000000,
793     on_instantiate => sub {
794     my ($obj, $data) = @_;
795 root 1.45
796 root 1.100 $data = from_json $data;
797 root 1.45
798 root 1.100 for (@$data) {
799     my ($name, $args) = @$_;
800 root 1.49
801 root 1.100 $obj->attach ($name, %{$args || {} });
802     }
803     },
804 root 1.102 on_reattach => \&reattach,
805 root 1.100 on_clone => sub {
806     my ($src, $dst) = @_;
807    
808     @{$dst->registry} = @{$src->registry};
809    
810     %$dst = %$src;
811    
812     %{$dst->{_attachment}} = %{$src->{_attachment}}
813     if exists $src->{_attachment};
814     },
815     );
816 root 1.45
817 root 1.46 sub object_freezer_save {
818 root 1.59 my ($filename, $rdata, $objs) = @_;
819 root 1.46
820 root 1.105 sync_job {
821     if (length $$rdata) {
822     warn sprintf "saving %s (%d,%d)\n",
823     $filename, length $$rdata, scalar @$objs;
824 root 1.60
825 root 1.105 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826 root 1.60 chmod SAVE_MODE, $fh;
827 root 1.105 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828 root 1.204 aio_fsync $fh if $cf::USE_FSYNC;
829 root 1.60 close $fh;
830 root 1.105
831     if (@$objs) {
832     if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
833     chmod SAVE_MODE, $fh;
834     my $data = Storable::nfreeze { version => 1, objs => $objs };
835     aio_write $fh, 0, (length $data), $data, 0;
836 root 1.204 aio_fsync $fh if $cf::USE_FSYNC;
837 root 1.105 close $fh;
838     aio_rename "$filename.pst~", "$filename.pst";
839     }
840     } else {
841     aio_unlink "$filename.pst";
842     }
843    
844     aio_rename "$filename~", $filename;
845 root 1.60 } else {
846 root 1.105 warn "FATAL: $filename~: $!\n";
847 root 1.60 }
848 root 1.59 } else {
849 root 1.105 aio_unlink $filename;
850     aio_unlink "$filename.pst";
851 root 1.59 }
852 root 1.45 }
853     }
854    
855 root 1.80 sub object_freezer_as_string {
856     my ($rdata, $objs) = @_;
857    
858     use Data::Dumper;
859    
860 root 1.81 $$rdata . Dumper $objs
861 root 1.80 }
862    
863 root 1.46 sub object_thawer_load {
864     my ($filename) = @_;
865    
866 root 1.105 my ($data, $av);
867 root 1.61
868 root 1.105 (aio_load $filename, $data) >= 0
869     or return;
870 root 1.61
871 root 1.105 unless (aio_stat "$filename.pst") {
872     (aio_load "$filename.pst", $av) >= 0
873     or return;
874 root 1.113 $av = eval { (Storable::thaw $av)->{objs} };
875 root 1.61 }
876 root 1.45
877 root 1.118 warn sprintf "loading %s (%d)\n",
878     $filename, length $data, scalar @{$av || []};#d#
879 root 1.105 return ($data, $av);
880 root 1.45 }
881    
882     #############################################################################
883 root 1.85 # command handling &c
884 root 1.39
885 root 1.85 =item cf::register_command $name => \&callback($ob,$args);
886 root 1.1
887 root 1.85 Register a callback for execution when the client sends the user command
888     $name.
889 root 1.5
890 root 1.85 =cut
891 root 1.5
892 root 1.85 sub register_command {
893     my ($name, $cb) = @_;
894 root 1.5
895 root 1.85 my $caller = caller;
896     #warn "registering command '$name/$time' to '$caller'";
897 root 1.1
898 root 1.85 push @{ $COMMAND{$name} }, [$caller, $cb];
899 root 1.1 }
900    
901 root 1.85 =item cf::register_extcmd $name => \&callback($pl,$packet);
902 root 1.1
903 root 1.85 Register a callbackf ro execution when the client sends an extcmd packet.
904 root 1.1
905 root 1.85 If the callback returns something, it is sent back as if reply was being
906     called.
907 root 1.1
908 root 1.85 =cut
909 root 1.1
910 root 1.16 sub register_extcmd {
911     my ($name, $cb) = @_;
912    
913 root 1.159 $EXTCMD{$name} = $cb;
914 root 1.16 }
915    
916 root 1.93 cf::player->attach (
917 root 1.85 on_command => sub {
918     my ($pl, $name, $params) = @_;
919    
920     my $cb = $COMMAND{$name}
921     or return;
922    
923     for my $cmd (@$cb) {
924     $cmd->[1]->($pl->ob, $params);
925     }
926    
927     cf::override;
928     },
929     on_extcmd => sub {
930     my ($pl, $buf) = @_;
931    
932     my $msg = eval { from_json $buf };
933    
934     if (ref $msg) {
935     if (my $cb = $EXTCMD{$msg->{msgtype}}) {
936 root 1.159 if (my %reply = $cb->($pl, $msg)) {
937 root 1.85 $pl->ext_reply ($msg->{msgid}, %reply);
938     }
939     }
940     } else {
941     warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942     }
943    
944     cf::override;
945     },
946 root 1.93 );
947 root 1.85
948 root 1.1 sub load_extension {
949     my ($path) = @_;
950    
951     $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 root 1.5 my $base = $1;
953 root 1.1 my $pkg = $1;
954     $pkg =~ s/[^[:word:]]/_/g;
955 root 1.41 $pkg = "ext::$pkg";
956 root 1.1
957 root 1.160 warn "... loading '$path' into '$pkg'\n";
958 root 1.1
959     open my $fh, "<:utf8", $path
960     or die "$path: $!";
961    
962     my $source =
963     "package $pkg; use strict; use utf8;\n"
964     . "#line 1 \"$path\"\n{\n"
965     . (do { local $/; <$fh> })
966     . "\n};\n1";
967    
968 root 1.166 unless (eval $source) {
969     my $msg = $@ ? "$path: $@\n"
970     : "extension disabled.\n";
971     if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972     warn $@;
973     warn "mandatory extension failed to load, exiting.\n";
974     exit 1;
975     }
976     die $@;
977     }
978 root 1.1
979 root 1.159 push @EXTS, $pkg;
980 root 1.1 }
981    
982     sub load_extensions {
983     for my $ext (<$LIBDIR/*.ext>) {
984 root 1.3 next unless -r $ext;
985 root 1.2 eval {
986     load_extension $ext;
987     1
988     } or warn "$ext not loaded: $@";
989 root 1.1 }
990     }
991    
992 root 1.8 #############################################################################
993 root 1.70
994     =head2 CORE EXTENSIONS
995    
996     Functions and methods that extend core crossfire objects.
997    
998 root 1.143 =cut
999    
1000     package cf::player;
1001    
1002 root 1.154 use Coro::AIO;
1003    
1004 root 1.95 =head3 cf::player
1005    
1006 root 1.70 =over 4
1007 root 1.22
1008 root 1.143 =item cf::player::find $login
1009 root 1.23
1010 root 1.143 Returns the given player object, loading it if necessary (might block).
1011 root 1.23
1012     =cut
1013    
1014 root 1.145 sub playerdir($) {
1015 root 1.253 "$PLAYERDIR/"
1016 root 1.145 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1017     }
1018    
1019 root 1.143 sub path($) {
1020 root 1.145 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1021    
1022 root 1.234 (playerdir $login) . "/playerdata"
1023 root 1.143 }
1024    
1025     sub find_active($) {
1026     $cf::PLAYER{$_[0]}
1027     and $cf::PLAYER{$_[0]}->active
1028     and $cf::PLAYER{$_[0]}
1029     }
1030    
1031     sub exists($) {
1032     my ($login) = @_;
1033    
1034     $cf::PLAYER{$login}
1035 root 1.180 or cf::sync_job { !aio_stat path $login }
1036 root 1.143 }
1037    
1038     sub find($) {
1039     return $cf::PLAYER{$_[0]} || do {
1040     my $login = $_[0];
1041    
1042     my $guard = cf::lock_acquire "user_find:$login";
1043    
1044 root 1.151 $cf::PLAYER{$_[0]} || do {
1045 root 1.234 # rename old playerfiles to new ones
1046     #TODO: remove when no longer required
1047     aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1048     aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1049     aio_unlink +(playerdir $login) . "/$login.pl.pst";
1050     aio_unlink +(playerdir $login) . "/$login.pl";
1051    
1052 root 1.151 my $pl = load_pl path $login
1053     or return;
1054     $cf::PLAYER{$login} = $pl
1055     }
1056     }
1057 root 1.143 }
1058    
1059     sub save($) {
1060     my ($pl) = @_;
1061    
1062     return if $pl->{deny_save};
1063    
1064     my $path = path $pl;
1065     my $guard = cf::lock_acquire "user_save:$path";
1066    
1067     return if $pl->{deny_save};
1068 root 1.146
1069 root 1.154 aio_mkdir playerdir $pl, 0770;
1070 root 1.143 $pl->{last_save} = $cf::RUNTIME;
1071    
1072     $pl->save_pl ($path);
1073     Coro::cede;
1074     }
1075    
1076     sub new($) {
1077     my ($login) = @_;
1078    
1079     my $self = create;
1080    
1081     $self->ob->name ($login);
1082     $self->{deny_save} = 1;
1083    
1084     $cf::PLAYER{$login} = $self;
1085    
1086     $self
1087 root 1.23 }
1088    
1089 root 1.154 =item $pl->quit_character
1090    
1091     Nukes the player without looking back. If logged in, the connection will
1092     be destroyed. May block for a long time.
1093    
1094     =cut
1095    
1096 root 1.145 sub quit_character {
1097     my ($pl) = @_;
1098    
1099 root 1.220 my $name = $pl->ob->name;
1100    
1101 root 1.145 $pl->{deny_save} = 1;
1102     $pl->password ("*"); # this should lock out the player until we nuked the dir
1103    
1104     $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1105     $pl->deactivate;
1106     $pl->invoke (cf::EVENT_PLAYER_QUIT);
1107     $pl->ns->destroy if $pl->ns;
1108    
1109     my $path = playerdir $pl;
1110     my $temp = "$path~$cf::RUNTIME~deleting~";
1111 root 1.154 aio_rename $path, $temp;
1112 root 1.150 delete $cf::PLAYER{$pl->ob->name};
1113     $pl->destroy;
1114 root 1.220
1115     my $prefix = qr<^~\Q$name\E/>;
1116    
1117     # nuke player maps
1118     $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1119    
1120 root 1.150 IO::AIO::aio_rmtree $temp;
1121 root 1.145 }
1122    
1123 pippijn 1.221 =item $pl->kick
1124    
1125     Kicks a player out of the game. This destroys the connection.
1126    
1127     =cut
1128    
1129     sub kick {
1130     my ($pl, $kicker) = @_;
1131    
1132     $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1133     $pl->killer ("kicked");
1134     $pl->ns->destroy;
1135     }
1136    
1137 root 1.154 =item cf::player::list_logins
1138    
1139     Returns am arrayref of all valid playernames in the system, can take a
1140     while and may block, so not sync_job-capable, ever.
1141    
1142     =cut
1143    
1144     sub list_logins {
1145 root 1.253 my $dirs = aio_readdir $PLAYERDIR
1146 root 1.154 or return [];
1147    
1148     my @logins;
1149    
1150     for my $login (@$dirs) {
1151     my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1152     aio_read $fh, 0, 512, my $buf, 0 or next;
1153 root 1.155 $buf !~ /^password -------------$/m or next; # official not-valid tag
1154 root 1.154
1155     utf8::decode $login;
1156     push @logins, $login;
1157     }
1158    
1159     \@logins
1160     }
1161    
1162     =item $player->maps
1163    
1164 root 1.166 Returns an arrayref of map paths that are private for this
1165 root 1.154 player. May block.
1166    
1167     =cut
1168    
1169     sub maps($) {
1170     my ($pl) = @_;
1171    
1172 root 1.201 $pl = ref $pl ? $pl->ob->name : $pl;
1173    
1174 root 1.154 my $files = aio_readdir playerdir $pl
1175     or return;
1176    
1177     my @paths;
1178    
1179     for (@$files) {
1180     utf8::decode $_;
1181     next if /\.(?:pl|pst)$/;
1182 root 1.158 next unless /^$PATH_SEP/o;
1183 root 1.154
1184 root 1.201 push @paths, cf::map::normalise "~$pl/$_";
1185 root 1.154 }
1186    
1187     \@paths
1188     }
1189    
1190 root 1.231 =item $player->ext_reply ($msgid, %msg)
1191 root 1.95
1192     Sends an ext reply to the player.
1193    
1194     =cut
1195    
1196 root 1.231 sub ext_reply($$%) {
1197 root 1.95 my ($self, $id, %msg) = @_;
1198    
1199     $msg{msgid} = $id;
1200    
1201 root 1.143 $self->send ("ext " . cf::to_json \%msg);
1202 root 1.95 }
1203    
1204 root 1.231 =item $player->ext_event ($type, %msg)
1205    
1206     Sends an ext event to the client.
1207    
1208     =cut
1209    
1210     sub ext_event($$%) {
1211     my ($self, $type, %msg) = @_;
1212    
1213 root 1.232 $self->ns->ext_event ($type, %msg);
1214 root 1.231 }
1215    
1216 root 1.238 =head3 cf::region
1217    
1218     =over 4
1219    
1220     =cut
1221    
1222     package cf::region;
1223    
1224     =item cf::region::find_by_path $path
1225    
1226     Tries to decuce the probable region for a map knowing only its path.
1227    
1228     =cut
1229    
1230     sub find_by_path($) {
1231     my ($path) = @_;
1232    
1233     my ($match, $specificity);
1234    
1235     for my $region (list) {
1236     if ($region->match && $path =~ $region->match) {
1237     ($match, $specificity) = ($region, $region->specificity)
1238     if $region->specificity > $specificity;
1239     }
1240     }
1241    
1242     $match
1243     }
1244 root 1.143
1245 root 1.95 =back
1246    
1247 root 1.110 =head3 cf::map
1248    
1249     =over 4
1250    
1251     =cut
1252    
1253     package cf::map;
1254    
1255     use Fcntl;
1256     use Coro::AIO;
1257    
1258 root 1.166 use overload
1259 root 1.173 '""' => \&as_string,
1260     fallback => 1;
1261 root 1.166
1262 root 1.133 our $MAX_RESET = 3600;
1263     our $DEFAULT_RESET = 3000;
1264 root 1.110
1265     sub generate_random_map {
1266 root 1.166 my ($self, $rmp) = @_;
1267 root 1.110 # mit "rum" bekleckern, nicht
1268 root 1.166 $self->_create_random_map (
1269 root 1.110 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1270     $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1271     $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1272     $rmp->{exit_on_final_map},
1273     $rmp->{xsize}, $rmp->{ysize},
1274     $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1275     $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1276     $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1277     $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1278     $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1279 root 1.162 (cf::region::find $rmp->{region}), $rmp->{custom}
1280     )
1281 root 1.110 }
1282    
1283 root 1.187 =item cf::map->register ($regex, $prio)
1284    
1285     Register a handler for the map path matching the given regex at the
1286     givne priority (higher is better, built-in handlers have priority 0, the
1287     default).
1288    
1289     =cut
1290    
1291 root 1.166 sub register {
1292 root 1.187 my (undef, $regex, $prio) = @_;
1293 root 1.166 my $pkg = caller;
1294    
1295     no strict;
1296     push @{"$pkg\::ISA"}, __PACKAGE__;
1297    
1298 root 1.187 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1299 root 1.166 }
1300    
1301     # also paths starting with '/'
1302 root 1.187 $EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1303 root 1.166
1304 root 1.170 sub thawer_merge {
1305 root 1.172 my ($self, $merge) = @_;
1306    
1307 root 1.170 # we have to keep some variables in memory intact
1308 root 1.172 local $self->{path};
1309     local $self->{load_path};
1310     local $self->{deny_save};
1311     local $self->{deny_reset};
1312 root 1.170
1313 root 1.172 $self->SUPER::thawer_merge ($merge);
1314 root 1.170 }
1315    
1316 root 1.166 sub normalise {
1317     my ($path, $base) = @_;
1318    
1319 root 1.192 $path = "$path"; # make sure its a string
1320    
1321 root 1.199 $path =~ s/\.map$//;
1322    
1323 root 1.166 # map plan:
1324     #
1325     # /! non-realised random map exit (special hack!)
1326     # {... are special paths that are not being touched
1327     # ?xxx/... are special absolute paths
1328     # ?random/... random maps
1329     # /... normal maps
1330     # ~user/... per-player map of a specific user
1331    
1332     $path =~ s/$PATH_SEP/\//go;
1333    
1334     # treat it as relative path if it starts with
1335     # something that looks reasonable
1336     if ($path =~ m{^(?:\./|\.\./|\w)}) {
1337     $base or Carp::carp "normalise called with relative path and no base: '$path'";
1338    
1339     $base =~ s{[^/]+/?$}{};
1340     $path = "$base/$path";
1341     }
1342    
1343     for ($path) {
1344     redo if s{//}{/};
1345     redo if s{/\.?/}{/};
1346     redo if s{/[^/]+/\.\./}{/};
1347     }
1348    
1349     $path
1350     }
1351    
1352     sub new_from_path {
1353     my (undef, $path, $base) = @_;
1354    
1355     return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1356    
1357     $path = normalise $path, $base;
1358    
1359 root 1.187 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1360     if ($path =~ $EXT_MAP{$pkg}[1]) {
1361 root 1.166 my $self = bless cf::map::new, $pkg;
1362     $self->{path} = $path; $self->path ($path);
1363     $self->init; # pass $1 etc.
1364     return $self;
1365     }
1366     }
1367    
1368 root 1.192 Carp::carp "unable to resolve path '$path' (base '$base').";
1369 root 1.166 ()
1370     }
1371    
1372     sub init {
1373     my ($self) = @_;
1374    
1375     $self
1376     }
1377    
1378     sub as_string {
1379     my ($self) = @_;
1380    
1381     "$self->{path}"
1382     }
1383    
1384     # the displayed name, this is a one way mapping
1385     sub visible_name {
1386     &as_string
1387     }
1388    
1389     # the original (read-only) location
1390     sub load_path {
1391     my ($self) = @_;
1392    
1393 root 1.254 "$MAPDIR/$self->{path}.map"
1394 root 1.166 }
1395    
1396     # the temporary/swap location
1397     sub save_path {
1398     my ($self) = @_;
1399    
1400 root 1.167 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1401 root 1.254 "$TMPDIR/$path.map"
1402 root 1.166 }
1403    
1404     # the unique path, undef == no special unique path
1405     sub uniq_path {
1406     my ($self) = @_;
1407    
1408 root 1.167 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1409 root 1.253 "$UNIQUEDIR/$path"
1410 root 1.166 }
1411    
1412 root 1.110 # and all this just because we cannot iterate over
1413     # all maps in C++...
1414     sub change_all_map_light {
1415     my ($change) = @_;
1416    
1417 root 1.122 $_->change_map_light ($change)
1418     for grep $_->outdoor, values %cf::MAP;
1419 root 1.110 }
1420    
1421 root 1.166 sub unlink_save {
1422     my ($self) = @_;
1423    
1424     utf8::encode (my $save = $self->save_path);
1425 root 1.170 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1426     IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1427 root 1.166 }
1428    
1429     sub load_header_from($) {
1430     my ($self, $path) = @_;
1431 root 1.110
1432     utf8::encode $path;
1433 root 1.200 #aio_open $path, O_RDONLY, 0
1434     # or return;
1435 root 1.110
1436 root 1.166 $self->_load_header ($path)
1437 root 1.110 or return;
1438    
1439 root 1.166 $self->{load_path} = $path;
1440 root 1.135
1441 root 1.166 1
1442     }
1443 root 1.110
1444 root 1.188 sub load_header_orig {
1445 root 1.166 my ($self) = @_;
1446 root 1.110
1447 root 1.166 $self->load_header_from ($self->load_path)
1448 root 1.110 }
1449    
1450 root 1.188 sub load_header_temp {
1451 root 1.166 my ($self) = @_;
1452 root 1.110
1453 root 1.166 $self->load_header_from ($self->save_path)
1454     }
1455 root 1.110
1456 root 1.188 sub prepare_temp {
1457     my ($self) = @_;
1458    
1459     $self->last_access ((delete $self->{last_access})
1460     || $cf::RUNTIME); #d#
1461     # safety
1462     $self->{instantiate_time} = $cf::RUNTIME
1463     if $self->{instantiate_time} > $cf::RUNTIME;
1464     }
1465    
1466     sub prepare_orig {
1467     my ($self) = @_;
1468    
1469     $self->{load_original} = 1;
1470     $self->{instantiate_time} = $cf::RUNTIME;
1471     $self->last_access ($cf::RUNTIME);
1472     $self->instantiate;
1473     }
1474    
1475 root 1.166 sub load_header {
1476     my ($self) = @_;
1477 root 1.110
1478 root 1.188 if ($self->load_header_temp) {
1479     $self->prepare_temp;
1480 root 1.166 } else {
1481 root 1.188 $self->load_header_orig
1482 root 1.166 or return;
1483 root 1.188 $self->prepare_orig;
1484 root 1.166 }
1485 root 1.120
1486 root 1.238 $self->default_region (cf::region::find_by_path $self->{path})
1487     unless $self->default_region;
1488    
1489 root 1.166 1
1490     }
1491 root 1.110
1492 root 1.166 sub find;
1493     sub find {
1494     my ($path, $origin) = @_;
1495 root 1.134
1496 root 1.166 $path = normalise $path, $origin && $origin->path;
1497 root 1.110
1498 root 1.166 cf::lock_wait "map_find:$path";
1499 root 1.110
1500 root 1.166 $cf::MAP{$path} || do {
1501     my $guard = cf::lock_acquire "map_find:$path";
1502     my $map = new_from_path cf::map $path
1503     or return;
1504 root 1.110
1505 root 1.116 $map->{last_save} = $cf::RUNTIME;
1506 root 1.110
1507 root 1.166 $map->load_header
1508     or return;
1509 root 1.134
1510 root 1.195 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1511 root 1.185 # doing this can freeze the server in a sync job, obviously
1512     #$cf::WAIT_FOR_TICK->wait;
1513 root 1.112 $map->reset;
1514 root 1.123 undef $guard;
1515 root 1.192 return find $path;
1516 root 1.112 }
1517 root 1.110
1518 root 1.166 $cf::MAP{$path} = $map
1519 root 1.110 }
1520     }
1521    
1522 root 1.188 sub pre_load { }
1523     sub post_load { }
1524    
1525 root 1.110 sub load {
1526     my ($self) = @_;
1527    
1528 root 1.196 local $self->{deny_reset} = 1; # loading can take a long time
1529    
1530 root 1.120 my $path = $self->{path};
1531    
1532 root 1.256 {
1533     my $guard = cf::lock_acquire "map_load:$path";
1534    
1535     return if $self->in_memory != cf::MAP_SWAPPED;
1536 root 1.110
1537 root 1.256 $self->in_memory (cf::MAP_LOADING);
1538 root 1.110
1539 root 1.256 $self->alloc;
1540 root 1.188
1541 root 1.256 $self->pre_load;
1542     Coro::cede;
1543 root 1.188
1544 root 1.256 $self->_load_objects ($self->{load_path}, 1)
1545     or return;
1546 root 1.110
1547 root 1.256 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1548     if delete $self->{load_original};
1549 root 1.111
1550 root 1.256 if (my $uniq = $self->uniq_path) {
1551     utf8::encode $uniq;
1552     if (aio_open $uniq, O_RDONLY, 0) {
1553     $self->clear_unique_items;
1554     $self->_load_objects ($uniq, 0);
1555     }
1556 root 1.110 }
1557    
1558 root 1.166 Coro::cede;
1559 root 1.256 # now do the right thing for maps
1560     $self->link_multipart_objects;
1561 root 1.110 $self->difficulty ($self->estimate_difficulty)
1562     unless $self->difficulty;
1563 root 1.166 Coro::cede;
1564 root 1.256
1565     unless ($self->{deny_activate}) {
1566     $self->decay_objects;
1567     $self->fix_auto_apply;
1568     $self->update_buttons;
1569     Coro::cede;
1570     $self->set_darkness_map;
1571     Coro::cede;
1572     $self->activate;
1573     }
1574    
1575     $self->in_memory (cf::MAP_IN_MEMORY);
1576 root 1.110 }
1577    
1578 root 1.188 $self->post_load;
1579 root 1.166 }
1580    
1581     sub customise_for {
1582     my ($self, $ob) = @_;
1583    
1584     return find "~" . $ob->name . "/" . $self->{path}
1585     if $self->per_player;
1586 root 1.134
1587 root 1.166 $self
1588 root 1.110 }
1589    
1590 root 1.157 # find and load all maps in the 3x3 area around a map
1591     sub load_diag {
1592     my ($map) = @_;
1593    
1594     my @diag; # diagonal neighbours
1595    
1596     for (0 .. 3) {
1597     my $neigh = $map->tile_path ($_)
1598     or next;
1599     $neigh = find $neigh, $map
1600     or next;
1601     $neigh->load;
1602    
1603     push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1604     [$neigh->tile_path (($_ + 1) % 4), $neigh];
1605     }
1606    
1607     for (@diag) {
1608     my $neigh = find @$_
1609     or next;
1610     $neigh->load;
1611     }
1612     }
1613    
1614 root 1.133 sub find_sync {
1615 root 1.110 my ($path, $origin) = @_;
1616    
1617 root 1.157 cf::sync_job { find $path, $origin }
1618 root 1.133 }
1619    
1620     sub do_load_sync {
1621     my ($map) = @_;
1622 root 1.110
1623 root 1.133 cf::sync_job { $map->load };
1624 root 1.110 }
1625    
1626 root 1.157 our %MAP_PREFETCH;
1627 root 1.183 our $MAP_PREFETCHER = undef;
1628 root 1.157
1629     sub find_async {
1630     my ($path, $origin) = @_;
1631    
1632 root 1.166 $path = normalise $path, $origin && $origin->{path};
1633 root 1.157
1634 root 1.166 if (my $map = $cf::MAP{$path}) {
1635 root 1.157 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1636     }
1637    
1638 root 1.183 undef $MAP_PREFETCH{$path};
1639     $MAP_PREFETCHER ||= cf::async {
1640     while (%MAP_PREFETCH) {
1641     for my $path (keys %MAP_PREFETCH) {
1642     my $map = find $path
1643     or next;
1644     $map->load;
1645    
1646     delete $MAP_PREFETCH{$path};
1647     }
1648     }
1649     undef $MAP_PREFETCHER;
1650     };
1651 root 1.189 $MAP_PREFETCHER->prio (6);
1652 root 1.157
1653     ()
1654     }
1655    
1656 root 1.110 sub save {
1657     my ($self) = @_;
1658    
1659 root 1.137 my $lock = cf::lock_acquire "map_data:" . $self->path;
1660    
1661 root 1.110 $self->{last_save} = $cf::RUNTIME;
1662    
1663     return unless $self->dirty;
1664    
1665 root 1.166 my $save = $self->save_path; utf8::encode $save;
1666     my $uniq = $self->uniq_path; utf8::encode $uniq;
1667 root 1.117
1668 root 1.110 $self->{load_path} = $save;
1669    
1670     return if $self->{deny_save};
1671    
1672 root 1.132 local $self->{last_access} = $self->last_access;#d#
1673    
1674 root 1.143 cf::async {
1675     $_->contr->save for $self->players;
1676     };
1677    
1678 root 1.110 if ($uniq) {
1679 root 1.166 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1680     $self->_save_objects ($uniq, cf::IO_UNIQUES);
1681 root 1.110 } else {
1682 root 1.166 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1683 root 1.110 }
1684     }
1685    
1686     sub swap_out {
1687     my ($self) = @_;
1688    
1689 root 1.130 # save first because save cedes
1690     $self->save;
1691    
1692 root 1.137 my $lock = cf::lock_acquire "map_data:" . $self->path;
1693    
1694 root 1.110 return if $self->players;
1695     return if $self->in_memory != cf::MAP_IN_MEMORY;
1696     return if $self->{deny_save};
1697    
1698     $self->clear;
1699     $self->in_memory (cf::MAP_SWAPPED);
1700     }
1701    
1702 root 1.112 sub reset_at {
1703     my ($self) = @_;
1704 root 1.110
1705     # TODO: safety, remove and allow resettable per-player maps
1706 root 1.169 return 1e99 if $self->isa ("ext::map_per_player");#d#
1707 root 1.114 return 1e99 if $self->{deny_reset};
1708 root 1.110
1709 root 1.112 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 root 1.114 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 root 1.110
1712 root 1.112 $time + $to
1713     }
1714    
1715     sub should_reset {
1716     my ($self) = @_;
1717    
1718     $self->reset_at <= $cf::RUNTIME
1719 root 1.111 }
1720    
1721 root 1.110 sub reset {
1722     my ($self) = @_;
1723    
1724 root 1.167 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 root 1.137
1726 root 1.110 return if $self->players;
1727 root 1.166 return if $self->isa ("ext::map_per_player");#d#
1728 root 1.110
1729     warn "resetting map ", $self->path;#d#
1730    
1731 root 1.210 $self->in_memory (cf::MAP_SWAPPED);
1732    
1733     # need to save uniques path
1734     unless ($self->{deny_save}) {
1735     my $uniq = $self->uniq_path; utf8::encode $uniq;
1736    
1737     $self->_save_objects ($uniq, cf::IO_UNIQUES)
1738     if $uniq;
1739     }
1740    
1741 root 1.111 delete $cf::MAP{$self->path};
1742 root 1.110
1743 root 1.167 $self->clear;
1744    
1745 root 1.110 $_->clear_links_to ($self) for values %cf::MAP;
1746    
1747 root 1.166 $self->unlink_save;
1748 root 1.111 $self->destroy;
1749 root 1.110 }
1750    
1751 root 1.114 my $nuke_counter = "aaaa";
1752    
1753     sub nuke {
1754     my ($self) = @_;
1755    
1756 root 1.174 delete $cf::MAP{$self->path};
1757    
1758     $self->unlink_save;
1759    
1760     bless $self, "cf::map";
1761     delete $self->{deny_reset};
1762 root 1.114 $self->{deny_save} = 1;
1763     $self->reset_timeout (1);
1764 root 1.174 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1765    
1766     $cf::MAP{$self->path} = $self;
1767    
1768 root 1.114 $self->reset; # polite request, might not happen
1769     }
1770    
1771 root 1.158 =item cf::map::unique_maps
1772    
1773 root 1.166 Returns an arrayref of paths of all shared maps that have
1774 root 1.158 instantiated unique items. May block.
1775    
1776     =cut
1777    
1778     sub unique_maps() {
1779 root 1.253 my $files = aio_readdir $UNIQUEDIR
1780 root 1.158 or return;
1781    
1782     my @paths;
1783    
1784     for (@$files) {
1785     utf8::decode $_;
1786     next if /\.pst$/;
1787     next unless /^$PATH_SEP/o;
1788    
1789 root 1.199 push @paths, cf::map::normalise $_;
1790 root 1.158 }
1791    
1792     \@paths
1793     }
1794    
1795 root 1.155 package cf;
1796    
1797     =back
1798    
1799     =head3 cf::object
1800    
1801     =cut
1802    
1803     package cf::object;
1804    
1805     =over 4
1806    
1807     =item $ob->inv_recursive
1808 root 1.110
1809 root 1.155 Returns the inventory of the object _and_ their inventories, recursively.
1810 root 1.110
1811 root 1.155 =cut
1812 root 1.144
1813 root 1.155 sub inv_recursive_;
1814     sub inv_recursive_ {
1815     map { $_, inv_recursive_ $_->inv } @_
1816     }
1817 root 1.110
1818 root 1.155 sub inv_recursive {
1819     inv_recursive_ inv $_[0]
1820 root 1.110 }
1821    
1822     package cf;
1823    
1824     =back
1825    
1826 root 1.95 =head3 cf::object::player
1827    
1828     =over 4
1829    
1830 root 1.79 =item $player_object->reply ($npc, $msg[, $flags])
1831 root 1.28
1832     Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1833     can be C<undef>. Does the right thing when the player is currently in a
1834     dialogue with the given NPC character.
1835    
1836     =cut
1837    
1838 root 1.22 # rough implementation of a future "reply" method that works
1839     # with dialog boxes.
1840 root 1.95 #TODO: the first argument must go, split into a $npc->reply_to ( method
1841 root 1.23 sub cf::object::player::reply($$$;$) {
1842     my ($self, $npc, $msg, $flags) = @_;
1843    
1844     $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 root 1.22
1846 root 1.24 if ($self->{record_replies}) {
1847     push @{ $self->{record_replies} }, [$npc, $msg, $flags];
1848     } else {
1849     $msg = $npc->name . " says: $msg" if $npc;
1850     $self->message ($msg, $flags);
1851     }
1852 root 1.22 }
1853    
1854 root 1.79 =item $player_object->may ("access")
1855    
1856     Returns wether the given player is authorized to access resource "access"
1857     (e.g. "command_wizcast").
1858    
1859     =cut
1860    
1861     sub cf::object::player::may {
1862     my ($self, $access) = @_;
1863    
1864     $self->flag (cf::FLAG_WIZ) ||
1865     (ref $cf::CFG{"may_$access"}
1866     ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1867     : $cf::CFG{"may_$access"})
1868     }
1869 root 1.70
1870 root 1.115 =item $player_object->enter_link
1871    
1872     Freezes the player and moves him/her to a special map (C<{link}>).
1873    
1874 root 1.166 The player should be reasonably safe there for short amounts of time. You
1875 root 1.115 I<MUST> call C<leave_link> as soon as possible, though.
1876    
1877 root 1.166 Will never block.
1878    
1879 root 1.115 =item $player_object->leave_link ($map, $x, $y)
1880    
1881 root 1.166 Moves the player out of the special C<{link}> map onto the specified
1882     map. If the map is not valid (or omitted), the player will be moved back
1883     to the location he/she was before the call to C<enter_link>, or, if that
1884     fails, to the emergency map position.
1885 root 1.115
1886     Might block.
1887    
1888     =cut
1889    
1890 root 1.166 sub link_map {
1891     unless ($LINK_MAP) {
1892     $LINK_MAP = cf::map::find "{link}"
1893 root 1.196 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1894 root 1.166 $LINK_MAP->load;
1895     }
1896    
1897     $LINK_MAP
1898     }
1899    
1900 root 1.110 sub cf::object::player::enter_link {
1901     my ($self) = @_;
1902    
1903 root 1.259 $self->deactivate_recursive;
1904 root 1.258
1905 root 1.166 return if UNIVERSAL::isa $self->map, "ext::map_link";
1906 root 1.110
1907 root 1.120 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1908 root 1.270 if $self->map && $self->map->{path} ne "{link}";
1909 root 1.110
1910 root 1.194 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1911 root 1.110 }
1912    
1913     sub cf::object::player::leave_link {
1914     my ($self, $map, $x, $y) = @_;
1915    
1916 root 1.270 return unless $self->contr->active;
1917    
1918 root 1.110 my $link_pos = delete $self->{_link_pos};
1919    
1920     unless ($map) {
1921     # restore original map position
1922     ($map, $x, $y) = @{ $link_pos || [] };
1923 root 1.133 $map = cf::map::find $map;
1924 root 1.110
1925     unless ($map) {
1926     ($map, $x, $y) = @$EMERGENCY_POSITION;
1927 root 1.133 $map = cf::map::find $map
1928 root 1.110 or die "FATAL: cannot load emergency map\n";
1929     }
1930     }
1931    
1932     ($x, $y) = (-1, -1)
1933     unless (defined $x) && (defined $y);
1934    
1935     # use -1 or undef as default coordinates, not 0, 0
1936     ($x, $y) = ($map->enter_x, $map->enter_y)
1937     if $x <=0 && $y <= 0;
1938    
1939     $map->load;
1940 root 1.157 $map->load_diag;
1941 root 1.110
1942 root 1.143 return unless $self->contr->active;
1943 root 1.110 $self->activate_recursive;
1944 root 1.215
1945     local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1946 root 1.110 $self->enter_map ($map, $x, $y);
1947     }
1948    
1949 root 1.268 =item $player_object->goto ($path, $x, $y[, $check->($map)])
1950    
1951     Moves the player to the given map-path and coordinates by first freezing
1952     her, loading and preparing them map, calling the provided $check callback
1953     that has to return the map if sucecssful, and then unfreezes the player on
1954     the new (success) or old (failed) map position.
1955 root 1.110
1956     =cut
1957    
1958 root 1.270 our $GOTOGEN;
1959    
1960 root 1.136 sub cf::object::player::goto {
1961 root 1.268 my ($self, $path, $x, $y, $check) = @_;
1962    
1963 root 1.270 # do generation counting so two concurrent goto's will be executed in-order
1964     my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1965    
1966 root 1.110 $self->enter_link;
1967    
1968 root 1.140 (async {
1969 root 1.197 my $map = eval {
1970     my $map = cf::map::find $path;
1971 root 1.268
1972     if ($map) {
1973     $map = $map->customise_for ($self);
1974     $map = $check->($map) if $check && $map;
1975     } else {
1976     $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1977     }
1978    
1979 root 1.197 $map
1980 root 1.268 };
1981    
1982     if ($@) {
1983     $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
1984     LOG llevError | logBacktrace, Carp::longmess $@;
1985     }
1986 root 1.115
1987 root 1.270 if ($gen == $self->{_goto_generation}) {
1988     delete $self->{_goto_generation};
1989     $self->leave_link ($map, $x, $y);
1990     }
1991 root 1.110 })->prio (1);
1992     }
1993    
1994     =item $player_object->enter_exit ($exit_object)
1995    
1996     =cut
1997    
1998     sub parse_random_map_params {
1999     my ($spec) = @_;
2000    
2001     my $rmp = { # defaults
2002 root 1.181 xsize => (cf::rndm 15, 40),
2003     ysize => (cf::rndm 15, 40),
2004     symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2005 root 1.182 #layout => string,
2006 root 1.110 };
2007    
2008     for (split /\n/, $spec) {
2009     my ($k, $v) = split /\s+/, $_, 2;
2010    
2011     $rmp->{lc $k} = $v if (length $k) && (length $v);
2012     }
2013    
2014     $rmp
2015     }
2016    
2017     sub prepare_random_map {
2018     my ($exit) = @_;
2019    
2020 root 1.179 my $guard = cf::lock_acquire "exit_prepare:$exit";
2021    
2022 root 1.110 # all this does is basically replace the /! path by
2023     # a new random map path (?random/...) with a seed
2024     # that depends on the exit object
2025    
2026     my $rmp = parse_random_map_params $exit->msg;
2027    
2028     if ($exit->map) {
2029 root 1.198 $rmp->{region} = $exit->region->name;
2030 root 1.110 $rmp->{origin_map} = $exit->map->path;
2031     $rmp->{origin_x} = $exit->x;
2032     $rmp->{origin_y} = $exit->y;
2033     }
2034    
2035     $rmp->{random_seed} ||= $exit->random_seed;
2036    
2037     my $data = cf::to_json $rmp;
2038     my $md5 = Digest::MD5::md5_hex $data;
2039 root 1.253 my $meta = "$RANDOMDIR/$md5.meta";
2040 root 1.110
2041 root 1.177 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2042 root 1.110 aio_write $fh, 0, (length $data), $data, 0;
2043 root 1.177 undef $fh;
2044     aio_rename "$meta~", $meta;
2045 root 1.110
2046     $exit->slaying ("?random/$md5");
2047     $exit->msg (undef);
2048     }
2049     }
2050    
2051     sub cf::object::player::enter_exit {
2052     my ($self, $exit) = @_;
2053    
2054     return unless $self->type == cf::PLAYER;
2055    
2056 root 1.195 if ($exit->slaying eq "/!") {
2057     #TODO: this should de-fi-ni-te-ly not be a sync-job
2058 root 1.233 # the problem is that $exit might not survive long enough
2059     # so it needs to be done right now, right here
2060 root 1.195 cf::sync_job { prepare_random_map $exit };
2061     }
2062    
2063     my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2064     my $hp = $exit->stats->hp;
2065     my $sp = $exit->stats->sp;
2066    
2067 root 1.110 $self->enter_link;
2068    
2069 root 1.140 (async {
2070 root 1.133 $self->deactivate_recursive; # just to be sure
2071 root 1.110 unless (eval {
2072 root 1.195 $self->goto ($slaying, $hp, $sp);
2073 root 1.110
2074     1;
2075     }) {
2076     $self->message ("Something went wrong deep within the crossfire server. "
2077 root 1.233 . "I'll try to bring you back to the map you were before. "
2078     . "Please report this to the dungeon master!",
2079     cf::NDI_UNIQUE | cf::NDI_RED);
2080 root 1.110
2081     warn "ERROR in enter_exit: $@";
2082     $self->leave_link;
2083     }
2084     })->prio (1);
2085     }
2086    
2087 root 1.95 =head3 cf::client
2088    
2089     =over 4
2090    
2091     =item $client->send_drawinfo ($text, $flags)
2092    
2093     Sends a drawinfo packet to the client. Circumvents output buffering so
2094     should not be used under normal circumstances.
2095    
2096 root 1.70 =cut
2097    
2098 root 1.95 sub cf::client::send_drawinfo {
2099     my ($self, $text, $flags) = @_;
2100    
2101     utf8::encode $text;
2102 root 1.225 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103 root 1.95 }
2104    
2105 root 1.232 =item $client->ext_event ($type, %msg)
2106    
2107     Sends an exti event to the client.
2108    
2109     =cut
2110    
2111     sub cf::client::ext_event($$%) {
2112     my ($self, $type, %msg) = @_;
2113    
2114     $msg{msgtype} = "event_$type";
2115     $self->send_packet ("ext " . cf::to_json \%msg);
2116     }
2117 root 1.95
2118     =item $success = $client->query ($flags, "text", \&cb)
2119    
2120     Queues a query to the client, calling the given callback with
2121     the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2122     C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123    
2124     Queries can fail, so check the return code. Or don't, as queries will become
2125     reliable at some point in the future.
2126    
2127     =cut
2128    
2129     sub cf::client::query {
2130     my ($self, $flags, $text, $cb) = @_;
2131    
2132     return unless $self->state == ST_PLAYING
2133     || $self->state == ST_SETUP
2134     || $self->state == ST_CUSTOM;
2135    
2136     $self->state (ST_CUSTOM);
2137    
2138     utf8::encode $text;
2139     push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140    
2141     $self->send_packet ($self->{query_queue}[0][0])
2142     if @{ $self->{query_queue} } == 1;
2143     }
2144    
2145     cf::client->attach (
2146     on_reply => sub {
2147     my ($ns, $msg) = @_;
2148    
2149     # this weird shuffling is so that direct followup queries
2150     # get handled first
2151 root 1.128 my $queue = delete $ns->{query_queue}
2152 root 1.129 or return; # be conservative, not sure how that can happen, but we saw a crash here
2153 root 1.95
2154     (shift @$queue)->[1]->($msg);
2155 root 1.202 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2156 root 1.95
2157     push @{ $ns->{query_queue} }, @$queue;
2158    
2159     if (@{ $ns->{query_queue} } == @$queue) {
2160     if (@$queue) {
2161     $ns->send_packet ($ns->{query_queue}[0][0]);
2162     } else {
2163 root 1.98 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 root 1.95 }
2165     }
2166     },
2167     );
2168    
2169 root 1.140 =item $client->async (\&cb)
2170 root 1.96
2171     Create a new coroutine, running the specified callback. The coroutine will
2172     be automatically cancelled when the client gets destroyed (e.g. on logout,
2173     or loss of connection).
2174    
2175     =cut
2176    
2177 root 1.140 sub cf::client::async {
2178 root 1.96 my ($self, $cb) = @_;
2179    
2180 root 1.140 my $coro = &Coro::async ($cb);
2181 root 1.103
2182     $coro->on_destroy (sub {
2183 root 1.96 delete $self->{_coro}{$coro+0};
2184 root 1.103 });
2185 root 1.96
2186     $self->{_coro}{$coro+0} = $coro;
2187 root 1.103
2188     $coro
2189 root 1.96 }
2190    
2191     cf::client->attach (
2192     on_destroy => sub {
2193     my ($ns) = @_;
2194    
2195 root 1.97 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2196 root 1.96 },
2197     );
2198    
2199 root 1.95 =back
2200    
2201 root 1.70
2202     =head2 SAFE SCRIPTING
2203    
2204     Functions that provide a safe environment to compile and execute
2205     snippets of perl code without them endangering the safety of the server
2206     itself. Looping constructs, I/O operators and other built-in functionality
2207     is not available in the safe scripting environment, and the number of
2208 root 1.79 functions and methods that can be called is greatly reduced.
2209 root 1.70
2210     =cut
2211 root 1.23
2212 root 1.42 our $safe = new Safe "safe";
2213 root 1.23 our $safe_hole = new Safe::Hole;
2214    
2215     $SIG{FPE} = 'IGNORE';
2216    
2217     $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
2218    
2219 root 1.25 # here we export the classes and methods available to script code
2220    
2221 root 1.70 =pod
2222    
2223 root 1.228 The following functions and methods are available within a safe environment:
2224 root 1.70
2225 elmex 1.91 cf::object contr pay_amount pay_player map
2226 root 1.70 cf::object::player player
2227     cf::player peaceful
2228 elmex 1.91 cf::map trigger
2229 root 1.70
2230     =cut
2231    
2232 root 1.25 for (
2233 elmex 1.91 ["cf::object" => qw(contr pay_amount pay_player map)],
2234 root 1.25 ["cf::object::player" => qw(player)],
2235     ["cf::player" => qw(peaceful)],
2236 elmex 1.91 ["cf::map" => qw(trigger)],
2237 root 1.25 ) {
2238     no strict 'refs';
2239     my ($pkg, @funs) = @$_;
2240 root 1.41 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2241 root 1.25 for @funs;
2242     }
2243 root 1.23
2244 root 1.70 =over 4
2245    
2246     =item @retval = safe_eval $code, [var => value, ...]
2247    
2248     Compiled and executes the given perl code snippet. additional var/value
2249     pairs result in temporary local (my) scalar variables of the given name
2250     that are available in the code snippet. Example:
2251    
2252     my $five = safe_eval '$first + $second', first => 1, second => 4;
2253    
2254     =cut
2255    
2256 root 1.23 sub safe_eval($;@) {
2257     my ($code, %vars) = @_;
2258    
2259     my $qcode = $code;
2260     $qcode =~ s/"/‟/g; # not allowed in #line filenames
2261     $qcode =~ s/\n/\\n/g;
2262    
2263     local $_;
2264 root 1.41 local @safe::cf::_safe_eval_args = values %vars;
2265 root 1.23
2266 root 1.42 my $eval =
2267 root 1.23 "do {\n"
2268     . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2269     . "#line 0 \"{$qcode}\"\n"
2270     . $code
2271     . "\n}"
2272 root 1.25 ;
2273    
2274     sub_generation_inc;
2275 root 1.42 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2276 root 1.25 sub_generation_inc;
2277    
2278 root 1.42 if ($@) {
2279     warn "$@";
2280     warn "while executing safe code '$code'\n";
2281     warn "with arguments " . (join " ", %vars) . "\n";
2282     }
2283    
2284 root 1.25 wantarray ? @res : $res[0]
2285 root 1.23 }
2286    
2287 root 1.69 =item cf::register_script_function $function => $cb
2288    
2289     Register a function that can be called from within map/npc scripts. The
2290     function should be reasonably secure and should be put into a package name
2291     like the extension.
2292    
2293     Example: register a function that gets called whenever a map script calls
2294     C<rent::overview>, as used by the C<rent> extension.
2295    
2296     cf::register_script_function "rent::overview" => sub {
2297     ...
2298     };
2299    
2300     =cut
2301    
2302 root 1.23 sub register_script_function {
2303     my ($fun, $cb) = @_;
2304    
2305     no strict 'refs';
2306 root 1.41 *{"safe::$fun"} = $safe_hole->wrap ($cb);
2307 root 1.23 }
2308    
2309 root 1.70 =back
2310    
2311 root 1.71 =cut
2312    
2313 root 1.23 #############################################################################
2314 root 1.65
2315     =head2 EXTENSION DATABASE SUPPORT
2316    
2317     Crossfire maintains a very simple database for extension use. It can
2318 root 1.250 currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2319     convert to/from binary).
2320 root 1.65
2321     The parameter C<$family> should best start with the name of the extension
2322     using it, it should be unique.
2323    
2324     =over 4
2325    
2326     =item $value = cf::db_get $family => $key
2327    
2328 root 1.208 Returns a single value from the database.
2329 root 1.65
2330     =item cf::db_put $family => $key => $value
2331    
2332 root 1.208 Stores the given C<$value> in the family.
2333 root 1.65
2334     =cut
2335    
2336 root 1.78 our $DB;
2337    
2338 root 1.210 sub db_init {
2339     unless ($DB) {
2340     $DB = BDB::db_create $DB_ENV;
2341 root 1.65
2342 root 1.210 cf::sync_job {
2343     eval {
2344     $DB->set_flags (BDB::CHKSUM);
2345 root 1.65
2346 root 1.210 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2347     BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2348     cf::cleanup "db_open(db): $!" if $!;
2349     };
2350     cf::cleanup "db_open(db): $@" if $@;
2351 root 1.208 };
2352 root 1.65 }
2353 root 1.208 }
2354 root 1.65
2355 root 1.208 sub db_get($$) {
2356     my $key = "$_[0]/$_[1]";
2357 root 1.65
2358 root 1.208 cf::sync_job {
2359     BDB::db_get $DB, undef, $key, my $data;
2360 root 1.65
2361 root 1.208 $! ? ()
2362 root 1.250 : $data
2363 root 1.65 }
2364 root 1.208 }
2365 root 1.65
2366 root 1.208 sub db_put($$$) {
2367     BDB::dbreq_pri 4;
2368 root 1.250 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2369 root 1.65 }
2370    
2371 root 1.250 =item cf::cache $id => [$paths...], $processversion => $process
2372 root 1.249
2373     Generic caching function that returns the value of the resource $id,
2374     caching and regenerating as required.
2375    
2376     This function can block.
2377    
2378     =cut
2379    
2380     sub cache {
2381 root 1.250 my ($id, $src, $processversion, $process) = @_;
2382 root 1.249
2383 root 1.250 my $meta =
2384     join "\x00",
2385     $processversion,
2386     map {
2387     aio_stat $_
2388     and Carp::croak "$_: $!";
2389    
2390     ($_, (stat _)[7,9])
2391     } @$src;
2392    
2393     my $dbmeta = db_get cache => "$id/meta";
2394     if ($dbmeta ne $meta) {
2395     # changed, we may need to process
2396    
2397     my @data;
2398     my $md5;
2399    
2400     for (0 .. $#$src) {
2401     0 <= aio_load $src->[$_], $data[$_]
2402     or Carp::croak "$src->[$_]: $!";
2403     }
2404    
2405     # if processing is expensive, check
2406     # checksum first
2407     if (1) {
2408     $md5 =
2409     join "\x00",
2410     $processversion,
2411     map {
2412     Coro::cede;
2413     ($src->[$_], Digest::MD5::md5_hex $data[$_])
2414     } 0.. $#$src;
2415    
2416    
2417     my $dbmd5 = db_get cache => "$id/md5";
2418     if ($dbmd5 eq $md5) {
2419     db_put cache => "$id/meta", $meta;
2420    
2421     return db_get cache => "$id/data";
2422     }
2423     }
2424 root 1.249
2425 root 1.253 my $t1 = Time::HiRes::time;
2426 root 1.250 my $data = $process->(\@data);
2427 root 1.253 my $t2 = Time::HiRes::time;
2428    
2429     warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430 root 1.249
2431 root 1.250 db_put cache => "$id/data", $data;
2432     db_put cache => "$id/md5" , $md5;
2433     db_put cache => "$id/meta", $meta;
2434 root 1.249
2435 root 1.250 return $data;
2436 root 1.249 }
2437    
2438 root 1.250 db_get cache => "$id/data"
2439     }
2440    
2441     =item fork_call { }, $args
2442    
2443     Executes the given code block with the given arguments in a seperate
2444     process, returning the results. Everything must be serialisable with
2445     Coro::Storable. May, of course, block. Note that the executed sub may
2446     never block itself or use any form of Event handling.
2447    
2448     =cut
2449    
2450     sub fork_call(&@) {
2451     my ($cb, @args) = @_;
2452    
2453     # socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454     # or die "socketpair: $!";
2455     pipe my $fh1, my $fh2
2456     or die "pipe: $!";
2457    
2458     if (my $pid = fork) {
2459     close $fh2;
2460    
2461     my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462     $res = Coro::Storable::thaw $res;
2463    
2464     waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465    
2466     die $$res unless "ARRAY" eq ref $res;
2467    
2468     return wantarray ? @$res : $res->[-1];
2469 root 1.249 } else {
2470 root 1.262 reset_signals;
2471 root 1.251 local $SIG{__WARN__};
2472 root 1.262 local $SIG{__DIE__};
2473 root 1.250 eval {
2474     close $fh1;
2475    
2476     my @res = eval { $cb->(@args) };
2477     syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478     };
2479    
2480 root 1.251 warn $@ if $@;
2481 root 1.250 _exit 0;
2482 root 1.249 }
2483 root 1.250 }
2484 root 1.249
2485 root 1.65 #############################################################################
2486 root 1.203 # the server's init and main functions
2487    
2488 root 1.246 sub load_facedata($) {
2489     my ($path) = @_;
2490 root 1.223
2491 root 1.229 warn "loading facedata from $path\n";
2492 root 1.223
2493 root 1.236 my $facedata;
2494     0 < aio_load $path, $facedata
2495 root 1.223 or die "$path: $!";
2496    
2497 root 1.237 $facedata = Coro::Storable::thaw $facedata;
2498 root 1.223
2499 root 1.236 $facedata->{version} == 2
2500 root 1.226 or cf::cleanup "$path: version mismatch, cannot proceed.";
2501    
2502 root 1.236 {
2503     my $faces = $facedata->{faceinfo};
2504    
2505     while (my ($face, $info) = each %$faces) {
2506     my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507     cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2508     cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509     cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510     Coro::cede;
2511     }
2512    
2513     while (my ($face, $info) = each %$faces) {
2514     next unless $info->{smooth};
2515     my $idx = cf::face::find $face
2516     or next;
2517     if (my $smooth = cf::face::find $info->{smooth}) {
2518     cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2519     } else {
2520     warn "smooth face '$info->{smooth}' not found for face '$face'";
2521     }
2522     Coro::cede;
2523     }
2524 root 1.223 }
2525    
2526 root 1.236 {
2527     my $anims = $facedata->{animinfo};
2528    
2529     while (my ($anim, $info) = each %$anims) {
2530     cf::anim::set $anim, $info->{frames}, $info->{facings};
2531     Coro::cede;
2532 root 1.225 }
2533 root 1.236
2534     cf::anim::invalidate_all; # d'oh
2535 root 1.225 }
2536    
2537 root 1.223 1
2538     }
2539    
2540 root 1.253 sub reload_regions {
2541     load_resource_file "$MAPDIR/regions"
2542     or die "unable to load regions file\n";
2543     }
2544    
2545 root 1.246 sub reload_facedata {
2546 root 1.253 load_facedata "$DATADIR/facedata"
2547 root 1.246 or die "unable to load facedata\n";
2548     }
2549    
2550     sub reload_archetypes {
2551 root 1.253 load_resource_file "$DATADIR/archetypes"
2552 root 1.246 or die "unable to load archetypes\n";
2553 root 1.241 }
2554    
2555 root 1.246 sub reload_treasures {
2556 root 1.253 load_resource_file "$DATADIR/treasures"
2557 root 1.246 or die "unable to load treasurelists\n";
2558 root 1.241 }
2559    
2560 root 1.223 sub reload_resources {
2561 root 1.245 warn "reloading resource files...\n";
2562    
2563 root 1.246 reload_regions;
2564     reload_facedata;
2565     reload_archetypes;
2566     reload_treasures;
2567 root 1.245
2568     warn "finished reloading resource files\n";
2569 root 1.223 }
2570    
2571     sub init {
2572     reload_resources;
2573 root 1.203 }
2574 root 1.34
2575 root 1.73 sub cfg_load {
2576 root 1.253 open my $fh, "<:utf8", "$CONFDIR/config"
2577 root 1.72 or return;
2578    
2579     local $/;
2580     *CFG = YAML::Syck::Load <$fh>;
2581 root 1.131
2582     $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2583    
2584 root 1.139 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2585     $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2586    
2587 root 1.131 if (exists $CFG{mlockall}) {
2588     eval {
2589 root 1.147 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2590 root 1.131 and die "WARNING: m(un)lockall failed: $!\n";
2591     };
2592     warn $@ if $@;
2593     }
2594 root 1.72 }
2595    
2596 root 1.39 sub main {
2597 root 1.108 # we must not ever block the main coroutine
2598     local $Coro::idle = sub {
2599 root 1.115 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2600 root 1.175 (async {
2601     Event::one_event;
2602     })->prio (Coro::PRIO_MAX);
2603 root 1.108 };
2604    
2605 root 1.73 cfg_load;
2606 root 1.210 db_init;
2607 root 1.61 load_extensions;
2608 root 1.183
2609     $TICK_WATCHER->start;
2610 root 1.34 Event::loop;
2611     }
2612    
2613     #############################################################################
2614 root 1.155 # initialisation and cleanup
2615    
2616     # install some emergency cleanup handlers
2617     BEGIN {
2618     for my $signal (qw(INT HUP TERM)) {
2619     Event->signal (
2620 root 1.189 reentrant => 0,
2621     data => WF_AUTOCANCEL,
2622     signal => $signal,
2623 root 1.191 prio => 0,
2624 root 1.189 cb => sub {
2625 root 1.155 cf::cleanup "SIG$signal";
2626     },
2627     );
2628     }
2629     }
2630    
2631 root 1.156 sub emergency_save() {
2632 root 1.155 my $freeze_guard = cf::freeze_mainloop;
2633    
2634     warn "enter emergency perl save\n";
2635    
2636     cf::sync_job {
2637     # use a peculiar iteration method to avoid tripping on perl
2638     # refcount bugs in for. also avoids problems with players
2639 root 1.167 # and maps saved/destroyed asynchronously.
2640 root 1.155 warn "begin emergency player save\n";
2641     for my $login (keys %cf::PLAYER) {
2642     my $pl = $cf::PLAYER{$login} or next;
2643     $pl->valid or next;
2644     $pl->save;
2645     }
2646     warn "end emergency player save\n";
2647    
2648     warn "begin emergency map save\n";
2649     for my $path (keys %cf::MAP) {
2650     my $map = $cf::MAP{$path} or next;
2651     $map->valid or next;
2652     $map->save;
2653     }
2654     warn "end emergency map save\n";
2655 root 1.208
2656     warn "begin emergency database checkpoint\n";
2657     BDB::db_env_txn_checkpoint $DB_ENV;
2658     warn "end emergency database checkpoint\n";
2659 root 1.155 };
2660    
2661     warn "leave emergency perl save\n";
2662     }
2663 root 1.22
2664 root 1.211 sub post_cleanup {
2665     my ($make_core) = @_;
2666    
2667     warn Carp::longmess "post_cleanup backtrace"
2668     if $make_core;
2669     }
2670    
2671 root 1.246 sub do_reload_perl() {
2672 root 1.106 # can/must only be called in main
2673     if ($Coro::current != $Coro::main) {
2674 root 1.183 warn "can only reload from main coroutine";
2675 root 1.106 return;
2676     }
2677    
2678 root 1.103 warn "reloading...";
2679    
2680 root 1.212 warn "entering sync_job";
2681    
2682 root 1.213 cf::sync_job {
2683 root 1.214 cf::write_runtime; # external watchdog should not bark
2684 root 1.212 cf::emergency_save;
2685 root 1.214 cf::write_runtime; # external watchdog should not bark
2686 root 1.183
2687 root 1.212 warn "syncing database to disk";
2688     BDB::db_env_txn_checkpoint $DB_ENV;
2689 root 1.106
2690     # if anything goes wrong in here, we should simply crash as we already saved
2691 root 1.65
2692 root 1.183 warn "cancelling all WF_AUTOCANCEL watchers";
2693 root 1.87 for (Event::all_watchers) {
2694     $_->cancel if $_->data & WF_AUTOCANCEL;
2695     }
2696 root 1.65
2697 root 1.183 warn "flushing outstanding aio requests";
2698     for (;;) {
2699 root 1.208 BDB::flush;
2700 root 1.183 IO::AIO::flush;
2701     Coro::cede;
2702 root 1.208 last unless IO::AIO::nreqs || BDB::nreqs;
2703 root 1.183 warn "iterate...";
2704     }
2705    
2706 root 1.223 ++$RELOAD;
2707    
2708 root 1.183 warn "cancelling all extension coros";
2709 root 1.103 $_->cancel for values %EXT_CORO;
2710     %EXT_CORO = ();
2711    
2712 root 1.183 warn "removing commands";
2713 root 1.159 %COMMAND = ();
2714    
2715 root 1.183 warn "removing ext commands";
2716 root 1.159 %EXTCMD = ();
2717    
2718 root 1.183 warn "unloading/nuking all extensions";
2719 root 1.159 for my $pkg (@EXTS) {
2720 root 1.160 warn "... unloading $pkg";
2721 root 1.159
2722     if (my $cb = $pkg->can ("unload")) {
2723     eval {
2724     $cb->($pkg);
2725     1
2726     } or warn "$pkg unloaded, but with errors: $@";
2727     }
2728    
2729 root 1.160 warn "... nuking $pkg";
2730 root 1.159 Symbol::delete_package $pkg;
2731 root 1.65 }
2732    
2733 root 1.183 warn "unloading all perl modules loaded from $LIBDIR";
2734 root 1.65 while (my ($k, $v) = each %INC) {
2735     next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2736    
2737 root 1.183 warn "... unloading $k";
2738 root 1.65 delete $INC{$k};
2739    
2740     $k =~ s/\.pm$//;
2741     $k =~ s/\//::/g;
2742    
2743     if (my $cb = $k->can ("unload_module")) {
2744     $cb->();
2745     }
2746    
2747     Symbol::delete_package $k;
2748     }
2749    
2750 root 1.183 warn "getting rid of safe::, as good as possible";
2751 root 1.65 Symbol::delete_package "safe::$_"
2752 root 1.103 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2753 root 1.65
2754 root 1.183 warn "unloading cf.pm \"a bit\"";
2755 root 1.65 delete $INC{"cf.pm"};
2756 root 1.252 delete $INC{"cf/pod.pm"};
2757 root 1.65
2758     # don't, removes xs symbols, too,
2759     # and global variables created in xs
2760     #Symbol::delete_package __PACKAGE__;
2761    
2762 root 1.183 warn "unload completed, starting to reload now";
2763    
2764 root 1.103 warn "reloading cf.pm";
2765 root 1.65 require cf;
2766 root 1.100 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2767    
2768 root 1.183 warn "loading config and database again";
2769 root 1.73 cf::cfg_load;
2770 root 1.65
2771 root 1.183 warn "loading extensions";
2772 root 1.65 cf::load_extensions;
2773    
2774 root 1.183 warn "reattaching attachments to objects/players";
2775 root 1.222 _global_reattach; # objects, sockets
2776 root 1.183 warn "reattaching attachments to maps";
2777 root 1.144 reattach $_ for values %MAP;
2778 root 1.222 warn "reattaching attachments to players";
2779     reattach $_ for values %PLAYER;
2780 root 1.183
2781 root 1.212 warn "leaving sync_job";
2782 root 1.183
2783 root 1.212 1
2784     } or do {
2785 root 1.106 warn $@;
2786     warn "error while reloading, exiting.";
2787     exit 1;
2788 root 1.212 };
2789 root 1.106
2790 root 1.159 warn "reloaded";
2791 root 1.65 };
2792    
2793 root 1.175 our $RELOAD_WATCHER; # used only during reload
2794    
2795 root 1.246 sub reload_perl() {
2796     # doing reload synchronously and two reloads happen back-to-back,
2797     # coro crashes during coro_state_free->destroy here.
2798    
2799     $RELOAD_WATCHER ||= Event->timer (
2800     reentrant => 0,
2801     after => 0,
2802     data => WF_AUTOCANCEL,
2803     cb => sub {
2804     do_reload_perl;
2805     undef $RELOAD_WATCHER;
2806     },
2807     );
2808     }
2809    
2810 root 1.111 register_command "reload" => sub {
2811 root 1.65 my ($who, $arg) = @_;
2812    
2813     if ($who->flag (FLAG_WIZ)) {
2814 root 1.175 $who->message ("reloading server.");
2815 root 1.246 async { reload_perl };
2816 root 1.65 }
2817     };
2818    
2819 root 1.27 unshift @INC, $LIBDIR;
2820 root 1.17
2821 root 1.183 my $bug_warning = 0;
2822    
2823 root 1.239 our @WAIT_FOR_TICK;
2824     our @WAIT_FOR_TICK_BEGIN;
2825    
2826     sub wait_for_tick {
2827 root 1.240 return unless $TICK_WATCHER->is_active;
2828 root 1.241 return if $Coro::current == $Coro::main;
2829    
2830 root 1.239 my $signal = new Coro::Signal;
2831     push @WAIT_FOR_TICK, $signal;
2832     $signal->wait;
2833     }
2834    
2835     sub wait_for_tick_begin {
2836 root 1.240 return unless $TICK_WATCHER->is_active;
2837 root 1.241 return if $Coro::current == $Coro::main;
2838    
2839 root 1.239 my $signal = new Coro::Signal;
2840     push @WAIT_FOR_TICK_BEGIN, $signal;
2841     $signal->wait;
2842     }
2843    
2844 root 1.268 my $min = 1e6;#d#
2845     my $avg = 10;
2846 root 1.35 $TICK_WATCHER = Event->timer (
2847 root 1.104 reentrant => 0,
2848 root 1.183 parked => 1,
2849 root 1.191 prio => 0,
2850 root 1.104 at => $NEXT_TICK || $TICK,
2851     data => WF_AUTOCANCEL,
2852     cb => sub {
2853 root 1.183 if ($Coro::current != $Coro::main) {
2854     Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2855     unless ++$bug_warning > 10;
2856     return;
2857     }
2858    
2859 root 1.265 $NOW = $tick_start = Event::time;
2860 root 1.163
2861 root 1.133 cf::server_tick; # one server iteration
2862 root 1.245
2863 root 1.268 0 && sync_job {#d#
2864     for(1..10) {
2865     my $t = Event::time;
2866     my $map = my $map = new_from_path cf::map "/tmp/x.map"
2867     or die;
2868    
2869     $map->width (50);
2870     $map->height (50);
2871     $map->alloc;
2872     $map->_load_objects ("/tmp/x.map", 1);
2873     my $t = Event::time - $t;
2874    
2875     #next unless $t < 0.0013;#d#
2876     if ($t < $min) {
2877     $min = $t;
2878     }
2879     $avg = $avg * 0.99 + $t * 0.01;
2880     }
2881     warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2882     exit 0;
2883     # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2884     };
2885    
2886 root 1.133 $RUNTIME += $TICK;
2887 root 1.35 $NEXT_TICK += $TICK;
2888    
2889 root 1.214 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2890     $NEXT_RUNTIME_WRITE = $NOW + 10;
2891     Coro::async_pool {
2892     write_runtime
2893     or warn "ERROR: unable to write runtime file: $!";
2894     };
2895     }
2896    
2897 root 1.191 # my $AFTER = Event::time;
2898     # warn $AFTER - $NOW;#d#
2899 root 1.190
2900 root 1.245 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2901     $sig->send;
2902     }
2903     while (my $sig = shift @WAIT_FOR_TICK) {
2904     $sig->send;
2905     }
2906    
2907 root 1.265 $NOW = Event::time;
2908    
2909     # if we are delayed by four ticks or more, skip them all
2910     $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2911    
2912     $TICK_WATCHER->at ($NEXT_TICK);
2913     $TICK_WATCHER->start;
2914    
2915     $LOAD = ($NOW - $tick_start) / $TICK;
2916     $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2917    
2918 root 1.245 _post_tick;
2919 root 1.265
2920    
2921 root 1.35 },
2922     );
2923    
2924 root 1.206 {
2925     BDB::max_poll_time $TICK * 0.1;
2926     $BDB_POLL_WATCHER = Event->io (
2927     reentrant => 0,
2928     fd => BDB::poll_fileno,
2929     poll => 'r',
2930     prio => 0,
2931     data => WF_AUTOCANCEL,
2932     cb => \&BDB::poll_cb,
2933     );
2934     BDB::min_parallel 8;
2935    
2936     BDB::set_sync_prepare {
2937     my $status;
2938     my $current = $Coro::current;
2939     (
2940     sub {
2941     $status = $!;
2942     $current->ready; undef $current;
2943     },
2944     sub {
2945     Coro::schedule while defined $current;
2946     $! = $status;
2947     },
2948     )
2949     };
2950 root 1.77
2951 root 1.206 unless ($DB_ENV) {
2952     $DB_ENV = BDB::db_env_create;
2953    
2954     cf::sync_job {
2955 root 1.208 eval {
2956     BDB::db_env_open
2957     $DB_ENV,
2958 root 1.253 $BDBDIR,
2959 root 1.208 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2960     | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2961     0666;
2962    
2963 root 1.253 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2964 root 1.208
2965     $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2966     $DB_ENV->set_lk_detect;
2967     };
2968    
2969     cf::cleanup "db_env_open(db): $@" if $@;
2970 root 1.206 };
2971     }
2972     }
2973    
2974     {
2975     IO::AIO::min_parallel 8;
2976    
2977     undef $Coro::AIO::WATCHER;
2978     IO::AIO::max_poll_time $TICK * 0.1;
2979     $AIO_POLL_WATCHER = Event->io (
2980     reentrant => 0,
2981 root 1.214 data => WF_AUTOCANCEL,
2982 root 1.206 fd => IO::AIO::poll_fileno,
2983     poll => 'r',
2984     prio => 6,
2985     cb => \&IO::AIO::poll_cb,
2986     );
2987     }
2988 root 1.108
2989 root 1.262 my $_log_backtrace;
2990    
2991 root 1.260 sub _log_backtrace {
2992     my ($msg, @addr) = @_;
2993    
2994 root 1.262 $msg =~ s/\n//;
2995 root 1.260
2996 root 1.262 # limit the # of concurrent backtraces
2997     if ($_log_backtrace < 2) {
2998     ++$_log_backtrace;
2999     async {
3000     my @bt = fork_call {
3001     @addr = map { sprintf "%x", $_ } @addr;
3002     my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3003     open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3004     or die "addr2line: $!";
3005    
3006     my @funcs;
3007     my @res = <$fh>;
3008     chomp for @res;
3009     while (@res) {
3010     my ($func, $line) = splice @res, 0, 2, ();
3011     push @funcs, "[$func] $line";
3012     }
3013 root 1.260
3014 root 1.262 @funcs
3015     };
3016 root 1.260
3017 root 1.262 LOG llevInfo, "[ABT] $msg\n";
3018     LOG llevInfo, "[ABT] $_\n" for @bt;
3019     --$_log_backtrace;
3020     };
3021     } else {
3022 root 1.260 LOG llevInfo, "[ABT] $msg\n";
3023 root 1.262 LOG llevInfo, "[ABT] [suppressed]\n";
3024     }
3025 root 1.260 }
3026    
3027 root 1.249 # load additional modules
3028     use cf::pod;
3029    
3030 root 1.125 END { cf::emergency_save }
3031    
3032 root 1.1 1
3033