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

Diff Legend

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