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

Diff Legend

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