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

Diff Legend

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