user_details.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef USER_DETAILS_H
#define USER_DETAILS_H
 
#include "bson/bson.h"
 
#include "jansson.h"
 
#include "typedefs.h"
#include "grassroots_users_library.h"
#include "linked_list.h"
#include "schema_keys.h"
#include "view_format.h"
 
 
typedef struct User
{
  bson_oid_t *us_id_p;
 
  char *us_email_s;
 
  char *us_surname_s;
 
  char *us_forename_s;
 
  char *us_org_s;
 
  char *us_orcid_s;
 
 
} User;
 
 
typedef struct UserNode
{
  ListItem un_node;
  User *un_user_p;
} UserNode;
 
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
 
#ifdef ALLOCATE_USER_TAGS
  #define USER_PREFIX  GRASSROOTS_USERS_API
  #define USER_VAL(x) = x
  #define USER_CONCAT_VAL(x,y) = x y
#else
  #define USER_PREFIX extern GRASSROOTS_USERS_API
  #define USER_VAL(x)
  #define USER_CONCAT_VAL(x,y)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
USER_PREFIX const char *US_FORENAME_S USER_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "givenName");
 
USER_PREFIX const char *US_SURNAME_S USER_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "familyName");
 
USER_PREFIX const char *US_EMAIL_S USER_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "email");
 
USER_PREFIX const char *US_AFFILATION_S USER_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "affiliation");
 
USER_PREFIX const char *US_ORCID_S USER_VAL ("orcid");
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
GRASSROOTS_USERS_API User *AllocateUser (bson_oid_t *id_p, const char *email_s, const char *forename_s, const char *surname_s, const char *org_s, const char *orcid_s);
 
 
GRASSROOTS_USERS_API void FreeUser (User *user_p);
 
 
GRASSROOTS_USERS_API json_t *GetUserAsJSON (const User *user_p, const ViewFormat vf);
 
 
 
GRASSROOTS_USERS_API User *GetUserFromJSON (const json_t *user_json_p);
 
 
 
GRASSROOTS_USERS_API User *GetUserFromNamedJSON (const json_t *json_p, const char *user_key_s);
 
 
 
GRASSROOTS_USERS_API bool AddUserToJSON (const User *user_p, json_t *json_p, const char * const user_key_s, const ViewFormat vf);
 
 
 
 
GRASSROOTS_USERS_API char *GetFullUsername (const User *user_p);
 
 
GRASSROOTS_USERS_API void FreeFullUsername (char *name_s);
 
 
GRASSROOTS_USERS_API UserNode *AllocateUserNode (User *user_p);
 
 
 
GRASSROOTS_USERS_API void FreeUserNode (ListItem *node_p);
 
 
 
#ifdef __cplusplus
}
#endif
 
 
#endif    /* #ifndef USER_DETAILS_H */