summaryrefslogtreecommitdiff
path: root/ishtar_common/serializers.py
blob: 7e61df5177c392f7f8488fc092923a87deb42051 (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
import json
import os
import tempfile
import zipfile
from rest_framework import serializers
from zipfile import ZipFile

from django.apps import apps
from django.conf import settings
from django.core.serializers import deserialize
from django.db.models import Q

from . import models

from ishtar_common.serializers_utils import generic_get_results, \
    archive_serialization, generic_archive_files, SERIALIZATION_VERSION, \
    get_model_from_filename

from archaeological_operations.serializers import operation_serialization, \
    OPERATION_MODEL_LIST
from archaeological_context_records.serializers import cr_serialization, \
    CR_MODEL_LIST
from archaeological_finds.serializers import find_serialization, \
    FIND_MODEL_LIST
from archaeological_warehouse.serializers import warehouse_serialization, \
    WAREHOUSE_MODEL_LIST


class PublicSerializer(serializers.BaseSerializer):
    def to_representation(self, obj):
        return obj.public_representation()


TYPE_MODEL_EXCLUDE = ["Area", "OperationTypeOld"]


def get_type_models():
    return [
        model for model in apps.get_models()
        if isinstance(model(), models.GeneralType) and (
                model.__name__ not in TYPE_MODEL_EXCLUDE)
    ]


def type_serialization(archive=False, return_empty_types=False,
                       archive_name=None):
    result = generic_get_results(get_type_models(), "types")
    return archive_serialization(result, archive_dir="types", archive=archive,
                                 return_empty_types=return_empty_types,
                                 archive_name=archive_name)


CONF_MODEL_LIST = [
    models.IshtarSiteProfile, models.GlobalVar, models.CustomForm,
    models.ExcludedField, models.JsonDataSection, models.JsonDataField,
    models.CustomFormJsonField, models.ImporterModel,
    models.DocumentTemplate
]


def conf_serialization(archive=False, return_empty_types=False,
                       archive_name=None):
    media_archive = None
    if archive:
        media_archive = generic_archive_files(CONF_MODEL_LIST)
    result = generic_get_results(CONF_MODEL_LIST, "common_configuration")
    full_archive = archive_serialization(
        result, archive_dir="common_configuration", archive=archive,
        return_empty_types=return_empty_types, archive_name=archive_name)
    if not media_archive:
        return full_archive
    with ZipFile(full_archive, 'a') as current_zip:
        current_zip.write(media_archive, arcname="media.zip")
    return full_archive


IMPORT_MODEL_LIST = [
    models.Regexp, models.ImporterModel, models.ImporterType,
    models.ValueFormater, models.ImporterColumn,
    models.FormaterType, models.ImporterDefault, models.ImporterDefaultValues,
    models.ImportTarget, models.ImporterDefaultValues,
    models.ImporterDuplicateField
]


def importer_serialization(archive=False, return_empty_types=False,
                           archive_name=None):
    result = generic_get_results(IMPORT_MODEL_LIST, "common_imports")
    full_archive = archive_serialization(
        result, archive_dir="common_imports", archive=archive,
        return_empty_types=return_empty_types, archive_name=archive_name)
    return full_archive


GEO_MODEL_LIST = [
    models.State, models.Department, models.Town, models.Area
]


def geo_serialization(archive=False, return_empty_types=False,
                      archive_name=None, no_geo=True):
    result = generic_get_results(GEO_MODEL_LIST, "common_geo", no_geo=no_geo)
    full_archive = archive_serialization(
        result, archive_dir="common_geo", archive=archive,
        return_empty_types=return_empty_types, archive_name=archive_name)
    return full_archive


DIRECTORY_MODEL_LIST = [
    models.Organization, models.Person, models.Author
]


def directory_serialization(archive=False, return_empty_types=False,
                            archive_name=None):
    result = generic_get_results(DIRECTORY_MODEL_LIST, "common_directory")
    full_archive = archive_serialization(
        result, archive_dir="common_directory", archive=archive,
        return_empty_types=return_empty_types, archive_name=archive_name)
    return full_archive


def document_serialization(archive=False, return_empty_types=False,
                           archive_name=None, operation_queryset=None,
                           site_queryset=None, cr_queryset=None,
                           find_queryset=None, warehouse_queryset=None):
    result_queryset = {}
    get_queryset_attr = None
    if operation_queryset:
        get_queryset_attr = {"operation_queryset": operation_queryset,
                             "get_queryset": True}
    elif site_queryset:
        get_queryset_attr = {"site_queryset": site_queryset,
                             "get_queryset": True}
    elif cr_queryset:
        get_queryset_attr = {"cr_queryset": cr_queryset,
                             "get_queryset": True}
    elif find_queryset:
        get_queryset_attr = {"find_queryset": find_queryset,
                             "get_queryset": True}
    elif warehouse_queryset:
        get_queryset_attr = {"warehouse_queryset": warehouse_queryset,
                             "get_queryset": True}

    if get_queryset_attr:
        queries = operation_serialization(**get_queryset_attr)
        queries.update(cr_serialization(**get_queryset_attr))
        queries.update(find_serialization(**get_queryset_attr))
        queries.update(warehouse_serialization(**get_queryset_attr))
        q = None
        for model, attr in (
                ("Operation", "operations"),
                ("ArchaeologicalSite", "sites"),
                ("ContextRecord", "context_records"),
                ("Find", "finds"),
                ("Warehouse", "warehouses"),
                ("Container", "containers")):
            values = queries[model].values_list("id", flat=True)
            base_q = Q(**{attr + "__id__in": values})
            if not q:
                q = base_q
            else:
                q |= base_q
        result_queryset["Document"] = models.Document.objects.filter(q)

    result = generic_get_results([models.Document], "documents",
                                 result_queryset=result_queryset)
    media_archive = None
    if archive:
        media_archive = generic_archive_files([models.Document],
                                              result_queryset=result_queryset)
    full_archive = archive_serialization(
        result, archive_dir="documents", archive=archive,
        return_empty_types=return_empty_types, archive_name=archive_name)
    if not media_archive:
        return full_archive
    with ZipFile(full_archive, 'a') as current_zip:
        current_zip.write(media_archive, arcname="media.zip")
    return full_archive


def full_serialization(operation_queryset=None, site_queryset=None,
                       cr_queryset=None, find_queryset=None,
                       warehouse_queryset=None):
    archive_name = type_serialization()
    conf_serialization(archive_name=archive_name)
    importer_serialization(archive_name=archive_name)
    geo_serialization(archive_name=archive_name)
    directory_serialization(archive_name=archive_name)
    document_serialization(archive_name=archive_name)
    operation_serialization(
        archive_name=archive_name, operation_queryset=operation_queryset,
        site_queryset=site_queryset, cr_queryset=cr_queryset,
        find_queryset=find_queryset, warehouse_queryset=warehouse_queryset)
    cr_serialization(
        archive_name=archive_name, operation_queryset=operation_queryset,
        site_queryset=site_queryset, cr_queryset=cr_queryset,
        find_queryset=find_queryset, warehouse_queryset=warehouse_queryset)
    find_serialization(
        archive_name=archive_name, operation_queryset=operation_queryset,
        site_queryset=site_queryset, cr_queryset=cr_queryset,
        find_queryset=find_queryset, warehouse_queryset=warehouse_queryset)
    warehouse_serialization(
        archive_name=archive_name, operation_queryset=operation_queryset,
        site_queryset=site_queryset, cr_queryset=cr_queryset,
        find_queryset=find_queryset, warehouse_queryset=warehouse_queryset)


def restore_serialized(archive_name, delete_existing=False):
    with zipfile.ZipFile(archive_name, "r") as zip_file:
        # check version
        info = json.loads(zip_file.read("info.json").decode("utf-8"))
        if info["serialize-version"] != SERIALIZATION_VERSION:
            raise ValueError(
                "This dump version: {} is not managed by this Ishtar "
                "installation".format(info["serialize-version"])
            )

        DIRS = (
            ("types", [None]),
            ("common_configuration", CONF_MODEL_LIST),
            ("common_imports", IMPORT_MODEL_LIST),
            ("common_geo", GEO_MODEL_LIST),
            ("common_directory", DIRECTORY_MODEL_LIST),
            ("documents", [models.Document]),
            ("operations", OPERATION_MODEL_LIST),
            ("context_records", CR_MODEL_LIST),
            ("finds", FIND_MODEL_LIST),
            ("warehouse", WAREHOUSE_MODEL_LIST),
        )
        namelist = zip_file.namelist()
        for current_dir, model_list in DIRS:
            for current_model in model_list:
                for json_filename in namelist:
                    path = json_filename.split(os.sep)
                    if len(path) != 2 or path[0] != current_dir:
                        continue
                    model = get_model_from_filename(path[-1])
                    if current_model and current_model != model:
                        continue
                    if delete_existing:
                        model.objects.all().delete()
                    data = zip_file.read(json_filename).decode("utf-8")
                    for obj in deserialize("json", data):
                        obj.save()
        # restore media
        if "media.zip" in namelist:
            with tempfile.TemporaryDirectory() as tmp_dir_name:
                zip_file.extract("media.zip", tmp_dir_name)
                with zipfile.ZipFile(
                        tmp_dir_name + os.sep + "media.zip", 'r') as media_zip:
                    media_zip.extractall(settings.MEDIA_ROOT)