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

Diff Legend

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