Backup diff view

backup/views.py

@@ -8,6 +8,8 @@ from .models import BackupProfile
 from .forms import BackupProfileForm
 from router_manager.models import Router
 from backup_data.models import RouterBackup
+import difflib
+import unicodedata
 
 
 @login_required()
@@ -76,13 +78,56 @@ def view_backup_list(request):
 @login_required()
 def view_backup_details(request):
     backup = get_object_or_404(RouterBackup, uuid=request.GET.get('uuid'))
+    hash_list = [backup.backup_text_hash]
+    backup_list = []
+    for backup_item in RouterBackup.objects.filter(router=backup.router, success=True).order_by('-created'):
+        if backup_item.backup_text_hash and backup_item.backup_text_hash not in hash_list:
+            hash_list.append(backup_item.backup_text_hash)
+            backup_list.append(backup_item)
     context = {
         'backup': backup,
+        'backup_list': backup_list,
         'page_title': 'Backup Details'
     }
     return render(request, 'backup/backup_details.html', context)
 
 
+def normalize_text(text):
+    text = unicodedata.normalize('NFC', text)
+    text = text.replace('\r\n', '\n')
+    text = text.replace('\r', '')
+    text = '\n'.join([line.rstrip() for line in text.splitlines()])
+    return text
+
+
+def view_compare_backups(request):
+    backup1 = get_object_or_404(RouterBackup, uuid=request.GET.get('uuid'))
+    backup2 = get_object_or_404(RouterBackup, uuid=request.GET.get('compare_uuid'))
+    if request.GET.get('display') == 'all':
+        show_lines = 100000
+        show_all = True
+    else:
+        show_lines = 3
+        show_all = False
+
+    diff = difflib.unified_diff(normalize_text(backup1.backup_text).splitlines(keepends=True),
+                                normalize_text(backup2.backup_text).splitlines(keepends=True),
+                                fromfile=backup1.backup_text_hash[:16] + '...',
+                                tofile=backup2.backup_text_hash[:16] + '...',
+                                lineterm='', n=show_lines)
+    diff_str = '\n'.join(list(diff))
+
+    context = {
+        'backup1': backup1,
+        'backup2': backup2,
+        'diff_str': diff_str,
+        'page_title': 'Compare Backups',
+        'show_all': show_all
+    }
+
+    return render(request, 'backup/compare_backups.html', context)
+
+
 def view_debug_run_backups(request):
     data = {
         'backup_count': 0,
@@ -91,4 +136,4 @@ def view_debug_run_backups(request):
         data['backup_count'] += 1
         perform_backup(backup)
 
-    return JsonResponse(data)
+    return JsonResponse(data)

backup_data/migrations/0004_routerbackup_backup_text_hash.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.3 on 2024-03-28 16:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('backup_data', '0003_routerbackup_config_change_detected'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='routerbackup',
+            name='backup_text_hash',
+            field=models.CharField(blank=True, max_length=64),
+        ),
+    ]

backup_data/migrations/0005_alter_routerbackup_backup_text_hash.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.3 on 2024-03-28 16:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('backup_data', '0004_routerbackup_backup_text_hash'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='routerbackup',
+            name='backup_text_hash',
+            field=models.CharField(blank=True, db_index=True, max_length=64),
+        ),
+    ]

backup_data/models.py

@@ -1,6 +1,7 @@
 from django.db import models
 from router_manager.models import Router
 import uuid
+import hashlib
 
 
 class RouterBackup(models.Model):
@@ -17,10 +18,18 @@ class RouterBackup(models.Model):
     queue_length = models.IntegerField(default=0) # Seconds
     finish_time = models.DateTimeField(blank=True, null=True)
     backup_text = models.TextField(blank=True, null=True)
+    backup_text_hash = models.CharField(max_length=64, blank=True, db_index=True)
     backup_binary = models.FileField(upload_to='backups/', blank=True, null=True)
 
     updated = models.DateTimeField(auto_now=True)
     created = models.DateTimeField(auto_now_add=True)
     uuid = models.UUIDField(unique=True, editable=False, default=uuid.uuid4)
 
+    def save(self, *args, **kwargs):
+        if self.backup_text:
+            self.backup_text_hash = hashlib.sha256(self.backup_text.encode('utf-8')).hexdigest()
+        else:
+            self.backup_text_hash = ''
+        super(RouterBackup, self).save(*args, **kwargs)
+
 

routerfleet/urls.py

@@ -4,7 +4,7 @@ from dashboard.views import view_dashboard, view_status
 from user_manager.views import view_manage_user, view_user_list
 from accounts.views import view_login, view_logout, view_create_first_user
 from router_manager.views import view_router_list, view_manage_router, view_router_group_list, view_ssh_key_list, view_manage_router_group, view_manage_sshkey, view_router_details
-from backup.views import view_backup_profile_list, view_manage_backup_profile, view_backup_list, view_backup_details, view_debug_run_backups
+from backup.views import view_backup_profile_list, view_manage_backup_profile, view_backup_list, view_backup_details, view_debug_run_backups, view_compare_backups
 
 
 urlpatterns = [
@@ -28,4 +28,6 @@ urlpatterns = [
     path('backup/manage_profile/', view_manage_backup_profile, name='manage_backup_profile'),
     path('backup/backup_list/', view_backup_list, name='backup_list'),
     path('backup/backup_details/', view_backup_details, name='backup_info'),
+    path('backup/compare/', view_compare_backups, name='compare_backups'),
+
 ]

routerlib/functions.py

@@ -9,6 +9,13 @@ def get_router_features(router_type):
         return []
 
 
+def get_router_backup_file_extension(router_type):
+    if router_type == 'routeros':
+        return {'text': 'rsc', 'binary': 'backup'}
+    else:
+        return {'text': 'txt', 'binary': 'bin'}
+
+
 def test_authentication(router_type, address, username, password, sshkey=None):
     router_features = get_router_features(router_type)
     if 'ssh' in router_features:

templates/backup/backup_details.html

@@ -1,5 +1,153 @@
 {% extends 'base.html' %}
+{% load crispy_forms_tags %}
 
 {% block content %}
-backup info
+    <div class='row'>
+        <div class='col-xl-4'>
+            <div class="card card-primary card-outline">
+                <div class="card-header">
+                    <h3 class="card-title">
+                        <a href="/router/details/?uuid={{ backup.router.uuid }}" >
+                            {{ backup.router.name }}
+                        </a>
+
+                    </h3>
+                    <span class="float-right">
+                        <a href="/router/manage/?uuid={{ backup.router.uuid }}" >
+                            <i class="fas fa-edit"></i>
+                        </a>
+                    </span>
+                </div>
+
+                <div class="card-body row">
+                    <div class="col-lg-12">
+
+                        <ul class="list-group list-group-unbordered mb-3">
+                            {% comment %}
+                            <li class="list-group-item">
+                                <b></b>
+                                <span class="float-right">{{ backup }}</span>
+                            </li>
+                            {% endcomment %}
+                            <li class="list-group-item">
+                                <b>Schedule Type</b>
+                                <span class="float-right">
+                                    {{ backup.get_schedule_type_display }}
+                                </span>
+                            </li>
+                            <li class="list-group-item">
+                                <b>Task Created</b>
+                                <span class="float-right">{{ backup.created }}</span>
+                            </li>
+                            <li class="list-group-item">
+                                <b>Schedule Time</b>
+                                <span class="float-right">{{ backup.schedule_time|default_if_none:"" }}</span>
+                            </li>
+
+                            <li class="list-group-item">
+                                <b>Finish Time</b>
+                                <span class="float-right">{{ backup.finish_time }}</span>
+                            </li>
+
+                            <li class="list-group-item">
+                                <b>Queue length</b>
+                                <span class="float-right">{{ backup.queue_length }}s</span>
+                            </li>
+
+                            <li class="list-group-item">
+                                <b>Backup hash</b>
+                                <span class="float-right" title="{{ backup.backup_text_hash }}">{{ backup.backup_text_hash|slice:":16" }}...</span>                            
+                            </li>
+                            
+                            <li class="list-group-item">
+                                <b>Download</b>
+                                <span class="float-right">
+                                {% if backup.backup_text %}
+                                <a href="/backup/download/?uuid={{ backup.uuid }}&type=text" download>
+                                    Text
+                                </a>
+                                   {% if backup.backup_binary %} - {% endif %}
+                                {% endif %}
+                                {% if backup.backup_binary %}
+                                <a href="/backup/download/?uuid={{ backup.uuid }}&type=binary" download>
+                                    Binary
+                                </a>
+                                {% endif %}
+                                </span>
+                            </li>
+                            
+                        </ul>
+
+
+                    </div>
+                    
+                </div>
+            </div>
+        
+        <div class="card card-primary card-outline">
+                <div class="card-header">
+                    <h3 class="card-title">
+                        Latest Configuration changes
+                    </h3>
+                    
+                </div>
+
+                <div class="card-body row">
+                    <div class="col-lg-12">
+                        <table class="table">
+                            <thead>
+                            <tr>
+                                
+                            </tr>
+                            </thead>
+                            <tbody>
+                            {% for compare_backup in backup_list %}
+                                <tr>
+                                <td>
+                                    {% if compare_backup.finish_time %}
+                                    {{ compare_backup.finish_time }}
+                                    {% else %}
+                                    {{ compare_backup.created }}
+                                    {% endif %}
+                                
+                                </td>
+                                
+                                <td>
+                                    <a href="/backup/compare/?uuid={{ backup.uuid }}&compare_uuid={{ compare_backup.uuid }}">
+                                        Compare
+                                    </a>
+                                </td>
+                                </tr>
+                            {% endfor %}
+                            </tbody>
+                        </table>
+                    </div>
+                    
+                </div>
+        </div>
+        </div>
+        <div class='col-xl-8'>
+            <div class="card card-primary card-outline">
+
+                <div class="card-header">
+                    <h3 class="card-title">Text Backup</h3>
+                </div>
+
+                <div class="card-body row">
+                    <div class="col-lg-12">
+                        <pre>{{ backup.backup_text }}</pre>
+                        
+
+                    </div>
+                </div>
+            </div>
+        </div>
+
+
+    </div>
+{% endblock %}
+
+{% block custom_page_scripts %}
+
+
 {% endblock %}

templates/backup/compare_backups.html

@@ -0,0 +1,89 @@
+{% extends 'base.html' %}
+
+{% block page_custom_head %}
+    <link rel="stylesheet" type="text/css" href="/static/plugins/diff2html/diff2html.min.css"/>
+    <script type="text/javascript" src="/static/plugins/diff2html/diff2html.min.js"></script>
+
+    <style>
+        .d2h-file-list-wrapper {
+            display: none;
+        }
+
+        .d2h-file-header {
+            display: none;
+        }
+    </style>
+
+{% endblock %}
+
+{% block content %}
+
+    <div class='row'>
+        <div class='col-xl-12'>
+            <div class="card card-primary card-outline">
+                <div class="card-header">
+                    <h3 class="card-title">
+
+                        <a href="/router/details/?uuid={{ backup1.router.uuid }}">{{ backup1.router }}</a> -
+                        Comparing backup:
+                        <a href="/backup/backup_details/?uuid={{ backup1.uuid }}"
+                           title="{{ backup1.backup_text_hash }}">
+                            {% if backup1.finish_time %}{{ backup1.finish_time }}{% else %}
+                                {{ backup1.created }}{% endif %}
+                        </a>
+                        with:
+                        <a href="/backup/backup_details/?uuid={{ backup2.uuid }}"
+                           title="{{ backup2.backup_text_hash }}">
+                            {% if backup2.finish_time %}{{ backup2.finish_time }}{% else %}
+                                {{ backup2.created }}{% endif %}
+                        </a>
+
+                    </h3>
+                </div>
+                <div class="card-body row">
+                    <div class="col-lg-12">
+                        <button class="btn btn-outline-primary" onclick="renderDiff('side-by-side')">Side by Side
+                        </button>
+                        <button class="btn btn-outline-primary" onclick="renderDiff('inline')">Inline</button>
+                        <a class="btn btn-outline-primary"
+                           href="?uuid={{ backup1.uuid }}&compare_uuid={{ backup2.uuid }}">Diff only</a>
+                        <a class="btn btn-outline-primary"
+                           href="?uuid={{ backup1.uuid }}&compare_uuid={{ backup2.uuid }}&display=all">Complete file</a>
+                        <div id="diff-container"></div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+
+
+{% endblock %}
+
+{% block custom_page_scripts %}
+    <script type="text/javascript">
+        var diffString = `{{ diff_str|safe }}`;
+
+        function renderDiff(viewType) {
+            var targetElement = document.getElementById('diff-container');
+            var processedDiffString = diffString.split('\n').filter(line => {
+                return !line.startsWith('--- a/') && !line.startsWith('+++ b/');
+            }).join('\n');
+            var configuration = {
+                inputFormat: 'diff',
+                showFiles: false,
+                matching: 'lines',
+                outputFormat: viewType,
+            };
+
+            var diffHtml = Diff2Html.html(processedDiffString, configuration);
+            targetElement.innerHTML = diffHtml;
+        }
+
+        //renderDiff('inline');
+        renderDiff('side-by-side');
+    </script>
+
+
+
+
+{% endblock %}