| 1 |
/* |
| 2 |
* -------------------------------------------------------------------------- |
| 3 |
* XooNiPs Xoops modules for Neuroinformatics Platforms |
| 4 |
* Copyright (C) 2005 RIKEN, Japan. All rights reserved. |
| 5 |
* http://sourceforge.jp/projects/xoonips/ |
| 6 |
* -------------------------------------------------------------------------- |
| 7 |
* This program is free software; you can redistribute it and/or |
| 8 |
* modify it under the terms of the GNU General Public License |
| 9 |
* as published by the Free Software Foundation; either version 2 |
| 10 |
* of the License, or (at your option) any later version. |
| 11 |
* |
| 12 |
* This program is distributed in the hope that it will be useful, |
| 13 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 |
* GNU General Public License for more details. |
| 16 |
* |
| 17 |
* You should have received a copy of the GNU General Public License |
| 18 |
* along with this program; if not, write to the Free Software |
| 19 |
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 20 |
* -------------------------------------------------------------------------- |
| 21 |
* |
| 22 |
* $Revision: 1.40 $ |
| 23 |
*/ |
| 24 |
#if !defined( COMMONAL_H ) |
| 25 |
#define COMMONAL_H |
| 26 |
|
| 27 |
#include "common.h" |
| 28 |
#include "session.h" |
| 29 |
#include "account.h" |
| 30 |
#include "group.h" |
| 31 |
#include "item.h" |
| 32 |
#include "changelog.h" |
| 33 |
#include "criteria.h" |
| 34 |
#include "item.h" |
| 35 |
#include "index.h" |
| 36 |
#include "changelog.h" |
| 37 |
#include "pubmed.h" |
| 38 |
#include "amazonbook.h" |
| 39 |
#include "event.h" |
| 40 |
|
| 41 |
#if defined( WIN32 ) |
| 42 |
#define EXPORTDLL extern "C" __declspec(dllexport) |
| 43 |
#else |
| 44 |
#define EXPORTDLL |
| 45 |
#endif |
| 46 |
|
| 47 |
#define SESSION_TIMEOUT_SEC 3600 /* <-> xoonips2/xoonips/condefs.php */ |
| 48 |
|
| 49 |
#define PUBMED_EFETCH_URL_BASE "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/efetch.fcgi?db=pubmed&retmode=xml&id=" |
| 50 |
#define PUBMED_ESEARCH_URL_BASE "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/esearch.fcgi?db=journals&term=" |
| 51 |
#define PUBMED_ESUMMARY_URL_BASE "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/esummary.fcgi?db=journals&id=" |
| 52 |
|
| 53 |
#define ACCOUNT_UNAME_LEN 25 |
| 54 |
#define ACCOUNT_NAME_LEN 60 |
| 55 |
#define ACCOUNT_EMAIL_LEN 60 |
| 56 |
#define ACCOUNT_URL_LEN 100 |
| 57 |
#define ACCOUNT_USER_AVATAR_LEN 30 |
| 58 |
#define ACCOUNT_USER_ICQ_LEN 15 |
| 59 |
#define ACCOUNT_USER_FROM_LEN 100 |
| 60 |
#define ACCOUNT_USER_SIG_LEN 255 |
| 61 |
#define ACCOUNT_ACTKEY_LEN 8 |
| 62 |
#define ACCOUNT_USER_AIM_LEN 18 |
| 63 |
#define ACCOUNT_USER_YIM_LEN 25 |
| 64 |
#define ACCOUNT_USER_MSNM_LEN 100 |
| 65 |
#define ACCOUNT_PASS_LEN 32 |
| 66 |
#define ACCOUNT_THEME_LEN 100 |
| 67 |
#define ACCOUNT_UMODE_LEN 10 |
| 68 |
#define ACCOUNT_USER_OCC_LEN 100 |
| 69 |
#define ACCOUNT_BIO_LEN 255 |
| 70 |
#define ACCOUNT_USER_INTREST_LEN 150 |
| 71 |
|
| 72 |
//maximum length for each columns defined in DB tables 'xnpaccount_user' |
| 73 |
#define XNP_ACCOUNT_ADDRESS_LEN 255 |
| 74 |
#define XNP_ACCOUNT_DIVISION_LEN 255 |
| 75 |
#define XNP_ACCOUNT_TEL_LEN 32 |
| 76 |
#define XNP_ACCOUNT_COMPANY_NAME_LEN 255 |
| 77 |
#define XNP_ACCOUNT_COUNTRY_LEN 255 |
| 78 |
#define XNP_ACCOUNT_ZIPCODE_LEN 32 |
| 79 |
#define XNP_ACCOUNT_FAX_LEN 32 |
| 80 |
#define XNP_ACCOUNT_BASE_URL_LEN 255 |
| 81 |
|
| 82 |
#define XNP_GROUP_GNAME_LEN 255 |
| 83 |
#define XNP_GROUP_GDESC_LEN 255 |
| 84 |
|
| 85 |
#define XNP_CONFIG_NAME_LEN 255 |
| 86 |
|
| 87 |
#define XNP_CONFIG_CERTIFY_ITEM_KEY "certify_item" |
| 88 |
#define XNP_CONFIG_CERTIFY_ITEM_AUTO "auto" |
| 89 |
#define XNP_CONFIG_CERTIFY_ITEM_ON "on" |
| 90 |
#define XNP_CONFIG_CERTIFY_ITEM_OFF "off" |
| 91 |
|
| 92 |
#define XNP_CONFIG_PUBLIC_ITEM_TARGET_USER_KEY "public_item_target_user" |
| 93 |
#define XNP_CONFIG_PUBLIC_ITEM_TARGET_USER_PLATFORM "platform" |
| 94 |
#define XNP_CONFIG_PUBLIC_ITEM_TARGET_USER_ALL "all" |
| 95 |
|
| 96 |
#define XNP_PRIVATE_INDEX_TITLE "Private" |
| 97 |
|
| 98 |
typedef enum { |
| 99 |
ME_CREATED = 1, |
| 100 |
ME_MODIFIED, |
| 101 |
ME_DELETED |
| 102 |
} metadataevent_t; |
| 103 |
|
| 104 |
//鐃?鐃緒申鐃緒申 date鐃緒申NULL鐃緒申鐃緒申0 |
| 105 |
typedef struct{ |
| 106 |
time_t createdTimestamp; |
| 107 |
time_t modifiedTimestamp; |
| 108 |
time_t deletedTimestamp; |
| 109 |
int isDeleted; |
| 110 |
} itemstatus_t; |
| 111 |
|
| 112 |
EXPORTDLL result_t initializeDB( const char* host, const char* user, const char* password, const char* dbname, const char* prefix, dbtype_t type ); |
| 113 |
EXPORTDLL result_t uninitializeDB(); |
| 114 |
EXPORTDLL bool isActivated( sessionid_t sid, userid_t uid ); |
| 115 |
EXPORTDLL result_t activate( sessionid_t sid, userid_t uid, bool activate ); |
| 116 |
EXPORTDLL int getAccountCount( sessionid_t sid ); |
| 117 |
EXPORTDLL result_t deleteAccount( sessionid_t sid, userid_t uid ); |
| 118 |
EXPORTDLL result_t getAccount( sessionid_t sid, userid_t uid, const account_t** ); |
| 119 |
EXPORTDLL result_t getAccounts( sessionid_t sid, const userid_t* uids, int uidsLen, criteria_t* cri, const account_t** accounts, int* accountsLen ); |
| 120 |
EXPORTDLL result_t insertAccount( sessionid_t sid, const account_t* account, userid_t* uid ); |
| 121 |
EXPORTDLL result_t updateAccount( sessionid_t sid, const account_t* account ); |
| 122 |
EXPORTDLL result_t dumpUids( sessionid_t sid, criteria_t* cri, userid_t** uids, int* uidsLen ); |
| 123 |
EXPORTDLL int getGroupCount( sessionid_t sid ); |
| 124 |
EXPORTDLL result_t getGroupsByUid( sessionid_t sid, userid_t uid, criteria_t* cri, groupid_t** gids, int* gidsLen ); |
| 125 |
EXPORTDLL bool isGroupAdmin( sessionid_t sid, groupid_t gid, userid_t uid ); |
| 126 |
EXPORTDLL result_t dumpGids( sessionid_t sid, criteria_t* cri, groupid_t** gids, int* gidsLen ); |
| 127 |
EXPORTDLL result_t dumpGroupAdmins( sessionid_t sid, groupid_t gid, criteria_t* cri, userid_t** uids, int* uidsLen ); |
| 128 |
EXPORTDLL result_t deleteMember( sessionid_t sid, groupid_t gid, userid_t uid ); |
| 129 |
EXPORTDLL result_t insertMember( sessionid_t sid, groupid_t gid, userid_t uid, bool admin ); |
| 130 |
EXPORTDLL result_t getMembers( sessionid_t sid, groupid_t gid, criteria_t* cri, userid_t** uids, int* uidsLen ); |
| 131 |
EXPORTDLL result_t deleteGroup( sessionid_t sid, groupid_t gid ); |
| 132 |
EXPORTDLL result_t insertGroup( sessionid_t sid, const group_t* group, groupid_t* gid ); |
| 133 |
EXPORTDLL result_t updateGroup( sessionid_t sid, const group_t* group ); |
| 134 |
EXPORTDLL result_t getGroup( sessionid_t sid, groupid_t gid, const group_t** group ); |
| 135 |
EXPORTDLL result_t getGroups( sessionid_t sid, groupid_t* gids, int gidsLen, criteria_t* cri, const group_t** groups, int* groupsLen ); |
| 136 |
EXPORTDLL bool isModerator( sessionid_t sid, userid_t uid ); |
| 137 |
EXPORTDLL result_t getUid( const char* uname, userid_t* uid ); |
| 138 |
EXPORTDLL result_t loginUser(const char* uname, const char* passwd, sessionid_t* sessions ); |
| 139 |
EXPORTDLL void logoutUser( sessionid_t sid ); |
| 140 |
EXPORTDLL result_t createSession( const char* sessionid, userid_t uid, sessionid_t* sessions ); |
| 141 |
EXPORTDLL result_t getSession( sessionid_t sess_id, const session_t** session ); |
| 142 |
|
| 143 |
EXPORTDLL result_t insertItem( sessionid_t, const item_t*, itemid_t* ); |
| 144 |
EXPORTDLL result_t insertItemDirect( sessionid_t, const item_t*, itemid_t* ); |
| 145 |
EXPORTDLL result_t getItem( sessionid_t, itemid_t, const item_t** ); |
| 146 |
EXPORTDLL result_t getItems( sessionid_t, const itemid_t*, int, criteria_t*, const item_t**, int* ); |
| 147 |
EXPORTDLL unsigned int getItemCount( sessionid_t sid ); |
| 148 |
EXPORTDLL result_t dumpItemID( sessionid_t sid, criteria_t* c, const itemid_t** iids, int* iidsLen ); |
| 149 |
|
| 150 |
EXPORTDLL result_t updateItem( sessionid_t, const item_t* ); |
| 151 |
EXPORTDLL result_t deleteItem( sessionid_t, itemid_t ); |
| 152 |
|
| 153 |
EXPORTDLL result_t getItemIDByIndexID( sessionid_t sid, indexid_t xid, criteria_t* cri, const itemid_t** iids, int* iidsLen ); |
| 154 |
EXPORTDLL result_t getUncertifiedLink( sessionid_t sid, const itemid_t** xids, const itemid_t** iids, int* iidsLen ); |
| 155 |
EXPORTDLL result_t getPrivateItemID( sessionid_t sid, userid_t uid, const itemid_t** iids, int* iidsLen ); |
| 156 |
EXPORTDLL result_t getGroupItemID( sessionid_t sid, groupid_t gid, const itemid_t** iids, int* iidsLen ); |
| 157 |
|
| 158 |
EXPORTDLL result_t getCertifyState( sessionid_t sid, indexid_t xid, itemid_t iid, certify_t* certify ); |
| 159 |
EXPORTDLL result_t setCertifyState( sessionid_t sid, indexid_t xid, itemid_t iid, certify_t state ); |
| 160 |
EXPORTDLL bool getCertifyPermission( sessionid_t sid, indexid_t xid, itemid_t iid, certify_t state ); |
| 161 |
EXPORTDLL result_t getOverlappedItems( sessionid_t sid, indexid_t xid, item_t* item, itemid_t** iids, int* iidsLen ); |
| 162 |
EXPORTDLL result_t registerItem( sessionid_t sid, indexid_t xid, itemid_t iid ); |
| 163 |
EXPORTDLL result_t unregisterItem( sessionid_t sid, indexid_t xid, itemid_t iid ); |
| 164 |
|
| 165 |
EXPORTDLL bool getItemPermission( sessionid_t sid, itemid_t iid, itemop_t op ); |
| 166 |
EXPORTDLL bool getIndexPermission( sessionid_t sid, indexid_t xid, indexop_t op ); |
| 167 |
|
| 168 |
EXPORTDLL bool isValidSessionID( sessionid_t sess_id ); |
| 169 |
|
| 170 |
EXPORTDLL result_t getAllIndexes( sessionid_t sess_id, criteria_t *cri, const index_t **indexes, int *indexesLen ); |
| 171 |
EXPORTDLL result_t getIndexes( sessionid_t sid, indexid_t parentXID, criteria_t *cri, const index_t **indexes, int *indexesLen ); |
| 172 |
EXPORTDLL result_t insertIndex( sessionid_t sid, index_t *index, indexid_t *xid ); |
| 173 |
EXPORTDLL result_t updateIndex( sessionid_t sid, index_t *index ); |
| 174 |
EXPORTDLL result_t deleteIndex( sessionid_t sid, indexid_t xid); |
| 175 |
EXPORTDLL result_t getIndex( sessionid_t sid, indexid_t xid, const index_t **index ); |
| 176 |
EXPORTDLL bool isIndexReadable( sessionid_t sid, indexid_t xid ); |
| 177 |
EXPORTDLL bool isIndexWritable( sessionid_t sid, indexid_t xid ); |
| 178 |
EXPORTDLL result_t swapIndexSortNumber( sessionid_t sid, indexid_t xid1, indexid_t xid2 ); |
| 179 |
|
| 180 |
EXPORTDLL result_t getConfigValue( const char* key, char** value ); |
| 181 |
EXPORTDLL result_t setConfigValue( const char* key, const char* value ); |
| 182 |
|
| 183 |
EXPORTDLL result_t pubmedComplete( pubmedid_t pmid, const pubmed_t** pubmed ); |
| 184 |
EXPORTDLL result_t amazonComplete( const char* url, const amazonbook_t** pubmed ); |
| 185 |
|
| 186 |
EXPORTDLL void freeAccount( const account_t* ); |
| 187 |
EXPORTDLL void freeGroup( const group_t* ); |
| 188 |
EXPORTDLL void freeSession( const session_t* ); |
| 189 |
EXPORTDLL void freeUID( const userid_t* ); |
| 190 |
EXPORTDLL void freeGID( const groupid_t* ); |
| 191 |
EXPORTDLL void freeItem( const item_t* ); |
| 192 |
EXPORTDLL void freeItemType( const itemtype_t* ); |
| 193 |
EXPORTDLL void freeItemID( const itemid_t* ); |
| 194 |
EXPORTDLL void freeIndex( const index_t* ptr ); |
| 195 |
EXPORTDLL void freeIndexID( const indexid_t* ptr ); |
| 196 |
EXPORTDLL void freeString( char* ptr ); |
| 197 |
EXPORTDLL void freeChangeLog( const changelog_t* ptr ); |
| 198 |
EXPORTDLL void freePubmed( const pubmed_t* ptr ); |
| 199 |
EXPORTDLL void freeInt( const int* ); |
| 200 |
|
| 201 |
EXPORTDLL const char* getLastErrorString(); |
| 202 |
|
| 203 |
EXPORTDLL result_t getChangeLogs( sessionid_t sid, itemid_t itemid, const changelog_t** logs, int* logsLen ); |
| 204 |
EXPORTDLL result_t insertChangeLog( sessionid_t sid, itemid_t itemid, const char* log ); |
| 205 |
|
| 206 |
EXPORTDLL result_t getItemIDByBinderID( sessionid_t sid, itemid_t binderid, criteria_t* cri, const itemid_t** iids, int* iidsLen ); |
| 207 |
EXPORTDLL result_t registerBinderItem( sessionid_t sid, itemid_t binderid, itemid_t iid ); |
| 208 |
EXPORTDLL result_t unregisterBinderItem( sessionid_t sid, itemid_t binderid, itemid_t iid ); |
| 209 |
|
| 210 |
EXPORTDLL result_t getItemTypes( const itemtype_t** types, int* len ); |
| 211 |
|
| 212 |
EXPORTDLL result_t getIndexIDByItemID( sessionid_t sid, itemid_t itemid, const indexid_t**, int* ); |
| 213 |
EXPORTDLL result_t getOwnPublicItemID( sessionid_t sid, userid_t uid, const itemid_t** iids, int* iidsLen ); |
| 214 |
|
| 215 |
EXPORTDLL result_t getItemCountGroupByIndex( sessionid_t sid, indexid_t **xids, int *xidsLen, int **counts ); |
| 216 |
EXPORTDLL result_t zipCreate( char* zippath, char** files, int filesLen ); |
| 217 |
|
| 218 |
EXPORTDLL result_t extractPublicItemId(sessionid_t sid, const itemid_t* iids, int iidsLen, itemid_t **pubilcIids, int* publicIidsLen ); |
| 219 |
EXPORTDLL result_t extractNonbinderItemId(sessionid_t sid, const itemid_t* iids, int iidsLen, itemid_t **nonbinderIids, int* nonbinderIidsLen ); |
| 220 |
EXPORTDLL result_t insertEvent( sessionid_t sid, event_t *ev); |
| 221 |
EXPORTDLL result_t getEvents( sessionid_t sid, event_t** events, int* eventsLen, time_t startTime, time_t endTime ); |
| 222 |
EXPORTDLL result_t getEventsForRSS(sessionid_t sid, event_t** events, int* eventsLen, int max ); |
| 223 |
EXPORTDLL bool isAdmin( userid_t ); |
| 224 |
EXPORTDLL result_t updateItemStatus(); |
| 225 |
EXPORTDLL result_t refreshItemStatus(); |
| 226 |
EXPORTDLL result_t selectiveHarvesting( time_t from, time_t until, int startIID, int limit, itemid_t **iids, int *iidsLen ); |
| 227 |
EXPORTDLL result_t getMetadataEvent( itemid_t iid, itemstatus_t *status ); |
| 228 |
|
| 229 |
|
| 230 |
#endif |
Parent Directory
Revision Log
Revision Graph