mirror of https://github.com/acanas/swad-core.git
145 lines
6.4 KiB
C
145 lines
6.4 KiB
C
// swad_image.h: processing of image uploaded in a form
|
|
|
|
#ifndef _SWAD_IMG
|
|
#define _SWAD_IMG
|
|
/*
|
|
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-2017 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 ***********************************/
|
|
/*****************************************************************************/
|
|
|
|
/*****************************************************************************/
|
|
/***************************** Public constants ******************************/
|
|
/*****************************************************************************/
|
|
|
|
#define Img_BYTES_NAME Cry_BYTES_ENCRYPTED_STR_SHA256_BASE64
|
|
|
|
#define Img_MAX_CHARS_TITLE (128 - 1) // 127
|
|
#define Img_MAX_BYTES_TITLE ((Img_MAX_CHARS_TITLE + 1) * Str_MAX_BYTES_PER_CHAR - 1) // 2047
|
|
|
|
#define Img_MAX_CHARS_ATTRIBUTION (256 - 1) // 255
|
|
#define Img_MAX_BYTES_ATTRIBUTION ((Img_MAX_CHARS_ATTRIBUTION + 1) * Str_MAX_BYTES_PER_CHAR - 1) // 4095
|
|
|
|
/*****************************************************************************/
|
|
/******************************* Public types ********************************/
|
|
/*****************************************************************************/
|
|
|
|
/***** Action to perform when editing a form with an image *****/
|
|
#define Img_NUM_ACTIONS 4
|
|
typedef enum
|
|
{
|
|
Img_ACTION_NEW_IMAGE, // Upload new image
|
|
Img_ACTION_KEEP_IMAGE, // Keep current image unchanged
|
|
Img_ACTION_CHANGE_IMAGE, // Change existing image by a new image
|
|
Img_ACTION_NO_IMAGE, // Do not use image (remove current image if exists)
|
|
} Img_Action_t;
|
|
#define Img_ACTION_DEFAULT Img_ACTION_NO_IMAGE
|
|
|
|
/***** Status of an image file *****/
|
|
/*
|
|
No image Original file Temporary Definitive Name of the image
|
|
uploaded uploaded by user processed image processed image stored in database
|
|
--------- --------------------------- ------------------ ------------------ ---------------------
|
|
Img_NONE Img_FILE_RECEIVED Img_FILE_PROCESSED Img_FILE_MOVED Img_NAME_STORED_IN_DB
|
|
--------- --------------------------- ------------------ ------------------ ---------------------
|
|
-> upload-file -> -> process-file -> b -> move-file -> -> insert-name ->
|
|
--------- --------------------------- ------------------ ------------------ ---------------------
|
|
file.ext / / / xx-unique-name
|
|
| | |
|
|
var var var
|
|
| | |
|
|
www www www
|
|
| | |
|
|
swad swad swad
|
|
| | |
|
|
img img img
|
|
| | |
|
|
tmp tmp xx (2 first chars)
|
|
| | |
|
|
xx-unique-name_original.ext xx-unique-name.jpg xx-unique-name.jpg
|
|
|
|
xx-unique-name: a unique name encrypted starting by two random chars xx
|
|
*/
|
|
typedef enum
|
|
{
|
|
Img_FILE_NONE,
|
|
Img_FILE_RECEIVED,
|
|
Img_FILE_PROCESSED,
|
|
Img_FILE_MOVED,
|
|
Img_NAME_STORED_IN_DB,
|
|
} Img_FileStatus_t;
|
|
|
|
/***** Struct used to get images from forms *****/
|
|
struct Image
|
|
{
|
|
Img_Action_t Action;
|
|
Img_FileStatus_t Status;
|
|
char Name[Img_BYTES_NAME + 1];
|
|
char *Title; // Title/attribution (it must be initialized to NULL
|
|
// in order to not trying to free it when no memory allocated)
|
|
char *URL; // URL, i.e. link to original big photo or video
|
|
// (it must be initialized to NULL
|
|
// in order to not trying to free it when no memory allocated)
|
|
unsigned Width;
|
|
unsigned Height;
|
|
unsigned Quality;
|
|
};
|
|
|
|
/***** Parameters used in a form to upload an image *****/
|
|
#define Img_MAX_BYTES_PARAM_UPLOAD_IMG (16 - 1)
|
|
struct ParamUploadImg
|
|
{
|
|
char Action[Img_MAX_BYTES_PARAM_UPLOAD_IMG + 1];
|
|
char File [Img_MAX_BYTES_PARAM_UPLOAD_IMG + 1];
|
|
char Title [Img_MAX_BYTES_PARAM_UPLOAD_IMG + 1];
|
|
char URL [Img_MAX_BYTES_PARAM_UPLOAD_IMG + 1];
|
|
};
|
|
|
|
/*****************************************************************************/
|
|
/***************************** Public prototypes *****************************/
|
|
/*****************************************************************************/
|
|
|
|
void Img_ImageConstructor (struct Image *Image);
|
|
void Img_ResetImageExceptTitleAndURL (struct Image *Image);
|
|
void Img_ImageDestructor (struct Image *Image);
|
|
void Img_FreeImageTitle (struct Image *Image);
|
|
void Img_FreeImageURL (struct Image *Image);
|
|
|
|
void Img_GetImageNameTitleAndURLFromRow (const char *Name,
|
|
const char *Title,
|
|
const char *URL,
|
|
struct Image *Image);
|
|
|
|
void Img_PutImageUploader (int NumImgInForm,const char *ClassImgTitURL);
|
|
void Img_GetImageFromForm (int NumImgInForm,struct Image *Image,
|
|
void (*GetImageFromDB) (int NumImgInForm,struct Image *Image));
|
|
void Img_SetParamNames (struct ParamUploadImg *ParamUploadImg,int NumImgInForm);
|
|
Img_Action_t Img_GetImageActionFromForm (const char *ParamAction);
|
|
void Img_GetAndProcessImageFileFromForm (struct Image *Image,const char *ParamFile);
|
|
|
|
void Img_MoveImageToDefinitiveDirectory (struct Image *Image);
|
|
void Img_ShowImage (struct Image *Image,
|
|
const char *ClassContainer,const char *ClassImg);
|
|
void Img_RemoveImageFile (const char *ImageName);
|
|
|
|
#endif
|