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.133 by root, Thu Jan 4 16:19:32 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
110	=item $object->attach ($attachment, key => $value...)	366	package cf::path;
111		367
112	=item $object->detach ($attachment)	368	sub new {
		369	my ($class, $path, $base) = @_;
113		370
114	Attach/detach a pre-registered attachment to an object.	371	$path = $path->as_string if ref $path;
115		372
116	=item $player->attach ($attachment, key => $value...)	373	my $self = bless { }, $class;
117		374
118	=item $player->detach ($attachment)	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
119		382
120	Attach/detach a pre-registered attachment to a player.	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;
121		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
122	=item $map->attach ($attachment, key => $value...)	498	=item $attachable->attach ($attachment, key => $value...)
123		499
124	=item $map->detach ($attachment)	500	=item $attachable->detach ($attachment)
125		501
126	Attach/detach a pre-registered attachment to a map.	502	Attach/detach a pre-registered attachment to a specific object and give it
		503	the specified key/value pairs as arguments.
127		504
128	=item cf::attach_global ...	505	Example, attach a minesweeper attachment to the given object, making it a
		506	10x10 minesweeper game:
129		507
130	Attach handlers for global events.	508	$obj->attach (minesweeper => width => 10, height => 10);
131		509
132	This and all following C<attach_*>-functions expect any number of the	510	=item $bool = $attachable->attached ($name)
133	following handler/hook descriptions:	511
		512	Checks wether the named attachment is currently attached to the object.
		513
		514	=item cf::CLASS->attach ...
		515
		516	=item cf::CLASS->detach ...
		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:
134		552
135	=over 4	553	=over 4
136		554
137	=item prio => $number	555	=item prio => $number
138		556
…		…
140	by another C<prio> setting). Lower priority handlers get executed	558	by another C<prio> setting). Lower priority handlers get executed
141	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
142	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
143	unless you know what you are doing.	561	unless you know what you are doing.
144		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
145	=item on_I<event> => \&cb	569	=item on_I<event> => \&cb
146		570
147	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
148	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
149	handlers are recognised generally depends on the type of object these	573	handlers are recognised generally depends on the type of object these
…		…
158	package and register them. Only handlers for eevents supported by the	582	package and register them. Only handlers for eevents supported by the
159	object/class are recognised.	583	object/class are recognised.
160		584
161	=back	585	=back
162		586
163	=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:
164		589
165	Attach handlers for a specific object type (e.g. TRANSPORT) and	590	cf::object::attachment sockpuppet =>
166	subtype. If C<$subtype> is zero or undef, matches all objects of the given	591	on_skill_attack => sub {
167	type.	592	my ($self, $victim) = @_;
		593	...
		594	}
		595	}
168		596
169	=item cf::attach_to_objects ...	597	=item $attachable->valid
170		598
171	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
172	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
173	the game.	601	valid C counterpart anymore you get an exception at runtime. This method
174		602	can be used to test for existence of the C object part without causing an
175	=item cf::attach_to_players ...	603	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		604
193	=cut	605	=cut
194		606
195	# 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
196	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
197	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)
198	our @CB_PLAYER = ();	611	our @CB_PLAYER = ();
		612	our @CB_CLIENT = ();
199	our @CB_TYPE = (); # registry for type (cf-object class) based events	613	our @CB_TYPE = (); # registry for type (cf-object class) based events
200	our @CB_MAP = ();	614	our @CB_MAP = ();
201		615
202	my %attachment;	616	my %attachment;
203		617
204	sub _attach_cb($\%$$$) {	618	sub _attach_cb($$$$) {
205	my ($registry, $undo, $event, $prio, $cb) = @_;	619	my ($registry, $event, $prio, $cb) = @_;
206		620
207	use sort 'stable';	621	use sort 'stable';
208		622
209	$cb = [$prio, $cb];	623	$cb = [$prio, $cb];
210		624
211	@{$registry->[$event]} = sort	625	@{$registry->[$event]} = sort
212	{ $a->[0] cmp $b->[0] }	626	{ $a->[0] cmp $b->[0] }
213	@{$registry->[$event] || []}, $cb;	627	@{$registry->[$event] || []}, $cb;
214
215	push @{$undo->{cb}}, [$event, $cb];
216	}	628	}
		629
		630	# hack
		631	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
217		632
218	# attach handles attaching event callbacks	633	# attach handles attaching event callbacks
219	# 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
220	# registry (== where the callback attaches to).	635	# registry (== where the callback attaches to).
221	sub _attach(\@$@) {	636	sub _attach {
222	my ($registry, $klass, @arg) = @_;	637	my ($registry, $klass, @arg) = @_;
223		638
		639	my $object_type;
224	my $prio = 0;	640	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;	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	}
232		647
233	while (@arg) {	648	while (@arg) {
234	my $type = shift @arg;	649	my $type = shift @arg;
235		650
236	if ($type eq "prio") {	651	if ($type eq "prio") {
237	$prio = shift @arg;	652	$prio = shift @arg;
238		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
239	} elsif ($type eq "package") {	663	} elsif ($type eq "package") {
240	my $pkg = shift @arg;	664	my $pkg = shift @arg;
241		665
242	while (my ($name, $id) = each %cb_id) {	666	while (my ($name, $id) = each %cb_id) {
243	if (my $cb = $pkg->can ($name)) {	667	if (my $cb = $pkg->can ($name)) {
244	_attach_cb $registry, %undo, $id, $prio, $cb;	668	_attach_cb $registry, $id, $prio, $cb;
245	}	669	}
246	}	670	}
247		671
248	} elsif (exists $cb_id{$type}) {	672	} elsif (exists $cb_id{$type}) {
249	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;	673	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
250		674
251	} elsif (ref $type) {	675	} elsif (ref $type) {
252	warn "attaching objects not supported, ignoring.\n";	676	warn "attaching objects not supported, ignoring.\n";
253		677
254	} else {	678	} else {
255	shift @arg;	679	shift @arg;
256	warn "attach argument '$type' not supported, ignoring.\n";	680	warn "attach argument '$type' not supported, ignoring.\n";
257	}	681	}
258	}	682	}
259
260	\%undo
261	}	683	}
262		684
263	sub _attach_attachment {	685	sub _object_attach {
264	my ($obj, $name, %arg) = @_;	686	my ($obj, $name, %arg) = @_;
265		687
266	my $res;	688	return if exists $obj->{_attachment}{$name};
267		689
268	if (my $attach = $attachment{$name}) {	690	if (my $attach = $attachment{$name}) {
269	my $registry = $obj->registry;	691	my $registry = $obj->registry;
270		692
271	for (@$attach) {	693	for (@$attach) {
272	my ($klass, @attach) = @$_;	694	my ($klass, @attach) = @$_;
273	$res = _attach @$registry, $klass, @attach;	695	_attach $registry, $klass, @attach;
274	}	696	}
275		697
276	$obj->{$name} = \%arg;	698	$obj->{$name} = \%arg;
277	} else {	699	} else {
278	warn "object uses attachment '$name' that is not available, postponing.\n";	700	warn "object uses attachment '$name' that is not available, postponing.\n";
279	}	701	}
280		702
281	$obj->{_attachment}{$name} = undef;	703	$obj->{_attachment}{$name} = undef;
282
283	$res->{attachment} = $name;
284	$res
285	}	704	}
286		705
287	sub cf::object::attach {	706	sub cf::attachable::attach {
288	my ($obj, $name, %arg) = @_;	707	if (ref $_[0]) {
		708	_object_attach @_;
		709	} else {
		710	_attach shift->_attach_registry, @_;
		711	}
		712	};
289		713
290	_attach_attachment $obj, $name, %arg;	714	# 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 {	715	sub cf::attachable::detach {
306	my ($obj, $name) = @_;	716	my ($obj, $name) = @_;
307	die;#d#	717
308	}	718	if (ref $obj) {
309	sub cf::player::detach {	719	delete $obj->{_attachment}{$name};
		720	reattach ($obj);
		721	} else {
		722	Carp::croak "cannot, currently, detach class attachments";
		723	}
		724	};
		725
		726	sub cf::attachable::attached {
310	my ($obj, $name) = @_;	727	my ($obj, $name) = @_;
311	die;#d#
312	}
313	sub cf::map::detach {
314	my ($obj, $name) = @_;
315	die;#d#
316	}
317		728
318	sub attach_global {	729	exists $obj->{_attachment}{$name}
319	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
320	}	730	}
321		731
322	sub attach_to_type {	732	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
323	my $type = shift;	733	eval "#line " . __LINE__ . " 'cf.pm'
324	my $subtype = shift;	734	sub cf::\L$klass\E::_attach_registry {
		735	(\\\@CB_$klass, KLASS_$klass)
		736	}
325		737
326	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_	738	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;	739	my \$name = shift;
343		740
344	$attachment{$name} = [[KLASS_OBJECT, @_]];
345	}
346
347	sub register_map_attachment {
348	my $name = shift;
349
350	$attachment{$name} = [[KLASS_MAP, @_]];	741	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		742	}
		743	";
		744	die if $@;
351	}	745	}
352		746
353	our $override;	747	our $override;
354	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?
355		749
…		…
369	for (@$callbacks) {	763	for (@$callbacks) {
370	eval { &{$_->[1]} };	764	eval { &{$_->[1]} };
371		765
372	if ($@) {	766	if ($@) {
373	warn "$@";	767	warn "$@";
374	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";	768	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
375	override;	769	override;
376	}	770	}
377		771
378	return 1 if $override;	772	return 1 if $override;
379	}	773	}
380		774
381	0	775	0
382	}	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
383		791
384	#############################################################################	792	#############################################################################
385	# object support	793	# object support
386		794
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 {	795	sub reattach {
		796	# basically do the same as instantiate, without calling instantiate
401	my ($obj) = @_;	797	my ($obj) = @_;
		798
402	my $registry = $obj->registry;	799	my $registry = $obj->registry;
403		800
404	@$registry = ();	801	@$registry = ();
405		802
406	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	803	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
407		804
408	for my $name (keys %{ $obj->{_attachment} || {} }) {	805	for my $name (keys %{ $obj->{_attachment} || {} }) {
409	if (my $attach = $attachment{$name}) {	806	if (my $attach = $attachment{$name}) {
410	for (@$attach) {	807	for (@$attach) {
411	my ($klass, @attach) = @$_;	808	my ($klass, @attach) = @$_;
412	_attach @$registry, $klass, @attach;	809	_attach $registry, $klass, @attach;
413	}	810	}
414	} else {	811	} else {
415	warn "object uses attachment '$name' that is not available, postponing.\n";	812	warn "object uses attachment '$name' that is not available, postponing.\n";
416	}	813	}
417	}	814	}
418	}	815	}
419		816
420	sub object_freezer_save {	817	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,	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,
448	on_clone => sub {	831	on_clone => sub {
449	my ($src, $dst) = @_;	832	my ($src, $dst) = @_;
450		833
451	@{$dst->registry} = @{$src->registry};	834	@{$dst->registry} = @{$src->registry};
452		835
453	%$dst = %$src;	836	%$dst = %$src;
454		837
455	%{$dst->{_attachment}} = %{$src->{_attachment}}	838	%{$dst->{_attachment}} = %{$src->{_attachment}}
456	if exists $src->{_attachment};	839	if exists $src->{_attachment};
457	},	840	},
458	;	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	}
459		907
460	#############################################################################	908	#############################################################################
461	# old plug-in events	909	# command handling &c
462		910
463	sub inject_event {	911	=item cf::register_command $name => \&callback($ob,$args);
464	my $extension = shift;
465	my $event_code = shift;
466		912
467	my $cb = $hook[$event_code]{$extension}	913	Register a callback for execution when the client sends the user command
468	or return;	914	$name.
469		915
470	&$cb	916	=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		917
492	sub register_command {	918	sub register_command {
493	my ($name, $time, $cb) = @_;	919	my ($name, $cb) = @_;
494		920
495	my $caller = caller;	921	my $caller = caller;
496	#warn "registering command '$name/$time' to '$caller'";	922	#warn "registering command '$name/$time' to '$caller'";
497		923
498	push @{ $command{$name} }, [$time, $cb, $caller];	924	push @{ $COMMAND{$name} }, [$caller, $cb];
499	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
500	}	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
501		935
502	sub register_extcmd {	936	sub register_extcmd {
503	my ($name, $cb) = @_;	937	my ($name, $cb) = @_;
504		938
505	my $caller = caller;	939	my $caller = caller;
506	#warn "registering extcmd '$name' to '$caller'";	940	#warn "registering extcmd '$name' to '$caller'";
507		941
508	$extcmd{$name} = [$cb, $caller];	942	$EXTCMD{$name} = [$cb, $caller];
509	}	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	);
510		976
511	sub register {	977	sub register {
512	my ($base, $pkg) = @_;	978	my ($base, $pkg) = @_;
513		979
514	#TODO	980	#TODO
…		…
533	. "#line 1 \"$path\"\n{\n"	999	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	1000	. (do { local $/; <$fh> })
535	. "\n};\n1";	1001	. "\n};\n1";
536		1002
537	eval $source	1003	eval $source
538	or die "$path: $@";	1004	or die $@ ? "$path: $@\n"
		1005	: "extension disabled.\n";
539		1006
540	push @exts, $pkg;	1007	push @exts, $pkg;
541	$ext_pkg{$base} = $pkg;	1008	$ext_pkg{$base} = $pkg;
542		1009
543	# no strict 'refs';	1010	# no strict 'refs';
…		…
556	# for my $idx (0 .. $#PLUGIN_EVENT) {	1023	# for my $idx (0 .. $#PLUGIN_EVENT) {
557	# delete $hook[$idx]{$pkg};	1024	# delete $hook[$idx]{$pkg};
558	# }	1025	# }
559		1026
560	# remove commands	1027	# remove commands
561	for my $name (keys %command) {	1028	for my $name (keys %COMMAND) {
562	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	1029	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
563		1030
564	if (@cb) {	1031	if (@cb) {
565	$command{$name} = \@cb;	1032	$COMMAND{$name} = \@cb;
566	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
567	} else {	1033	} else {
568	delete $command{$name};
569	delete $COMMAND{"$name\000"};	1034	delete $COMMAND{$name};
570	}	1035	}
571	}	1036	}
572		1037
573	# remove extcmds	1038	# remove extcmds
574	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1039	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
575	delete $extcmd{$name};	1040	delete $EXTCMD{$name};
576	}	1041	}
577		1042
578	if (my $cb = $pkg->can ("unload")) {	1043	if (my $cb = $pkg->can ("unload")) {
579	eval {	1044	eval {
580	$cb->($pkg);	1045	$cb->($pkg);
…		…
584		1049
585	Symbol::delete_package $pkg;	1050	Symbol::delete_package $pkg;
586	}	1051	}
587		1052
588	sub load_extensions {	1053	sub load_extensions {
589	my $LIBDIR = maps_directory "perl";
590
591	for my $ext (<$LIBDIR/*.ext>) {	1054	for my $ext (<$LIBDIR/*.ext>) {
592	next unless -r $ext;	1055	next unless -r $ext;
593	eval {	1056	eval {
594	load_extension $ext;	1057	load_extension $ext;
595	1	1058	1
596	} or warn "$ext not loaded: $@";	1059	} or warn "$ext not loaded: $@";
597	}	1060	}
598	}	1061	}
599		1062
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	#############################################################################	1063	#############################################################################
698	# load/save/clean perl data associated with a map	1064	# load/save/clean perl data associated with a map
699		1065
700	*cf::mapsupport::on_clean = sub {	1066	*cf::mapsupport::on_clean = sub {
701	my ($map) = @_;	1067	my ($map) = @_;
…		…
704	defined $path or return;	1070	defined $path or return;
705		1071
706	unlink "$path.pst";	1072	unlink "$path.pst";
707	};	1073	};
708		1074
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::;	1075	cf::map->attach (prio => -10000, package => cf::mapsupport::);
730		1076
731	#############################################################################	1077	#############################################################################
732	# load/save perl data associated with player->ob objects	1078	# load/save perl data associated with player->ob objects
733		1079
734	sub all_objects(@) {	1080	sub all_objects(@) {
735	@_, map all_objects ($_->inv), @_	1081	@_, map all_objects ($_->inv), @_
736	}	1082	}
737		1083
738	attach_to_players	1084	# TODO: compatibility cruft, remove when no longer needed
		1085	cf::player->attach (
739	on_load => sub {	1086	on_load => sub {
740	my ($pl, $path) = @_;	1087	my ($pl, $path) = @_;
741		1088
742	for my $o (all_objects $pl->ob) {	1089	for my $o (all_objects $pl->ob) {
743	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1090	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
745		1092
746	%$o = %{ Storable::thaw pack "H*", $value };	1093	%$o = %{ Storable::thaw pack "H*", $value };
747	}	1094	}
748	}	1095	}
749	},	1096	},
750	;	1097	);
751		1098
752	#############################################################################	1099	#############################################################################
753	# 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
754		1108
755	=item cf::player::exists $login	1109	=item cf::player::exists $login
756		1110
757	Returns true when the given account exists.	1111	Returns true when the given account exists.
758		1112
…		…
761	sub cf::player::exists($) {	1115	sub cf::player::exists($) {
762	cf::player::find $_[0]	1116	cf::player::find $_[0]
763	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;
764	}	1118	}
765		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	if ($map) {
		1215	$map->last_access ((delete $map->{last_access})
		1216	|| $cf::RUNTIME); #d#
		1217	# safety
		1218	$map->{instantiate_time} = $cf::RUNTIME
		1219	if $map->{instantiate_time} > $cf::RUNTIME;
		1220	} else {
		1221	if (my $rmp = $path->random_map_params) {
		1222	$map = generate_random_map $key, $rmp;
		1223	} else {
		1224	$map = try_load_header $path->load_path;
		1225	}
		1226
		1227	$map or return;
		1228
		1229	$map->{load_original} = 1;
		1230	$map->{instantiate_time} = $cf::RUNTIME;
		1231	$map->last_access ($cf::RUNTIME);
		1232	$map->instantiate;
		1233
		1234	# per-player maps become, after loading, normal maps
		1235	$map->per_player (0) if $path->{user_rel};
		1236	}
		1237
		1238	$map->path ($key);
		1239	$map->{path} = $path;
		1240	$map->{last_save} = $cf::RUNTIME;
		1241
		1242	if ($map->should_reset) {
		1243	$map->reset;
		1244	undef $guard;
		1245	$map = find $path
		1246	or return;
		1247	}
		1248
		1249	$cf::MAP{$key} = $map
		1250	}
		1251	}
		1252
		1253	sub load {
		1254	my ($self) = @_;
		1255
		1256	my $path = $self->{path};
		1257	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1258
		1259	return if $self->in_memory != cf::MAP_SWAPPED;
		1260
		1261	$self->in_memory (cf::MAP_LOADING);
		1262
		1263	$self->alloc;
		1264	$self->load_objects ($self->{load_path}, 1)
		1265	or return;
		1266
		1267	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1268	if delete $self->{load_original};
		1269
		1270	if (my $uniq = $path->uniq_path) {
		1271	utf8::encode $uniq;
		1272	if (aio_open $uniq, O_RDONLY, 0) {
		1273	$self->clear_unique_items;
		1274	$self->load_objects ($uniq, 0);
		1275	}
		1276	}
		1277
		1278	# now do the right thing for maps
		1279	$self->link_multipart_objects;
		1280
		1281	if ($self->{path}->is_style_map) {
		1282	$self->{deny_save} = 1;
		1283	$self->{deny_reset} = 1;
		1284	} else {
		1285	$self->fix_auto_apply;
		1286	$self->decay_objects;
		1287	$self->update_buttons;
		1288	$self->set_darkness_map;
		1289	$self->difficulty ($self->estimate_difficulty)
		1290	unless $self->difficulty;
		1291	$self->activate;
		1292	}
		1293
		1294	$self->in_memory (cf::MAP_IN_MEMORY);
		1295	}
		1296
		1297	sub find_sync {
		1298	my ($path, $origin) = @_;
		1299
		1300	cf::sync_job { cf::map::find $path, $origin }
		1301	}
		1302
		1303	sub do_load_sync {
		1304	my ($map) = @_;
		1305
		1306	cf::sync_job { $map->load };
		1307	}
		1308
		1309	sub save {
		1310	my ($self) = @_;
		1311
		1312	$self->{last_save} = $cf::RUNTIME;
		1313
		1314	return unless $self->dirty;
		1315
		1316	my $save = $self->{path}->save_path; utf8::encode $save;
		1317	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1318
		1319	$self->{load_path} = $save;
		1320
		1321	return if $self->{deny_save};
		1322
		1323	local $self->{last_access} = $self->last_access;#d#
		1324
		1325	if ($uniq) {
		1326	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1327	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1328	} else {
		1329	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1330	}
		1331	}
		1332
		1333	sub swap_out {
		1334	my ($self) = @_;
		1335
		1336	# save first because save cedes
		1337	$self->save;
		1338
		1339	return if $self->players;
		1340	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1341	return if $self->{deny_save};
		1342
		1343	$self->clear;
		1344	$self->in_memory (cf::MAP_SWAPPED);
		1345	}
		1346
		1347	sub reset_at {
		1348	my ($self) = @_;
		1349
		1350	# TODO: safety, remove and allow resettable per-player maps
		1351	return 1e99 if $self->{path}{user_rel};
		1352	return 1e99 if $self->{deny_reset};
		1353
		1354	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1355	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1356
		1357	$time + $to
		1358	}
		1359
		1360	sub should_reset {
		1361	my ($self) = @_;
		1362
		1363	$self->reset_at <= $cf::RUNTIME
		1364	}
		1365
		1366	sub unlink_save {
		1367	my ($self) = @_;
		1368
		1369	utf8::encode (my $save = $self->{path}->save_path);
		1370	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1371	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1372	}
		1373
		1374	sub rename {
		1375	my ($self, $new_path) = @_;
		1376
		1377	$self->unlink_save;
		1378
		1379	delete $cf::MAP{$self->path};
		1380	$self->{path} = new cf::path $new_path;
		1381	$self->path ($self->{path}->as_string);
		1382	$cf::MAP{$self->path} = $self;
		1383
		1384	$self->save;
		1385	}
		1386
		1387	sub reset {
		1388	my ($self) = @_;
		1389
		1390	return if $self->players;
		1391	return if $self->{path}{user_rel};#d#
		1392
		1393	warn "resetting map ", $self->path;#d#
		1394
		1395	delete $cf::MAP{$self->path};
		1396
		1397	$_->clear_links_to ($self) for values %cf::MAP;
		1398
		1399	$self->unlink_save;
		1400	$self->destroy;
		1401	}
		1402
		1403	my $nuke_counter = "aaaa";
		1404
		1405	sub nuke {
		1406	my ($self) = @_;
		1407
		1408	$self->{deny_save} = 1;
		1409	$self->reset_timeout (1);
		1410	$self->rename ("{nuke}/" . ($nuke_counter++));
		1411	$self->reset; # polite request, might not happen
		1412	}
		1413
		1414	sub customise_for {
		1415	my ($map, $ob) = @_;
		1416
		1417	if ($map->per_player) {
		1418	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
		1419	}
		1420
		1421	$map
		1422	}
		1423
		1424	sub emergency_save {
		1425	my $freeze_guard = cf::freeze_mainloop;
		1426
		1427	warn "enter emergency map save\n";
		1428
		1429	cf::sync_job {
		1430	warn "begin emergency map save\n";
		1431	$_->save for values %cf::MAP;
		1432	};
		1433
		1434	warn "end emergency map save\n";
		1435	}
		1436
		1437	package cf;
		1438
		1439	=back
		1440
		1441
		1442	=head3 cf::object::player
		1443
		1444	=over 4
		1445
766	=item $player->reply ($npc, $msg[, $flags])	1446	=item $player_object->reply ($npc, $msg[, $flags])
767		1447
768	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1448	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	1449	can be C<undef>. Does the right thing when the player is currently in a
770	dialogue with the given NPC character.	1450	dialogue with the given NPC character.
771		1451
772	=cut	1452	=cut
773		1453
774	# rough implementation of a future "reply" method that works	1454	# rough implementation of a future "reply" method that works
775	# with dialog boxes.	1455	# with dialog boxes.
		1456	#TODO: the first argument must go, split into a $npc->reply_to ( method
776	sub cf::object::player::reply($$$;$) {	1457	sub cf::object::player::reply($$$;$) {
777	my ($self, $npc, $msg, $flags) = @_;	1458	my ($self, $npc, $msg, $flags) = @_;
778		1459
779	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1460	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
780		1461
…		…
784	$msg = $npc->name . " says: $msg" if $npc;	1465	$msg = $npc->name . " says: $msg" if $npc;
785	$self->message ($msg, $flags);	1466	$self->message ($msg, $flags);
786	}	1467	}
787	}	1468	}
788		1469
789	=item $player->ext_reply ($msgid, $msgtype, %msg)	1470	=item $player_object->may ("access")
790		1471
791	Sends an ext reply to the player.	1472	Returns wether the given player is authorized to access resource "access"
		1473	(e.g. "command_wizcast").
792		1474
793	=cut	1475	=cut
794		1476
795	sub cf::player::ext_reply($$$%) {	1477	sub cf::object::player::may {
		1478	my ($self, $access) = @_;
		1479
		1480	$self->flag (cf::FLAG_WIZ) ||
		1481	(ref $cf::CFG{"may_$access"}
		1482	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1483	: $cf::CFG{"may_$access"})
		1484	}
		1485
		1486	=item $player_object->enter_link
		1487
		1488	Freezes the player and moves him/her to a special map (C<{link}>).
		1489
		1490	The player should be reaosnably safe there for short amounts of time. You
		1491	I<MUST> call C<leave_link> as soon as possible, though.
		1492
		1493	=item $player_object->leave_link ($map, $x, $y)
		1494
		1495	Moves the player out of the specila link map onto the given map. If the
		1496	map is not valid (or omitted), the player will be moved back to the
		1497	location he/she was before the call to C<enter_link>, or, if that fails,
		1498	to the emergency map position.
		1499
		1500	Might block.
		1501
		1502	=cut
		1503
		1504	sub cf::object::player::enter_link {
		1505	my ($self) = @_;
		1506
		1507	$self->deactivate_recursive;
		1508
		1509	return if $self->map == $LINK_MAP;
		1510
		1511	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1512	if $self->map;
		1513
		1514	$self->enter_map ($LINK_MAP, 20, 20);
		1515	}
		1516
		1517	sub cf::object::player::leave_link {
		1518	my ($self, $map, $x, $y) = @_;
		1519
		1520	my $link_pos = delete $self->{_link_pos};
		1521
		1522	unless ($map) {
		1523	# restore original map position
		1524	($map, $x, $y) = @{ $link_pos || [] };
		1525	$map = cf::map::find $map;
		1526
		1527	unless ($map) {
		1528	($map, $x, $y) = @$EMERGENCY_POSITION;
		1529	$map = cf::map::find $map
		1530	or die "FATAL: cannot load emergency map\n";
		1531	}
		1532	}
		1533
		1534	($x, $y) = (-1, -1)
		1535	unless (defined $x) && (defined $y);
		1536
		1537	# use -1 or undef as default coordinates, not 0, 0
		1538	($x, $y) = ($map->enter_x, $map->enter_y)
		1539	if $x <=0 && $y <= 0;
		1540
		1541	$map->load;
		1542
		1543	$self->activate_recursive;
		1544	$self->enter_map ($map, $x, $y);
		1545	}
		1546
		1547	cf::player->attach (
		1548	on_logout => sub {
		1549	my ($pl) = @_;
		1550
		1551	# abort map switching before logout
		1552	if ($pl->ob->{_link_pos}) {
		1553	cf::sync_job {
		1554	$pl->ob->leave_link
		1555	};
		1556	}
		1557	},
		1558	on_login => sub {
		1559	my ($pl) = @_;
		1560
		1561	# try to abort aborted map switching on player login :)
		1562	# should happen only on crashes
		1563	if ($pl->ob->{_link_pos}) {
		1564	$pl->ob->enter_link;
		1565	cf::async {
		1566	# we need this sleep as the login has a concurrent enter_exit running
		1567	# and this sleep increases chances of the player not ending up in scorn
		1568	Coro::Timer::sleep 1;
		1569	$pl->ob->leave_link;
		1570	};
		1571	}
		1572	},
		1573	);
		1574
		1575	=item $player_object->goto_map ($path, $x, $y)
		1576
		1577	=cut
		1578
		1579	sub cf::object::player::goto_map {
		1580	my ($self, $path, $x, $y) = @_;
		1581
		1582	$self->enter_link;
		1583
		1584	(cf::async {
		1585	$path = new cf::path $path;
		1586
		1587	my $map = cf::map::find $path->as_string;
		1588	$map = $map->customise_for ($self) if $map;
		1589
		1590	# warn "entering ", $map->path, " at ($x, $y)\n"
		1591	# if $map;
		1592
		1593	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1594
		1595	$self->leave_link ($map, $x, $y);
		1596	})->prio (1);
		1597	}
		1598
		1599	=item $player_object->enter_exit ($exit_object)
		1600
		1601	=cut
		1602
		1603	sub parse_random_map_params {
		1604	my ($spec) = @_;
		1605
		1606	my $rmp = { # defaults
		1607	xsize => 10,
		1608	ysize => 10,
		1609	};
		1610
		1611	for (split /\n/, $spec) {
		1612	my ($k, $v) = split /\s+/, $_, 2;
		1613
		1614	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1615	}
		1616
		1617	$rmp
		1618	}
		1619
		1620	sub prepare_random_map {
		1621	my ($exit) = @_;
		1622
		1623	# all this does is basically replace the /! path by
		1624	# a new random map path (?random/...) with a seed
		1625	# that depends on the exit object
		1626
		1627	my $rmp = parse_random_map_params $exit->msg;
		1628
		1629	if ($exit->map) {
		1630	$rmp->{region} = $exit->map->region_name;
		1631	$rmp->{origin_map} = $exit->map->path;
		1632	$rmp->{origin_x} = $exit->x;
		1633	$rmp->{origin_y} = $exit->y;
		1634	}
		1635
		1636	$rmp->{random_seed} ||= $exit->random_seed;
		1637
		1638	my $data = cf::to_json $rmp;
		1639	my $md5 = Digest::MD5::md5_hex $data;
		1640
		1641	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1642	aio_write $fh, 0, (length $data), $data, 0;
		1643
		1644	$exit->slaying ("?random/$md5");
		1645	$exit->msg (undef);
		1646	}
		1647	}
		1648
		1649	sub cf::object::player::enter_exit {
796	my ($self, $id, %msg) = @_;	1650	my ($self, $exit) = @_;
797		1651
798	$msg{msgid} = $id;	1652	return unless $self->type == cf::PLAYER;
799		1653
800	$self->send ("ext " . to_json \%msg);	1654	$self->enter_link;
801	}
802		1655
803	#############################################################################	1656	(cf::async {
804	# map scripting support	1657	$self->deactivate_recursive; # just to be sure
		1658	unless (eval {
		1659	prepare_random_map $exit
		1660	if $exit->slaying eq "/!";
		1661
		1662	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1663	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1664
		1665	1;
		1666	}) {
		1667	$self->message ("Something went wrong deep within the crossfire server. "
		1668	. "I'll try to bring you back to the map you were before. "
		1669	. "Please report this to the dungeon master",
		1670	cf::NDI_UNIQUE | cf::NDI_RED);
		1671
		1672	warn "ERROR in enter_exit: $@";
		1673	$self->leave_link;
		1674	}
		1675	})->prio (1);
		1676	}
		1677
		1678	=head3 cf::client
		1679
		1680	=over 4
		1681
		1682	=item $client->send_drawinfo ($text, $flags)
		1683
		1684	Sends a drawinfo packet to the client. Circumvents output buffering so
		1685	should not be used under normal circumstances.
		1686
		1687	=cut
		1688
		1689	sub cf::client::send_drawinfo {
		1690	my ($self, $text, $flags) = @_;
		1691
		1692	utf8::encode $text;
		1693	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1694	}
		1695
		1696
		1697	=item $success = $client->query ($flags, "text", \&cb)
		1698
		1699	Queues a query to the client, calling the given callback with
		1700	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1701	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1702
		1703	Queries can fail, so check the return code. Or don't, as queries will become
		1704	reliable at some point in the future.
		1705
		1706	=cut
		1707
		1708	sub cf::client::query {
		1709	my ($self, $flags, $text, $cb) = @_;
		1710
		1711	return unless $self->state == ST_PLAYING
		1712	|| $self->state == ST_SETUP
		1713	|| $self->state == ST_CUSTOM;
		1714
		1715	$self->state (ST_CUSTOM);
		1716
		1717	utf8::encode $text;
		1718	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1719
		1720	$self->send_packet ($self->{query_queue}[0][0])
		1721	if @{ $self->{query_queue} } == 1;
		1722	}
		1723
		1724	cf::client->attach (
		1725	on_reply => sub {
		1726	my ($ns, $msg) = @_;
		1727
		1728	# this weird shuffling is so that direct followup queries
		1729	# get handled first
		1730	my $queue = delete $ns->{query_queue}
		1731	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1732
		1733	(shift @$queue)->[1]->($msg);
		1734
		1735	push @{ $ns->{query_queue} }, @$queue;
		1736
		1737	if (@{ $ns->{query_queue} } == @$queue) {
		1738	if (@$queue) {
		1739	$ns->send_packet ($ns->{query_queue}[0][0]);
		1740	} else {
		1741	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1742	}
		1743	}
		1744	},
		1745	);
		1746
		1747	=item $client->coro (\&cb)
		1748
		1749	Create a new coroutine, running the specified callback. The coroutine will
		1750	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1751	or loss of connection).
		1752
		1753	=cut
		1754
		1755	sub cf::client::coro {
		1756	my ($self, $cb) = @_;
		1757
		1758	my $coro = &cf::async ($cb);
		1759
		1760	$coro->on_destroy (sub {
		1761	delete $self->{_coro}{$coro+0};
		1762	});
		1763
		1764	$self->{_coro}{$coro+0} = $coro;
		1765
		1766	$coro
		1767	}
		1768
		1769	cf::client->attach (
		1770	on_destroy => sub {
		1771	my ($ns) = @_;
		1772
		1773	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1774	},
		1775	);
		1776
		1777	=back
		1778
		1779
		1780	=head2 SAFE SCRIPTING
		1781
		1782	Functions that provide a safe environment to compile and execute
		1783	snippets of perl code without them endangering the safety of the server
		1784	itself. Looping constructs, I/O operators and other built-in functionality
		1785	is not available in the safe scripting environment, and the number of
		1786	functions and methods that can be called is greatly reduced.
		1787
		1788	=cut
805		1789
806	our $safe = new Safe "safe";	1790	our $safe = new Safe "safe";
807	our $safe_hole = new Safe::Hole;	1791	our $safe_hole = new Safe::Hole;
808		1792
809	$SIG{FPE} = 'IGNORE';	1793	$SIG{FPE} = 'IGNORE';
810		1794
811	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1795	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
812		1796
813	# here we export the classes and methods available to script code	1797	# here we export the classes and methods available to script code
814		1798
		1799	=pod
		1800
		1801	The following fucntions and emthods are available within a safe environment:
		1802
		1803	cf::object contr pay_amount pay_player map
		1804	cf::object::player player
		1805	cf::player peaceful
		1806	cf::map trigger
		1807
		1808	=cut
		1809
815	for (	1810	for (
816	["cf::object" => qw(contr pay_amount pay_player)],	1811	["cf::object" => qw(contr pay_amount pay_player map)],
817	["cf::object::player" => qw(player)],	1812	["cf::object::player" => qw(player)],
818	["cf::player" => qw(peaceful)],	1813	["cf::player" => qw(peaceful)],
		1814	["cf::map" => qw(trigger)],
819	) {	1815	) {
820	no strict 'refs';	1816	no strict 'refs';
821	my ($pkg, @funs) = @$_;	1817	my ($pkg, @funs) = @$_;
822	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1818	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
823	for @funs;	1819	for @funs;
824	}	1820	}
		1821
		1822	=over 4
		1823
		1824	=item @retval = safe_eval $code, [var => value, ...]
		1825
		1826	Compiled and executes the given perl code snippet. additional var/value
		1827	pairs result in temporary local (my) scalar variables of the given name
		1828	that are available in the code snippet. Example:
		1829
		1830	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1831
		1832	=cut
825		1833
826	sub safe_eval($;@) {	1834	sub safe_eval($;@) {
827	my ($code, %vars) = @_;	1835	my ($code, %vars) = @_;
828		1836
829	my $qcode = $code;	1837	my $qcode = $code;
…		…
852	}	1860	}
853		1861
854	wantarray ? @res : $res[0]	1862	wantarray ? @res : $res[0]
855	}	1863	}
856		1864
		1865	=item cf::register_script_function $function => $cb
		1866
		1867	Register a function that can be called from within map/npc scripts. The
		1868	function should be reasonably secure and should be put into a package name
		1869	like the extension.
		1870
		1871	Example: register a function that gets called whenever a map script calls
		1872	C<rent::overview>, as used by the C<rent> extension.
		1873
		1874	cf::register_script_function "rent::overview" => sub {
		1875	...
		1876	};
		1877
		1878	=cut
		1879
857	sub register_script_function {	1880	sub register_script_function {
858	my ($fun, $cb) = @_;	1881	my ($fun, $cb) = @_;
859		1882
860	no strict 'refs';	1883	no strict 'refs';
861	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1884	*{"safe::$fun"} = $safe_hole->wrap ($cb);
862	}	1885	}
863		1886
		1887	=back
		1888
		1889	=cut
		1890
		1891	#############################################################################
		1892
		1893	=head2 EXTENSION DATABASE SUPPORT
		1894
		1895	Crossfire maintains a very simple database for extension use. It can
		1896	currently store anything that can be serialised using Storable, which
		1897	excludes objects.
		1898
		1899	The parameter C<$family> should best start with the name of the extension
		1900	using it, it should be unique.
		1901
		1902	=over 4
		1903
		1904	=item $hashref = cf::db_get $family
		1905
		1906	Return a hashref for use by the extension C<$family>, which can be
		1907	modified. After modifications, you have to call C<cf::db_dirty> or
		1908	C<cf::db_sync>.
		1909
		1910	=item $value = cf::db_get $family => $key
		1911
		1912	Returns a single value from the database
		1913
		1914	=item cf::db_put $family => $hashref
		1915
		1916	Stores the given family hashref into the database. Updates are delayed, if
		1917	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1918
		1919	=item cf::db_put $family => $key => $value
		1920
		1921	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1922	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1923
		1924	=item cf::db_dirty
		1925
		1926	Marks the database as dirty, to be updated at a later time.
		1927
		1928	=item cf::db_sync
		1929
		1930	Immediately write the database to disk I<if it is dirty>.
		1931
		1932	=cut
		1933
		1934	our $DB;
		1935
		1936	{
		1937	my $path = cf::localdir . "/database.pst";
		1938
		1939	sub db_load() {
		1940	$DB = stat $path ? Storable::retrieve $path : { };
		1941	}
		1942
		1943	my $pid;
		1944
		1945	sub db_save() {
		1946	waitpid $pid, 0 if $pid;
		1947	if (0 == ($pid = fork)) {
		1948	$DB->{_meta}{version} = 1;
		1949	Storable::nstore $DB, "$path~";
		1950	rename "$path~", $path;
		1951	cf::_exit 0 if defined $pid;
		1952	}
		1953	}
		1954
		1955	my $dirty;
		1956
		1957	sub db_sync() {
		1958	db_save if $dirty;
		1959	undef $dirty;
		1960	}
		1961
		1962	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1963	db_sync;
		1964	});
		1965
		1966	sub db_dirty() {
		1967	$dirty = 1;
		1968	$idle->start;
		1969	}
		1970
		1971	sub db_get($;$) {
		1972	@_ >= 2
		1973	? $DB->{$_[0]}{$_[1]}
		1974	: ($DB->{$_[0]} ||= { })
		1975	}
		1976
		1977	sub db_put($$;$) {
		1978	if (@_ >= 3) {
		1979	$DB->{$_[0]}{$_[1]} = $_[2];
		1980	} else {
		1981	$DB->{$_[0]} = $_[1];
		1982	}
		1983	db_dirty;
		1984	}
		1985
		1986	cf::global->attach (
		1987	prio => 10000,
		1988	on_cleanup => sub {
		1989	db_sync;
		1990	},
		1991	);
		1992	}
		1993
864	#############################################################################	1994	#############################################################################
865	# the server's main()	1995	# the server's main()
866		1996
		1997	sub cfg_load {
		1998	open my $fh, "<:utf8", cf::confdir . "/config"
		1999	or return;
		2000
		2001	local $/;
		2002	*CFG = YAML::Syck::Load <$fh>;
		2003
		2004	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2005
		2006	if (exists $CFG{mlockall}) {
		2007	eval {
		2008	$CFG{mlockall} ? &mlockall : &munlockall
		2009	and die "WARNING: m(un)lockall failed: $!\n";
		2010	};
		2011	warn $@ if $@;
		2012	}
		2013	}
		2014
867	sub main {	2015	sub main {
		2016	# we must not ever block the main coroutine
		2017	local $Coro::idle = sub {
		2018	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2019	(Coro::unblock_sub {
		2020	Event::one_event;
		2021	})->();
		2022	};
		2023
		2024	cfg_load;
		2025	db_load;
		2026	load_extensions;
868	Event::loop;	2027	Event::loop;
869	}	2028	}
870		2029
871	#############################################################################	2030	#############################################################################
872	# initialisation	2031	# initialisation
873		2032
		2033	sub reload() {
		2034	# can/must only be called in main
		2035	if ($Coro::current != $Coro::main) {
		2036	warn "can only reload from main coroutine\n";
		2037	return;
		2038	}
		2039
		2040	warn "reloading...";
		2041
		2042	my $guard = freeze_mainloop;
		2043	cf::emergency_save;
		2044
		2045	eval {
		2046	# if anything goes wrong in here, we should simply crash as we already saved
		2047
		2048	# cancel all watchers
		2049	for (Event::all_watchers) {
		2050	$_->cancel if $_->data & WF_AUTOCANCEL;
		2051	}
		2052
		2053	# cancel all extension coros
		2054	$_->cancel for values %EXT_CORO;
		2055	%EXT_CORO = ();
		2056
		2057	# unload all extensions
		2058	for (@exts) {
		2059	warn "unloading <$_>";
		2060	unload_extension $_;
		2061	}
		2062
		2063	# unload all modules loaded from $LIBDIR
		2064	while (my ($k, $v) = each %INC) {
		2065	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2066
		2067	warn "removing <$k>";
		2068	delete $INC{$k};
		2069
		2070	$k =~ s/\.pm$//;
		2071	$k =~ s/\//::/g;
		2072
		2073	if (my $cb = $k->can ("unload_module")) {
		2074	$cb->();
		2075	}
		2076
		2077	Symbol::delete_package $k;
		2078	}
		2079
		2080	# sync database to disk
		2081	cf::db_sync;
		2082	IO::AIO::flush;
		2083
		2084	# get rid of safe::, as good as possible
		2085	Symbol::delete_package "safe::$_"
		2086	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2087
		2088	# remove register_script_function callbacks
		2089	# TODO
		2090
		2091	# unload cf.pm "a bit"
		2092	delete $INC{"cf.pm"};
		2093
		2094	# don't, removes xs symbols, too,
		2095	# and global variables created in xs
		2096	#Symbol::delete_package __PACKAGE__;
		2097
		2098	# reload cf.pm
		2099	warn "reloading cf.pm";
		2100	require cf;
		2101	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2102
		2103	# load config and database again
		2104	cf::cfg_load;
		2105	cf::db_load;
		2106
		2107	# load extensions
		2108	warn "load extensions";
		2109	cf::load_extensions;
		2110
		2111	# reattach attachments to objects
		2112	warn "reattach";
		2113	_global_reattach;
		2114	};
		2115
		2116	if ($@) {
		2117	warn $@;
		2118	warn "error while reloading, exiting.";
		2119	exit 1;
		2120	}
		2121
		2122	warn "reloaded successfully";
		2123	};
		2124
		2125	#############################################################################
		2126
		2127	unless ($LINK_MAP) {
		2128	$LINK_MAP = cf::map::new;
		2129
		2130	$LINK_MAP->width (41);
		2131	$LINK_MAP->height (41);
		2132	$LINK_MAP->alloc;
		2133	$LINK_MAP->path ("{link}");
		2134	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2135	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2136
		2137	# dirty hack because... archetypes are not yet loaded
		2138	Event->timer (
		2139	after => 2,
		2140	cb => sub {
		2141	$_[0]->w->cancel;
		2142
		2143	# provide some exits "home"
		2144	my $exit = cf::object::new "exit";
		2145
		2146	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2147	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2148	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2149
		2150	$LINK_MAP->insert ($exit->clone, 19, 19);
		2151	$LINK_MAP->insert ($exit->clone, 19, 20);
		2152	$LINK_MAP->insert ($exit->clone, 19, 21);
		2153	$LINK_MAP->insert ($exit->clone, 20, 19);
		2154	$LINK_MAP->insert ($exit->clone, 20, 21);
		2155	$LINK_MAP->insert ($exit->clone, 21, 19);
		2156	$LINK_MAP->insert ($exit->clone, 21, 20);
		2157	$LINK_MAP->insert ($exit->clone, 21, 21);
		2158
		2159	$exit->destroy;
		2160	});
		2161
		2162	$LINK_MAP->{deny_save} = 1;
		2163	$LINK_MAP->{deny_reset} = 1;
		2164
		2165	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2166	}
		2167
874	register "<global>", __PACKAGE__;	2168	register "<global>", __PACKAGE__;
875		2169
		2170	register_command "reload" => sub {
		2171	my ($who, $arg) = @_;
		2172
		2173	if ($who->flag (FLAG_WIZ)) {
		2174	$who->message ("start of reload.");
		2175	reload;
		2176	$who->message ("end of reload.");
		2177	}
		2178	};
		2179
876	unshift @INC, $LIBDIR;	2180	unshift @INC, $LIBDIR;
877		2181
878	load_extensions;
879
880	$TICK_WATCHER = Event->timer (	2182	$TICK_WATCHER = Event->timer (
		2183	reentrant => 0,
881	prio => 1,	2184	prio => 0,
882	at => $NEXT_TICK || 1,	2185	at => $NEXT_TICK || $TICK,
		2186	data => WF_AUTOCANCEL,
883	cb => sub {	2187	cb => sub {
884	cf::server_tick; # one server iteration	2188	cf::server_tick; # one server iteration
885		2189	$RUNTIME += $TICK;
886	my $NOW = Event::time;
887	$NEXT_TICK += $TICK;	2190	$NEXT_TICK += $TICK;
888		2191
889	# if we are delayed by four ticks, skip them all	2192	# if we are delayed by four ticks or more, skip them all
890	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2193	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
891		2194
892	$TICK_WATCHER->at ($NEXT_TICK);	2195	$TICK_WATCHER->at ($NEXT_TICK);
893	$TICK_WATCHER->start;	2196	$TICK_WATCHER->start;
894	},	2197	},
895	);	2198	);
896		2199
897	_reload_2;	2200	IO::AIO::max_poll_time $TICK * 0.2;
		2201
		2202	Event->io (
		2203	fd => IO::AIO::poll_fileno,
		2204	poll => 'r',
		2205	prio => 5,
		2206	data => WF_AUTOCANCEL,
		2207	cb => \&IO::AIO::poll_cb,
		2208	);
		2209
		2210	Event->timer (
		2211	data => WF_AUTOCANCEL,
		2212	after => 0,
		2213	interval => 10,
		2214	cb => sub {
		2215	(Coro::unblock_sub {
		2216	write_runtime
		2217	or warn "ERROR: unable to write runtime file: $!";
		2218	})->();
		2219	},
		2220	);
		2221
		2222	END { cf::emergency_save }
898		2223
899	1	2224	1
900		2225

Diff Legend

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