util.c File Reference

local function of delagent More...

#include "delagent.h"

Include dependency graph for util.c:

Go to the source code of this file.

Functions
int	printfInCaseOfVerbosity (const char *format,...)
	If verbose is on, print to stdout. More...
PGresult *	PQexecCheck (const char *desc, char *SQL, char *file, const int line)
	simple wrapper which includes PQexec and fo_checkPQcommand More...
void	PQexecCheckClear (const char *desc, char *SQL, char *file, const int line)
	Execute SQL query and create the result. More...
int	authentication (char *user, char *password, int *userId, int *userPerm)
	if this account is valid More...
int	check_permission_upload (int wanted_permissions, long uploadId, int userId, int userPerm)
	check if the upload can be deleted, that is the user have the permission to delete this upload More...
int	check_read_permission_upload (long uploadId, int userId, int userPerm)
	check if the user has read permission on the given upload More...
int	check_write_permission_upload (long uploadId, int userId, int userPerm)
	check if the user has read permission on the given upload More...
int	check_write_permission_folder (long folder_id, int userId, int userPerm)
	check if the upload can be deleted, that is the user have the permission to delete this upload More...
int	check_write_permission_license (long license_id, int userPerm)
	check if the license can be deleted, that is the user have the permission to delete this license More...
int	deleteUpload (long uploadId, int userId, int userPerm)
	Given an upload ID, delete it. More...
int	unlinkContent (long child, long parent, int mode, int userId, int userPerm)
	remove link between parent and (child,mode) if there are other parents More...
int	listFoldersRecurse (long Parent, int Depth, long Row, int DelFlag, int userId, int userPerm)
	Draw folder tree. More...
int	listFoldersFindDetatchedFolders (PGresult *result, int userId, int userPerm)
	Given a PGresult, find detached folders. More...
int	listFoldersFindDetatchedUploads (PGresult *result, int userId, int userPerm)
	Given a PGresult, find detached uploads. More...
int	listFoldersFindDetatched (int userId, int userPerm)
	Given a user id, find detached folders and uploads. More...
int	listFolders (int userId, int userPerm)
	List every folder. More...
int	listUploads (int userId, int userPerm)
	List every upload ID. More...
int	deleteFolder (long cFolder, long pFolder, int userId, int userPerm)
	recursively delete a folder More...
int	readAndProcessParameter (char *Parm, int userId, int userPerm)
	Parse parameters. More...
void	doSchedulerTasks ()
	process the jobs from scheduler More...
void	exitNow (int exitVal)
	Exit function. This does all cleanup and should be used instead of calling exit() or main() return. More...

Variables
int	Verbose = 0
	Verbose level. More...
int	Test = 0
PGconn *	pgConn = NULL
	Database connection. More...

Detailed Description

local function of delagent

delagent: Remove an upload from the DB and repository

Definition in file util.c.

Function Documentation

int authentication	(	char *	user,
		char *	password,
		int *	userId,
		int *	userPerm
	)

if this account is valid

Parameters

[in]	user	user name
[in]	password	password
[out]	userId	will be set to the id of the user
[out]	userPerm	will be set to the permission level of the user

Returns

1: invalid; 0: yes, valid; -1: failure

get user_seed, user_pass on one specified user

Definition at line 105 of file util.c.

int check_permission_upload	(	int	wanted_permissions,
		long	uploadId,
		int	userId,
		int	userPerm
	)

check if the upload can be deleted, that is the user have the permission to delete this upload

Parameters

uploadId	upload id
user_name	user name

Returns

0: yes, you have the needed permissions; 1: no; -1: failure; -2: does not exist

Definition at line 169 of file util.c.

int check_read_permission_upload	(	long	uploadId,
		int	userId,
		int	userPerm
	)

check if the user has read permission on the given upload

Parameters

uploadId
userId
userPerm	Permission requested by user

Returns

0: yes, you have the needed permissions; 1: no; -1: failure; -2: does not exist

Definition at line 200 of file util.c.

int check_write_permission_folder	(	long	folder_id,
		int	userId,
		int	userPerm
	)

check if the upload can be deleted, that is the user have the permission to delete this upload

Parameters

uploadId	upload id
user_name	user name
userPerm	Permission requested by user

Returns

0: yes, can be deleted; 1: can not be deleted; -1: failure;

Definition at line 232 of file util.c.

int check_write_permission_license	(	long	license_id,
		int	userPerm
	)

check if the license can be deleted, that is the user have the permission to delete this license

Parameters

license_id	license id
userPerm	Permission requested by user

Returns

0: yes, can be deleted; 1: can not be deleted;

Definition at line 267 of file util.c.

int check_write_permission_upload	(	long	uploadId,
		int	userId,
		int	userPerm
	)

check if the user has read permission on the given upload

Parameters

uploadId
userId
userPerm	Permission requested by user

Returns

0: yes, you have the needed permissions; 1: no; -1: failure; -2: does not exist

Definition at line 215 of file util.c.

int deleteFolder	(	long	cFolder,
		long	pFolder,
		int	userId,
		int	userPerm
	)

recursively delete a folder

Given a folder ID, delete it AND recursively delete everything below it! This includes upload deletion!

Parameters

cFolder	the folder id to delete
pFolder	parent of the current folder
userId
userPerm	permission level the user has

Returns

0: success; 1: fail -1: failure

Definition at line 940 of file util.c.

int deleteUpload	(	long	uploadId,
		int	userId,
		int	userPerm
	)

Given an upload ID, delete it.

Parameters

uploadId	the upload id
userId
userPerm	permission level the user has

Returns

0: yes, can is deleted; 1: can not be deleted; -1: failure; -2: does not exist

Definition at line 289 of file util.c.

void doSchedulerTasks

(

)

process the jobs from scheduler

1. Read the jobs from the scheduler using fo_scheduler_next().
2. Get the permission level of the current user.
3. Parse the parameters and process

   See also

   fo_scheduler_next()

   readAndProcessParameter()

Definition at line 1060 of file util.c.

void exitNow

(

int

exitVal

)

Exit function. This does all cleanup and should be used instead of calling exit() or main() return.

Parameters

ExitVal

Exit value

Returns

void Calls exit()

Definition at line 1099 of file util.c.

int listFolders	(	int	userId,
		int	userPerm
	)

List every folder.

Parameters

userId
userPerm	permission level the user has

Definition at line 843 of file util.c.

int listFoldersFindDetatched	(	int	userId,
		int	userPerm
	)

Given a user id, find detached folders and uploads.

Parameters

userId
userPerm	permission level the user has

Returns

0: success; 1: fail; -1: failure

Definition at line 811 of file util.c.

int listFoldersFindDetatchedFolders	(	PGresult *	result,
		int	userId,
		int	userPerm
	)

Given a PGresult, find detached folders.

Parameters

result	PGresult from a query
userId
userPerm	permission level the user has

Returns

0: success; 1: fail; -1: failure

Definition at line 708 of file util.c.

int listFoldersFindDetatchedUploads	(	PGresult *	result,
		int	userId,
		int	userPerm
	)

Given a PGresult, find detached uploads.

Parameters

result	PGresult from a query
userId
userPerm	permission level the user has

Returns

0: success

Definition at line 762 of file util.c.

int listFoldersRecurse	(	long	Parent,
		int	Depth,
		long	Row,
		int	DelFlag,
		int	userId,
		int	userPerm
	)

Draw folder tree.

if DelFlag is set, then all child uploads are deleted and the folders are deleted.

Parameters

Parent	the parent folder id
Depth
row	grandparent (used to unlink if multiple grandparents)
DelFlag	0=no del, 1=del if unique parent, 2=del unconditional
userId
userPerm	permission level the user has

Returns

0: success; 1: fail; -1: failure

Definition at line 520 of file util.c.

int listUploads	(	int	userId,
		int	userPerm
	)

List every upload ID.

Parameters

userId	user id
userPerm	permission level the user has

Returns

0 on success; -1 on failure

Definition at line 886 of file util.c.

PGresult* PQexecCheck	(	const char *	desc,
		char *	SQL,
		char *	file,
		const int	line
	)

simple wrapper which includes PQexec and fo_checkPQcommand

Parameters

desc	description for the SQL command, else NULL
SQL	SQL command executed
file	source file name
line	source line number

Returns

PQexec query result

See also

PQexec()

Definition at line 61 of file util.c.

void PQexecCheckClear	(	const char *	desc,
		char *	SQL,
		char *	file,
		const int	line
	)

Execute SQL query and create the result.

See also

PQexecCheck()

Definition at line 86 of file util.c.

int printfInCaseOfVerbosity	(	const char *	format,
			...
	)

If verbose is on, print to stdout.

Parameters

format	printf format to use for printing
...	Data to be printed

Returns

Number of characters printed

Definition at line 38 of file util.c.

int readAndProcessParameter	(	char *	Parm,
		int	userId,
		int	userPerm
	)

Parse parameters.

Read Parameter from scheduler. Process line elements.

Parameters

Parm	the parameter string
userId
userPerm	permission level the user has

Returns

0: yes, can is deleted; 1: can not be deleted; -1: failure; -2: does not exist

Get the type of command: delete or list

Get the target

Definition at line 964 of file util.c.

int unlinkContent	(	long	child,
		long	parent,
		int	mode,
		int	userId,
		int	userPerm
	)

remove link between parent and (child,mode) if there are other parents

Parameters

child	id of the child to be unlinked
parent	id of the parent to unlink from
mode	1<<0 child is folder_fk, 1<<1 child is upload_fk, 1<<2 child is an uploadtree_fk
userPerm	permission level the user has

Returns

0: successfully deleted link (other link existed); 1: was not able to delete the link (no other link to this upload existed); -1: failure

Todo:

add permission checks

Definition at line 458 of file util.c.

Variable Documentation

PGconn* pgConn = NULL

Database connection.

DB connection.

Definition at line 30 of file util.c.

int Test = 0

Set if working in test mode else 0

Definition at line 29 of file util.c.

int Verbose = 0

Verbose level.

Global verbose level.

Contains all the functions supported by delagent

Definition at line 28 of file util.c.