summaryrefslogtreecommitdiff
path: root/support/dktools/dk4appdeltree.ctr
blob: a9d65c42c3636854a4ce8ece4e527b068b34e81d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	module

#include "dk4conf.h"

#include "dk4types.h"

#if DK4_ON_WINDOWS
#ifndef WINDOWS_H_INCLUDED
#include <windows.h>
#define WINDOWS_H_INCLUDED 1
#endif
#endif

#ifndef DK4APP_H_INCLUDED
#include "dk4app.h"
#endif

#ifndef DK4CONST_H_INCLUDED
#include "dk4const.h"
#endif

#ifndef DK4STATD_H_INCLUDED
#include "dk4statd.h"
#endif

#ifndef DK4STAT_H_INCLUDED
#include "dk4stat.h"
#endif

#ifndef DK4DIR_H_INCLUDED
#include "dk4dir.h"
#endif

#ifndef DK4DIRA_H_INCLUDED
#include "dk4dira.h"
#endif

#ifndef DK4MEM_H_INCLUDED
#include "dk4mem.h"
#endif

#ifndef DK4MEMA_H_INCLUDED
#include "dk4mema.h"
#endif

#ifndef DK4MPL_H_INCLUDED
#include "dk4mpl.h"
#endif

#ifndef DK4STR_H_INCLUDED
#include "dk4strd.h"
#endif

#ifndef DK4MAASZ_H_INCLUDED
#include "dk4maasz.h"
#endif

#if DK4_HAVE_SYS_TYPES_H
#ifndef SYS_TYPES_H_INCLUDED
#include <sys/types.h>
#define	SYS_TYPES_H_INCLUDED 1
#endif
#endif

#if DK4_HAVE_DIRENT_H
#ifndef DIRENT_H_INCLUDED
#include <dirent.h>
#define	DIRENT_H_INCLUDED 1
#endif
#endif

#if DK4_CHAR_SIZE > 1
#if DK4_HAVE_WCHAR_H
#ifndef WCHAR_H_INCLUDED
#include <wchar.h>
#define	WCHAR_H_INCLUDED 1
#endif
#endif
#endif


$!trace-include



/**	Information about failed removals of files or directories.
*/
enum {
					/**	No errors yet.
					*/
  NE_NO_ERROR				= 0,

					/**	Failed to remove one file.
					*/
  NE_ONE_FILE_REMOVAL_FAILED ,

					/**	Failed to remove multiple files.
					*/
  NE_MULTIPLE_FILE_REMOVALS_FAILED ,

					/**	Failed to remove one directory.
					*/
  NE_ONE_DIRECTORY_REMOVAL_FAILED ,

					/**	Failed to remove multiple dirs.
					*/
  NE_MULTIPLE_DIRECTORY_REMOVALS_FAILED
};



/**	One node in tree to delete.
*/
typedef struct _dk4_del_tree_node_t_ {
  struct _dk4_del_tree_node_t_	*parent;	/**< Parent node. */
  dk4_dir_t			*dir;		/**< Directory contents. */
  size_t			 dplen;		/**< Directory path length. */
  int				 ne;		/**< Flag: Not empty. */
} dk4_del_tree_node_t;



/**	Job structure (information passed downwards).
*/
typedef struct {
  dkChar		*sbptr;		/**< Static buffer. */
  dkChar		*dbptr;		/**< Dynamic buffer, may be NULL. */
  size_t		 sbsz;		/**< Static buffer size. */
  size_t		 dbsz;		/**< Dynamic buffer size. */
  int			 result;	/**< Suggested function result. */
} dk4_del_tree_job_t;



#if DK4_ON_WINDOWS
/* +++ Windows */
#if DK4_CHAR_SIZE > 1
/* +++ Windows, wchar_t */

/* --- Windows, wchar_t */
#else
/* +++ Windows, char */

/* --- Windows, char */
#endif

static
int
dk4app_del_tree_process_dir(const dkChar *dirname)
{
#if DK4_CHAR_SIZE > 1
  WIN32_FIND_DATAW	ff;
#else
  WIN32_FIND_DATAA	ff;
#endif
  DWORD			dwFileAttributes;
  HANDLE		ha;
  int			back = 1;

#if DK4_CHAR_SIZE > 1
  dwFileAttributes = GetFileAttributesW(dirname);
#else
  dwFileAttributes = GetFileAttributesA(dirname);
#endif
  if (INVALID_FILE_ATTRIBUTES == dwFileAttributes) {
#if DK4_CHAR_SIZE > 1
    ha = FindFirstFileW(dirname, &ff);
#else
    ha = FindFirstFileA(dirname, &ff);
#endif
    if (INVALID_HANDLE_VALUE != ha) {
      dwFileAttributes = ff.dwFileAttributes;
      FindClose(ha);
    }
  }
  if (INVALID_FILE_ATTRIBUTES != dwFileAttributes) {
    if (0 != (FILE_ATTRIBUTE_REPARSE_POINT & dwFileAttributes)) {
#if DK4_CHAR_SIZE > 1
      ha = FindFirstFileW(dirname, &ff);
#else
      ha = FindFirstFileA(dirname, &ff);
#endif
      if (INVALID_HANDLE_VALUE != ha) {
        if (0 != (FILE_ATTRIBUTE_REPARSE_POINT & ff.dwFileAttributes)) {
	  if (IO_REPARSE_TAG_MOUNT_POINT == ff.dwReserved0) {
	    back = 0;
	  }
	  if (IO_REPARSE_TAG_SYMLINK == ff.dwReserved0) {
	    back = 0;
	  }
	}
        FindClose(ha);
      } else {
        back = 0;
      }
    }
  }
  return back;
}

/* --- Windows */
#else
/* +++ non-Windows */
#if DK4_CHAR_SIZE > 1
/* +++ non-Windows, wchar_t */

/* --- non-Windows, wchar_t */
#else
/* +++ non-Windows, char */

/* --- non-Windows, char */
#endif
/* --- non-Windows */
#endif



#if DK4_HAVE_BACKSLASH_AS_SEP
static const dkChar dk4appdeltree_fnsep[] = { dkT("\\") };
#else
static const dkChar dk4appdeltree_fnsep[] = { dkT("/") };
#endif



static
void
dk4app_del_tree_node_close(dk4_del_tree_node_t *ptr)
{
  if (NULL != ptr) {
    ptr->parent = NULL;
    if (NULL != ptr->dir) {
      dk4dir_close(ptr->dir);
      ptr->dir = NULL;
    }
    ptr->dplen = 0;
    ptr->ne = 0;
    dk4mem_free(ptr);
  }
}



static
dk4_del_tree_node_t *
dk4app_del_tree_node_open(
  const dkChar			*dn,
  dk4_del_tree_node_t		*par,
  dk4_del_tree_job_t		*job,
  dk4_app_t			*app
)
{
  dk4_er_t		 er;		/* Error report */
  const dkChar		*fn;		/* File name to process */
  dkChar		*nbptr;		/* Buffer pointer */
  dk4_del_tree_node_t	*back	= NULL;
  size_t		 lgt;		/* Length of buffer */
#if VERSION_BEFORE_20150821 || TRACE_DEBUG
  int			 dfres;		/* Result from file deletion */
#endif
  $? "+ dk4_del_tree_node_t \"%!ds\"", dn
  back = dk4mem_new_app(dk4_del_tree_node_t,1,app);
  if (NULL != back) {			$? ". memory ok"
    back->parent = par;
    back->ne     = NE_NO_ERROR;
    back->dplen  = dk4str_len(dn);
    dk4error_init(&er);
    back->dir    = dk4dir_open_app(dn, DK4_DIR_OPEN_DELTREE, app);
    if (NULL != back->dir) {		$? ". dir open ok"
      dk4error_init(&er);
      lgt = dk4ma_size_t_add(
        dk4ma_size_t_add(
	  back->dplen, dk4dir_get_max_entry_length(back->dir), &er
	),
	2,
	&er
      );
      if (DK4_E_NONE == er.ec) {	$? ". buffer length calculated"
        if ((lgt > job->sbsz) && (lgt > job->dbsz)) {
	  $? ". NEED %u", (unsigned)lgt
	  nbptr = dk4mem_new_app(dkChar,lgt,app);
	  if (NULL != nbptr) {		$? ". new buffer allocated"
	    if (job->dbptr) {
	      dk4mem_free(job->dbptr);	$? ". RELEASE dbptr"
	    }
	    job->dbptr = nbptr; job->dbsz = lgt;	$? ". ALLOC dbptr"
	  } else {			$? "! allocation"
	    dk4app_del_tree_node_close(back);
	    back = NULL;
	    job->result = 0;
	  }
	}
	if (NULL != back) {
	  if ((NULL != job->dbptr) && (0 < job->dbsz)) {
	    nbptr = job->dbptr;		$? ". use dynamic buffer"
	    lgt   = job->dbsz;
	  } else {			$? ". use static buffer"
	    nbptr = job->sbptr;
	    lgt   = job->sbsz;
	  }				$? ". process files"
	  do {
	    fn = dk4dir_next_file(back->dir);
	    if (NULL != fn) {	$? ". processing file \"%!ds\" \"%!ds\"", dn, fn
	      if (dk4str_cpy_s(nbptr,lgt,dk4dir_get_path(back->dir),NULL)) {
	        $? ". nbptr=\"%!ds\" dn=\"%!ds\"", nbptr, dk4dir_get_path(back->dir)
	        if (dk4str_cat_s(nbptr, lgt, dk4appdeltree_fnsep, NULL)) {
		  $? ". nbptr=\"%!ds\" dn=\"%!ds\"",nbptr,dk4dir_get_path(back->dir)
		  if (dk4str_cat_s(nbptr, lgt, fn, NULL)) {
		    $? ". nbptr=\"%!ds\" dn=\"%!ds\"",nbptr,dk4dir_get_path(back->dir)
		    $? ". full path name \"%!ds\"", nbptr
		    switch (back->ne) {
		      case NE_NO_ERROR : {
		        if (0 == dk4app_del_file(nbptr, app)) {
			  back->ne = NE_ONE_FILE_REMOVAL_FAILED;
			  job->result = 0;
			  $? "! file deletion failed"
			}
		      } break;
		      case NE_ONE_FILE_REMOVAL_FAILED : {
		        if (0 == dk4app_del_file(nbptr, NULL)) {
			  back->ne = NE_MULTIPLE_FILE_REMOVALS_FAILED;
			  /* ERROR: Further file removals failed */
			  dk4app_log_base3(
			    app,DK4_LL_ERROR,94,95,dk4dir_get_path(back->dir)
			  );
			  $? "! file deletion failed"
			}
		      } break;
		      default : {
#if TRACE_DEBUG
		        dfres = dk4app_del_file(nbptr, NULL);
			if (0 == dfres) {	$? "! file deletion failed"
			}
#else
			dk4app_del_file(nbptr, NULL);
#endif
		      } break;
		    }
		  } else {			$? "! buffer too short"
	            if (NE_ONE_FILE_REMOVAL_FAILED < back->ne) {
		      back->ne = NE_ONE_FILE_REMOVAL_FAILED;
		    }
		    /* ERROR: Directory name too long */
		    dk4app_log_base3(
		      app, DK4_LL_ERROR, 98, 99, dk4dir_get_path(back->dir)
		    );
		  }
		} else {			$? "! buffer too short"
	          if (NE_ONE_FILE_REMOVAL_FAILED < back->ne) {
		    back->ne = NE_ONE_FILE_REMOVAL_FAILED;
		  }
		  /* ERROR: Directory name too long */
		  dk4app_log_base3(
		    app, DK4_LL_ERROR, 98, 99, dk4dir_get_path(back->dir)
		  );
		}
	      } else {				$? "! buffer too short"
	        if (NE_ONE_FILE_REMOVAL_FAILED < back->ne) {
		  back->ne = NE_ONE_FILE_REMOVAL_FAILED;
		}
		/* ERROR: Directory name too long */
		dk4app_log_base3(
		  app, DK4_LL_ERROR, 98, 99, dk4dir_get_path(back->dir)
		);
	      }
	    }
	  } while(NULL != fn);
	  dk4dir_skip_files(back->dir);
	} else {			$? "! allocation"
	}
      } else {				$? "! overflow in buffer length calc"
        /* ERROR: Math error in size calculation */
	dk4app_log_base1(app, DK4_LL_ERROR, 82);
	dk4app_del_tree_node_close(back);
	back = NULL;
	job->result = 0;
      }
    } else {				$? "! dir open"
      dk4app_del_tree_node_close(back);
      back = NULL;
      job->result = 0;
      /* ERROR: Failed to open directory, already reported */
      /* !!!!! TODO: Attempt to remove directory or file */
    }
  } else {				$? "! memory"
  }
  $? "- dk4_del_tree_node_t PTR=%d", TR_IPTR(back)
  return back;
}



static
void
dk4app_del_tree_debug_file_or_dir(
  dk4_app_t	*app,
  const dkChar	*fn,
  size_t	 ind
)
{
  const dkChar 	*msg[3];
  if ((NULL != app) && (NULL != fn)) {
    if (0 != dk4app_log_do(app, DK4_LL_DEBUG)) {
      if ((NULL != app->msg_debug) && (ind < app->sz_msg_debug)) {
        msg[0] = (app->msg_debug)[ind];
	msg[1] = fn;
	msg[2] = NULL;
	dk4app_log_msg(app, DK4_LL_DEBUG, msg, 2);
      }
    }
  }
}



int
dk4app_del_tree(const dkChar *fn, dk4_app_t *app)
{
  dkChar		 sb[DK4_MAX_PATH];
  dk4_del_tree_job_t	 job;	/* Buffers */
  dk4_del_tree_node_t	*cn;	/* Current node */
  dk4_del_tree_node_t	*nn;	/* Next node */
  dkChar		*fnb;	/* File name buffer */
  const dkChar		*dn;	/* Directory name */
  size_t		 fnbsz;	/* File name buffer size */
  int			 res;	/* Operation result */
#if VERSION_BEFORE_20150821 || TRACE_DEBUG
  int			 dfres;	/* Delete file result */
#endif
  int back	= 0;

  $? "+ dk4app_del_tree \"%!ds\"", TR_DKSTR(fn)
  job.sbptr  = sb;
  job.sbsz   = DK4_SIZEOF(sb,dkChar);
  job.dbptr  = NULL;
  job.dbsz   = 0;
  job.result = 1;
  if (NULL != fn) {				$? ". directory name ok"
    cn = dk4app_del_tree_node_open(fn, NULL, &job, app);
    if (NULL != cn) {				$? ". node ok"
      while (NULL != cn) {			$? ". start of loop"
        if ((NULL != job.dbptr) && (0 < job.dbsz)) {
	  fnb = job.dbptr; fnbsz = job.dbsz;	$? ". use dynamic buffer"
	} else {				$? ". use static buffer"
	  fnb = job.sbptr; fnbsz = job.sbsz;
	}
        dn = dk4dir_next_dir(cn->dir);
        if (NULL != dn) {			$? ". subdirectory found"
	  if (0 != dk4str_cpy_s(fnb, fnbsz, dk4dir_get_path(cn->dir), NULL)) {
	    if (0 != dk4str_cat_s(fnb, fnbsz, dk4appdeltree_fnsep, NULL)) {
	      if (0 != dk4str_cat_s(fnb, fnbsz, dn, NULL)) { $? ". fnb=%!ds",fnb
#if DK4_ON_WINDOWS
	        res = dk4app_del_tree_process_dir(fnb);
#else
		res = 1;
#endif
		if (0 != res) {			$? ". directory processing"
		  nn = dk4app_del_tree_node_open(fnb, cn, &job, app);
		  if (NULL != nn) {
		    cn = nn;
		  } else {
		    job.result = 0;
		  }
		} else {			$? ". no directory processing"
		  switch (cn->ne) {
		    case NE_NO_ERROR:
		    case NE_ONE_FILE_REMOVAL_FAILED:
		    case NE_MULTIPLE_FILE_REMOVALS_FAILED: {
		      dk4app_del_tree_debug_file_or_dir(app, fnb, 27);
		      if (0 == dk4app_del_dir(fnb, NULL)) {
		        if (0 == dk4app_del_file(fnb, NULL)) {
			  job.result = 0;
			  cn->ne = NE_ONE_DIRECTORY_REMOVAL_FAILED;
			  dk4app_log_base3(app, DK4_LL_ERROR, 66, 77, fnb);
			  $? "! file deletion failed"
			}
		      }
		    } break;
		    case NE_ONE_DIRECTORY_REMOVAL_FAILED: {
		      dk4app_del_tree_debug_file_or_dir(app, fnb, 27);
		      if (0 == dk4app_del_dir(fnb, NULL)) {
		        if (0 == dk4app_del_file(fnb, NULL)) {
			  job.result = 0;
			  cn->ne = NE_MULTIPLE_DIRECTORY_REMOVALS_FAILED;
			  dk4app_log_base3(
			    app, DK4_LL_ERROR, 96, 97, dk4dir_get_path(cn->dir)
			  );
			  $? "! file deletion failed"
			}
		      }
		    } break;
		    default: {
		      dk4app_del_tree_debug_file_or_dir(app, fnb, 27);
		      if (0 == dk4app_del_dir(fnb, NULL)) {
#if TRACE_DEBUG
		        dfres = dk4app_del_file(fnb, NULL);
			if (0 == dfres) {	$? "! file deletion failed"
			}
#else
			dk4app_del_file(fnb, NULL);
#endif
		      }
		    } break;
		  }
		}
	      } else {				$? "! buffer too small"
	        /* ERROR: Directory name too long! */
		dk4app_log_base3(app, DK4_LL_ERROR, 98, 99, dn);
		job.result = 0;
	      }
	    } else {				$? "! buffer too small"
	      /* ERROR: Directory name too long! */
	      dk4app_log_base3(app,DK4_LL_ERROR,98,99,dk4dir_get_path(cn->dir));
	      job.result = 0;
	    }
	  } else {				$? "! buffer too small"
	    /* ERROR: Directory name too long! */
	    dk4app_log_base3(app,DK4_LL_ERROR,98,99,dk4dir_get_path(cn->dir));
	    job.result = 0;
	  }
        } else {				$? ". no more subdirectories"
          nn = cn->parent;
  	  if (NULL != nn) {			$? ". propagate errors"
  	    switch (nn->ne) {
  	      case NE_NO_ERROR:
  	      case NE_ONE_FILE_REMOVAL_FAILED:
  	      case NE_MULTIPLE_FILE_REMOVALS_FAILED: {
  	        if (0 == dk4app_del_dir(dk4dir_get_path(cn->dir), app)) {
  	          job.result = 0;
  		  nn->ne = NE_ONE_DIRECTORY_REMOVAL_FAILED;
  	        }
  	      } break;
  	      case NE_ONE_DIRECTORY_REMOVAL_FAILED: {
	        dk4app_del_tree_debug_file_or_dir(
		  app, dk4dir_get_path(cn->dir), 25
		);
  	        if (0 == dk4app_del_dir(dk4dir_get_path(cn->dir), NULL)) {
  	          job.result = 0;
  		  nn->ne = NE_MULTIPLE_DIRECTORY_REMOVALS_FAILED;
  		  dk4app_log_base3(
  		    app, DK4_LL_ERROR, 96, 97, dk4dir_get_path(nn->dir)
  		  );
  	        }
  	      } break;
  	      default: {
	        dk4app_del_tree_debug_file_or_dir(
		  app, dk4dir_get_path(cn->dir), 25
		);
  	        (void)dk4app_del_dir(dk4dir_get_path(cn->dir), NULL);
  	      } break;
  	    }
  	  } else {				$? ". no parent directory"
  	    if (0 == dk4app_del_dir(dk4dir_get_path(cn->dir), app)) {
  	      job.result = 0;
  	    }
  	  }
    	  dk4app_del_tree_node_close(cn);
    	  cn = nn;
        }
      }
    } else {					$? "! node"
    }
  } else {					$? "! directory name"
  }
  if ((NULL != job.dbptr) && (0 < job.dbsz)) {
    dk4mem_free(job.dbptr);			$? ". RELEASE dbptr"
  }
  back = job.result;
  $? "- dk4app_del_tree %d", back
  return back;
}