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.50 by root, Mon Aug 28 07:07:42 2006 UTC vs.
Revision 1.154 by root, Tue Jan 9 15:36:19 2007 UTC

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

Diff Legend

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