dsalib_util.c 24 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124
  1. /** BEGIN COPYRIGHT BLOCK
  2. * Copyright (C) 2001 Sun Microsystems, Inc. Used by permission.
  3. * Copyright (C) 2005 Red Hat, Inc.
  4. * All rights reserved.
  5. * END COPYRIGHT BLOCK **/
  6. #if defined( XP_WIN32 )
  7. #include <windows.h>
  8. #include <io.h>
  9. #else /* XP_WIN32 */
  10. # if defined( AIXV4 )
  11. # include <fcntl.h>
  12. # else /* AIXV4 */
  13. # include <sys/fcntl.h>
  14. # endif /* AIXV4 */
  15. #include <dirent.h>
  16. #include <unistd.h>
  17. #include <fcntl.h>
  18. #endif /* XP_WIN3 */
  19. #include "dsalib.h"
  20. #include <sys/types.h>
  21. #include <stdio.h>
  22. #include <stdlib.h>
  23. #include <string.h>
  24. #include <sys/stat.h>
  25. #include <ctype.h>
  26. #include "nspr.h"
  27. #include "plstr.h"
  28. #define COPY_BUFFER_SIZE 4096
  29. /* This is the separator string to use when outputting key/value pairs
  30. to be read by the non-HTML front end (Java console)
  31. */
  32. static const char *SEPARATOR = ":"; /* from AdmTask.java */
  33. #define LOGFILEENVVAR "DEBUG_LOGFILE" /* used for logfp */
  34. static int internal_rm_rf(const char *path, DS_RM_RF_ERR_FUNC ds_rm_rf_err_func, void *arg);
  35. /* return a FILE * opened in append mode to the log file
  36. caller must use fclose to close it
  37. */
  38. static FILE *
  39. get_logfp(void)
  40. {
  41. FILE *logfp = NULL;
  42. char *logfile = getenv(LOGFILEENVVAR);
  43. if (logfile) {
  44. logfp = fopen(logfile, "a");
  45. }
  46. return logfp;
  47. }
  48. DS_EXPORT_SYMBOL int
  49. ds_file_exists(char *filename)
  50. {
  51. struct stat finfo;
  52. if ( filename == NULL )
  53. return 0;
  54. if ( stat(filename, &finfo) == 0 ) /* successful */
  55. return 1;
  56. else
  57. return 0;
  58. }
  59. DS_EXPORT_SYMBOL int
  60. ds_mkdir(char *dir, int mode)
  61. {
  62. if(!ds_file_exists(dir)) {
  63. #ifdef XP_UNIX
  64. if(mkdir(dir, mode) == -1)
  65. #else /* XP_WIN32 */
  66. if(!CreateDirectory(dir, NULL))
  67. #endif /* XP_WIN32 */
  68. return -1;
  69. }
  70. return 0;
  71. }
  72. DS_EXPORT_SYMBOL char *
  73. ds_mkdir_p(char *dir, int mode)
  74. {
  75. static char errmsg[ERR_SIZE];
  76. struct stat fi;
  77. char *t;
  78. #ifdef XP_UNIX
  79. t = dir + 1;
  80. #else /* XP_WIN32 */
  81. t = dir + 3;
  82. #endif /* XP_WIN32 */
  83. while(1) {
  84. t = strchr(t, FILE_PATHSEP);
  85. if(t) *t = '\0';
  86. if(stat(dir, &fi) == -1) {
  87. if(ds_mkdir(dir, mode) == -1) {
  88. PR_snprintf(errmsg, sizeof(errmsg), "mkdir %s failed (%s)", dir, ds_system_errmsg());
  89. return errmsg;
  90. }
  91. }
  92. if(t) *t++ = FILE_PATHSEP;
  93. else break;
  94. }
  95. return NULL;
  96. }
  97. /*
  98. * Given the name of a directory, return a NULL-terminated array of
  99. * the file names contained in that directory. Returns NULL if the directory
  100. * does not exist or an error occurs, and returns an array with a
  101. * single NULL string if the directory exists but is empty. The caller
  102. * is responsible for freeing the returned array of strings.
  103. * File names "." and ".." are not returned.
  104. */
  105. #if !defined( XP_WIN32 )
  106. DS_EXPORT_SYMBOL char **
  107. ds_get_file_list( char *dir )
  108. {
  109. DIR *dirp;
  110. struct dirent *direntp;
  111. char **ret = NULL;
  112. int nfiles = 0;
  113. if (( dirp = opendir( dir )) == NULL ) {
  114. return NULL;
  115. }
  116. if (( ret = malloc( sizeof( char * ))) == NULL ) {
  117. return NULL;
  118. };
  119. while (( direntp = readdir( dirp )) != NULL ) {
  120. if ( strcmp( direntp->d_name, "." ) &&
  121. strcmp( direntp->d_name, ".." )) {
  122. if (( ret = (char **) realloc( ret,
  123. sizeof( char * ) * ( nfiles + 2 ))) == NULL );
  124. ret[ nfiles ] = strdup( direntp->d_name );
  125. nfiles++;
  126. }
  127. }
  128. (void) closedir( dirp );
  129. ret[ nfiles ] = NULL;
  130. return ret;
  131. }
  132. #else
  133. DS_EXPORT_SYMBOL char **
  134. ds_get_file_list( char *dir )
  135. {
  136. char szWildcardFileSpec[MAX_PATH];
  137. char **ret = NULL;
  138. long hFile;
  139. struct _finddata_t fileinfo;
  140. int nfiles = 0;
  141. if( ( dir == NULL ) || (strlen( dir ) == 0) )
  142. return NULL;
  143. if( ( ret = malloc( sizeof( char * ) ) ) == NULL )
  144. return NULL;
  145. PL_strncpyz(szWildcardFileSpec, dir, sizeof(szWildcardFileSpec));
  146. PL_strcatn(szWildcardFileSpec, sizeof(szWildcardFileSpec), "/*");
  147. hFile = _findfirst( szWildcardFileSpec, &fileinfo);
  148. if( hFile == -1 )
  149. return NULL;
  150. if( ( strcmp( fileinfo.name, "." ) != 0 ) &&
  151. ( strcmp( fileinfo.name, ".." ) != 0 ) )
  152. {
  153. ret[ nfiles++ ] = strdup( fileinfo.name );
  154. }
  155. while( _findnext( hFile, &fileinfo ) == 0 )
  156. {
  157. if( ( strcmp( fileinfo.name, "." ) != 0 ) &&
  158. ( strcmp( fileinfo.name, ".." ) != 0 ) )
  159. {
  160. if( ( ret = (char **) realloc( ret, sizeof( char * ) * ( nfiles + 2 ) ) ) != NULL )
  161. ret[ nfiles++ ] = strdup( fileinfo.name);
  162. }
  163. }
  164. _findclose( hFile );
  165. ret[ nfiles ] = NULL;
  166. return ret;
  167. }
  168. #endif /* ( XP_WIN32 ) */
  169. DS_EXPORT_SYMBOL time_t
  170. ds_get_mtime(char *filename)
  171. {
  172. struct stat fi;
  173. if ( stat(filename, &fi) )
  174. return 0;
  175. return fi.st_mtime;
  176. }
  177. /*
  178. * Copy files: return is
  179. * 1: success
  180. * 0: failure
  181. * Print errors as needed.
  182. */
  183. DS_EXPORT_SYMBOL int
  184. ds_cp_file(char *sfile, char *dfile, int mode)
  185. {
  186. #if defined( XP_WIN32 )
  187. return( CopyFile( sfile, dfile, FALSE ) ); /* Copy even if dfile exists */
  188. #else
  189. int sfd, dfd, len;
  190. struct stat fi;
  191. char copy_buffer[COPY_BUFFER_SIZE];
  192. unsigned long read_len;
  193. char error[BIG_LINE];
  194. /* Make sure we're in the right umask */
  195. umask(022);
  196. if( (sfd = open(sfile, O_RDONLY)) == -1) {
  197. PR_snprintf(error, sizeof(error), "Can't open file %s for reading.", sfile);
  198. ds_send_error(error, 1);
  199. return(0);
  200. }
  201. fstat(sfd, &fi);
  202. if (!(S_ISREG(fi.st_mode))) {
  203. PR_snprintf(error, sizeof(error), "File %s is not a regular file.", sfile);
  204. ds_send_error(error, 1);
  205. close(sfd);
  206. return(0);
  207. }
  208. len = fi.st_size;
  209. if( (dfd = open(dfile, O_RDWR | O_CREAT | O_TRUNC, mode)) == -1) {
  210. PR_snprintf(error, sizeof(error), "can't write to file %s", dfile);
  211. ds_send_error(error, 1);
  212. close(sfd);
  213. return(0);
  214. }
  215. while (len) {
  216. read_len = len>COPY_BUFFER_SIZE?COPY_BUFFER_SIZE:len;
  217. if ( (read_len = read(sfd, copy_buffer, read_len)) == -1) {
  218. PR_snprintf(error, sizeof(error), "Error reading file %s for copy.", sfile);
  219. ds_send_error(error, 1);
  220. close(sfd);
  221. close(dfd);
  222. return(0);
  223. }
  224. if ( write(dfd, copy_buffer, read_len) != read_len) {
  225. PR_snprintf(error, sizeof(error), "Error writing file %s for copy.", dfile);
  226. ds_send_error(error, 1);
  227. close(sfd);
  228. close(dfd);
  229. return(0);
  230. }
  231. len -= read_len;
  232. }
  233. close(sfd);
  234. close(dfd);
  235. return(1);
  236. #endif
  237. }
  238. /* Returns a directory path used for tmp files. */
  239. DS_EXPORT_SYMBOL char *
  240. ds_get_tmp_dir()
  241. {
  242. #if defined( XP_WIN32 )
  243. size_t ilen;
  244. char pch;
  245. #endif
  246. static char tmpdir[] = "/tmp";
  247. static char tmp[256] = {0};
  248. char* instanceDir = ds_get_install_root();
  249. if(instanceDir == NULL)
  250. {
  251. #if defined( XP_WIN32 )
  252. ilen = strlen(tmp);
  253. GetTempPath( ilen +1, tmp );
  254. /* Remove trailing slash. */
  255. pch = tmp[ilen-1];
  256. if( pch == '\\' || pch == '/' )
  257. tmp[ilen-1] = '\0';
  258. return tmp;
  259. #else
  260. return( tmpdir );
  261. #endif
  262. }
  263. PR_snprintf(tmp, sizeof(tmp), "%s/tmp",instanceDir);
  264. #if defined( XP_WIN32 )
  265. for(ilen=0;ilen < strlen(tmp); ilen++)
  266. {
  267. if(tmp[ilen]=='/')
  268. tmp[ilen]='\\';
  269. }
  270. #endif
  271. if(!ds_file_exists(tmp))
  272. ds_mkdir_p(tmp,00770);
  273. return ( tmp );
  274. }
  275. DS_EXPORT_SYMBOL void
  276. ds_unixtodospath(char *szText)
  277. {
  278. if(szText)
  279. {
  280. while(*szText)
  281. {
  282. if( *szText == '/' )
  283. *szText = '\\';
  284. szText++;
  285. }
  286. }
  287. }
  288. /* converts '\' chars to '/' */
  289. DS_EXPORT_SYMBOL void
  290. ds_dostounixpath(char *szText)
  291. {
  292. if(szText)
  293. {
  294. while(*szText)
  295. {
  296. if( *szText == '\\' )
  297. *szText = '/';
  298. szText++;
  299. }
  300. }
  301. }
  302. /* converts ':' chars to ' ' */
  303. DS_EXPORT_SYMBOL void
  304. ds_timetofname(char *szText)
  305. {
  306. if(szText)
  307. {
  308. /* Replace trailing newline */
  309. szText[ strlen( szText ) -1 ] = 0;
  310. while(*szText)
  311. {
  312. if( *szText == ':' ||
  313. *szText == ' ' )
  314. *szText = '_';
  315. szText++;
  316. }
  317. }
  318. }
  319. /* Effects a rename in 2 steps, needed on NT because if the
  320. target of a rename() already exists, the rename() will fail. */
  321. DS_EXPORT_SYMBOL int
  322. ds_saferename(char *szSrc, char *szTarget)
  323. {
  324. #ifdef XP_WIN32
  325. int iRetVal;
  326. char *szTmpFile;
  327. struct stat buf;
  328. #endif
  329. if( !szSrc || !szTarget )
  330. return 1;
  331. #if defined( XP_WIN32 )
  332. szTmpFile = mktemp("slrnXXXXXX" );
  333. if( stat( szTarget, &buf ) == 0 )
  334. {
  335. /* Target file exists */
  336. if( !szTmpFile )
  337. return 1;
  338. if( !ds_cp_file( szTarget, szTmpFile, 0644) )
  339. return( 1 );
  340. unlink( szTarget );
  341. if( (iRetVal = rename( szSrc, szTarget )) != 0 )
  342. {
  343. /* Failed to rename, copy back. */
  344. ds_cp_file( szTmpFile, szTarget, 0644);
  345. }
  346. /* Now remove temp file */
  347. unlink( szTmpFile );
  348. }
  349. else
  350. iRetVal = rename(szSrc, szTarget);
  351. return iRetVal;
  352. #else
  353. return rename(szSrc, szTarget);
  354. #endif
  355. }
  356. DS_EXPORT_SYMBOL char*
  357. ds_encode_all (const char* s)
  358. {
  359. char* r;
  360. size_t l;
  361. size_t i;
  362. if (s == NULL || *s == '\0') {
  363. return strdup ("");
  364. }
  365. l = strlen (s);
  366. r = malloc (l * 3 + 1);
  367. for (i = 0; *s != '\0'; ++s) {
  368. r[i++] = '%';
  369. sprintf (r + i, "%.2X", 0xFF & (unsigned int)*s);
  370. i += 2;
  371. }
  372. r[i] = '\0';
  373. return r;
  374. }
  375. DS_EXPORT_SYMBOL char*
  376. ds_URL_encode (const char* s)
  377. {
  378. char* r;
  379. size_t l;
  380. size_t i;
  381. if (s == NULL || *s == '\0') {
  382. return strdup ("");
  383. }
  384. l = strlen (s) + 1;
  385. r = malloc (l);
  386. for (i = 0; *s != '\0'; ++s) {
  387. if (*s >= 0x20 && *s <= 0x7E && strchr (" <>\"#%{}[]|\\^~`?,;=+\n", *s) == NULL) {
  388. if (l - i <= 1) r = realloc (r, l *= 2);
  389. r[i++] = *s;
  390. } else { /* encode *s */
  391. if (l - i <= 3) r = realloc (r, l *= 2);
  392. r[i++] = '%';
  393. sprintf (r + i, "%.2X", 0xFF & (unsigned int)*s);
  394. i += 2;
  395. }
  396. }
  397. r[i] = '\0';
  398. return r;
  399. }
  400. DS_EXPORT_SYMBOL char*
  401. ds_URL_decode (const char* original)
  402. {
  403. char* r = strdup (original);
  404. char* s;
  405. for (s = r; *s != '\0'; ++s) {
  406. if (*s == '+') {
  407. *s = ' ';
  408. }
  409. else if (*s == '%' && isxdigit(s[1]) && isxdigit(s[2])) {
  410. memmove (s, s+1, 2);
  411. s[2] = '\0';
  412. *s = (char)strtoul (s, NULL, 16);
  413. memmove (s+1, s+3, strlen (s+3) + 1);
  414. }
  415. }
  416. return r;
  417. }
  418. #if !defined( XP_WIN32 )
  419. #include <errno.h> /* errno */
  420. #include <pwd.h> /* getpwnam */
  421. static int saved_uid_valid = 0;
  422. static uid_t saved_uid;
  423. static int saved_gid_valid = 0;
  424. static gid_t saved_gid;
  425. #if defined( HPUX )
  426. #define SETEUID(id) setresuid((uid_t) -1, id, (uid_t) -1)
  427. #else
  428. #define SETEUID(id) seteuid(id)
  429. #endif
  430. #endif
  431. DS_EXPORT_SYMBOL char*
  432. ds_become_localuser_name (char *localuser)
  433. {
  434. #if !defined( XP_WIN32 )
  435. if (localuser != NULL) {
  436. struct passwd* pw = getpwnam (localuser);
  437. if (pw == NULL) {
  438. fprintf (stderr, "getpwnam(%s) == NULL; errno %d",
  439. localuser, errno);
  440. fprintf (stderr, "\n");
  441. fflush (stderr);
  442. } else {
  443. if ( ! saved_uid_valid) saved_uid = geteuid();
  444. if ( ! saved_gid_valid) saved_gid = getegid();
  445. if (setgid (pw->pw_gid) == 0) {
  446. saved_gid_valid = 1;
  447. } else {
  448. fprintf (stderr, "setgid(%li) != 0; errno %d",
  449. (long)pw->pw_gid, errno);
  450. fprintf (stderr, "\n");
  451. fflush (stderr);
  452. }
  453. if (SETEUID (pw->pw_uid) == 0) {
  454. saved_uid_valid = 1;
  455. } else {
  456. fprintf (stderr, "seteuid(%li) != 0; errno %d",
  457. (long)pw->pw_uid, errno);
  458. fprintf (stderr, "\n");
  459. fflush (stderr);
  460. }
  461. }
  462. }
  463. return NULL;
  464. #else
  465. return NULL;
  466. #endif
  467. }
  468. DS_EXPORT_SYMBOL char*
  469. ds_become_localuser (char **ds_config)
  470. {
  471. #if !defined( XP_WIN32 )
  472. char* localuser = ds_get_value (ds_config, ds_get_var_name(DS_LOCALUSER), 0, 1);
  473. if (localuser != NULL) {
  474. char *rv = ds_become_localuser_name(localuser);
  475. free(localuser);
  476. return rv;
  477. }
  478. return NULL;
  479. #else
  480. return NULL;
  481. #endif
  482. }
  483. DS_EXPORT_SYMBOL char*
  484. ds_become_original (char **ds_config)
  485. {
  486. #if !defined( XP_WIN32 )
  487. if (saved_uid_valid) {
  488. if (SETEUID (saved_uid) == 0) {
  489. saved_uid_valid = 0;
  490. } else {
  491. fprintf (stderr, "seteuid(%li) != 0; errno %d<br>n",
  492. (long)saved_uid, errno);
  493. fflush (stderr);
  494. }
  495. }
  496. if (saved_gid_valid) {
  497. if (setgid (saved_gid) == 0) {
  498. saved_gid_valid = 0;
  499. } else {
  500. fprintf (stderr, "setgid(%li) != 0; errno %d<br>\n",
  501. (long)saved_gid, errno);
  502. fflush (stderr);
  503. }
  504. }
  505. return NULL;
  506. #else
  507. return NULL;
  508. #endif
  509. }
  510. /*
  511. * When a path containing a long filename is passed to system(), the call
  512. * fails. Therfore, we need to use the short version of the path, when
  513. * constructing the path to pass to system().
  514. */
  515. DS_EXPORT_SYMBOL char*
  516. ds_makeshort( char * filepath )
  517. {
  518. #if defined( XP_WIN32 )
  519. char *shortpath = malloc( MAX_PATH );
  520. DWORD dwStatus;
  521. if( shortpath )
  522. {
  523. dwStatus = GetShortPathName( filepath, shortpath, MAX_PATH );
  524. return( shortpath );
  525. }
  526. #endif
  527. return filepath;
  528. }
  529. /* returns 1 if string "searchstring" found in file "filename" */
  530. DS_EXPORT_SYMBOL int
  531. ds_search_file(char *filename, char *searchstring)
  532. {
  533. struct stat finfo;
  534. FILE * sf;
  535. char big_line[BIG_LINE];
  536. if( filename == NULL )
  537. return 0;
  538. if( stat(filename, &finfo) != 0 ) /* successful */
  539. return 0;
  540. if( !(sf = fopen(filename, "r")) )
  541. return 0;
  542. while ( fgets(big_line, BIG_LINE, sf) ) {
  543. if( strstr( big_line, searchstring ) != NULL ) {
  544. fclose(sf);
  545. return 1;
  546. }
  547. }
  548. fclose(sf);
  549. return 0;
  550. }
  551. /*
  552. * on linux when running as root, doing something like
  553. * system("date > out.log 2>&1") will fail, because of an
  554. * ambigious redirect. This works for /bin/sh, but not /bin/csh or /bin/tcsh
  555. *
  556. * using this would turn
  557. * system("date > out.log 2>&1");
  558. * into
  559. * system("/bin/sh/ -c \"date > out.log 2>&1\"")
  560. *
  561. */
  562. DS_EXPORT_SYMBOL void
  563. alter_startup_line(char *startup_line)
  564. {
  565. #if (defined Linux && !defined LINUX2_4)
  566. char temp_startup_line[BIG_LINE+40];
  567. PR_snprintf(temp_startup_line, sizeof(temp_startup_line), "/bin/sh -c \"%s\"", startup_line);
  568. strcpy(startup_line, temp_startup_line);
  569. #else
  570. /* do nothing */
  571. #endif /* Linux */
  572. }
  573. DS_EXPORT_SYMBOL void
  574. ds_send_error(char *errstr, int print_errno)
  575. {
  576. FILE *logfp;
  577. fprintf(stdout, "error%s%s\n", SEPARATOR, errstr);
  578. if (print_errno && errno)
  579. fprintf(stdout, "system_errno%s%d\n", SEPARATOR, errno);
  580. fflush(stdout);
  581. if ((logfp = get_logfp())) {
  582. fprintf(logfp, "error%s%s\n", SEPARATOR, errstr);
  583. if (print_errno && errno)
  584. fprintf(logfp, "system_errno%s%d\n", SEPARATOR, errno);
  585. fclose(logfp);
  586. }
  587. }
  588. DS_EXPORT_SYMBOL void
  589. ds_send_status(char *str)
  590. {
  591. FILE *logfp;
  592. fprintf(stdout, "[%s]: %s\n", ds_get_server_name(), str);
  593. fflush(stdout);
  594. if ((logfp = get_logfp())) {
  595. fprintf(logfp, "[%s]: %s\n", ds_get_server_name(), str);
  596. fclose(logfp);
  597. }
  598. }
  599. /* type and doexit are unused
  600. I'm not sure what type is supposed to be used for
  601. removed the doexit code because we don't want to
  602. exit abruptly anymore, we must exit by returning an
  603. exit code from the return in main()
  604. */
  605. static void
  606. report_error(int type, char *msg, char *details, int doexit)
  607. {
  608. char error[BIG_LINE*4] = {0};
  609. if (msg)
  610. {
  611. PL_strcatn(error, BIG_LINE*4, msg);
  612. PL_strcatn(error, BIG_LINE*4, SEPARATOR);
  613. }
  614. if (details)
  615. PL_strcatn(error, BIG_LINE*4, details);
  616. ds_send_error(error, 1);
  617. }
  618. DS_EXPORT_SYMBOL void
  619. ds_report_error(int type, char *msg, char *details)
  620. {
  621. /* richm - changed exit flag to 0 - we must not exit
  622. abruptly, we should instead exit by returning a code
  623. as the return value of main - this ensures that callers
  624. are properly notified of the status
  625. */
  626. report_error(type, msg, details, 0);
  627. }
  628. DS_EXPORT_SYMBOL void
  629. ds_report_warning(int type, char *msg, char *details)
  630. {
  631. report_error(type, msg, details, 0);
  632. }
  633. DS_EXPORT_SYMBOL void
  634. ds_show_message(const char *message)
  635. {
  636. FILE *logfp;
  637. printf("%s\n", message);
  638. fflush(stdout);
  639. if ((logfp = get_logfp())) {
  640. fprintf(logfp, "%s\n", message);
  641. fclose(logfp);
  642. }
  643. return;
  644. }
  645. DS_EXPORT_SYMBOL void
  646. ds_show_key_value(char *key, char *value)
  647. {
  648. FILE *logfp;
  649. printf("%s%s%s\n", key, SEPARATOR, value);
  650. if ((logfp = get_logfp())) {
  651. fprintf(logfp, "%s%s%s\n", key, SEPARATOR, value);
  652. fclose(logfp);
  653. }
  654. return;
  655. }
  656. /* Stolen from the Admin Server dsgw_escape_for_shell */
  657. DS_EXPORT_SYMBOL char *
  658. ds_escape_for_shell( char *s )
  659. {
  660. char *escaped;
  661. char tmpbuf[4];
  662. size_t x,l;
  663. if ( s == NULL ) {
  664. return( s );
  665. }
  666. l = 3 * strlen( s ) + 1;
  667. escaped = malloc( l );
  668. memset( escaped, 0, l );
  669. for ( x = 0; s[x]; x++ ) {
  670. if (( (unsigned char)s[x] & 0x80 ) == 0 ) {
  671. strncat( escaped, &s[x], 1 );
  672. } else {
  673. /* not an ASCII character - escape it */
  674. sprintf( tmpbuf, "\\%x", (unsigned)(((unsigned char)(s[x])) & 0xff) );
  675. strcat( escaped, tmpbuf );
  676. }
  677. }
  678. return( escaped );
  679. }
  680. DS_EXPORT_SYMBOL char *
  681. ds_system_errmsg(void)
  682. {
  683. static char static_error[BUFSIZ];
  684. char *lmsg = 0; /* Local message pointer */
  685. size_t msglen = 0;
  686. int sys_error = 0;
  687. #ifdef XP_WIN32
  688. LPTSTR sysmsg = 0;
  689. #endif
  690. /* Grab the OS error message */
  691. #ifdef XP_WIN32
  692. sys_error = GetLastError();
  693. #else
  694. sys_error = errno;
  695. #endif
  696. #if defined(XP_WIN32)
  697. msglen = FormatMessage(
  698. FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_ALLOCATE_BUFFER,
  699. NULL,
  700. GetLastError(),
  701. LOCALE_SYSTEM_DEFAULT,
  702. (LPTSTR)&sysmsg,
  703. 0,
  704. 0);
  705. if (msglen > 0)
  706. lmsg = sysmsg;
  707. SetLastError(0);
  708. #else
  709. lmsg = strerror(errno);
  710. errno = 0;
  711. #endif
  712. if (!lmsg)
  713. static_error[0] = 0;
  714. else
  715. {
  716. /* At this point lmsg points to something. */
  717. int min = 0;
  718. msglen = strlen(lmsg);
  719. min = msglen > BUFSIZ ? BUFSIZ : msglen;
  720. strncpy(static_error, lmsg, min-1);
  721. static_error[min-1] = 0;
  722. }
  723. #ifdef XP_WIN32
  724. /* NT's FormatMessage() dynamically allocated the msg; free it */
  725. if (sysmsg)
  726. LocalFree(sysmsg);
  727. #endif
  728. return static_error;
  729. }
  730. /* get db path dir info from dse.ldif and remove it if it's not under path
  731. */
  732. #ifndef MAXPATHLEN
  733. #define MAXPATHLEN 1024
  734. #endif
  735. enum {
  736. DB_DIRECTORY = 0,
  737. DB_LOGDIRECTORY,
  738. DB_CHANGELOGDIRECTORY,
  739. DB_HOME_DIRECTORY
  740. };
  741. static int
  742. is_fullpath(char *path)
  743. {
  744. int len;
  745. if (NULL == path || '\0' == *path)
  746. return 0;
  747. if (FILE_PATHSEP == *path) /* UNIX */
  748. return 1;
  749. len = strlen(path);
  750. if (len > 2)
  751. {
  752. if (':' == path[1] && ('/' == path[2] || '\\' == path[2])) /* Windows */
  753. return 1;
  754. }
  755. return 0;
  756. }
  757. static void
  758. rm_db_dirs(char *fullpath, DS_RM_RF_ERR_FUNC ds_rm_rf_err_func, void *arg)
  759. {
  760. FILE *fp = fopen(fullpath, "r");
  761. char buf[2][MAXPATHLEN];
  762. char *bufp, *nextbufp;
  763. char *retp;
  764. int readit = 0;
  765. if (fp == NULL)
  766. {
  767. ds_rm_rf_err_func(fullpath, "opening dse.ldif", arg);
  768. return;
  769. }
  770. bufp = buf[0]; *bufp = '\0';
  771. nextbufp = buf[1]; *nextbufp = '\0';
  772. while (readit || (retp = fgets(bufp, MAXPATHLEN, fp)) != NULL)
  773. {
  774. int len = strlen(bufp);
  775. int type = -1;
  776. char *p, *q;
  777. if (strstr(bufp, "nsslapd-directory"))
  778. type = DB_DIRECTORY;
  779. else if (strstr(bufp, "nsslapd-db-home-directory"))
  780. type = DB_HOME_DIRECTORY;
  781. else if (strstr(bufp, "nsslapd-db-logdirectory"))
  782. type = DB_LOGDIRECTORY;
  783. else if (strstr(bufp, "nsslapd-changelogdir"))
  784. type = DB_CHANGELOGDIRECTORY;
  785. else
  786. {
  787. readit = 0;
  788. continue;
  789. }
  790. p = bufp + len;
  791. while ((retp = fgets(nextbufp, MAXPATHLEN, fp)) != NULL)
  792. {
  793. int thislen;
  794. if (*nextbufp == ' ')
  795. {
  796. thislen = strlen(nextbufp);
  797. len += thislen;
  798. if (len < MAXPATHLEN)
  799. {
  800. strncpy(p, nextbufp, thislen);
  801. p += thislen;
  802. }
  803. /* else too long as a path. ignore it */
  804. }
  805. else
  806. break;
  807. }
  808. if (retp == NULL) /* done */
  809. break;
  810. p = strchr(bufp, ':');
  811. if (p == NULL)
  812. {
  813. char *tmpp = bufp;
  814. bufp = nextbufp;
  815. nextbufp = tmpp;
  816. readit = 1;
  817. continue;
  818. }
  819. while (*(++p) == ' ') ;
  820. q = p + strlen(p) - 1;
  821. while (*q == ' ' || *q == '\t' || *q == '\n')
  822. q--;
  823. *(q+1) = '\0';
  824. switch (type)
  825. {
  826. case DB_DIRECTORY:
  827. case DB_LOGDIRECTORY:
  828. case DB_CHANGELOGDIRECTORY:
  829. if (is_fullpath(p))
  830. internal_rm_rf(p, ds_rm_rf_err_func, NULL);
  831. break;
  832. case DB_HOME_DIRECTORY:
  833. internal_rm_rf(p, ds_rm_rf_err_func, NULL);
  834. break;
  835. }
  836. }
  837. fclose(fp);
  838. }
  839. /* this function will recursively remove a directory hierarchy from the file
  840. system, like "rm -rf"
  841. In order to handle errors, the user supplies a callback function. When an
  842. error occurs, the callback function is called with the file or directory name
  843. and the system errno. The callback function should return TRUE if it wants
  844. to continue or FALSE if it wants the remove aborted.
  845. The error callback should use PR_GetError and/or PR_GetOSError to
  846. determine the cause of the failure
  847. */
  848. /* you could locate db dirs non standard location
  849. we should remove them, as well.
  850. */
  851. static int
  852. internal_rm_rf(const char *path, DS_RM_RF_ERR_FUNC ds_rm_rf_err_func, void *arg)
  853. {
  854. struct PRFileInfo prfi;
  855. int retval = 0;
  856. if (PR_GetFileInfo(path, &prfi) != PR_SUCCESS) {
  857. if (!ds_rm_rf_err_func(path, "reading directory", arg)) {
  858. return 1;
  859. }
  860. }
  861. if (prfi.type == PR_FILE_DIRECTORY)
  862. {
  863. PRDir *dir;
  864. PRDirEntry *dirent;
  865. if (!(dir = PR_OpenDir(path))) {
  866. if (!ds_rm_rf_err_func(path, "opening directory", arg)) {
  867. return 1;
  868. }
  869. return 0;
  870. }
  871. while ((dirent = PR_ReadDir(dir, PR_SKIP_BOTH))) {
  872. char *fullpath = PR_smprintf("%s%c%s", path, FILE_PATHSEP, dirent->name);
  873. if (PR_GetFileInfo(fullpath, &prfi) != PR_SUCCESS) {
  874. if (!ds_rm_rf_err_func(fullpath, "reading file", arg)) {
  875. PR_smprintf_free(fullpath);
  876. PR_CloseDir(dir);
  877. return 1;
  878. } /* else just continue */
  879. } else if (prfi.type == PR_FILE_DIRECTORY) {
  880. retval = internal_rm_rf(fullpath, ds_rm_rf_err_func, arg);
  881. if (retval) { /* non zero return means stop */
  882. PR_smprintf_free(fullpath);
  883. break;
  884. }
  885. } else {
  886. /* if dse.ldif, check db dir is under the instance dir or not */
  887. if (0 == strcmp(dirent->name, "dse.ldif"))
  888. rm_db_dirs(fullpath, ds_rm_rf_err_func, arg);
  889. if (PR_Delete(fullpath) != PR_SUCCESS) {
  890. if (!ds_rm_rf_err_func(fullpath, "deleting file", arg)) {
  891. PR_smprintf_free(fullpath);
  892. PR_CloseDir(dir);
  893. return 1;
  894. }
  895. }
  896. }
  897. PR_smprintf_free(fullpath);
  898. }
  899. PR_CloseDir(dir);
  900. if (PR_RmDir(path) != PR_SUCCESS) {
  901. if (!ds_rm_rf_err_func(path, "removing directory", arg)) {
  902. retval = 1;
  903. }
  904. }
  905. }
  906. return retval;
  907. }
  908. static int
  909. default_err_func(const char *path, const char *op, void *arg)
  910. {
  911. PRInt32 errcode = PR_GetError();
  912. char *msg;
  913. const char *errtext;
  914. if (!errcode || (errcode == PR_UNKNOWN_ERROR)) {
  915. errcode = PR_GetOSError();
  916. errtext = ds_system_errmsg();
  917. } else {
  918. errtext = PR_ErrorToString(errcode, PR_LANGUAGE_I_DEFAULT);
  919. }
  920. msg = PR_smprintf("%s %s: error code %d (%s)", op, path, errcode, errtext);
  921. ds_send_error(msg, 0);
  922. PR_smprintf_free(msg);
  923. return 1; /* just continue */
  924. }
  925. DS_EXPORT_SYMBOL int
  926. ds_rm_rf(const char *dir, DS_RM_RF_ERR_FUNC ds_rm_rf_err_func, void *arg)
  927. {
  928. struct PRFileInfo prfi;
  929. if (!dir) {
  930. ds_send_error("Could not remove NULL directory name", 1);
  931. return 1;
  932. }
  933. if (!ds_rm_rf_err_func) {
  934. ds_rm_rf_err_func = default_err_func;
  935. }
  936. if (PR_GetFileInfo(dir, &prfi) != PR_SUCCESS) {
  937. if (ds_rm_rf_err_func(dir, "reading directory", arg)) {
  938. return 0;
  939. } else {
  940. return 1;
  941. }
  942. }
  943. if (prfi.type != PR_FILE_DIRECTORY) {
  944. char *msg = PR_smprintf("Cannot remove directory %s because it is not a directory", dir);
  945. ds_send_error(msg, 0);
  946. PR_smprintf_free(msg);
  947. return 1;
  948. }
  949. return internal_rm_rf(dir, ds_rm_rf_err_func, arg);
  950. }
  951. DS_EXPORT_SYMBOL int
  952. ds_remove_reg_key(void *base, const char *format, ...)
  953. {
  954. int rc = 0;
  955. #ifdef XP_WIN32
  956. int retries = 3;
  957. HKEY hkey = (HKEY)base;
  958. char *key;
  959. va_list ap;
  960. va_start(ap, format);
  961. key = PR_vsmprintf(format, ap);
  962. va_end(ap);
  963. do {
  964. if (ERROR_SUCCESS != RegDeleteKey(hkey, key)) {
  965. rc = GetLastError();
  966. if (rc == ERROR_BADKEY || rc == ERROR_CANTOPEN ||
  967. rc == ERROR_CANTREAD ||
  968. rc == ERROR_CANTWRITE || rc == ERROR_KEY_DELETED ||
  969. rc == ERROR_ALREADY_EXISTS || rc == ERROR_NO_MORE_FILES) {
  970. rc = 0; /* key already deleted - no error */
  971. } else if ((retries > 1) && (rc == ERROR_IO_PENDING)) {
  972. /* the key is busy - lets wait and try again */
  973. PR_Sleep(PR_SecondsToInterval(3));
  974. retries--;
  975. } else {
  976. char *errmsg = PR_smprintf("Could not remove registry key %s - error %d (%s)",
  977. key, rc, ds_system_errmsg());
  978. ds_send_error(errmsg, 0);
  979. PR_smprintf_free(errmsg);
  980. break; /* no retry, just fail */
  981. }
  982. }
  983. } while (rc && retries);
  984. PR_smprintf_free(key);
  985. #endif
  986. return rc;
  987. }