Develop and Download Open Source Software

XooNIps

Browse CVS Repository

/[OSDN]/xoonips/AL/commonal.cc

Diff of /xoonips/AL/commonal.cc

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.30 by youi, Sat Dec 18 10:24:54 2004 UTC revision 1.31 by youi, Tue Dec 21 11:42:59 2004 UTC
# Line 2  Line 2 
2   *   *
3   * $Revision$   * $Revision$
4   * $Log$   * $Log$
5     * Revision 1.31  2004/12/21 11:42:59  youi
6     * コメントの引数，戻り値の説明などを追加.
7     *
8   * Revision 1.30  2004/12/18 10:24:54  youi   * Revision 1.30  2004/12/18 10:24:54  youi
9   * IMPORT_MYSQLDLLを定義したとき，MYSQLのDLLを動的リンクするプロトタイプ宣言が   * IMPORT_MYSQLDLLを定義したとき，MYSQLのDLLを動的リンクするプロトタイプ宣言が
10   * 有効になるように修正した.   * 有効になるように修正した.
# Line 322  string criteria2str( criteria* cri ) Line 325  string criteria2str( criteria* cri )
325   * @param password 上記ユーザのパスワード   * @param password 上記ユーザのパスワード
326   * @param dbname データベースの名前   * @param dbname データベースの名前
327   * @param prefix XOOPSデータベーステーブルのPREFIX   * @param prefix XOOPSデータベーステーブルのPREFIX
328   * @return result_t   * @return RES_OK
329     * @return RES_DB_INITIALIZE_ERROR
330     * @return RES_DB_CONNECT_ERROR
331   * @refer result_t   * @refer result_t
332   */   */
333  result_t initializeDB( const char* host, const char* user, const char* password, const char* dbname, const char* prefix )  result_t initializeDB( const char* host, const char* user, const char* password, const char* dbname, const char* prefix )
# Line 370  result_t uninitializeDB() Line 375  result_t uninitializeDB()
375   *   *
376   * Platformユーザ承認状態取得   * Platformユーザ承認状態取得
377   *   *
378   * @param   * @param sid セッションID
379   * @return   * @param uid 状態を取得したいユーザのUID
380     * @return true 承認済み
381     * @return false 未承認
382   *   *
383   */   */
384  bool isActivated( sessionid_t sid, userid_t uid )  bool isActivated( sessionid_t sid, userid_t uid )
# Line 401  bool isActivated( sessionid_t sid, useri Line 408  bool isActivated( sessionid_t sid, useri
408   *   *
409   * Platformユーザ承認状態変更   * Platformユーザ承認状態変更
410   *   *
411   * @param   * @param sid セッションID
412   * @return   * @param uid 変更したいユーザのUID
413   *   * @param activate 承認(true) / 未承認(false)の指定
414     * @return RES_OK
415     * @return RES_DB_QUERY_ERROR
416     * @return RES_NO_SUCH_USER
417   */   */
418  result_t activate( sessionid_t sid, userid_t uid, bool activate )  result_t activate( sessionid_t sid, userid_t uid, bool activate )
419  {  {
# Line 430  result_t activate( sessionid_t sid, user Line 440  result_t activate( sessionid_t sid, user
440    
441  /**  /**
442   *   *
443   * アカウント数   * アカウント数を取得する．
444   *   *
445   * @param   * @param sid セッションID
446   * @return   * @return アカウント数
447   *   *
448   */   */
449  int getAccountCount( sessionid_t sid )  int getAccountCount( sessionid_t sid )
# Line 469  int getAccountCount( sessionid_t sid ) Line 479  int getAccountCount( sessionid_t sid )
479   *   *
480   * @param   * @param
481   * @return RES_OK   * @return RES_OK
482     * @return RES_DB_NOT_INITIALIZED
483   * @return RES_NO_SUCH_SESSION   * @return RES_NO_SUCH_SESSION
484   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
485   *   *
# Line 504  result_t deleteAccount( sessionid_t sid, Line 515  result_t deleteAccount( sessionid_t sid,
515   * @param uid 取得したいユーザのUID   * @param uid 取得したいユーザのUID
516   * @param acc 取得したアカウント情報(account_t)のポインタを書き込む引数   * @param acc 取得したアカウント情報(account_t)のポインタを書き込む引数
517   * @return RES_OK   * @return RES_OK
518     * @return RES_DB_NOT_INITIALIZED
519   * @return RES_NO_SUCH_USER   * @return RES_NO_SUCH_USER
520   * @return RES_NO_SUCH_SESSION   * @return RES_NO_SUCH_SESSION
521   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
  * @return RES_ERROR  
522   *   *
523   */   */
524  result_t getAccount( sessionid_t sid, userid_t uid, const account_t** acc )  result_t getAccount( sessionid_t sid, userid_t uid, const account_t** acc )
# Line 529  result_t getAccount( sessionid_t sid, us Line 540  result_t getAccount( sessionid_t sid, us
540   * @param cri 結果の範囲指定，ソート条件指定   * @param cri 結果の範囲指定，ソート条件指定
541   * @param accounts 検索結果の配列のポインタを書き込む引数   * @param accounts 検索結果の配列のポインタを書き込む引数
542   * @param accountsLen 検索結果の数(配列*accountsの要素数)   * @param accountsLen 検索結果の数(配列*accountsの要素数)
543   * @return RES_OK| RES_DB_NOT_INITIALIZED| RES_NO_SUCH_SESSION   * @return RES_OK
544     * @return RES_DB_NOT_INITIALIZED
545     * @return RES_NO_SUCH_SESSION
546   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
547   *   *
548   */   */
# Line 652  result_t getAccounts( sessionid_t sid, c Line 665  result_t getAccounts( sessionid_t sid, c
665   * @return RES_OK   * @return RES_OK
666   * @return RES_NO_SUCH_SESSION   * @return RES_NO_SUCH_SESSION
667   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
668   * @return RES_ERROR   * @return RES_DB_NOT_INITIALIZED
669   *   *
670   */   */
671  result_t insertAccount( sessionid_t sid, const account_t* account, userid_t* uid )  result_t insertAccount( sessionid_t sid, const account_t* account, userid_t* uid )
# Line 759  result_t insertAccount( sessionid_t sid, Line 772  result_t insertAccount( sessionid_t sid,
772   * @param sid セッションID   * @param sid セッションID
773   * @param account 変更したいアカウント情報   * @param account 変更したいアカウント情報
774   * @return RES_OK   * @return RES_OK
775     * @return RES_DB_NOT_INITIALIZED
776   * @return RES_NO_SUCH_SESSION   * @return RES_NO_SUCH_SESSION
777   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
778   * @return RES_NO_SUCH_USER   * @return RES_NO_SUCH_USER
779     * @return RES_ERROR
780   *   *
781   */   */
782  result_t updateAccount( sessionid_t sid, const account_t* account )  result_t updateAccount( sessionid_t sid, const account_t* account )
# Line 853  result_t updateAccount( sessionid_t sid, Line 868  result_t updateAccount( sessionid_t sid,
868   *   *
869   * @param sid セッションID   * @param sid セッションID
870   * @param cri 結果の範囲指定，ソート条件指定   * @param cri 結果の範囲指定，ソート条件指定
871   * @param uids ユーザのUIDの配列   * @param uids ユーザのUIDの配列の出力先
872   * @param uidsLen uids配列の要素数   * @param uidsLen uids配列の要素数の出力先
873   * @return RES_OK| RES_DB_NOT_INITIALIZED| RES_NO_SUCH_SESSION   * @return RES_OK
874   * @return RES_DB_QUERY_ERROR| RES_ERROR   * @return RES_DB_NOT_INITIALIZED
875     * @return RES_NO_SUCH_SESSION
876     * @return RES_DB_QUERY_ERROR
877   *   *
878   */   */
879  result_t dumpUids( sessionid_t sid, criteria_t* cri, userid_t** uids, int* uidsLen )  result_t dumpUids( sessionid_t sid, criteria_t* cri, userid_t** uids, int* uidsLen )
# Line 926  int getGroupCount( sessionid_t sid ) Line 943  int getGroupCount( sessionid_t sid )
943    
944  /**  /**
945   *   *
946   * 所属グループ一覧取得   * 所属グループ一覧取得.
947     * ユーザが所属しているグループのIDを取得する
948   *   *
949   * @param   * @param sid セッションID
950   * @return   * @param uid ユーザのUID
951     * @param cri 結果の範囲指定，ソート条件指定
952     * @param gids グループIDの配列の出力先
953     * @param gidsLen gids配列の要素数の出力先
954     * @return RES_DB_NOT_INITIALIZED
955     * @return RES_NO_SUCH_SESSION
956     * @return RES_NO_SUCH_USER
957     * @return RES_DB_QUERY_ERROR
958     * @return RES_OK
959   *   *
960   */   */
961  result_t getGroupsByUid( sessionid_t sid, userid_t uid, criteria_t* cri, groupid_t** gids, int* gidsLen )  result_t getGroupsByUid( sessionid_t sid, userid_t uid, criteria_t* cri, groupid_t** gids, int* gidsLen )
# Line 982  result_t getGroupsByUid( sessionid_t sid Line 1008  result_t getGroupsByUid( sessionid_t sid
1008    
1009  /**  /**
1010   *   *
1011   * グループ管理権限問合せ   * グループ管理権限問合せ.
1012     * ユーザにループの管理権限があるか(グループ管理者であるか)を問い合わせる.
1013     * ユーザやグループが存在しないなどの異常の場合，falseを返す.
1014   *   *
1015   * @param   * @param sid セッションID
1016   * @return   * @param gid グループのUID
1017     * @param uid ユーザのUID
1018     * @return true 管理権限あり
1019     * @return false 管理権限なし，または不明
1020   *   *
1021   */   */
1022  bool isGroupAdmin( sessionid_t sid, groupid_t gid, userid_t uid )  bool isGroupAdmin( sessionid_t sid, groupid_t gid, userid_t uid )
# Line 1021  bool isGroupAdmin( sessionid_t sid, grou Line 1052  bool isGroupAdmin( sessionid_t sid, grou
1052    
1053  /**  /**
1054   *   *
1055   * グループID一覧   * グループID一覧.
1056     * 登録されているグループのID一覧を取得する.
1057   *   *
1058   * @param   * @param sid セッションID
1059   * @return   * @param cri 結果の範囲指定，ソート条件指定
1060     * @param gids グループIDの配列の出力先
1061     * @param gidsLen gids配列の要素数の出力先
1062     * @return RES_DB_NOT_INITIALIZED
1063     * @return RES_NO_SUCH_SESSION
1064     * @return RES_DB_QUERY_ERROR
1065     * @return RES_OK
1066   *   *
1067   */   */
1068  result_t dumpGids( sessionid_t sid, criteria_t* cri, groupid_t** gids, int* gidsLen )  result_t dumpGids( sessionid_t sid, criteria_t* cri, groupid_t** gids, int* gidsLen )
# Line 1103  result_t dumpGids( sessionid_t sid, crit Line 1141  result_t dumpGids( sessionid_t sid, crit
1141    
1142  /**  /**
1143   *   *
1144   * グループ管理者IDを取得する   * グループ管理者IDを取得する.
1145     * あるグループの管理者のユーザIDを取得する.
1146   *   *
1147   * @param sid セッションID   * @param sid セッションID
1148   * @param gid 問い合わせるグループをIDで指定する   * @param gid 問い合わせるグループをIDで指定する
# Line 1153  result_t dumpGroupAdmins( sessionid_t si Line 1192  result_t dumpGroupAdmins( sessionid_t si
1192    
1193  /**  /**
1194   *   *
1195   * グループ所属ユーザ削除   * グループ所属ユーザ削除.
1196     * グループに所属するユーザを，グループから削除する.
1197   *   *
1198   * @param   * @param sid セッションID
1199   * @return   * @param gid どのグループから削除するかを指定するグループID
1200     * @param uid 削除対象のユーザのID
1201     * @return RES_DB_NOT_INITIALIZED
1202     * @return RES_NO_SUCH_SESSION
1203     * @return RES_NO_SUCH_USER
1204     * @return RES_NO_SUCH_GROUP
1205     * @return RES_DB_QUERY_ERROR
1206     * @return RES_OK;
1207   *   *
1208   */   */
1209  result_t deleteMember( sessionid_t sid, groupid_t gid, userid_t uid )  result_t deleteMember( sessionid_t sid, groupid_t gid, userid_t uid )
# Line 1180  result_t deleteMember( sessionid_t sid, Line 1227  result_t deleteMember( sessionid_t sid,
1227    
1228  /**  /**
1229   *   *
1230   * グループ所属ユーザ追加   * グループ所属ユーザ追加.
1231     * グループのメンバーにユーザを追加する.
1232   *   *
1233   * @param sid セッションID   * @param sid セッションID
1234   * @param gid 所属先グループのID   * @param gid 所属先グループのID
# Line 1189  result_t deleteMember( sessionid_t sid, Line 1237  result_t deleteMember( sessionid_t sid,
1237   * @return RES_OK   * @return RES_OK
1238   * @return RES_DB_NOT_INITIALIZED   * @return RES_DB_NOT_INITIALIZED
1239   * @return RES_NO_SUCH_SESSION   * @return RES_NO_SUCH_SESSION
1240     * @return RES_NO_SUCH_USER
1241     * @return RES_NO_SUCH_GROUP
1242   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
  * @return RES_ERROR  
1243   *   *
1244   */   */
1245  result_t insertMember( sessionid_t sid, groupid_t gid, userid_t uid, bool admin )  result_t insertMember( sessionid_t sid, groupid_t gid, userid_t uid, bool admin )
# Line 1220  result_t insertMember( sessionid_t sid, Line 1269  result_t insertMember( sessionid_t sid,
1269    
1270  /**  /**
1271   *   *
1272   * グループ所属ユーザ取得   * グループ所属ユーザ取得.
1273     * あるグループの所属しているユーザのユーザIDを取得する
1274   *   *
1275   * @param   * @param sid セッションID
1276   * @return   * @param gid どのグループの所属ユーザを問い合わせるかをグループをIDで指定
1277     * @param cri 結果の範囲指定，ソート条件指定
1278     * @param uids 所属ユーザのUIDの配列を受け取るポインタ
1279     * @param uidsLen uids配列の要素数
1280     * @return RES_OK
1281     * @return RES_DB_NOT_INITIALIZED
1282     * @return RES_NO_SUCH_SESSION
1283     * @return RES_NO_SUCH_GROUP
1284     * @return RES_DB_QUERY_ERROR
1285     * @return RES_ERROR
1286   *   *
1287   */   */
1288  result_t getMembers( sessionid_t sid, groupid_t gid, criteria_t* cri, userid_t** uids, int* uidsLen )  result_t getMembers( sessionid_t sid, groupid_t gid, criteria_t* cri, userid_t** uids, int* uidsLen )
# Line 1279  result_t getMembers( sessionid_t sid, gr Line 1338  result_t getMembers( sessionid_t sid, gr
1338    
1339  /**  /**
1340   *   *
1341   * グループの削除   * グループの削除.
1342     * データベースからグループを削除します.
1343   *   *
1344   * @param   * @param sid セッションID
1345     * @param gid どのグループの所属ユーザを問い合わせるかをグループをIDで指定
1346   * @return RES_OK   * @return RES_OK
1347   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
1348   * @return RES_NO_SUCH_SESSION   * @return RES_NO_SUCH_SESSION
# Line 1307  result_t deleteGroup( sessionid_t sid, g Line 1368  result_t deleteGroup( sessionid_t sid, g
1368  /**  /**
1369   *   *
1370   * グループ登録.   * グループ登録.
1371   * グループの情報をデータベースに記録します.   * グループの情報をデータベースに記録する．
1372   * 登録したグループに対応するグループIDをgidに格納します.   * 登録したグループに対応するグループIDをgidに格納する．
1373   *   *
1374   * @param sid セッションID   * @param sid セッションID
1375   * @param group 登録したいグループの情報   * @param group 登録したいグループの情報
# Line 1652  void logoutUser( sessionid_t sid ) Line 1713  void logoutUser( sessionid_t sid )
1713   * @param sessionid xoopsのsession_id   * @param sessionid xoopsのsession_id
1714   * @param uid  xoops_usersのuid   * @param uid  xoops_usersのuid
1715   * @param session sessionid_tを受け取るためのポインタ。   * @param session sessionid_tを受け取るためのポインタ。
1716   * @return RES_OK 成功。<br>   * @return RES_OK
1717   * @return RES_ERROR   * @return RES_ERROR
1718   * @return RES_DB_QUERY_ERROR   * @return RES_DB_QUERY_ERROR
1719   *   *
Legend:
Removed from v.1.30  
changed lines
  Added in v.1.31
Back to OSDN">Back to OSDN
 ViewVC Help
Powered by ViewVC 1.1.26  
About OSDN
Find Software
Develop Software
Help