aboutsummaryrefslogtreecommitdiffstats
path: root/mediagoblin/db/base.py
blob: deae2a0110583ac287cd068baaa6afbefbdcf83d (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
# GNU MediaGoblin -- federated, autonomous media hosting
# Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
import copy

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import inspect

from mediagoblin.tools.transition import DISABLE_GLOBALS

if not DISABLE_GLOBALS:
    from sqlalchemy.orm import scoped_session, sessionmaker
    Session = scoped_session(sessionmaker())

class FakeCursor:

    def __init__ (self, cursor, mapper, filter=None):
        self.cursor = cursor
        self.mapper = mapper
        self.filter = filter

    def count(self):
        return self.cursor.count()

    def __copy__(self):
        # Or whatever the function is named to make
        # copy.copy happy?
        return FakeCursor(copy.copy(self.cursor), self.mapper, self.filter)

    def __iter__(self):
        return filter(self.filter, map(self.mapper, self.cursor))

    def __getitem__(self, key):
        return self.mapper(self.cursor[key])

    def slice(self, *args, **kwargs):
        r = self.cursor.slice(*args, **kwargs)
        return list(filter(self.filter, map(self.mapper, r)))

class GMGTableBase:
    # Deletion types
    HARD_DELETE = "hard-deletion"
    SOFT_DELETE = "soft-deletion"

    deletion_mode = HARD_DELETE

    @property
    def _session(self):
        return inspect(self).session

    @property
    def _app(self):
        return self._session.bind.app

    if not DISABLE_GLOBALS:
        query = Session.query_property()

    def get(self, key):
        return getattr(self, key)

    def setdefault(self, key, defaultvalue):
        # The key *has* to exist on sql.
        return getattr(self, key)

    def save(self, commit=True):
        sess = self._session
        if sess is None and not DISABLE_GLOBALS:
            sess = Session()
        assert sess is not None, "Can't save, %r has a detached session" % self
        sess.add(self)
        if commit:
            sess.commit()
        else:
            sess.flush()

    def delete(self, commit=True, deletion=None):
        """ Delete the object either using soft or hard deletion """
        # Get the setting in the model args if none has been specified.
        if deletion is None:
            deletion = self.deletion_mode

        # If the item is in any collection then it should be removed, this will
        # cause issues if it isn't. See #5382.
        # Import here to prevent cyclic imports.
        from mediagoblin.db.models import CollectionItem, GenericModelReference, \
                                          Report, Notification, Comment
        
        # Some of the models don't have an "id" field which means they can't be
        # used with GMR, these models won't be in collections because they
        # can't be. We can skip all of this.
        if hasattr(self, "id"):
            # First find the GenericModelReference for this object
            gmr = GenericModelReference.query.filter_by(
                obj_pk=self.id,
                model_type=self.__tablename__
            ).first()

            # If there is no gmr then we've got lucky, a GMR is a requirement of
            # being in a collection.
            if gmr is not None:
                # Delete collections found
                items = CollectionItem.query.filter_by(
                    object_id=gmr.id
                )
                items.delete()

                # Delete notifications found
                notifications = Notification.query.filter_by(
                    object_id=gmr.id
                )
                notifications.delete()
                
                # Delete this as a comment
                comments = Comment.query.filter_by(
                    comment_id=gmr.id
                )
                comments.delete()

                # Set None on reports found
                reports = Report.query.filter_by(
                    object_id=gmr.id
                )
                for report in reports:
                    report.object_id = None
                    report.save(commit=commit)

        # Hand off to the correct deletion function.
        if deletion == self.HARD_DELETE:
            return self.hard_delete(commit=commit)
        elif deletion == self.SOFT_DELETE:
            return self.soft_delete(commit=commit)
        else:
            raise ValueError(
                "Invalid deletion mode {mode!r}".format(
                    mode=deletion
                )
            )

    def soft_delete(self, commit):
        # Create the graveyard version of this model
        # Importing this here due to cyclic imports
        from mediagoblin.db.models import User, Graveyard, GenericModelReference
        
        tombstone = Graveyard()
        if getattr(self, "public_id", None) is not None:
            tombstone.public_id = self.public_id

        # This is a special case, we don't want to save any actor if the thing
        # being soft deleted is a User model as this would create circular
        # ForeignKeys
        if not isinstance(self, User):
            tombstone.actor = User.query.filter_by(
                id=self.actor
            ).first()
        tombstone.object_type = self.object_type
        tombstone.save(commit=False)

        # There will be a lot of places where the GenericForeignKey will point
        # to the model, we want to remap those to our tombstone.
        gmrs = GenericModelReference.query.filter_by(
            obj_pk=self.id,
            model_type=self.__tablename__
        ).update({
            "obj_pk": tombstone.id,
            "model_type": tombstone.__tablename__,
        })

        
        # Now we can go ahead and actually delete the model.
        return self.hard_delete(commit=commit)

    def hard_delete(self, commit):
        """Delete the object and commit the change immediately by default"""
        sess = self._session
        assert sess is not None, "Not going to delete detached %r" % self
        sess.delete(self)
        if commit:
            sess.commit()


Base = declarative_base(cls=GMGTableBase)


class DictReadAttrProxy:
    """
    Maps read accesses to obj['key'] to obj.key
    and hides all the rest of the obj
    """
    def __init__(self, proxied_obj):
        self.proxied_obj = proxied_obj

    def __getitem__(self, key):
        try:
            return getattr(self.proxied_obj, key)
        except AttributeError:
            raise KeyError("%r is not an attribute on %r"
                % (key, self.proxied_obj))