File: ctrl_consistency_checker.c

package info (click to toggle)
crystal-facet-uml 1.63.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 21,640 kB
  • sloc: ansic: 109,610; xml: 3,085; makefile: 138; sh: 113
file content (755 lines) | stat: -rw-r--r-- 34,076 bytes parent folder | download
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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
/* File: ctrl_consistency_checker.c; Copyright and License: see below */

#include "ctrl_consistency_checker.h"
#include "storage/data_database_consistency_checker.h"
#include "entity/data_id.h"
#include "u8/u8_trace.h"
#include "u8/u8_log.h"
#include <assert.h>

void ctrl_consistency_checker_init ( ctrl_consistency_checker_t *this_,
                                     data_database_t *database,
                                     data_database_reader_t *db_reader,
                                     data_database_writer_t *db_writer )
{
    U8_TRACE_BEGIN();
    assert( NULL != database );
    assert( NULL != db_reader );
    assert( NULL != db_writer );

    (*this_).database = database;
    (*this_).db_reader = db_reader;
    (*this_).db_writer = db_writer;

    data_database_consistency_checker_init( &((*this_).db_checker), database );

    U8_TRACE_END();
}

void ctrl_consistency_checker_destroy ( ctrl_consistency_checker_t *this_ )
{
    U8_TRACE_BEGIN();

    data_database_consistency_checker_destroy( &((*this_).db_checker) );

    (*this_).database = NULL;
    (*this_).db_reader = NULL;
    (*this_).db_writer = NULL;

    U8_TRACE_END();
}

u8_error_t ctrl_consistency_checker_repair_database ( ctrl_consistency_checker_t *this_,
                                                      bool modify_db,
                                                      uint32_t *out_err,
                                                      uint32_t *out_fix,
                                                      utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    uint32_t error_count = 0;
    uint32_t fix_count = 0;

    /* write report title */
    if ( modify_db )
    {
        utf8stream_writer_write_str( out_english_report, "TITLE: Repair database\n" );
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "TITLE: Check database\n" );
    }

    /* == find inconsistencies in drawings == */

    /* get all root diagrams */
    err_result |= ctrl_consistency_checker_private_ensure_single_root_diagram( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* find invalid and circular diagram parent links */
    err_result |= ctrl_consistency_checker_private_ensure_valid_diagram_parents( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* find nonreferencing diagramelements */
    err_result |= ctrl_consistency_checker_private_ensure_valid_diagramelements( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* find illreferencing diagramelements */
    err_result |= ctrl_consistency_checker_private_ensure_valid_diagele_features( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* find unreferenced, invisible classifiers */
    err_result |= ctrl_consistency_checker_private_ensure_referenced_classifiers( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* == find inconsistencies in meta model == */

    /* find nonreferencing features */
    err_result |= ctrl_consistency_checker_private_ensure_valid_feature_parents( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* find nonreferencing relationships */
    err_result |= ctrl_consistency_checker_private_ensure_valid_relationship_classifiers( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* find illreferencing relationships */
    err_result |= ctrl_consistency_checker_private_ensure_valid_relationship_features( this_, modify_db, &error_count, &fix_count, out_english_report );

    /* prepare results and return */
    if ( NULL != out_err )
    {
        (*out_err) = error_count;
    }
    if ( NULL != out_fix )
    {
        (*out_fix) = fix_count;
    }

    /* write report summary */
    const char *db_filename = data_database_get_filename_ptr ( (*this_).database );
    utf8stream_writer_write_str( out_english_report, "SUMMARY: " );
    if ( db_filename != NULL )
    {
        utf8stream_writer_write_str( out_english_report, "\n    File: " );
        utf8stream_writer_write_str( out_english_report, db_filename );
    }
    utf8stream_writer_write_str( out_english_report, "\n    Errors found: " );
    utf8stream_writer_write_int( out_english_report, error_count );
    utf8stream_writer_write_str( out_english_report, "\n    Errors fixed: " );
    utf8stream_writer_write_int( out_english_report, fix_count );
    utf8stream_writer_write_str( out_english_report, "\n" );

    /* if not all errors fixed, set result to U8_ERROR_DB_STRUCTURE */
    if ( error_count > fix_count )
    {
        err_result |= U8_ERROR_DB_STRUCTURE;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_single_root_diagram ( ctrl_consistency_checker_t *this_,
                                                                         bool modify_db,
                                                                         uint32_t *io_err,
                                                                         uint32_t *io_fix,
                                                                         utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t result = U8_ERROR_NONE;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure a single root diagram\n" );

    /* get all root diagrams */
    data_small_set_t all_roots;
    data_small_set_init( &all_roots );
    data_diagram_iterator_t diagram_iterator;
    result |= data_diagram_iterator_init_empty( &diagram_iterator );

    result |= data_database_reader_get_diagrams_by_parent_id( (*this_).db_reader,
                                                              DATA_ROW_VOID,
                                                              &diagram_iterator
                                                            );

    if ( U8_ERROR_NONE != result )
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
    }

    while ( data_diagram_iterator_has_next( &diagram_iterator ) )
    {
        result |= data_diagram_iterator_next( &diagram_iterator, &((*this_).temp_diagram) );
        result |= data_small_set_add_obj( &all_roots, data_diagram_get_data_id( &((*this_).temp_diagram) ) );

        utf8stream_writer_write_str( out_english_report, "    INFO: Root diagram: " );
        utf8stream_writer_write_int( out_english_report, data_diagram_get_row_id( &((*this_).temp_diagram) ) );
        utf8stream_writer_write_str( out_english_report, ": " );
        utf8stream_writer_write_str( out_english_report, data_diagram_get_name_const( &((*this_).temp_diagram) ) );
        utf8stream_writer_write_str( out_english_report, "\n" );
    }
    const uint_fast32_t root_diagram_count = data_small_set_get_count( &all_roots );
    utf8stream_writer_write_str( out_english_report, "    ROOT DIAGRAM COUNT: " );
    utf8stream_writer_write_int( out_english_report, root_diagram_count );
    utf8stream_writer_write_str( out_english_report, "\n" );
    result |= data_diagram_iterator_destroy( &diagram_iterator );

    if ( root_diagram_count == 0 )
    {
        (*io_err) ++;
        utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Create a diagram via the GUI.\n" );
    }
    else if ( root_diagram_count > 1 )
    {
        (*io_err) += (root_diagram_count-1) ;
        const data_id_t proposed_root_diagram = data_small_set_get_id( &all_roots, 0 );
        const data_row_t proposed_root_diagram_id = data_id_get_row_id( &proposed_root_diagram );
        if ( ! modify_db )
        {
            utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Attach additional root diagrams below the first: " );
            utf8stream_writer_write_int( out_english_report, proposed_root_diagram_id );
            utf8stream_writer_write_str( out_english_report, "\n" );
        }
        else
        {
            for ( int list_pos = 1; list_pos < root_diagram_count; list_pos ++ )
            {
                const data_id_t proposed_child_diagram = data_small_set_get_id( &all_roots, list_pos );
                const data_row_t proposed_child_diagram_id = data_id_get_row_id( &proposed_child_diagram );
                const u8_error_t data_err
                    = data_database_writer_update_diagram_parent_id( (*this_).db_writer,
                                                                     proposed_child_diagram_id,
                                                                     proposed_root_diagram_id,
                                                                     NULL
                                                                   );
                if ( U8_ERROR_NONE == data_err )
                {
                    utf8stream_writer_write_str( out_english_report, "    FIX: Diagram " );
                    utf8stream_writer_write_int( out_english_report, proposed_child_diagram_id );
                    utf8stream_writer_write_str( out_english_report, " attached to " );
                    utf8stream_writer_write_int( out_english_report, proposed_root_diagram_id);
                    utf8stream_writer_write_str( out_english_report, "\n" );
                    (*io_fix) ++;
                }
                else
                {
                    utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                    result |= data_err;
                }
            }
        }
    }
    data_small_set_destroy( &all_roots );

    U8_TRACE_END_ERR( result );
    return result;
}

u8_error_t ctrl_consistency_checker_private_ensure_valid_diagram_parents ( ctrl_consistency_checker_t *this_,
                                                                           bool modify_db,
                                                                           uint32_t *io_err,
                                                                           uint32_t *io_fix,
                                                                           utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that no circular/invalid references of diagram parents exist\n" );

    data_small_set_t circ_ref;
    data_small_set_init( &circ_ref );
    data_err = data_database_consistency_checker_find_circular_diagram_parents ( &((*this_).db_checker), &circ_ref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t circ_ref_count = data_small_set_get_count( &circ_ref );

        utf8stream_writer_write_str( out_english_report, "    DIAGRAMS WITH CIRCLUAR OR INVALID PARENT REFERENCES: " );
        utf8stream_writer_write_int( out_english_report, circ_ref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( circ_ref_count != 0 )
        {
            (*io_err) += circ_ref_count;

            /* get the root diagram */
            data_row_t root_diag_id = DATA_ROW_VOID;
            {
                data_diagram_iterator_t diagram_iterator;
                err_result |= data_diagram_iterator_init_empty( &diagram_iterator );
                err_result |= data_database_reader_get_diagrams_by_parent_id( (*this_).db_reader,
                                                                              DATA_ROW_VOID,
                                                                              &diagram_iterator
                                                                            );
                if (( U8_ERROR_NONE == err_result )&& data_diagram_iterator_has_next( &diagram_iterator ) )
                {
                    err_result |= data_diagram_iterator_next( &diagram_iterator, &((*this_).temp_diagram) );
                    root_diag_id = data_diagram_get_row_id( &((*this_).temp_diagram) );
                }
                err_result |= data_diagram_iterator_destroy( &diagram_iterator );
            }

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Move " );
                utf8stream_writer_write_int( out_english_report, circ_ref_count );
                utf8stream_writer_write_str( out_english_report, " diagrams below root diagram " );
                utf8stream_writer_write_int( out_english_report, root_diag_id );
                utf8stream_writer_write_str( out_english_report, ".\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < circ_ref_count; list_pos ++ )
                {
                    data_id_t diagram_id = data_small_set_get_id( &circ_ref, list_pos );
                    data_row_t diagram_row_id = data_id_get_row_id( &diagram_id );

                    data_err = data_database_writer_update_diagram_parent_id ( (*this_).db_writer,
                                                                               diagram_row_id,
                                                                               root_diag_id,
                                                                               NULL /*out_old_diagram*/
                                                                             );
                    if ( U8_ERROR_NONE == data_err )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Diagram " );
                        utf8stream_writer_write_int( out_english_report, diagram_row_id );
                        utf8stream_writer_write_str( out_english_report, " moved below root diagram " );
                        utf8stream_writer_write_int( out_english_report, root_diag_id );
                        utf8stream_writer_write_str( out_english_report, ".\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                        err_result |= data_err;
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }
    data_small_set_destroy( &circ_ref );

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_valid_diagramelements ( ctrl_consistency_checker_t *this_,
                                                                           bool modify_db,
                                                                           uint32_t *io_err,
                                                                           uint32_t *io_fix,
                                                                           utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that diagramelements reference valid diagrams and classifiers\n" );

    data_small_set_t unref;
    data_small_set_init( &unref );
    data_err = data_database_consistency_checker_find_nonreferencing_diagramelements ( &((*this_).db_checker), &unref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t unref_count = data_small_set_get_count( &unref );

        utf8stream_writer_write_str( out_english_report, "    NONREFERENCING DIAGRAMELEMENTS COUNT: " );
        utf8stream_writer_write_int( out_english_report, unref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( unref_count != 0 )
        {
            (*io_err) += unref_count;

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Delete " );
                utf8stream_writer_write_int( out_english_report, unref_count );
                utf8stream_writer_write_str( out_english_report, " diagramelements.\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < unref_count; list_pos ++ )
                {
                    data_id_t diagramelement_id = data_small_set_get_id( &unref, list_pos );
                    data_row_t diagramelement_row_id = data_id_get_row_id( &diagramelement_id );
                    data_err = data_database_writer_delete_diagramelement ( (*this_).db_writer, diagramelement_row_id, NULL );
                    if ( U8_ERROR_NONE == data_err )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Diagramelement " );
                        utf8stream_writer_write_int( out_english_report, diagramelement_row_id );
                        utf8stream_writer_write_str( out_english_report, " deleted.\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                        err_result |= data_err;
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_valid_diagele_features ( ctrl_consistency_checker_t *this_,
                                                                            bool modify_db,
                                                                            uint32_t *io_err,
                                                                            uint32_t *io_fix,
                                                                            utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that diagramelements reference NULL or valid features\n" );

    data_small_set_t unref;
    data_small_set_init( &unref );
    data_err = data_database_consistency_checker_find_invalid_focused_features ( &((*this_).db_checker), &unref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t unref_count = data_small_set_get_count( &unref );

        utf8stream_writer_write_str( out_english_report, "    ILLREFERENCING DIAGRAMELEMENTS COUNT: " );
        utf8stream_writer_write_int( out_english_report, unref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( unref_count != 0 )
        {
            (*io_err) += unref_count;

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Unlink focused features from " );
                utf8stream_writer_write_int( out_english_report, unref_count );
                utf8stream_writer_write_str( out_english_report, " diagramelements.\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < unref_count; list_pos ++ )
                {
                    data_id_t diagramelement_id = data_small_set_get_id( &unref, list_pos );
                    data_row_t diagramelement_row_id = data_id_get_row_id( &diagramelement_id );
                    data_err = data_database_writer_update_diagramelement_focused_feature_id ( (*this_).db_writer, diagramelement_row_id, DATA_ROW_VOID, NULL );
                    if ( U8_ERROR_NONE == data_err )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Focused features unlinked from " );
                        utf8stream_writer_write_int( out_english_report, diagramelement_row_id );
                        utf8stream_writer_write_str( out_english_report, " diagramelements.\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                        err_result |= data_err;
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_referenced_classifiers ( ctrl_consistency_checker_t *this_,
                                                                            bool modify_db,
                                                                            uint32_t *io_err,
                                                                            uint32_t *io_fix,
                                                                            utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that classifiers are referenced\n" );

    data_small_set_t unref;
    data_small_set_init( &unref );
    data_err = data_database_consistency_checker_find_unreferenced_classifiers ( &((*this_).db_checker), &unref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t unref_count = data_small_set_get_count( &unref );

        utf8stream_writer_write_str( out_english_report, "    UNREFERENCED CLASSIFIER COUNT: " );
        utf8stream_writer_write_int( out_english_report, unref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( unref_count != 0 )
        {
            (*io_err) += unref_count;

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Delete " );
                utf8stream_writer_write_int( out_english_report, unref_count );
                utf8stream_writer_write_str( out_english_report, " classifiers.\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < unref_count; list_pos ++ )
                {
                    data_id_t classifier_id = data_small_set_get_id( &unref, list_pos );
                    data_row_t classifier_row_id = data_id_get_row_id( &classifier_id );
                    err_result |= data_database_consistency_checker_kill_classifier ( &((*this_).db_checker), classifier_row_id );
                    if ( U8_ERROR_NONE == err_result )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Classifier " );
                        utf8stream_writer_write_int( out_english_report, classifier_row_id );
                        utf8stream_writer_write_str( out_english_report, " deleted.\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_valid_feature_parents ( ctrl_consistency_checker_t *this_,
                                                                           bool modify_db,
                                                                           uint32_t *io_err,
                                                                           uint32_t *io_fix,
                                                                           utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that features have valid classifiers\n" );

    data_small_set_t unref;
    data_small_set_init( &unref );
    data_err = data_database_consistency_checker_find_unreferenced_features ( &((*this_).db_checker), &unref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t unref_count = data_small_set_get_count( &unref );

        utf8stream_writer_write_str( out_english_report, "    NONREFERENCING FEATURES COUNT: " );
        utf8stream_writer_write_int( out_english_report, unref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( unref_count != 0 )
        {
            (*io_err) += unref_count;

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Delete " );
                utf8stream_writer_write_int( out_english_report, unref_count );
                utf8stream_writer_write_str( out_english_report, " features.\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < unref_count; list_pos ++ )
                {
                    data_id_t feature_id = data_small_set_get_id( &unref, list_pos );
                    data_row_t feature_row_id = data_id_get_row_id( &feature_id );
                    data_err = data_database_writer_delete_feature ( (*this_).db_writer, feature_row_id, NULL );
                    if ( U8_ERROR_NONE == data_err )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Feature " );
                        utf8stream_writer_write_int( out_english_report, feature_row_id );
                        utf8stream_writer_write_str( out_english_report, " deleted.\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                        err_result |= data_err;
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_valid_relationship_classifiers ( ctrl_consistency_checker_t *this_,
                                                                                    bool modify_db,
                                                                                    uint32_t *io_err,
                                                                                    uint32_t *io_fix,
                                                                                    utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that relationships link valid classifiers\n" );

    data_small_set_t unref;
    data_small_set_init( &unref );
    data_err = data_database_consistency_checker_find_unreferenced_relationships ( &((*this_).db_checker), &unref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t unref_count = data_small_set_get_count( &unref );

        utf8stream_writer_write_str( out_english_report, "    NONREFERENCING RELATIONSHIPS COUNT: " );
        utf8stream_writer_write_int( out_english_report, unref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( unref_count != 0 )
        {
            (*io_err) += unref_count;

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Delete " );
                utf8stream_writer_write_int( out_english_report, unref_count );
                utf8stream_writer_write_str( out_english_report, " relationships.\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < unref_count; list_pos ++ )
                {
                    data_id_t relationship_id = data_small_set_get_id( &unref, list_pos );
                    data_row_t relation_row_id = data_id_get_row_id( &relationship_id );
                    data_err = data_database_writer_delete_relationship ( (*this_).db_writer, relation_row_id, NULL );
                    if ( U8_ERROR_NONE == data_err )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Relationship " );
                        utf8stream_writer_write_int( out_english_report, relation_row_id );
                        utf8stream_writer_write_str( out_english_report, " deleted.\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                        err_result |= data_err;
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}

u8_error_t ctrl_consistency_checker_private_ensure_valid_relationship_features ( ctrl_consistency_checker_t *this_,
                                                                                 bool modify_db,
                                                                                 uint32_t *io_err,
                                                                                 uint32_t *io_fix,
                                                                                 utf8stream_writer_t *out_english_report )
{
    U8_TRACE_BEGIN();
    assert ( NULL != io_err );
    assert ( NULL != io_fix );
    assert ( NULL != out_english_report );
    u8_error_t err_result = U8_ERROR_NONE;
    u8_error_t data_err;

    /* write report title */
    utf8stream_writer_write_str( out_english_report, "STEP: Ensure that relationships link NULL or valid features\n" );

    data_small_set_t unref;
    data_small_set_init( &unref );
    data_err = data_database_consistency_checker_find_invalid_relationship_features ( &((*this_).db_checker), &unref );
    if ( U8_ERROR_NONE == data_err )
    {
        uint32_t unref_count = data_small_set_get_count( &unref );

        utf8stream_writer_write_str( out_english_report, "    ILLREFERENCING RELATIONSHIPS COUNT: " );
        utf8stream_writer_write_int( out_english_report, unref_count );
        utf8stream_writer_write_str( out_english_report, "\n" );

        if ( unref_count != 0 )
        {
            (*io_err) += unref_count;

            if ( ! modify_db )
            {
                utf8stream_writer_write_str( out_english_report, "    PROPOSED FIX: Delete " );
                utf8stream_writer_write_int( out_english_report, unref_count );
                utf8stream_writer_write_str( out_english_report, " relationships.\n" );
            }
            else
            {
                for ( int list_pos = 0; list_pos < unref_count; list_pos ++ )
                {
                    data_id_t relationship_id = data_small_set_get_id( &unref, list_pos );
                    data_row_t relation_row_id = data_id_get_row_id( &relationship_id );
                    data_err = data_database_writer_delete_relationship ( (*this_).db_writer, relation_row_id, NULL );
                    if ( U8_ERROR_NONE == data_err )
                    {
                        utf8stream_writer_write_str( out_english_report, "    FIX: Relationship " );
                        utf8stream_writer_write_int( out_english_report, relation_row_id );
                        utf8stream_writer_write_str( out_english_report, " deleted.\n" );
                        (*io_fix) ++;
                    }
                    else
                    {
                        utf8stream_writer_write_str( out_english_report, "ERROR WRITING DATABASE.\n" );
                        err_result |= data_err;
                    }
                }
            }
        }
    }
    else
    {
        utf8stream_writer_write_str( out_english_report, "ERROR READING DATABASE.\n" );
        err_result |= data_err;
    }

    U8_TRACE_END_ERR( err_result );
    return err_result;
}


/*
Copyright 2016-2025 Andreas Warnke

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/