mirror of https://github.com/acanas/swad-core.git
96 lines
4.0 KiB
C
96 lines
4.0 KiB
C
// swad_file.h: files
|
|
|
|
#ifndef _SWAD_FIL
|
|
#define _SWAD_FIL
|
|
/*
|
|
SWAD (Shared Workspace At a Distance in Spanish),
|
|
is a web platform developed at the University of Granada (Spain),
|
|
and used to support university teaching.
|
|
|
|
This file is part of SWAD core.
|
|
Copyright (C) 1999-2024 Antonio Cañas Vargas
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
/*****************************************************************************/
|
|
/********************************* Headers ***********************************/
|
|
/*****************************************************************************/
|
|
|
|
#include <stdbool.h> // For boolean type
|
|
#include <stdio.h> // For FILE
|
|
#include <time.h> // For time_t
|
|
|
|
/*****************************************************************************/
|
|
/************************** Public types and constants ***********************/
|
|
/*****************************************************************************/
|
|
|
|
#define Fil_MIN_BYTES_FILE_EXTENSION 1
|
|
#define Fil_MAX_BYTES_FILE_EXTENSION 5
|
|
|
|
#define Fil_NAME_OF_PARAM_FILENAME_ORG "file"
|
|
|
|
// Maximum allowed size (in bytes) of a file when uploading it.
|
|
// Must be < 2 GiB, because off_t type is of type long int
|
|
#define Fil_MAX_FILE_SIZE (2000ULL * 1024ULL * 1024ULL) // 2000 MiB = 1.95 GiB
|
|
|
|
#define Fil_MAX_BYTES_FILE_SIZE_STRING (32 - 1)
|
|
|
|
/*****************************************************************************/
|
|
/***************************** Public prototypes *****************************/
|
|
/*****************************************************************************/
|
|
|
|
FILE *Fil_GetQueryFile (void);
|
|
void Fil_SetOutputFileToStdout (void);
|
|
FILE *Fil_GetOutputFile (void);
|
|
|
|
void Fil_CreateFileForHTMLOutput (void);
|
|
void Fil_CloseAndRemoveFileForHTMLOutput (void);
|
|
bool Fil_ReadStdinIntoTmpFile (void);
|
|
void Fil_EndOfReadingStdin (void);
|
|
struct Par_Param *Fil_StartReceptionOfFile (const char *ParFile,
|
|
char *FileName,char *MIMEType);
|
|
bool Fil_EndReceptionOfFile (char *FileNameDataTmp,struct Par_Param *Par);
|
|
void Fil_CreateUpdateFile (const char CurrentName[PATH_MAX + 1],
|
|
const char *ExtensionOldName,
|
|
char OldName[PATH_MAX + 1],
|
|
char NewName[PATH_MAX + 1],
|
|
FILE **NewFile);
|
|
void Fil_CloseUpdateFile (const char CurrentName[PATH_MAX + 1],
|
|
const char OldName[PATH_MAX + 1],
|
|
const char NewName[PATH_MAX + 1],
|
|
FILE *NewFile);
|
|
|
|
bool Fil_CheckIfPathExists (const char *Path);
|
|
void Fil_CreateDirIfNotExists (const char *Path);
|
|
void Fil_RemoveTree (const char *Path);
|
|
|
|
void Fil_RemoveOldTmpFiles (const char *Path,time_t TimeToRemove,
|
|
bool RemoveDirectory);
|
|
void Fil_FastCopyOfFiles (const char *PathSrc,const char *PathTgt);
|
|
void Fil_FastCopyOfOpenFiles (FILE *FileSrc,FILE *FileTgt);
|
|
|
|
void Fil_WriteFileSizeBrief (double SizeInBytes,
|
|
char FileSizeStr[Fil_MAX_BYTES_FILE_SIZE_STRING + 1]);
|
|
void Fil_WriteFileSizeFull (double SizeInBytes,
|
|
char FileSizeStr[Fil_MAX_BYTES_FILE_SIZE_STRING + 1]);
|
|
|
|
//------------------------------- File caches ---------------------------------
|
|
|
|
void Fil_AddPublicDirToCache (const char *FullPathPriv,
|
|
const char TmpPubDir[PATH_MAX + 1]);
|
|
bool Fil_GetPublicDirFromCache (const char *FullPathPriv,
|
|
char TmpPubDir[PATH_MAX + 1]);
|
|
|
|
#endif
|