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

Diff Legend

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