storage/storage.h File Reference

#include <gdbm.h>
#include <sys/types.h>
#include "class.h"

Include dependency graph for storage/storage.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	StoragePutResult { SPR_OK = 0, SPR_READ_ONLY = 1, SPR_EXISTS = 2, SPR_UNKNOWN = -1 }

Functions
	CLASS (Storage)
StoragePutResult	storagePut (Storage, char *, size_t, char *, size_t)
StoragePutResult	storageUpdate (Storage, char *, size_t, char *, size_t)
void	storageGet (Storage, char *, size_t, char **, size_t *)
int	storageDelete (Storage, char *, size_t)

Detailed Description

Author

Georg Hopp

Copyright

Copyright © 2012 Georg Hopp

This program is free software: you can redistribute it and/or modify it under the terms of the GNU 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file storage/storage.h.

Enumeration Type Documentation

enum StoragePutResult

Enumerator
SPR_OK
SPR_READ_ONLY
SPR_EXISTS
SPR_UNKNOWN

Definition at line 32 of file storage/storage.h.

                                 {
    SPR_OK        = 0,
    SPR_READ_ONLY = 1,
    SPR_EXISTS    = 2,
    SPR_UNKNOWN   = -1
} StoragePutResult;

Function Documentation

CLASS

(

Storage

)

Definition at line 40 of file storage/storage.h.

               {
    GDBM_FILE   gdbm;
    char      * db_name;
};

int storageDelete	(	Storage	,
		char *	,
		size_t
	)

Definition at line 34 of file storage/delete.c.

References FALSE, and TRUE.

Referenced by applicationCreateUser().

{
    datum key = {_key, nkey};

    switch (gdbm_delete(this->gdbm, key)) {
        case 0:
            return TRUE;
        case -1:
        default:
            return FALSE;
    }

    return FALSE;
}

Here is the caller graph for this function:

void storageGet	(	Storage	,
		char *	,
		size_t	,
		char **	,
		size_t *
	)

Definition at line 34 of file storage/get.c.

References MEM_FREE, and memMalloc().

Referenced by applicationGetUser(), applicationLogin(), and authStorageAuthenticate().

{
    char  * key      = memMalloc(nkey);
    datum   gdbm_key = {key, nkey};
    datum   value;

    if (NULL == this) {
        *data  = NULL;
        *ndata = 0;
    }

    memcpy(key, _key, nkey);
    value = gdbm_fetch(this->gdbm, gdbm_key);
    MEM_FREE(key);

    if (NULL != value.dptr) {
        *ndata = value.dsize;
        *data  = memMalloc(value.dsize);
        memcpy(*data, value.dptr, value.dsize);

        free(value.dptr);
    } else {
        *data  = NULL;
        *ndata = 0;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

StoragePutResult storagePut	(	Storage	,
		char *	,
		size_t	,
		char *	,
		size_t
	)

Definition at line 34 of file storage/put.c.

References SPR_EXISTS, SPR_OK, SPR_READ_ONLY, and SPR_UNKNOWN.

Referenced by applicationCreateUser(), and applicationLogin().

{
    datum key   = {_key, nkey};
    datum value = {data, ndata};

    switch (gdbm_store(this->gdbm, key, value, GDBM_INSERT)) {
        case 0:
            return SPR_OK;
        case 1:
            return SPR_EXISTS;
        case -1:
            return SPR_READ_ONLY;
        default:
            return SPR_UNKNOWN;
    }

    return SPR_UNKNOWN;
}

Here is the caller graph for this function:

StoragePutResult storageUpdate	(	Storage	,
		char *	,
		size_t	,
		char *	,
		size_t
	)

Definition at line 33 of file storage/update.c.

References SPR_OK, SPR_READ_ONLY, and SPR_UNKNOWN.

Referenced by applicationUpdatePassword(), and applicationUpdateUser().

{
    datum key   = {_key, nkey};
    datum value = {data, ndata};

    switch (gdbm_store(this->gdbm, key, value, GDBM_REPLACE)) {
        case 0:
            return SPR_OK;
        case -1:
            return SPR_READ_ONLY;
        default:
            return SPR_UNKNOWN;
    }

    return SPR_UNKNOWN;
}

Here is the caller graph for this function: