Ye_Ol_Pi_Shack
/
CppCMS
2
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 1 Wiki Activity
ChipMaster's trial hacks on C++CMS starting with v1.2.1. Not sure I'll follow on with the v2 since it looks to be breaking and mostly frivolous.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1318 Commits
2 Branches
13 MiB
 
 
 
 
 
 
Tree: de995bae7a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'de995bae7a'
${ noResults }
CppCMS/cppcms/capi/session.h

171 lines
7.6 KiB
Raw Blame History 

  1. ///////////////////////////////////////////////////////////////////////////////

  2. //                                                                             

  3. //  Copyright (C) 2008-2012  Artyom Beilis (Tonkikh) <artyomtnk@yahoo.com>     

  4. //                                                                             

  5. //  See accompanying file COPYING.TXT file for licensing details.

  6. //

  7. ///////////////////////////////////////////////////////////////////////////////

  8. #ifndef CPPCMS_CAPI_SESSION_H

  9. #define CPPCMS_CAPI_SESSION_H

  10. #include <cppcms/defs.h>

  11. 

  12. #ifdef __cplusplus

  13. extern "C" {

  14. #endif

  15. ///

  16. /// \defgroup capi_session CppCMS C Session API 

  17. /// @{

  18. /// \ver{v1_2}

  19. ///

  20. 

  21. /// \defgroup capi_session_expiration Expiration Codes

  22. /// @{

  23. #define CPPCMS_CAPI_SESSION_FIXED	0 ///< Fixed session expiration 

  24. #define CPPCMS_CAPI_SESSION_RENEW	1 ///< Session expiration automatically renewed on access 

  25. #define CPPCMS_CAPI_SESSION_BROWSER	2 ///< Session is tied to browser session

  26. /// @}

  27. 

  28. ///

  29. /// \defgroup capi_session_error_handling Error Handling

  30. /// @{

  31. #define CPPCMS_CAPI_ERROR_OK		0 ///< Success 

  32. #define CPPCMS_CAPI_ERROR_GENERAL	1 ///< Uncategorized error

  33. #define CPPCMS_CAPI_ERROR_RUNTIME	2 ///< Runtime Error occured

  34. #define CPPCMS_CAPI_ERROR_INVALID_ARGUMENT	4 ///< Invalid Argument Provided

  35. #define CPPCMS_CAPI_ERROR_LOGIC		5 ///< Invalid API Use

  36. #define CPPCMS_CAPI_ERROR_ALLOC		6 ///< Allocation Failed

  37. 

  38. ///

  39. /// "Base class" for cppcms_capi_session, cppcms_capi_session_pool, and cppcms_capi_cookie

  40. ///

  41. /// Is used to get error status of the object

  42. ///

  43. typedef void *cppcms_capi_object; 

  44. 

  45. /// @}

  46. 

  47. /// Class that represents cppcms::session_pool in C

  48. ///

  49. /// \defgroup cppcms_capi_session_pool Session Pool

  50. typedef struct cppcms_capi_session_pool cppcms_capi_session_pool;

  51. /// Class that represents cppcms::session_interface in C

  52. ///

  53. /// \defgroup cppcms_capi_session_pool_init_from_json Session Interface

  54. typedef struct cppcms_capi_session cppcms_capi_session;

  55. /// Class that represents cppcms::http::cookie in C

  56. ///

  57. /// \defgroup cppcms_capi_session_cookie Cookie

  58. typedef struct cppcms_capi_cookie cppcms_capi_cookie;

  59. 

  60. ///

  61. /// \addtogroup capi_session_error_handling 

  62. /// @{

  63. 

  64. CPPCMS_API int cppcms_capi_error(cppcms_capi_object obj); ///< Get error code for the object

  65. CPPCMS_API char const *cppcms_capi_error_message(cppcms_capi_object obj); ///< Get error message for the object

  66. CPPCMS_API char const *cppcms_capi_error_clear(cppcms_capi_object obj); ///< Clear error and get last message

  67. 

  68. /// @}

  69. 

  70. /// \addtogroup cppcms_capi_session_pool

  71. /// @{

  72. 

  73. /// Create new empty pool object, returns NULL in case of fatal error

  74. CPPCMS_API cppcms_capi_session_pool *cppcms_capi_session_pool_new();

  75. /// Destroys pool object

  76. CPPCMS_API void cppcms_capi_session_pool_delete(cppcms_capi_session_pool *pool);

  77. 

  78. /// Initialize the pool from CppCMS configuration file,\a config_file

  79. CPPCMS_API int cppcms_capi_session_pool_init(cppcms_capi_session_pool *pool,char const *config_file);

  80. /// Initialize the pool from CppCMS configuration in json fromat \a json

  81. CPPCMS_API int cppcms_capi_session_pool_init_from_json(cppcms_capi_session_pool *pool,char const *json);

  82. 

  83. /// @}

  84. 

  85. CPPCMS_API cppcms_capi_session *cppcms_capi_session_new();

  86. CPPCMS_API void cppcms_capi_session_delete(cppcms_capi_session *session);

  87. 

  88. 

  89. CPPCMS_API int cppcms_capi_session_init(cppcms_capi_session *session,cppcms_capi_session_pool *pool);

  90. 

  91. CPPCMS_API int cppcms_capi_session_clear(cppcms_capi_session *session);

  92. 

  93. CPPCMS_API int cppcms_capi_session_is_set(cppcms_capi_session *session,char const *key);

  94. CPPCMS_API int cppcms_capi_session_erase(cppcms_capi_session *session,char const *key);

  95. CPPCMS_API int cppcms_capi_session_get_exposed(cppcms_capi_session *session,char const *key);

  96. CPPCMS_API int cppcms_capi_session_set_exposed(cppcms_capi_session *session,char const *key,int is_exposed);

  97. 

  98. CPPCMS_API char const *cppcms_capi_session_get_first_key(cppcms_capi_session *session);

  99. CPPCMS_API char const *cppcms_capi_session_get_next_key(cppcms_capi_session *session);

  100. 

  101. 

  102. CPPCMS_API char const *cppcms_capi_session_get_csrf_token(cppcms_capi_session *session);

  103. 

  104. 

  105. CPPCMS_API int cppcms_capi_session_set(cppcms_capi_session *session,char const *key,char const *value);

  106. CPPCMS_API char const *cppcms_capi_session_get(cppcms_capi_session *session,char const *key);

  107. 

  108. CPPCMS_API int cppcms_capi_session_set_binary_as_hex(cppcms_capi_session *session,char const *key,char const *value);

  109. CPPCMS_API char const *cppcms_capi_session_get_binary_as_hex(cppcms_capi_session *session,char const *key);

  110. 

  111. CPPCMS_API int cppcms_capi_session_set_binary(cppcms_capi_session *session,char const *key,void const *value,int length);

  112. CPPCMS_API int cppcms_capi_session_get_binary(cppcms_capi_session *session,char const *key,void *buf,int buffer_size);

  113. CPPCMS_API int cppcms_capi_session_get_binary_len(cppcms_capi_session *session,char const *key);

  114. 

  115. 

  116. CPPCMS_API int cppcms_capi_session_reset_session(cppcms_capi_session *session);

  117. 

  118. CPPCMS_API int cppcms_capi_session_set_default_age(cppcms_capi_session *session);

  119. CPPCMS_API int cppcms_capi_session_set_age(cppcms_capi_session *session,int t);

  120. CPPCMS_API int cppcms_capi_session_get_age(cppcms_capi_session *session);

  121. 

  122. CPPCMS_API int cppcms_capi_session_set_default_expiration(cppcms_capi_session *session);

  123. /// Define expiration method

  124. CPPCMS_API int cppcms_capi_session_set_expiration(cppcms_capi_session *session,int t);

  125. /// Get current expiration method

  126. CPPCMS_API int cppcms_capi_session_get_expiration(cppcms_capi_session *session);

  127. 

  128. CPPCMS_API int cppcms_capi_session_set_on_server(cppcms_capi_session *session,int is_on_server);

  129. CPPCMS_API int cppcms_capi_session_get_on_server(cppcms_capi_session *session);

  130. 

  131. CPPCMS_API char const *cppcms_capi_session_get_session_cookie_name(cppcms_capi_session *session);

  132. CPPCMS_API int cppcms_capi_session_set_session_cookie(cppcms_capi_session *session,char const *session_cookie_value);

  133. CPPCMS_API int cppcms_capi_session_add_cookie_name(cppcms_capi_session *session,char const *name);

  134. CPPCMS_API int cppcms_capi_session_load(cppcms_capi_session *session);

  135. CPPCMS_API int cppcms_capi_session_save(cppcms_capi_session *session);

  136. 

  137. CPPCMS_API cppcms_capi_cookie *cppcms_capi_session_cookie_first(cppcms_capi_session *session);

  138. CPPCMS_API cppcms_capi_cookie *cppcms_capi_session_cookie_next(cppcms_capi_session *session);

  139. 

  140. CPPCMS_API void cppcms_capi_cookie_delete(cppcms_capi_cookie *cookie);

  141. 

  142. CPPCMS_API char const *cppcms_capi_cookie_header(cppcms_capi_cookie const *cookie);

  143. CPPCMS_API char const *cppcms_capi_cookie_header_content(cppcms_capi_cookie const *cookie);

  144. 

  145. CPPCMS_API char const *cppcms_capi_cookie_name(cppcms_capi_cookie const *cookie);

  146. CPPCMS_API char const *cppcms_capi_cookie_value(cppcms_capi_cookie const *cookie);

  147. CPPCMS_API char const *cppcms_capi_cookie_path(cppcms_capi_cookie const *cookie);

  148. CPPCMS_API char const *cppcms_capi_cookie_domain(cppcms_capi_cookie const *cookie);

  149. 

  150. CPPCMS_API int cppcms_capi_cookie_max_age_defined(cppcms_capi_cookie const *cookie);

  151. CPPCMS_API unsigned cppcms_capi_cookie_max_age(cppcms_capi_cookie const *cookie);

  152. 

  153. CPPCMS_API int cppcms_capi_cookie_expires_defined(cppcms_capi_cookie const *cookie);

  154. CPPCMS_API long long cppcms_capi_cookie_expires(cppcms_capi_cookie const *cookie);

  155. 

  156. CPPCMS_API int cppcms_capi_cookie_is_secure(cppcms_capi_cookie const *cookie);

  157. 

  158. CPPCMS_API int cppcms_capi_cookie_is_httponly(cppcms_capi_cookie const *cookie);

  159. 

  160. CPPCMS_API int cppcms_capi_cookie_samesite_none_defined(cppcms_capi_cookie const *cookie);

  161. CPPCMS_API int cppcms_capi_cookie_samesite_lax_defined(cppcms_capi_cookie const *cookie);

  162. CPPCMS_API int cppcms_capi_cookie_samesite_strict_defined(cppcms_capi_cookie const *cookie);

  163. 

  164. ///

  165. /// @}

  166. ///

  167. #ifdef __cplusplus

  168. } // extern "C"

  169. #endif

  170. #endif