ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.192 by root, Wed Jan 24 01:43:01 2007 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.4 ();
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Data::Dumper;
		21	use Digest::MD5;
		22	use Fcntl;
10	use IO::AIO ();	23	use IO::AIO 2.32 ();
11	use YAML::Syck ();	24	use YAML::Syck ();
12	use Time::HiRes;	25	use Time::HiRes;
13	use Event;	26
14	$Event::Eval = 1; # no idea why this is required, but it is	27	use Event; $Event::Eval = 1; # no idea why this is required, but it is
		28
		29	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15		30
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	31	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	32	$YAML::Syck::ImplicitUnicode = 1;
18		33
19	use strict;	34	$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		35
23	our %COMMAND = ();	36	our %COMMAND = ();
24	our %COMMAND_TIME = ();	37	our %COMMAND_TIME = ();
		38
		39	our @EXTS = (); # list of extension package names
25	our %EXTCMD = ();	40	our %EXTCMD = ();
26		41	our %EXT_CORO = (); # coroutines bound to extensions
27	_init_vars;	42	our %EXT_MAP = (); # pluggable maps
28		43
29	our @EVENT;	44	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	45	our $LIBDIR = datadir . "/ext";
31		46
32	our $TICK = MAX_TIME * 1e-6;	47	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	48	our $TICK_WATCHER;
		49	our $AIO_POLL_WATCHER;
		50	our $WRITE_RUNTIME_WATCHER;
34	our $NEXT_TICK;	51	our $NEXT_TICK;
		52	our $NOW;
35		53
36	our %CFG;	54	our %CFG;
37		55
38	our $UPTIME; $UPTIME ||= time;	56	our $UPTIME; $UPTIME ||= time;
		57	our $RUNTIME;
		58
		59	our %PLAYER; # all users
		60	our %MAP; # all maps
		61	our $LINK_MAP; # the special {link} map, which is always available
		62	our $RANDOM_MAPS = cf::localdir . "/random";
		63
		64	our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
		65	our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
		66
		67	# used to convert map paths into valid unix filenames by replacing / by ∕
		68	our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
		69
		70	binmode STDOUT;
		71	binmode STDERR;
		72
		73	# read virtual server time, if available
		74	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		75	open my $fh, "<", cf::localdir . "/runtime"
		76	or die "unable to read runtime file: $!";
		77	$RUNTIME = <$fh> + 0.;
		78	}
		79
		80	mkdir cf::localdir;
		81	mkdir cf::localdir . "/" . cf::playerdir;
		82	mkdir cf::localdir . "/" . cf::tmpdir;
		83	mkdir cf::localdir . "/" . cf::uniquedir;
		84	mkdir $RANDOM_MAPS;
		85
		86	our $EMERGENCY_POSITION;
39		87
40	#############################################################################	88	#############################################################################
41		89
42	=head2 GLOBAL VARIABLES	90	=head2 GLOBAL VARIABLES
43		91
44	=over 4	92	=over 4
45		93
46	=item $cf::UPTIME	94	=item $cf::UPTIME
47		95
48	The timestamp of the server start (so not actually an uptime).	96	The timestamp of the server start (so not actually an uptime).
		97
		98	=item $cf::RUNTIME
		99
		100	The time this server has run, starts at 0 and is increased by $cf::TICK on
		101	every server tick.
49		102
50	=item $cf::LIBDIR	103	=item $cf::LIBDIR
51		104
52	The perl library directory, where extensions and cf-specific modules can	105	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	106	be found. It will be added to C<@INC> automatically.
54		107
		108	=item $cf::NOW
		109
		110	The time of the last (current) server tick.
		111
55	=item $cf::TICK	112	=item $cf::TICK
56		113
57	The interval between server ticks, in seconds.	114	The interval between server ticks, in seconds.
58		115
59	=item %cf::CFG	116	=item %cf::CFG
60		117
61	Configuration for the server, loaded from C</etc/crossfire/config>, or	118	Configuration for the server, loaded from C</etc/crossfire/config>, or
62	from wherever your confdir points to.	119	from wherever your confdir points to.
		120
		121	=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
		122
		123	These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
		124	or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
		125	processing has been done. Call C<< ->wait >> on them to maximise the
		126	window of cpu time available, or simply to synchronise to the server tick.
63		127
64	=back	128	=back
65		129
66	=cut	130	=cut
67		131
68	BEGIN {	132	BEGIN {
69	*CORE::GLOBAL::warn = sub {	133	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	134	my $msg = join "", @_;
		135	utf8::encode $msg;
		136
71	$msg .= "\n"	137	$msg .= "\n"
72	unless $msg =~ /\n$/;	138	unless $msg =~ /\n$/;
73		139
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	140	LOG llevError, $msg;
76	};	141	};
77	}	142	}
78		143
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	144	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';	145	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
…		…
84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	149	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85		150
86	# we bless all objects into (empty) derived classes to force a method lookup	151	# we bless all objects into (empty) derived classes to force a method lookup
87	# within the Safe compartment.	152	# within the Safe compartment.
88	for my $pkg (qw(	153	for my $pkg (qw(
89	cf::global	154	cf::global cf::attachable
90	cf::object cf::object::player	155	cf::object cf::object::player
91	cf::client cf::player	156	cf::client cf::player
92	cf::arch cf::living	157	cf::arch cf::living
93	cf::map cf::party cf::region	158	cf::map cf::party cf::region
94	)) {	159	)) {
…		…
98		163
99	$Event::DIED = sub {	164	$Event::DIED = sub {
100	warn "error in event callback: @_";	165	warn "error in event callback: @_";
101	};	166	};
102		167
103	my %ext_pkg;
104	my @exts;
105	my @hook;
106
107	=head2 UTILITY FUNCTIONS	168	=head2 UTILITY FUNCTIONS
108		169
109	=over 4	170	=over 4
110		171
		172	=item dumpval $ref
		173
111	=cut	174	=cut
		175
		176	sub dumpval {
		177	eval {
		178	local $SIG{__DIE__};
		179	my $d;
		180	if (1) {
		181	$d = new Data::Dumper([$_[0]], ["*var"]);
		182	$d->Terse(1);
		183	$d->Indent(2);
		184	$d->Quotekeys(0);
		185	$d->Useqq(1);
		186	#$d->Bless(...);
		187	$d->Seen($_[1]) if @_ > 1;
		188	$d = $d->Dump();
		189	}
		190	$d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
		191	$d
		192	} || "[unable to dump $_[0]: '$@']";
		193	}
112		194
113	use JSON::Syck (); # TODO# replace by JSON::PC once working	195	use JSON::Syck (); # TODO# replace by JSON::PC once working
114		196
115	=item $ref = cf::from_json $json	197	=item $ref = cf::from_json $json
116		198
…		…
132	sub to_json($) {	214	sub to_json($) {
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	215	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134	JSON::Syck::Dump $_[0]	216	JSON::Syck::Dump $_[0]
135	}	217	}
136		218
		219	=item cf::lock_wait $string
		220
		221	Wait until the given lock is available. See cf::lock_acquire.
		222
		223	=item my $lock = cf::lock_acquire $string
		224
		225	Wait until the given lock is available and then acquires it and returns
		226	a Coro::guard object. If the guard object gets destroyed (goes out of scope,
		227	for example when the coroutine gets canceled), the lock is automatically
		228	returned.
		229
		230	Lock names should begin with a unique identifier (for example, cf::map::find
		231	uses map_find and cf::map::load uses map_load).
		232
		233	=cut
		234
		235	our %LOCK;
		236
		237	sub lock_wait($) {
		238	my ($key) = @_;
		239
		240	# wait for lock, if any
		241	while ($LOCK{$key}) {
		242	push @{ $LOCK{$key} }, $Coro::current;
		243	Coro::schedule;
		244	}
		245	}
		246
		247	sub lock_acquire($) {
		248	my ($key) = @_;
		249
		250	# wait, to be sure we are not locked
		251	lock_wait $key;
		252
		253	$LOCK{$key} = [];
		254
		255	Coro::guard {
		256	# wake up all waiters, to be on the safe side
		257	$_->ready for @{ delete $LOCK{$key} };
		258	}
		259	}
		260
		261	sub freeze_mainloop {
		262	return unless $TICK_WATCHER->is_active;
		263
		264	my $guard = Coro::guard {
		265	$TICK_WATCHER->start;
		266	$WRITE_RUNTIME_WATCHER->start;
		267	};
		268	$WRITE_RUNTIME_WATCHER->stop;
		269	$TICK_WATCHER->stop;
		270	$guard
		271	}
		272
		273	=item cf::async { BLOCK }
		274
		275	Currently the same as Coro::async_pool, meaning you cannot use
		276	C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
		277	thing you are allowed to do is call C<prio> on it.
		278
		279	=cut
		280
		281	BEGIN { *async = \&Coro::async_pool }
		282
		283	=item cf::sync_job { BLOCK }
		284
		285	The design of crossfire+ requires that the main coro ($Coro::main) is
		286	always able to handle events or runnable, as crossfire+ is only partly
		287	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		288
		289	If it must be done, put the blocking parts into C<sync_job>. This will run
		290	the given BLOCK in another coroutine while waiting for the result. The
		291	server will be frozen during this time, so the block should either finish
		292	fast or be very important.
		293
		294	=cut
		295
		296	sub sync_job(&) {
		297	my ($job) = @_;
		298
		299	if ($Coro::current == $Coro::main) {
		300	# this is the main coro, too bad, we have to block
		301	# till the operation succeeds, freezing the server :/
		302
		303	# TODO: use suspend/resume instead
		304	# (but this is cancel-safe)
		305	my $freeze_guard = freeze_mainloop;
		306
		307	my $busy = 1;
		308	my @res;
		309
		310	(async {
		311	@res = eval { $job->() };
		312	warn $@ if $@;
		313	undef $busy;
		314	})->prio (Coro::PRIO_MAX);
		315
		316	while ($busy) {
		317	Coro::cede or Event::one_event;
		318	}
		319
		320	wantarray ? @res : $res[0]
		321	} else {
		322	# we are in another coroutine, how wonderful, everything just works
		323
		324	$job->()
		325	}
		326	}
		327
		328	=item $coro = cf::async_ext { BLOCK }
		329
		330	Like async, but this coro is automatically being canceled when the
		331	extension calling this is being unloaded.
		332
		333	=cut
		334
		335	sub async_ext(&) {
		336	my $cb = shift;
		337
		338	my $coro = &Coro::async ($cb);
		339
		340	$coro->on_destroy (sub {
		341	delete $EXT_CORO{$coro+0};
		342	});
		343	$EXT_CORO{$coro+0} = $coro;
		344
		345	$coro
		346	}
		347
		348	sub write_runtime {
		349	my $runtime = cf::localdir . "/runtime";
		350
		351	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		352	or return;
		353
		354	my $value = $cf::RUNTIME + 90 + 10;
		355	# 10 is the runtime save interval, for a monotonic clock
		356	# 60 allows for the watchdog to kill the server.
		357
		358	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		359	and return;
		360
		361	aio_fsync $fh
		362	and return;
		363
		364	close $fh
		365	or return;
		366
		367	aio_rename "$runtime~", $runtime
		368	and return;
		369
		370	1
		371	}
		372
137	=back	373	=back
138		374
139	=cut	375	=cut
140		376
141	#############################################################################	377	#############################################################################
142		378
143	=head2 ATTACHABLE OBJECTS	379	=head2 ATTACHABLE OBJECTS
144		380
145	You can define and attach attachments to each "attachable" object in	381	Many objects in crossfire are so-called attachable objects. That means you can
146	crossfire+ (objects, players, clients, maps and the special "global"	382	attach callbacks/event handlers (a collection of which is called an "attachment")
		383	to it. All such attachable objects support the following methods.
		384
147	class). In the following description, CLASS can be any of C<global>,	385	In the following description, CLASS can be any of C<global>, C<object>
148	C<object> C<player>, C<client> or C<map>.	386	C<player>, C<client> or C<map> (i.e. the attachable objects in
		387	crossfire+).
149		388
150	=over 4	389	=over 4
151		390
		391	=item $attachable->attach ($attachment, key => $value...)
		392
		393	=item $attachable->detach ($attachment)
		394
		395	Attach/detach a pre-registered attachment to a specific object and give it
		396	the specified key/value pairs as arguments.
		397
		398	Example, attach a minesweeper attachment to the given object, making it a
		399	10x10 minesweeper game:
		400
		401	$obj->attach (minesweeper => width => 10, height => 10);
		402
		403	=item $bool = $attachable->attached ($name)
		404
		405	Checks wether the named attachment is currently attached to the object.
		406
		407	=item cf::CLASS->attach ...
		408
		409	=item cf::CLASS->detach ...
		410
		411	Define an anonymous attachment and attach it to all objects of the given
		412	CLASS. See the next function for an explanation of its arguments.
		413
		414	You can attach to global events by using the C<cf::global> class.
		415
		416	Example, log all player logins:
		417
		418	cf::player->attach (
		419	on_login => sub {
		420	my ($pl) = @_;
		421	...
		422	},
		423	);
		424
		425	Example, attach to the jeweler skill:
		426
		427	cf::object->attach (
		428	type => cf::SKILL,
		429	subtype => cf::SK_JEWELER,
		430	on_use_skill => sub {
		431	my ($sk, $ob, $part, $dir, $msg) = @_;
		432	...
		433	},
		434	);
		435
152	=item cf::CLASS::attachment $name, ...	436	=item cf::CLASS::attachment $name, ...
153		437
154	Register an attachment by name through which attachable objects can refer	438	Register an attachment by C<$name> through which attachable objects of the
155	to this attachment.	439	given CLASS can refer to this attachment.
156		440
157	=item $bool = $attachable->attached ($name)	441	Some classes such as crossfire maps and objects can specify attachments
		442	that are attached at load/instantiate time, thus the need for a name.
158		443
159	Checks wether the named attachment is currently attached to the object.
160
161	=item $attachable->attach ($attachment, key => $value...)
162
163	=item $attachable->detach ($attachment)
164
165	Attach/detach a pre-registered attachment either to a specific object
166	(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167	class in a static method call).
168
169	You can attach to global events by using the C<cf::global> class.
170
171	These method calls expect any number of the following handler/hook	444	These calls expect any number of the following handler/hook descriptions:
172	descriptions:
173		445
174	=over 4	446	=over 4
175		447
176	=item prio => $number	448	=item prio => $number
177		449
…		…
203	package and register them. Only handlers for eevents supported by the	475	package and register them. Only handlers for eevents supported by the
204	object/class are recognised.	476	object/class are recognised.
205		477
206	=back	478	=back
207		479
		480	Example, define an attachment called "sockpuppet" that calls the given
		481	event handler when a monster attacks:
		482
		483	cf::object::attachment sockpuppet =>
		484	on_skill_attack => sub {
		485	my ($self, $victim) = @_;
		486	...
		487	}
		488	}
		489
		490	=item $attachable->valid
		491
		492	Just because you have a perl object does not mean that the corresponding
		493	C-level object still exists. If you try to access an object that has no
		494	valid C counterpart anymore you get an exception at runtime. This method
		495	can be used to test for existence of the C object part without causing an
		496	exception.
		497
208	=cut	498	=cut
209		499
210	# the following variables are defined in .xs and must not be re-created	500	# the following variables are defined in .xs and must not be re-created
211	our @CB_GLOBAL = (); # registry for all global events	501	our @CB_GLOBAL = (); # registry for all global events
		502	our @CB_ATTACHABLE = (); # registry for all attachables
212	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	503	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213	our @CB_PLAYER = ();	504	our @CB_PLAYER = ();
214	our @CB_CLIENT = ();	505	our @CB_CLIENT = ();
215	our @CB_TYPE = (); # registry for type (cf-object class) based events	506	our @CB_TYPE = (); # registry for type (cf-object class) based events
216	our @CB_MAP = ();	507	our @CB_MAP = ();
217		508
218	my %attachment;	509	my %attachment;
		510
		511	sub cf::attachable::thawer_merge {
		512	# simply override everything except _meta
		513	local $_[0]{_meta};
		514	%{$_[0]} = %{$_[1]};
		515	}
219		516
220	sub _attach_cb($$$$) {	517	sub _attach_cb($$$$) {
221	my ($registry, $event, $prio, $cb) = @_;	518	my ($registry, $event, $prio, $cb) = @_;
222		519
223	use sort 'stable';	520	use sort 'stable';
…		…
226		523
227	@{$registry->[$event]} = sort	524	@{$registry->[$event]} = sort
228	{ $a->[0] cmp $b->[0] }	525	{ $a->[0] cmp $b->[0] }
229	@{$registry->[$event] || []}, $cb;	526	@{$registry->[$event] || []}, $cb;
230	}	527	}
		528
		529	# hack
		530	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231		531
232	# attach handles attaching event callbacks	532	# attach handles attaching event callbacks
233	# the only thing the caller has to do is pass the correct	533	# the only thing the caller has to do is pass the correct
234	# registry (== where the callback attaches to).	534	# registry (== where the callback attaches to).
235	sub _attach {	535	sub _attach {
…		…
237		537
238	my $object_type;	538	my $object_type;
239	my $prio = 0;	539	my $prio = 0;
240	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	540	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241		541
		542	#TODO: get rid of this hack
		543	if ($attachable_klass{$klass}) {
		544	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		545	}
		546
242	while (@arg) {	547	while (@arg) {
243	my $type = shift @arg;	548	my $type = shift @arg;
244		549
245	if ($type eq "prio") {	550	if ($type eq "prio") {
246	$prio = shift @arg;	551	$prio = shift @arg;
…		…
321	my ($obj, $name) = @_;	626	my ($obj, $name) = @_;
322		627
323	exists $obj->{_attachment}{$name}	628	exists $obj->{_attachment}{$name}
324	}	629	}
325		630
326	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	631	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327	eval "#line " . __LINE__ . " 'cf.pm'	632	eval "#line " . __LINE__ . " 'cf.pm'
328	sub cf::\L$klass\E::_attach_registry {	633	sub cf::\L$klass\E::_attach_registry {
329	(\\\@CB_$klass, KLASS_$klass)	634	(\\\@CB_$klass, KLASS_$klass)
330	}	635	}
331		636
…		…
367	}	672	}
368		673
369	0	674	0
370	}	675	}
371		676
372	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	677	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
373		678
374	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
375
376	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	679	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379		680
380	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382	Generate a global/object/player/map-specific event with the given arguments.	681	Generate an object-specific event with the given arguments.
383		682
384	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	683	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
385	removed in future versions), and there is no public API to access override	684	removed in future versions), and there is no public API to access override
386	results (if you must, access C<@cf::invoke_results> directly).	685	results (if you must, access C<@cf::invoke_results> directly).
387		686
388	=back	687	=back
389		688
390	=cut	689	=cut
391		690
392	#############################################################################	691	#############################################################################
393
394	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396	Attachable objects includes objects, players, clients and maps.
397
398	=over 4
399
400	=item $object->valid
401
402	Just because you have a perl object does not mean that the corresponding
403	C-level object still exists. If you try to access an object that has no
404	valid C counterpart anymore you get an exception at runtime. This method
405	can be used to test for existence of the C object part without causing an
406	exception.
407
408	=back
409
410	=cut
411
412	#############################################################################
413	# object support	692	# object support
414		693
415	sub instantiate {
416	my ($obj, $data) = @_;
417
418	$data = from_json $data;
419
420	for (@$data) {
421	my ($name, $args) = @$_;
422
423	$obj->attach ($name, %{$args || {} });
424	}
425	}
426
427	# basically do the same as instantiate, without calling instantiate
428	sub reattach {	694	sub reattach {
		695	# basically do the same as instantiate, without calling instantiate
429	my ($obj) = @_;	696	my ($obj) = @_;
		697
		698	bless $obj, ref $obj; # re-bless in case extensions have been reloaded
		699
430	my $registry = $obj->registry;	700	my $registry = $obj->registry;
431		701
432	@$registry = ();	702	@$registry = ();
433		703
434	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	704	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
…		…
443	warn "object uses attachment '$name' that is not available, postponing.\n";	713	warn "object uses attachment '$name' that is not available, postponing.\n";
444	}	714	}
445	}	715	}
446	}	716	}
447		717
448	sub object_freezer_save {	718	cf::attachable->attach (
449	my ($filename, $rdata, $objs) = @_;
450
451	if (length $$rdata) {
452	warn sprintf "saving %s (%d,%d)\n",
453	$filename, length $$rdata, scalar @$objs;
454
455	if (open my $fh, ">:raw", "$filename~") {
456	chmod SAVE_MODE, $fh;
457	syswrite $fh, $$rdata;
458	close $fh;
459
460	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
461	chmod SAVE_MODE, $fh;
462	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
463	close $fh;
464	rename "$filename.pst~", "$filename.pst";
465	} else {
466	unlink "$filename.pst";
467	}
468
469	rename "$filename~", $filename;
470	} else {
471	warn "FATAL: $filename~: $!\n";
472	}
473	} else {
474	unlink $filename;
475	unlink "$filename.pst";
476	}
477	}
478
479	sub object_freezer_as_string {
480	my ($rdata, $objs) = @_;
481
482	use Data::Dumper;
483
484	$$rdata . Dumper $objs
485	}
486
487	sub object_thawer_load {
488	my ($filename) = @_;
489
490	local $/;
491
492	my $av;
493
494	#TODO: use sysread etc.
495	if (open my $data, "<:raw:perlio", $filename) {
496	$data = <$data>;
497	if (open my $pst, "<:raw:perlio", "$filename.pst") {
498	$av = eval { (Storable::thaw <$pst>)->{objs} };
499	}
500	return ($data, $av);
501	}
502
503	()
504	}
505
506	cf::object->attach (
507	prio => -1000000,	719	prio => -1000000,
		720	on_instantiate => sub {
		721	my ($obj, $data) = @_;
		722
		723	$data = from_json $data;
		724
		725	for (@$data) {
		726	my ($name, $args) = @$_;
		727
		728	$obj->attach ($name, %{$args || {} });
		729	}
		730	},
		731	on_reattach => \&reattach,
508	on_clone => sub {	732	on_clone => sub {
509	my ($src, $dst) = @_;	733	my ($src, $dst) = @_;
510		734
511	@{$dst->registry} = @{$src->registry};	735	@{$dst->registry} = @{$src->registry};
512		736
…		…
515	%{$dst->{_attachment}} = %{$src->{_attachment}}	739	%{$dst->{_attachment}} = %{$src->{_attachment}}
516	if exists $src->{_attachment};	740	if exists $src->{_attachment};
517	},	741	},
518	);	742	);
519		743
		744	sub object_freezer_save {
		745	my ($filename, $rdata, $objs) = @_;
		746
		747	sync_job {
		748	if (length $$rdata) {
		749	warn sprintf "saving %s (%d,%d)\n",
		750	$filename, length $$rdata, scalar @$objs;
		751
		752	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		753	chmod SAVE_MODE, $fh;
		754	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		755	aio_fsync $fh;
		756	close $fh;
		757
		758	if (@$objs) {
		759	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		760	chmod SAVE_MODE, $fh;
		761	my $data = Storable::nfreeze { version => 1, objs => $objs };
		762	aio_write $fh, 0, (length $data), $data, 0;
		763	aio_fsync $fh;
		764	close $fh;
		765	aio_rename "$filename.pst~", "$filename.pst";
		766	}
		767	} else {
		768	aio_unlink "$filename.pst";
		769	}
		770
		771	aio_rename "$filename~", $filename;
		772	} else {
		773	warn "FATAL: $filename~: $!\n";
		774	}
		775	} else {
		776	aio_unlink $filename;
		777	aio_unlink "$filename.pst";
		778	}
		779	}
		780	}
		781
		782	sub object_freezer_as_string {
		783	my ($rdata, $objs) = @_;
		784
		785	use Data::Dumper;
		786
		787	$$rdata . Dumper $objs
		788	}
		789
		790	sub object_thawer_load {
		791	my ($filename) = @_;
		792
		793	my ($data, $av);
		794
		795	(aio_load $filename, $data) >= 0
		796	or return;
		797
		798	unless (aio_stat "$filename.pst") {
		799	(aio_load "$filename.pst", $av) >= 0
		800	or return;
		801	$av = eval { (Storable::thaw $av)->{objs} };
		802	}
		803
		804	warn sprintf "loading %s (%d)\n",
		805	$filename, length $data, scalar @{$av || []};#d#
		806	return ($data, $av);
		807	}
		808
520	#############################################################################	809	#############################################################################
521	# command handling &c	810	# command handling &c
522		811
523	=item cf::register_command $name => \&callback($ob,$args);	812	=item cf::register_command $name => \&callback($ob,$args);
524		813
…		…
546	=cut	835	=cut
547		836
548	sub register_extcmd {	837	sub register_extcmd {
549	my ($name, $cb) = @_;	838	my ($name, $cb) = @_;
550		839
551	my $caller = caller;
552	#warn "registering extcmd '$name' to '$caller'";
553
554	$EXTCMD{$name} = [$cb, $caller];	840	$EXTCMD{$name} = $cb;
555	}	841	}
556		842
557	cf::player->attach (	843	cf::player->attach (
558	on_command => sub {	844	on_command => sub {
559	my ($pl, $name, $params) = @_;	845	my ($pl, $name, $params) = @_;
…		…
572		858
573	my $msg = eval { from_json $buf };	859	my $msg = eval { from_json $buf };
574		860
575	if (ref $msg) {	861	if (ref $msg) {
576	if (my $cb = $EXTCMD{$msg->{msgtype}}) {	862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
577	if (my %reply = $cb->[0]->($pl, $msg)) {	863	if (my %reply = $cb->($pl, $msg)) {
578	$pl->ext_reply ($msg->{msgid}, %reply);	864	$pl->ext_reply ($msg->{msgid}, %reply);
579	}	865	}
580	}	866	}
581	} else {	867	} else {
582	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";	868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
…		…
584		870
585	cf::override;	871	cf::override;
586	},	872	},
587	);	873	);
588		874
589	sub register {
590	my ($base, $pkg) = @_;
591
592	#TODO
593	}
594
595	sub load_extension {	875	sub load_extension {
596	my ($path) = @_;	876	my ($path) = @_;
597		877
598	$path =~ /([^\/\\]+)\.ext$/ or die "$path";	878	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
599	my $base = $1;	879	my $base = $1;
600	my $pkg = $1;	880	my $pkg = $1;
601	$pkg =~ s/[^[:word:]]/_/g;	881	$pkg =~ s/[^[:word:]]/_/g;
602	$pkg = "ext::$pkg";	882	$pkg = "ext::$pkg";
603		883
604	warn "loading '$path' into '$pkg'\n";	884	warn "... loading '$path' into '$pkg'\n";
605		885
606	open my $fh, "<:utf8", $path	886	open my $fh, "<:utf8", $path
607	or die "$path: $!";	887	or die "$path: $!";
608		888
609	my $source =	889	my $source =
610	"package $pkg; use strict; use utf8;\n"	890	"package $pkg; use strict; use utf8;\n"
611	. "#line 1 \"$path\"\n{\n"	891	. "#line 1 \"$path\"\n{\n"
612	. (do { local $/; <$fh> })	892	. (do { local $/; <$fh> })
613	. "\n};\n1";	893	. "\n};\n1";
614		894
615	eval $source	895	unless (eval $source) {
616	or die $@ ? "$path: $@\n"	896	my $msg = $@ ? "$path: $@\n"
617	: "extension disabled.\n";	897	: "extension disabled.\n";
618		898	if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
619	push @exts, $pkg;	899	warn $@;
620	$ext_pkg{$base} = $pkg;	900	warn "mandatory extension failed to load, exiting.\n";
621		901	exit 1;
622	# no strict 'refs';	902	}
623	# @{"$pkg\::ISA"} = ext::;	903	die $@;
624
625	register $base, $pkg;
626	}
627
628	sub unload_extension {
629	my ($pkg) = @_;
630
631	warn "removing extension $pkg\n";
632
633	# remove hooks
634	#TODO
635	# for my $idx (0 .. $#PLUGIN_EVENT) {
636	# delete $hook[$idx]{$pkg};
637	# }	904	}
638		905
639	# remove commands	906	push @EXTS, $pkg;
640	for my $name (keys %COMMAND) {
641	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
642
643	if (@cb) {
644	$COMMAND{$name} = \@cb;
645	} else {
646	delete $COMMAND{$name};
647	}
648	}
649
650	# remove extcmds
651	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
652	delete $EXTCMD{$name};
653	}
654
655	if (my $cb = $pkg->can ("unload")) {
656	eval {
657	$cb->($pkg);
658	1
659	} or warn "$pkg unloaded, but with errors: $@";
660	}
661
662	Symbol::delete_package $pkg;
663	}	907	}
664		908
665	sub load_extensions {	909	sub load_extensions {
666	for my $ext (<$LIBDIR/*.ext>) {	910	for my $ext (<$LIBDIR/*.ext>) {
667	next unless -r $ext;	911	next unless -r $ext;
…		…
671	} or warn "$ext not loaded: $@";	915	} or warn "$ext not loaded: $@";
672	}	916	}
673	}	917	}
674		918
675	#############################################################################	919	#############################################################################
676	# load/save/clean perl data associated with a map
677		920
678	*cf::mapsupport::on_clean = sub {	921	=head2 CORE EXTENSIONS
		922
		923	Functions and methods that extend core crossfire objects.
		924
		925	=cut
		926
		927	package cf::player;
		928
		929	use Coro::AIO;
		930
		931	=head3 cf::player
		932
		933	=over 4
		934
		935	=item cf::player::find $login
		936
		937	Returns the given player object, loading it if necessary (might block).
		938
		939	=cut
		940
		941	sub playerdir($) {
		942	cf::localdir
		943	. "/"
		944	. cf::playerdir
		945	. "/"
		946	. (ref $_[0] ? $_[0]->ob->name : $_[0])
		947	}
		948
		949	sub path($) {
		950	my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
		951
		952	(playerdir $login) . "/$login.pl"
		953	}
		954
		955	sub find_active($) {
		956	$cf::PLAYER{$_[0]}
		957	and $cf::PLAYER{$_[0]}->active
		958	and $cf::PLAYER{$_[0]}
		959	}
		960
		961	sub exists($) {
		962	my ($login) = @_;
		963
		964	$cf::PLAYER{$login}
		965	or cf::sync_job { !aio_stat path $login }
		966	}
		967
		968	sub find($) {
		969	return $cf::PLAYER{$_[0]} || do {
		970	my $login = $_[0];
		971
		972	my $guard = cf::lock_acquire "user_find:$login";
		973
		974	$cf::PLAYER{$_[0]} || do {
		975	my $pl = load_pl path $login
		976	or return;
		977	$cf::PLAYER{$login} = $pl
		978	}
		979	}
		980	}
		981
		982	sub save($) {
		983	my ($pl) = @_;
		984
		985	return if $pl->{deny_save};
		986
		987	my $path = path $pl;
		988	my $guard = cf::lock_acquire "user_save:$path";
		989
		990	return if $pl->{deny_save};
		991
		992	aio_mkdir playerdir $pl, 0770;
		993	$pl->{last_save} = $cf::RUNTIME;
		994
		995	$pl->save_pl ($path);
		996	Coro::cede;
		997	}
		998
		999	sub new($) {
		1000	my ($login) = @_;
		1001
		1002	my $self = create;
		1003
		1004	$self->ob->name ($login);
		1005	$self->{deny_save} = 1;
		1006
		1007	$cf::PLAYER{$login} = $self;
		1008
		1009	$self
		1010	}
		1011
		1012	=item $pl->quit_character
		1013
		1014	Nukes the player without looking back. If logged in, the connection will
		1015	be destroyed. May block for a long time.
		1016
		1017	=cut
		1018
		1019	sub quit_character {
		1020	my ($pl) = @_;
		1021
		1022	$pl->{deny_save} = 1;
		1023	$pl->password ("*"); # this should lock out the player until we nuked the dir
		1024
		1025	$pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
		1026	$pl->deactivate;
		1027	$pl->invoke (cf::EVENT_PLAYER_QUIT);
		1028	$pl->ns->destroy if $pl->ns;
		1029
		1030	my $path = playerdir $pl;
		1031	my $temp = "$path~$cf::RUNTIME~deleting~";
		1032	aio_rename $path, $temp;
		1033	delete $cf::PLAYER{$pl->ob->name};
		1034	$pl->destroy;
		1035	IO::AIO::aio_rmtree $temp;
		1036	}
		1037
		1038	=item cf::player::list_logins
		1039
		1040	Returns am arrayref of all valid playernames in the system, can take a
		1041	while and may block, so not sync_job-capable, ever.
		1042
		1043	=cut
		1044
		1045	sub list_logins {
		1046	my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
		1047	or return [];
		1048
		1049	my @logins;
		1050
		1051	for my $login (@$dirs) {
		1052	my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
		1053	aio_read $fh, 0, 512, my $buf, 0 or next;
		1054	$buf !~ /^password -------------$/m or next; # official not-valid tag
		1055
		1056	utf8::decode $login;
		1057	push @logins, $login;
		1058	}
		1059
		1060	\@logins
		1061	}
		1062
		1063	=item $player->maps
		1064
		1065	Returns an arrayref of map paths that are private for this
		1066	player. May block.
		1067
		1068	=cut
		1069
		1070	sub maps($) {
		1071	my ($pl) = @_;
		1072
		1073	my $files = aio_readdir playerdir $pl
		1074	or return;
		1075
		1076	my @paths;
		1077
		1078	for (@$files) {
		1079	utf8::decode $_;
		1080	next if /\.(?:pl|pst)$/;
		1081	next unless /^$PATH_SEP/o;
		1082
		1083	s/\.map$//;
		1084	push @paths, "~" . $pl->ob->name . "/" . $_;
		1085	}
		1086
		1087	\@paths
		1088	}
		1089
		1090	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1091
		1092	Sends an ext reply to the player.
		1093
		1094	=cut
		1095
		1096	sub ext_reply($$$%) {
		1097	my ($self, $id, %msg) = @_;
		1098
		1099	$msg{msgid} = $id;
		1100
		1101	$self->send ("ext " . cf::to_json \%msg);
		1102	}
		1103
		1104	package cf;
		1105
		1106	=back
		1107
		1108
		1109	=head3 cf::map
		1110
		1111	=over 4
		1112
		1113	=cut
		1114
		1115	package cf::map;
		1116
		1117	use Fcntl;
		1118	use Coro::AIO;
		1119
		1120	use overload
		1121	'""' => \&as_string,
		1122	fallback => 1;
		1123
		1124	our $MAX_RESET = 3600;
		1125	our $DEFAULT_RESET = 3000;
		1126
		1127	sub generate_random_map {
		1128	my ($self, $rmp) = @_;
		1129	# mit "rum" bekleckern, nicht
		1130	$self->_create_random_map (
		1131	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1132	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1133	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1134	$rmp->{exit_on_final_map},
		1135	$rmp->{xsize}, $rmp->{ysize},
		1136	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1137	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1138	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1139	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1140	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1141	(cf::region::find $rmp->{region}), $rmp->{custom}
		1142	)
		1143	}
		1144
		1145	=item cf::map->register ($regex, $prio)
		1146
		1147	Register a handler for the map path matching the given regex at the
		1148	givne priority (higher is better, built-in handlers have priority 0, the
		1149	default).
		1150
		1151	=cut
		1152
		1153	sub register {
		1154	my (undef, $regex, $prio) = @_;
		1155	my $pkg = caller;
		1156
		1157	no strict;
		1158	push @{"$pkg\::ISA"}, __PACKAGE__;
		1159
		1160	$EXT_MAP{$pkg} = [$prio, qr<$regex>];
		1161	}
		1162
		1163	# also paths starting with '/'
		1164	$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
		1165
		1166	sub thawer_merge {
		1167	my ($self, $merge) = @_;
		1168
		1169	# we have to keep some variables in memory intact
		1170	local $self->{path};
		1171	local $self->{load_path};
		1172	local $self->{deny_save};
		1173	local $self->{deny_reset};
		1174
		1175	$self->SUPER::thawer_merge ($merge);
		1176	}
		1177
		1178	sub normalise {
		1179	my ($path, $base) = @_;
		1180
		1181	$path = "$path"; # make sure its a string
		1182
		1183	# map plan:
		1184	#
		1185	# /! non-realised random map exit (special hack!)
		1186	# {... are special paths that are not being touched
		1187	# ?xxx/... are special absolute paths
		1188	# ?random/... random maps
		1189	# /... normal maps
		1190	# ~user/... per-player map of a specific user
		1191
		1192	$path =~ s/$PATH_SEP/\//go;
		1193
		1194	# treat it as relative path if it starts with
		1195	# something that looks reasonable
		1196	if ($path =~ m{^(?:\./|\.\./|\w)}) {
		1197	$base or Carp::carp "normalise called with relative path and no base: '$path'";
		1198
		1199	$base =~ s{[^/]+/?$}{};
		1200	$path = "$base/$path";
		1201	}
		1202
		1203	for ($path) {
		1204	redo if s{//}{/};
		1205	redo if s{/\.?/}{/};
		1206	redo if s{/[^/]+/\.\./}{/};
		1207	}
		1208
		1209	$path
		1210	}
		1211
		1212	sub new_from_path {
		1213	my (undef, $path, $base) = @_;
		1214
		1215	return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
		1216
		1217	$path = normalise $path, $base;
		1218
		1219	for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
		1220	if ($path =~ $EXT_MAP{$pkg}[1]) {
		1221	my $self = bless cf::map::new, $pkg;
		1222	$self->{path} = $path; $self->path ($path);
		1223	$self->init; # pass $1 etc.
		1224	return $self;
		1225	}
		1226	}
		1227
		1228	Carp::carp "unable to resolve path '$path' (base '$base').";
		1229	()
		1230	}
		1231
		1232	sub init {
		1233	my ($self) = @_;
		1234
		1235	$self
		1236	}
		1237
		1238	sub as_string {
		1239	my ($self) = @_;
		1240
		1241	"$self->{path}"
		1242	}
		1243
		1244	# the displayed name, this is a one way mapping
		1245	sub visible_name {
		1246	&as_string
		1247	}
		1248
		1249	# the original (read-only) location
		1250	sub load_path {
		1251	my ($self) = @_;
		1252
		1253	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		1254	}
		1255
		1256	# the temporary/swap location
		1257	sub save_path {
		1258	my ($self) = @_;
		1259
		1260	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1261	sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
		1262	}
		1263
		1264	# the unique path, undef == no special unique path
		1265	sub uniq_path {
		1266	my ($self) = @_;
		1267
		1268	(my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
		1269	sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
		1270	}
		1271
		1272	# and all this just because we cannot iterate over
		1273	# all maps in C++...
		1274	sub change_all_map_light {
		1275	my ($change) = @_;
		1276
		1277	$_->change_map_light ($change)
		1278	for grep $_->outdoor, values %cf::MAP;
		1279	}
		1280
		1281	sub unlink_save {
		1282	my ($self) = @_;
		1283
		1284	utf8::encode (my $save = $self->save_path);
		1285	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
		1286	IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
		1287	}
		1288
		1289	sub load_header_from($) {
		1290	my ($self, $path) = @_;
		1291
		1292	utf8::encode $path;
		1293	aio_open $path, O_RDONLY, 0
		1294	or return;
		1295
		1296	$self->_load_header ($path)
		1297	or return;
		1298
		1299	$self->{load_path} = $path;
		1300
		1301	1
		1302	}
		1303
		1304	sub load_header_orig {
		1305	my ($self) = @_;
		1306
		1307	$self->load_header_from ($self->load_path)
		1308	}
		1309
		1310	sub load_header_temp {
		1311	my ($self) = @_;
		1312
		1313	$self->load_header_from ($self->save_path)
		1314	}
		1315
		1316	sub prepare_temp {
		1317	my ($self) = @_;
		1318
		1319	$self->last_access ((delete $self->{last_access})
		1320	|| $cf::RUNTIME); #d#
		1321	# safety
		1322	$self->{instantiate_time} = $cf::RUNTIME
		1323	if $self->{instantiate_time} > $cf::RUNTIME;
		1324	}
		1325
		1326	sub prepare_orig {
		1327	my ($self) = @_;
		1328
		1329	$self->{load_original} = 1;
		1330	$self->{instantiate_time} = $cf::RUNTIME;
		1331	$self->last_access ($cf::RUNTIME);
		1332	$self->instantiate;
		1333	}
		1334
		1335	sub load_header {
		1336	my ($self) = @_;
		1337
		1338	if ($self->load_header_temp) {
		1339	$self->prepare_temp;
		1340	} else {
		1341	$self->load_header_orig
		1342	or return;
		1343	$self->prepare_orig;
		1344	}
		1345
		1346	1
		1347	}
		1348
		1349	sub find;
		1350	sub find {
		1351	my ($path, $origin) = @_;
		1352
		1353	$path = normalise $path, $origin && $origin->path;
		1354
		1355	cf::lock_wait "map_find:$path";
		1356
		1357	$cf::MAP{$path} || do {
		1358	my $guard = cf::lock_acquire "map_find:$path";
		1359	my $map = new_from_path cf::map $path
		1360	or return;
		1361
		1362	$map->{last_save} = $cf::RUNTIME;
		1363
		1364	$map->load_header
		1365	or return;
		1366
		1367	if ($map->should_reset) {
		1368	# doing this can freeze the server in a sync job, obviously
		1369	#$cf::WAIT_FOR_TICK->wait;
		1370	$map->reset;
		1371	undef $guard;
		1372	return find $path;
		1373	}
		1374
		1375	$cf::MAP{$path} = $map
		1376	}
		1377	}
		1378
		1379	sub pre_load { }
		1380	sub post_load { }
		1381
		1382	sub load {
		1383	my ($self) = @_;
		1384
		1385	my $path = $self->{path};
		1386	my $guard = cf::lock_acquire "map_load:$path";
		1387
		1388	return if $self->in_memory != cf::MAP_SWAPPED;
		1389
		1390	$self->in_memory (cf::MAP_LOADING);
		1391
		1392	$self->alloc;
		1393
		1394	$self->pre_load;
		1395
		1396	$self->_load_objects ($self->{load_path}, 1)
		1397	or return;
		1398
		1399	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1400	if delete $self->{load_original};
		1401
		1402	if (my $uniq = $self->uniq_path) {
		1403	utf8::encode $uniq;
		1404	if (aio_open $uniq, O_RDONLY, 0) {
		1405	$self->clear_unique_items;
		1406	$self->_load_objects ($uniq, 0);
		1407	}
		1408	}
		1409
		1410	Coro::cede;
		1411
		1412	# now do the right thing for maps
		1413	$self->link_multipart_objects;
		1414
		1415	unless ($self->{deny_activate}) {
		1416	$self->decay_objects;
		1417	$self->fix_auto_apply;
		1418	$self->update_buttons;
		1419	Coro::cede;
		1420	$self->set_darkness_map;
		1421	$self->difficulty ($self->estimate_difficulty)
		1422	unless $self->difficulty;
		1423	Coro::cede;
		1424	$self->activate;
		1425	}
		1426
		1427	$self->post_load;
		1428
		1429	$self->in_memory (cf::MAP_IN_MEMORY);
		1430	}
		1431
		1432	sub customise_for {
		1433	my ($self, $ob) = @_;
		1434
		1435	return find "~" . $ob->name . "/" . $self->{path}
		1436	if $self->per_player;
		1437
		1438	$self
		1439	}
		1440
		1441	# find and load all maps in the 3x3 area around a map
		1442	sub load_diag {
679	my ($map) = @_;	1443	my ($map) = @_;
680		1444
681	my $path = $map->tmpname;	1445	my @diag; # diagonal neighbours
682	defined $path or return;
683		1446
684	unlink "$path.pst";	1447	for (0 .. 3) {
685	};	1448	my $neigh = $map->tile_path ($_)
		1449	or next;
		1450	$neigh = find $neigh, $map
		1451	or next;
		1452	$neigh->load;
686		1453
687	cf::map->attach (prio => -10000, package => cf::mapsupport::);	1454	push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
		1455	[$neigh->tile_path (($_ + 1) % 4), $neigh];
		1456	}
688		1457
689	#############################################################################	1458	for (@diag) {
690	# load/save perl data associated with player->ob objects	1459	my $neigh = find @$_
691		1460	or next;
692	sub all_objects(@) {	1461	$neigh->load;
693	@_, map all_objects ($_->inv), @_	1462	}
694	}	1463	}
695		1464
696	# TODO: compatibility cruft, remove when no longer needed	1465	sub find_sync {
697	cf::player->attach (	1466	my ($path, $origin) = @_;
698	on_load => sub {
699	my ($pl, $path) = @_;
700		1467
701	for my $o (all_objects $pl->ob) {	1468	cf::sync_job { find $path, $origin }
702	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1469	}
703	$o->set_ob_key_value ("_perl_data");
704		1470
705	%$o = %{ Storable::thaw pack "H*", $value };	1471	sub do_load_sync {
		1472	my ($map) = @_;
		1473
		1474	cf::sync_job { $map->load };
		1475	}
		1476
		1477	our %MAP_PREFETCH;
		1478	our $MAP_PREFETCHER = undef;
		1479
		1480	sub find_async {
		1481	my ($path, $origin) = @_;
		1482
		1483	$path = normalise $path, $origin && $origin->{path};
		1484
		1485	if (my $map = $cf::MAP{$path}) {
		1486	return $map if $map->in_memory == cf::MAP_IN_MEMORY;
		1487	}
		1488
		1489	undef $MAP_PREFETCH{$path};
		1490	$MAP_PREFETCHER ||= cf::async {
		1491	while (%MAP_PREFETCH) {
		1492	for my $path (keys %MAP_PREFETCH) {
		1493	my $map = find $path
		1494	or next;
		1495	$map->load;
		1496
		1497	delete $MAP_PREFETCH{$path};
706	}	1498	}
707	}	1499	}
		1500	undef $MAP_PREFETCHER;
		1501	};
		1502	$MAP_PREFETCHER->prio (6);
		1503
		1504	()
		1505	}
		1506
		1507	sub save {
		1508	my ($self) = @_;
		1509
		1510	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1511
		1512	$self->{last_save} = $cf::RUNTIME;
		1513
		1514	return unless $self->dirty;
		1515
		1516	my $save = $self->save_path; utf8::encode $save;
		1517	my $uniq = $self->uniq_path; utf8::encode $uniq;
		1518
		1519	$self->{load_path} = $save;
		1520
		1521	return if $self->{deny_save};
		1522
		1523	local $self->{last_access} = $self->last_access;#d#
		1524
		1525	cf::async {
		1526	$_->contr->save for $self->players;
		1527	};
		1528
		1529	if ($uniq) {
		1530	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1531	$self->_save_objects ($uniq, cf::IO_UNIQUES);
		1532	} else {
		1533	$self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
708	},	1534	}
709	);	1535	}
710		1536
711	#############################################################################	1537	sub swap_out {
		1538	my ($self) = @_;
712		1539
713	=head2 CORE EXTENSIONS	1540	# save first because save cedes
		1541	$self->save;
714		1542
715	Functions and methods that extend core crossfire objects.	1543	my $lock = cf::lock_acquire "map_data:" . $self->path;
		1544
		1545	return if $self->players;
		1546	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1547	return if $self->{deny_save};
		1548
		1549	$self->clear;
		1550	$self->in_memory (cf::MAP_SWAPPED);
		1551	}
		1552
		1553	sub reset_at {
		1554	my ($self) = @_;
		1555
		1556	# TODO: safety, remove and allow resettable per-player maps
		1557	return 1e99 if $self->isa ("ext::map_per_player");#d#
		1558	return 1e99 if $self->{deny_reset};
		1559
		1560	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1561	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1562
		1563	$time + $to
		1564	}
		1565
		1566	sub should_reset {
		1567	my ($self) = @_;
		1568
		1569	$self->reset_at <= $cf::RUNTIME
		1570	}
		1571
		1572	sub reset {
		1573	my ($self) = @_;
		1574
		1575	my $lock = cf::lock_acquire "map_data:$self->{path}";
		1576
		1577	return if $self->players;
		1578	return if $self->isa ("ext::map_per_player");#d#
		1579
		1580	warn "resetting map ", $self->path;#d#
		1581
		1582	delete $cf::MAP{$self->path};
		1583
		1584	$self->in_memory (cf::MAP_SWAPPED);
		1585	$self->clear;
		1586
		1587	$_->clear_links_to ($self) for values %cf::MAP;
		1588
		1589	$self->unlink_save;
		1590	$self->destroy;
		1591	}
		1592
		1593	my $nuke_counter = "aaaa";
		1594
		1595	sub nuke {
		1596	my ($self) = @_;
		1597
		1598	delete $cf::MAP{$self->path};
		1599
		1600	$self->unlink_save;
		1601
		1602	bless $self, "cf::map";
		1603	delete $self->{deny_reset};
		1604	$self->{deny_save} = 1;
		1605	$self->reset_timeout (1);
		1606	$self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
		1607
		1608	$cf::MAP{$self->path} = $self;
		1609
		1610	$self->reset; # polite request, might not happen
		1611	}
		1612
		1613	=item cf::map::unique_maps
		1614
		1615	Returns an arrayref of paths of all shared maps that have
		1616	instantiated unique items. May block.
		1617
		1618	=cut
		1619
		1620	sub unique_maps() {
		1621	my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
		1622	or return;
		1623
		1624	my @paths;
		1625
		1626	for (@$files) {
		1627	utf8::decode $_;
		1628	next if /\.pst$/;
		1629	next unless /^$PATH_SEP/o;
		1630
		1631	s/\.map$//;
		1632	push @paths, $_;
		1633	}
		1634
		1635	\@paths
		1636	}
		1637
		1638	package cf;
		1639
		1640	=back
		1641
		1642	=head3 cf::object
		1643
		1644	=cut
		1645
		1646	package cf::object;
716		1647
717	=over 4	1648	=over 4
718		1649
719	=item cf::player::exists $login	1650	=item $ob->inv_recursive
720		1651
721	Returns true when the given account exists.	1652	Returns the inventory of the object _and_ their inventories, recursively.
722		1653
723	=cut	1654	=cut
724		1655
725	sub cf::player::exists($) {	1656	sub inv_recursive_;
726	cf::player::find $_[0]	1657	sub inv_recursive_ {
727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1658	map { $_, inv_recursive_ $_->inv } @_
728	}	1659	}
		1660
		1661	sub inv_recursive {
		1662	inv_recursive_ inv $_[0]
		1663	}
		1664
		1665	package cf;
		1666
		1667	=back
		1668
		1669	=head3 cf::object::player
		1670
		1671	=over 4
729		1672
730	=item $player_object->reply ($npc, $msg[, $flags])	1673	=item $player_object->reply ($npc, $msg[, $flags])
731		1674
732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1675	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733	can be C<undef>. Does the right thing when the player is currently in a	1676	can be C<undef>. Does the right thing when the player is currently in a
…		…
735		1678
736	=cut	1679	=cut
737		1680
738	# rough implementation of a future "reply" method that works	1681	# rough implementation of a future "reply" method that works
739	# with dialog boxes.	1682	# with dialog boxes.
		1683	#TODO: the first argument must go, split into a $npc->reply_to ( method
740	sub cf::object::player::reply($$$;$) {	1684	sub cf::object::player::reply($$$;$) {
741	my ($self, $npc, $msg, $flags) = @_;	1685	my ($self, $npc, $msg, $flags) = @_;
742		1686
743	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1687	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
744		1688
…		…
748	$msg = $npc->name . " says: $msg" if $npc;	1692	$msg = $npc->name . " says: $msg" if $npc;
749	$self->message ($msg, $flags);	1693	$self->message ($msg, $flags);
750	}	1694	}
751	}	1695	}
752		1696
753	=item $player->ext_reply ($msgid, $msgtype, %msg)
754
755	Sends an ext reply to the player.
756
757	=cut
758
759	sub cf::player::ext_reply($$$%) {
760	my ($self, $id, %msg) = @_;
761
762	$msg{msgid} = $id;
763
764	$self->send ("ext " . to_json \%msg);
765	}
766
767	=item $player_object->may ("access")	1697	=item $player_object->may ("access")
768		1698
769	Returns wether the given player is authorized to access resource "access"	1699	Returns wether the given player is authorized to access resource "access"
770	(e.g. "command_wizcast").	1700	(e.g. "command_wizcast").
771		1701
…		…
778	(ref $cf::CFG{"may_$access"}	1708	(ref $cf::CFG{"may_$access"}
779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1709	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780	: $cf::CFG{"may_$access"})	1710	: $cf::CFG{"may_$access"})
781	}	1711	}
782		1712
783	=cut	1713	=item $player_object->enter_link
784		1714
785	#############################################################################	1715	Freezes the player and moves him/her to a special map (C<{link}>).
		1716
		1717	The player should be reasonably safe there for short amounts of time. You
		1718	I<MUST> call C<leave_link> as soon as possible, though.
		1719
		1720	Will never block.
		1721
		1722	=item $player_object->leave_link ($map, $x, $y)
		1723
		1724	Moves the player out of the special C<{link}> map onto the specified
		1725	map. If the map is not valid (or omitted), the player will be moved back
		1726	to the location he/she was before the call to C<enter_link>, or, if that
		1727	fails, to the emergency map position.
		1728
		1729	Might block.
		1730
		1731	=cut
		1732
		1733	sub link_map {
		1734	unless ($LINK_MAP) {
		1735	$LINK_MAP = cf::map::find "{link}"
		1736	or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
		1737	$LINK_MAP->load;
		1738	}
		1739
		1740	$LINK_MAP
		1741	}
		1742
		1743	sub cf::object::player::enter_link {
		1744	my ($self) = @_;
		1745
		1746	$self->deactivate_recursive;
		1747
		1748	return if UNIVERSAL::isa $self->map, "ext::map_link";
		1749
		1750	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1751	if $self->map;
		1752
		1753	$self->enter_map ($LINK_MAP || link_map, 20, 20);
		1754	}
		1755
		1756	sub cf::object::player::leave_link {
		1757	my ($self, $map, $x, $y) = @_;
		1758
		1759	my $link_pos = delete $self->{_link_pos};
		1760
		1761	unless ($map) {
		1762	# restore original map position
		1763	($map, $x, $y) = @{ $link_pos || [] };
		1764	$map = cf::map::find $map;
		1765
		1766	unless ($map) {
		1767	($map, $x, $y) = @$EMERGENCY_POSITION;
		1768	$map = cf::map::find $map
		1769	or die "FATAL: cannot load emergency map\n";
		1770	}
		1771	}
		1772
		1773	($x, $y) = (-1, -1)
		1774	unless (defined $x) && (defined $y);
		1775
		1776	# use -1 or undef as default coordinates, not 0, 0
		1777	($x, $y) = ($map->enter_x, $map->enter_y)
		1778	if $x <=0 && $y <= 0;
		1779
		1780	$map->load;
		1781	$map->load_diag;
		1782
		1783	return unless $self->contr->active;
		1784	$self->activate_recursive;
		1785	$self->enter_map ($map, $x, $y);
		1786	}
		1787
		1788	cf::player->attach (
		1789	on_logout => sub {
		1790	my ($pl) = @_;
		1791
		1792	# abort map switching before logout
		1793	if ($pl->ob->{_link_pos}) {
		1794	cf::sync_job {
		1795	$pl->ob->leave_link
		1796	};
		1797	}
		1798	},
		1799	on_login => sub {
		1800	my ($pl) = @_;
		1801
		1802	# try to abort aborted map switching on player login :)
		1803	# should happen only on crashes
		1804	if ($pl->ob->{_link_pos}) {
		1805	$pl->ob->enter_link;
		1806	(async {
		1807	# we need this sleep as the login has a concurrent enter_exit running
		1808	# and this sleep increases chances of the player not ending up in scorn
		1809	$pl->ob->reply (undef,
		1810	"There was an internal problem at your last logout, "
		1811	. "the server will try to bring you to your intended destination in a second.",
		1812	cf::NDI_RED);
		1813	Coro::Timer::sleep 1;
		1814	$pl->ob->leave_link;
		1815	})->prio (2);
		1816	}
		1817	},
		1818	);
		1819
		1820	=item $player_object->goto ($path, $x, $y)
		1821
		1822	=cut
		1823
		1824	sub cf::object::player::goto {
		1825	my ($self, $path, $x, $y) = @_;
		1826
		1827	$self->enter_link;
		1828
		1829	(async {
		1830	my $map = cf::map::find $path;
		1831	$map = $map->customise_for ($self) if $map;
		1832
		1833	# warn "entering ", $map->path, " at ($x, $y)\n"
		1834	# if $map;
		1835
		1836	$map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1837
		1838	$self->leave_link ($map, $x, $y);
		1839	})->prio (1);
		1840	}
		1841
		1842	=item $player_object->enter_exit ($exit_object)
		1843
		1844	=cut
		1845
		1846	sub parse_random_map_params {
		1847	my ($spec) = @_;
		1848
		1849	my $rmp = { # defaults
		1850	xsize => (cf::rndm 15, 40),
		1851	ysize => (cf::rndm 15, 40),
		1852	symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
		1853	#layout => string,
		1854	};
		1855
		1856	for (split /\n/, $spec) {
		1857	my ($k, $v) = split /\s+/, $_, 2;
		1858
		1859	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1860	}
		1861
		1862	$rmp
		1863	}
		1864
		1865	sub prepare_random_map {
		1866	my ($exit) = @_;
		1867
		1868	my $guard = cf::lock_acquire "exit_prepare:$exit";
		1869
		1870	# all this does is basically replace the /! path by
		1871	# a new random map path (?random/...) with a seed
		1872	# that depends on the exit object
		1873
		1874	my $rmp = parse_random_map_params $exit->msg;
		1875
		1876	if ($exit->map) {
		1877	$rmp->{region} = $exit->map->region_name;
		1878	$rmp->{origin_map} = $exit->map->path;
		1879	$rmp->{origin_x} = $exit->x;
		1880	$rmp->{origin_y} = $exit->y;
		1881	}
		1882
		1883	$rmp->{random_seed} ||= $exit->random_seed;
		1884
		1885	my $data = cf::to_json $rmp;
		1886	my $md5 = Digest::MD5::md5_hex $data;
		1887	my $meta = "$cf::RANDOM_MAPS/$md5.meta";
		1888
		1889	if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
		1890	aio_write $fh, 0, (length $data), $data, 0;
		1891	undef $fh;
		1892	aio_rename "$meta~", $meta;
		1893
		1894	$exit->slaying ("?random/$md5");
		1895	$exit->msg (undef);
		1896	}
		1897	}
		1898
		1899	sub cf::object::player::enter_exit {
		1900	my ($self, $exit) = @_;
		1901
		1902	return unless $self->type == cf::PLAYER;
		1903
		1904	$self->enter_link;
		1905
		1906	(async {
		1907	$self->deactivate_recursive; # just to be sure
		1908	unless (eval {
		1909	prepare_random_map $exit
		1910	if $exit->slaying eq "/!";
		1911
		1912	my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
		1913	$self->goto ($path, $exit->stats->hp, $exit->stats->sp);
		1914
		1915	1;
		1916	}) {
		1917	$self->message ("Something went wrong deep within the crossfire server. "
		1918	. "I'll try to bring you back to the map you were before. "
		1919	. "Please report this to the dungeon master!",
		1920	cf::NDI_UNIQUE | cf::NDI_RED);
		1921
		1922	warn "ERROR in enter_exit: $@";
		1923	$self->leave_link;
		1924	}
		1925	})->prio (1);
		1926	}
		1927
		1928	=head3 cf::client
		1929
		1930	=over 4
		1931
		1932	=item $client->send_drawinfo ($text, $flags)
		1933
		1934	Sends a drawinfo packet to the client. Circumvents output buffering so
		1935	should not be used under normal circumstances.
		1936
		1937	=cut
		1938
		1939	sub cf::client::send_drawinfo {
		1940	my ($self, $text, $flags) = @_;
		1941
		1942	utf8::encode $text;
		1943	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1944	}
		1945
		1946
		1947	=item $success = $client->query ($flags, "text", \&cb)
		1948
		1949	Queues a query to the client, calling the given callback with
		1950	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1951	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1952
		1953	Queries can fail, so check the return code. Or don't, as queries will become
		1954	reliable at some point in the future.
		1955
		1956	=cut
		1957
		1958	sub cf::client::query {
		1959	my ($self, $flags, $text, $cb) = @_;
		1960
		1961	return unless $self->state == ST_PLAYING
		1962	|| $self->state == ST_SETUP
		1963	|| $self->state == ST_CUSTOM;
		1964
		1965	$self->state (ST_CUSTOM);
		1966
		1967	utf8::encode $text;
		1968	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1969
		1970	$self->send_packet ($self->{query_queue}[0][0])
		1971	if @{ $self->{query_queue} } == 1;
		1972	}
		1973
		1974	cf::client->attach (
		1975	on_reply => sub {
		1976	my ($ns, $msg) = @_;
		1977
		1978	# this weird shuffling is so that direct followup queries
		1979	# get handled first
		1980	my $queue = delete $ns->{query_queue}
		1981	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1982
		1983	(shift @$queue)->[1]->($msg);
		1984
		1985	push @{ $ns->{query_queue} }, @$queue;
		1986
		1987	if (@{ $ns->{query_queue} } == @$queue) {
		1988	if (@$queue) {
		1989	$ns->send_packet ($ns->{query_queue}[0][0]);
		1990	} else {
		1991	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1992	}
		1993	}
		1994	},
		1995	);
		1996
		1997	=item $client->async (\&cb)
		1998
		1999	Create a new coroutine, running the specified callback. The coroutine will
		2000	be automatically cancelled when the client gets destroyed (e.g. on logout,
		2001	or loss of connection).
		2002
		2003	=cut
		2004
		2005	sub cf::client::async {
		2006	my ($self, $cb) = @_;
		2007
		2008	my $coro = &Coro::async ($cb);
		2009
		2010	$coro->on_destroy (sub {
		2011	delete $self->{_coro}{$coro+0};
		2012	});
		2013
		2014	$self->{_coro}{$coro+0} = $coro;
		2015
		2016	$coro
		2017	}
		2018
		2019	cf::client->attach (
		2020	on_destroy => sub {
		2021	my ($ns) = @_;
		2022
		2023	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		2024	},
		2025	);
		2026
		2027	=back
		2028
786		2029
787	=head2 SAFE SCRIPTING	2030	=head2 SAFE SCRIPTING
788		2031
789	Functions that provide a safe environment to compile and execute	2032	Functions that provide a safe environment to compile and execute
790	snippets of perl code without them endangering the safety of the server	2033	snippets of perl code without them endangering the safety of the server
…		…
942		2185
943	{	2186	{
944	my $path = cf::localdir . "/database.pst";	2187	my $path = cf::localdir . "/database.pst";
945		2188
946	sub db_load() {	2189	sub db_load() {
947	warn "loading database $path\n";#d# remove later
948	$DB = stat $path ? Storable::retrieve $path : { };	2190	$DB = stat $path ? Storable::retrieve $path : { };
949	}	2191	}
950		2192
951	my $pid;	2193	my $pid;
952		2194
953	sub db_save() {	2195	sub db_save() {
954	warn "saving database $path\n";#d# remove later
955	waitpid $pid, 0 if $pid;	2196	waitpid $pid, 0 if $pid;
956	if (0 == ($pid = fork)) {	2197	if (0 == ($pid = fork)) {
957	$DB->{_meta}{version} = 1;	2198	$DB->{_meta}{version} = 1;
958	Storable::nstore $DB, "$path~";	2199	Storable::nstore $DB, "$path~";
959	rename "$path~", $path;	2200	rename "$path~", $path;
…		…
966	sub db_sync() {	2207	sub db_sync() {
967	db_save if $dirty;	2208	db_save if $dirty;
968	undef $dirty;	2209	undef $dirty;
969	}	2210	}
970		2211
971	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {	2212	my $idle = Event->idle (
972	db_sync;	2213	reentrant => 0,
		2214	min => 10,
		2215	max => 20,
		2216	repeat => 0,
		2217	data => WF_AUTOCANCEL,
		2218	cb => \&db_sync,
973	});	2219	);
974		2220
975	sub db_dirty() {	2221	sub db_dirty() {
976	$dirty = 1;	2222	$dirty = 1;
977	$idle->start;	2223	$idle->start;
978	}	2224	}
…		…
1007	open my $fh, "<:utf8", cf::confdir . "/config"	2253	open my $fh, "<:utf8", cf::confdir . "/config"
1008	or return;	2254	or return;
1009		2255
1010	local $/;	2256	local $/;
1011	*CFG = YAML::Syck::Load <$fh>;	2257	*CFG = YAML::Syck::Load <$fh>;
		2258
		2259	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2260
		2261	$cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
		2262	$cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
		2263
		2264	if (exists $CFG{mlockall}) {
		2265	eval {
		2266	$CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
		2267	and die "WARNING: m(un)lockall failed: $!\n";
		2268	};
		2269	warn $@ if $@;
		2270	}
1012	}	2271	}
1013		2272
1014	sub main {	2273	sub main {
		2274	# we must not ever block the main coroutine
		2275	local $Coro::idle = sub {
		2276	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2277	(async {
		2278	Event::one_event;
		2279	})->prio (Coro::PRIO_MAX);
		2280	};
		2281
1015	cfg_load;	2282	cfg_load;
1016	db_load;	2283	db_load;
1017	load_extensions;	2284	load_extensions;
		2285
		2286	$TICK_WATCHER->start;
1018	Event::loop;	2287	Event::loop;
1019	}	2288	}
1020		2289
1021	#############################################################################	2290	#############################################################################
1022	# initialisation	2291	# initialisation and cleanup
1023		2292
		2293	# install some emergency cleanup handlers
		2294	BEGIN {
		2295	for my $signal (qw(INT HUP TERM)) {
		2296	Event->signal (
		2297	reentrant => 0,
		2298	data => WF_AUTOCANCEL,
		2299	signal => $signal,
		2300	prio => 0,
		2301	cb => sub {
		2302	cf::cleanup "SIG$signal";
		2303	},
		2304	);
		2305	}
		2306	}
		2307
		2308	sub emergency_save() {
		2309	my $freeze_guard = cf::freeze_mainloop;
		2310
		2311	warn "enter emergency perl save\n";
		2312
		2313	cf::sync_job {
		2314	# use a peculiar iteration method to avoid tripping on perl
		2315	# refcount bugs in for. also avoids problems with players
		2316	# and maps saved/destroyed asynchronously.
		2317	warn "begin emergency player save\n";
		2318	for my $login (keys %cf::PLAYER) {
		2319	my $pl = $cf::PLAYER{$login} or next;
		2320	$pl->valid or next;
		2321	$pl->save;
		2322	}
		2323	warn "end emergency player save\n";
		2324
		2325	warn "begin emergency map save\n";
		2326	for my $path (keys %cf::MAP) {
		2327	my $map = $cf::MAP{$path} or next;
		2328	$map->valid or next;
		2329	$map->save;
		2330	}
		2331	warn "end emergency map save\n";
		2332	};
		2333
		2334	warn "leave emergency perl save\n";
		2335	}
		2336
1024	sub _perl_reload(&) {	2337	sub reload() {
1025	my ($msg) = @_;	2338	# can/must only be called in main
		2339	if ($Coro::current != $Coro::main) {
		2340	warn "can only reload from main coroutine";
		2341	return;
		2342	}
1026		2343
1027	$msg->("reloading...");	2344	warn "reloading...";
		2345
		2346	warn "cancelling server ticker";
		2347	$TICK_WATCHER->cancel;
		2348
		2349	cf::emergency_save;
1028		2350
1029	eval {	2351	eval {
1030	# cancel all watchers	2352	# if anything goes wrong in here, we should simply crash as we already saved
		2353
		2354	warn "syncing database to disk";
		2355	cf::db_sync;
		2356
		2357	warn "cancelling all WF_AUTOCANCEL watchers";
1031	for (Event::all_watchers) {	2358	for (Event::all_watchers) {
1032	$_->cancel if $_->data & WF_AUTOCANCEL;	2359	$_->cancel if $_->data & WF_AUTOCANCEL;
1033	}	2360	}
1034		2361
1035	# unload all extensions	2362	warn "flushing outstanding aio requests";
1036	for (@exts) {	2363	for (;;) {
1037	$msg->("unloading <$_>");	2364	IO::AIO::flush;
1038	unload_extension $_;	2365	Coro::cede;
		2366	last unless IO::AIO::nreqs;
		2367	warn "iterate...";
		2368	}
		2369
		2370	warn "cancelling all extension coros";
		2371	$_->cancel for values %EXT_CORO;
		2372	%EXT_CORO = ();
		2373
		2374	warn "removing commands";
		2375	%COMMAND = ();
		2376
		2377	warn "removing ext commands";
		2378	%EXTCMD = ();
		2379
		2380	warn "unloading/nuking all extensions";
		2381	for my $pkg (@EXTS) {
		2382	warn "... unloading $pkg";
		2383
		2384	if (my $cb = $pkg->can ("unload")) {
		2385	eval {
		2386	$cb->($pkg);
		2387	1
		2388	} or warn "$pkg unloaded, but with errors: $@";
1039	}	2389	}
1040		2390
		2391	warn "... nuking $pkg";
		2392	Symbol::delete_package $pkg;
		2393	}
		2394
1041	# unload all modules loaded from $LIBDIR	2395	warn "unloading all perl modules loaded from $LIBDIR";
1042	while (my ($k, $v) = each %INC) {	2396	while (my ($k, $v) = each %INC) {
1043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	2397	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044		2398
1045	$msg->("removing <$k>");	2399	warn "... unloading $k";
1046	delete $INC{$k};	2400	delete $INC{$k};
1047		2401
1048	$k =~ s/\.pm$//;	2402	$k =~ s/\.pm$//;
1049	$k =~ s/\//::/g;	2403	$k =~ s/\//::/g;
1050		2404
…		…
1053	}	2407	}
1054		2408
1055	Symbol::delete_package $k;	2409	Symbol::delete_package $k;
1056	}	2410	}
1057		2411
1058	# sync database to disk
1059	cf::db_sync;
1060
1061	# get rid of safe::, as good as possible	2412	warn "getting rid of safe::, as good as possible";
1062	Symbol::delete_package "safe::$_"	2413	Symbol::delete_package "safe::$_"
1063	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	2414	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064		2415
1065	# remove register_script_function callbacks
1066	# TODO
1067
1068	# unload cf.pm "a bit"	2416	warn "unloading cf.pm \"a bit\"";
1069	delete $INC{"cf.pm"};	2417	delete $INC{"cf.pm"};
1070		2418
1071	# don't, removes xs symbols, too,	2419	# don't, removes xs symbols, too,
1072	# and global variables created in xs	2420	# and global variables created in xs
1073	#Symbol::delete_package __PACKAGE__;	2421	#Symbol::delete_package __PACKAGE__;
1074		2422
1075	# reload cf.pm	2423	warn "unload completed, starting to reload now";
		2424
1076	$msg->("reloading cf.pm");	2425	warn "reloading cf.pm";
1077	require cf;	2426	require cf;
		2427	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078		2428
1079	# load config and database again	2429	warn "loading config and database again";
1080	cf::cfg_load;	2430	cf::cfg_load;
1081	cf::db_load;	2431	cf::db_load;
1082		2432
1083	# load extensions	2433	warn "loading extensions";
1084	$msg->("load extensions");
1085	cf::load_extensions;	2434	cf::load_extensions;
1086		2435
1087	# reattach attachments to objects	2436	warn "reattaching attachments to objects/players";
1088	$msg->("reattach");
1089	_global_reattach;	2437	_global_reattach;
		2438	warn "reattaching attachments to maps";
		2439	reattach $_ for values %MAP;
		2440
		2441	warn "restarting server ticker";
		2442
		2443	$TICK_WATCHER->start;
1090	};	2444	};
1091	$msg->($@) if $@;
1092		2445
1093	$msg->("reloaded");	2446	if ($@) {
		2447	warn $@;
		2448	warn "error while reloading, exiting.";
		2449	exit 1;
		2450	}
		2451
		2452	warn "reloaded";
1094	};	2453	};
1095		2454
1096	sub perl_reload() {	2455	our $RELOAD_WATCHER; # used only during reload
1097	_perl_reload {
1098	warn $_[0];
1099	print "$_[0]\n";
1100	};
1101	}
1102		2456
1103	register "<global>", __PACKAGE__;
1104
1105	register_command "perl-reload" => sub {	2457	register_command "reload" => sub {
1106	my ($who, $arg) = @_;	2458	my ($who, $arg) = @_;
1107		2459
1108	if ($who->flag (FLAG_WIZ)) {	2460	if ($who->flag (FLAG_WIZ)) {
1109	_perl_reload {	2461	$who->message ("reloading server.");
1110	warn $_[0];	2462
1111	$who->message ($_[0]);	2463	# doing reload synchronously and two reloads happen back-to-back,
		2464	# coro crashes during coro_state_free->destroy here.
		2465
		2466	$RELOAD_WATCHER ||= Event->timer (
		2467	reentrant => 0,
		2468	after => 0,
		2469	data => WF_AUTOCANCEL,
		2470	cb => sub {
		2471	reload;
		2472	undef $RELOAD_WATCHER;
		2473	},
1112	};	2474	);
1113	}	2475	}
1114	};	2476	};
1115		2477
1116	unshift @INC, $LIBDIR;	2478	unshift @INC, $LIBDIR;
1117		2479
		2480	my $bug_warning = 0;
		2481
1118	$TICK_WATCHER = Event->timer (	2482	$TICK_WATCHER = Event->timer (
		2483	reentrant => 0,
		2484	parked => 1,
1119	prio => 0,	2485	prio => 0,
1120	at => $NEXT_TICK || 1,	2486	at => $NEXT_TICK || $TICK,
1121	data => WF_AUTOCANCEL,	2487	data => WF_AUTOCANCEL,
1122	cb => sub {	2488	cb => sub {
		2489	if ($Coro::current != $Coro::main) {
		2490	Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
		2491	unless ++$bug_warning > 10;
		2492	return;
		2493	}
		2494
		2495	$NOW = Event::time;
		2496
1123	cf::server_tick; # one server iteration	2497	cf::server_tick; # one server iteration
1124		2498	$RUNTIME += $TICK;
1125	my $NOW = Event::time;
1126	$NEXT_TICK += $TICK;	2499	$NEXT_TICK += $TICK;
1127		2500
		2501	$WAIT_FOR_TICK->broadcast;
		2502	$WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
		2503
		2504	Event::sweep;
		2505	Coro::cede_notself;
		2506
		2507	# my $AFTER = Event::time;
		2508	# warn $AFTER - $NOW;#d#
		2509
1128	# if we are delayed by four ticks or more, skip them all	2510	# if we are delayed by four ticks or more, skip them all
1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2511	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130		2512
1131	$TICK_WATCHER->at ($NEXT_TICK);	2513	$TICK_WATCHER->at ($NEXT_TICK);
1132	$TICK_WATCHER->start;	2514	$TICK_WATCHER->start;
1133	},	2515	},
1134	);	2516	);
1135		2517
1136	IO::AIO::max_poll_time $TICK * 0.2;	2518	IO::AIO::max_poll_time $TICK * 0.1;
1137		2519
		2520	undef $Coro::AIO::WATCHER;
		2521	$AIO_POLL_WATCHER = Event->io (
		2522	reentrant => 0,
1138	Event->io (fd => IO::AIO::poll_fileno,	2523	fd => IO::AIO::poll_fileno,
1139	poll => 'r',	2524	poll => 'r',
1140	prio => 5,	2525	prio => 6,
1141	data => WF_AUTOCANCEL,	2526	data => WF_AUTOCANCEL,
1142	cb => \&IO::AIO::poll_cb);	2527	cb => \&IO::AIO::poll_cb,
		2528	);
		2529
		2530	$WRITE_RUNTIME_WATCHER = Event->timer (
		2531	reentrant => 0,
		2532	data => WF_AUTOCANCEL,
		2533	after => 1,
		2534	interval => 10,
		2535	prio => 6, # keep it lowest so it acts like a watchdog
		2536	cb => Coro::unblock_sub {
		2537	write_runtime
		2538	or warn "ERROR: unable to write runtime file: $!";
		2539	},
		2540	);
		2541
		2542	END { cf::emergency_save }
1143		2543
1144	1	2544	1
1145		2545

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines