17c478bd9Sstevel@tonic-gate #ifndef homedir_h 27c478bd9Sstevel@tonic-gate #define homedir_h 37c478bd9Sstevel@tonic-gate 47c478bd9Sstevel@tonic-gate /* 57c478bd9Sstevel@tonic-gate * Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd. 6*1da57d55SToomas Soome * 77c478bd9Sstevel@tonic-gate * All rights reserved. 8*1da57d55SToomas Soome * 97c478bd9Sstevel@tonic-gate * Permission is hereby granted, free of charge, to any person obtaining a 107c478bd9Sstevel@tonic-gate * copy of this software and associated documentation files (the 117c478bd9Sstevel@tonic-gate * "Software"), to deal in the Software without restriction, including 127c478bd9Sstevel@tonic-gate * without limitation the rights to use, copy, modify, merge, publish, 137c478bd9Sstevel@tonic-gate * distribute, and/or sell copies of the Software, and to permit persons 147c478bd9Sstevel@tonic-gate * to whom the Software is furnished to do so, provided that the above 157c478bd9Sstevel@tonic-gate * copyright notice(s) and this permission notice appear in all copies of 167c478bd9Sstevel@tonic-gate * the Software and that both the above copyright notice(s) and this 177c478bd9Sstevel@tonic-gate * permission notice appear in supporting documentation. 18*1da57d55SToomas Soome * 197c478bd9Sstevel@tonic-gate * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 207c478bd9Sstevel@tonic-gate * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 217c478bd9Sstevel@tonic-gate * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 227c478bd9Sstevel@tonic-gate * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 237c478bd9Sstevel@tonic-gate * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL 247c478bd9Sstevel@tonic-gate * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING 257c478bd9Sstevel@tonic-gate * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 267c478bd9Sstevel@tonic-gate * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION 277c478bd9Sstevel@tonic-gate * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 28*1da57d55SToomas Soome * 297c478bd9Sstevel@tonic-gate * Except as contained in this notice, the name of a copyright holder 307c478bd9Sstevel@tonic-gate * shall not be used in advertising or otherwise to promote the sale, use 317c478bd9Sstevel@tonic-gate * or other dealings in this Software without prior written authorization 327c478bd9Sstevel@tonic-gate * of the copyright holder. 337c478bd9Sstevel@tonic-gate */ 347c478bd9Sstevel@tonic-gate 357c478bd9Sstevel@tonic-gate typedef struct HomeDir HomeDir; 367c478bd9Sstevel@tonic-gate 377c478bd9Sstevel@tonic-gate /* 387c478bd9Sstevel@tonic-gate * The following constructor and destructor functions create and 397c478bd9Sstevel@tonic-gate * delete the resources needed to look up home directories. 407c478bd9Sstevel@tonic-gate */ 417c478bd9Sstevel@tonic-gate HomeDir *_new_HomeDir(void); 427c478bd9Sstevel@tonic-gate HomeDir *_del_HomeDir(HomeDir *home); 437c478bd9Sstevel@tonic-gate 447c478bd9Sstevel@tonic-gate /* 457c478bd9Sstevel@tonic-gate * Return the home directory of a specified user, or NULL if unknown. 467c478bd9Sstevel@tonic-gate */ 477c478bd9Sstevel@tonic-gate const char *_hd_lookup_home_dir(HomeDir *home, const char *user); 487c478bd9Sstevel@tonic-gate 497c478bd9Sstevel@tonic-gate /* 507c478bd9Sstevel@tonic-gate * Get the description of the that occured when _hd_lookup_home_dir() was 517c478bd9Sstevel@tonic-gate * last called. 527c478bd9Sstevel@tonic-gate */ 537c478bd9Sstevel@tonic-gate const char *_hd_last_home_dir_error(HomeDir *home); 547c478bd9Sstevel@tonic-gate 557c478bd9Sstevel@tonic-gate /* 567c478bd9Sstevel@tonic-gate * The _hd_scan_user_home_dirs() function calls a user-provided function 577c478bd9Sstevel@tonic-gate * for each username known by the system, passing the function both 587c478bd9Sstevel@tonic-gate * the name and the home directory of the user. 597c478bd9Sstevel@tonic-gate * 607c478bd9Sstevel@tonic-gate * The following macro can be used to declare both pointers and 617c478bd9Sstevel@tonic-gate * prototypes for the callback functions. The 'data' argument is 627c478bd9Sstevel@tonic-gate * a copy of the 'data' argument passed to _hd_scan_user_home_dirs() 637c478bd9Sstevel@tonic-gate * and is intended for the user of _hd_scan_user_home_dirs() to use 647c478bd9Sstevel@tonic-gate * to pass anonymous context data to the callback function. 657c478bd9Sstevel@tonic-gate * The username and home directories are passed to the callback function 667c478bd9Sstevel@tonic-gate * in the *usrnam and *homedir arguments respectively. 677c478bd9Sstevel@tonic-gate * To abort the scan, and have _hd_scan_user_home_dirs() return 1, the 687c478bd9Sstevel@tonic-gate * callback function can return 1. A description of up to maxerr 697c478bd9Sstevel@tonic-gate * characters before the terminating '\0', can be written to errmsg[]. 707c478bd9Sstevel@tonic-gate * This can then be examined by calling _hd_last_home_dir_error(). 717c478bd9Sstevel@tonic-gate * To indicate success and continue the scan, the callback function 727c478bd9Sstevel@tonic-gate * should return 0. _hd_scan_user_home_dirs() returns 0 on successful 737c478bd9Sstevel@tonic-gate * completion of the scan, or 1 if an error occurred or a call to the 747c478bd9Sstevel@tonic-gate * callback function returned 1. 757c478bd9Sstevel@tonic-gate */ 767c478bd9Sstevel@tonic-gate #define HOME_DIR_FN(fn) int (fn)(void *data, const char *usrnam, const char *homedir, char *errmsg, int maxerr) 777c478bd9Sstevel@tonic-gate 787c478bd9Sstevel@tonic-gate int _hd_scan_user_home_dirs(HomeDir *home, const char *prefix, void *data, 797c478bd9Sstevel@tonic-gate HOME_DIR_FN(*callback_fn)); 807c478bd9Sstevel@tonic-gate 817c478bd9Sstevel@tonic-gate #endif 82