file_c.c File Reference

File cache management. More...

#include "config.h"
#include "constants.h"
#include "typedefs.h"
#include "macros.h"
#include "externs.h"
#include "prototypes.h"
#include <stdbool.h>
#include <fcntl.h>
#include <string.h>
#include <unistd.h>

Include dependency graph for file_c.c:

Functions
void	do_list_file (dbref player, dbref cause __attribute__((unused)), int extra __attribute__((unused)), char *arg)
	Show text file. More...
FBLOCK *	fcache_fill (FBLOCK *fp, char ch)
	Add date to a file block. More...
int	fcache_read (FBLOCK **cp, char *filename)
	Read a file into cache. More...
void	fcache_rawdump (int fd, int num)
	Raw dump a cache file to a file descriptor. More...
void	fcache_dump (DESC *d, int num)
	Dump a file to a descriptor. More...
void	fcache_send (dbref player, int num)
	Send the content of a file cache to a player. More...
void	fcache_load (dbref player)
	Load all files into cache. More...
void	fcache_init (void)
	Initialize the file cache. More...

Variables
FCACHE	fcache []
	Text files cache. More...

Detailed Description

File cache management.

Author

TinyMUSH development team (https://github.com/TinyMUSH)

Version

3.3

Date

2021-01-04

Copyright

Copyright (C) 1989-2021 TinyMUSH development team. You may distribute under the terms the Artistic License, as specified in the COPYING file.

Function Documentation

do_list_file()

void do_list_file	(	dbref	player,
		dbref cause	__attribute__(unused),
		int extra	__attribute__(unused),
		char *	arg
	)

Show text file.

Parameters

player	DBref of player
cause	Not used
extra	Not used
arg	File to show

fcache_dump()

void fcache_dump	(	DESC *	d,
		int	num
	)

Dump a file to a descriptor.

Parameters

d	Descriptor
num	Index of the file in the file cache

fcache_fill()

FBLOCK * fcache_fill	(	FBLOCK *	fp,
		char	ch
	)

Add date to a file block.

Parameters

fp	File block
ch	character to add

Returns

FBLOCK* Updated file block.

We filled the current buffer. Go get a new one.

fcache_init()

void fcache_init

(

void

)

Initialize the file cache.

fcache_load()

void fcache_load

(

dbref

player

)

Load all files into cache.

Parameters

player

DBref of player

fcache_rawdump()

void fcache_rawdump	(	int	fd,
		int	num
	)

Raw dump a cache file to a file descriptor.

Parameters

fd	File descriptor
num	Index of the file in the file cache

fcache_read()

int fcache_read	(	FBLOCK **	cp,
		char *	filename
	)

Read a file into cache.

Parameters

cp	Cache buffer
filename	File to read

Returns

int Size of cached text.

Free a prior buffer chain

Set up the initial cache buffer to make things easier

Read the text file into a new chain

Failure: log the event

Process the file, one lbuf at a time

If we didn't read anything in, toss the initial buffer

fcache_send()

void fcache_send	(	dbref	player,
		int	num
	)

Send the content of a file cache to a player.

Parameters

player	DBref of player
num	Index of the file in the file cache

Variable Documentation

fcache

FCACHE fcache[]

Initial value:

= {
    {&mushconf.conn_file, NULL, "Conn"},
    {&mushconf.site_file, NULL, "Conn/Badsite"},
    {&mushconf.down_file, NULL, "Conn/Down"},
    {&mushconf.full_file, NULL, "Conn/Full"},
    {&mushconf.guest_file, NULL, "Conn/Guest"},
    {&mushconf.creg_file, NULL, "Conn/Reg"},
    {&mushconf.crea_file, NULL, "Crea/Newuser"},
    {&mushconf.regf_file, NULL, "Crea/RegFail"},
    {&mushconf.motd_file, NULL, "Motd"},
    {&mushconf.wizmotd_file, NULL, "Wizmotd"},
    {&mushconf.quit_file, NULL, "Quit"},
    {&mushconf.htmlconn_file, NULL, "Conn/Html"},
    {NULL, NULL, NULL}}

Text files cache.