1 # GNU MediaGoblin -- federated, autonomous media hosting
2 # Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS.
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU Affero General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU Affero General Public License for more details.
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 TODO: indexes on foreignkeys, where useful.
24 from sqlalchemy
import Column
, Integer
, Unicode
, UnicodeText
, DateTime
, \
25 Boolean
, ForeignKey
, UniqueConstraint
, PrimaryKeyConstraint
, \
27 from sqlalchemy
.orm
import relationship
, backref
28 from sqlalchemy
.orm
.collections
import attribute_mapped_collection
29 from sqlalchemy
.sql
.expression
import desc
30 from sqlalchemy
.ext
.associationproxy
import association_proxy
31 from sqlalchemy
.util
import memoized_property
33 from mediagoblin
.db
.extratypes
import PathTupleWithSlashes
, JSONEncoded
34 from mediagoblin
.db
.base
import Base
, DictReadAttrProxy
35 from mediagoblin
.db
.mixin
import UserMixin
, MediaEntryMixin
, MediaCommentMixin
, CollectionMixin
, CollectionItemMixin
36 from mediagoblin
.tools
.files
import delete_media_files
37 from mediagoblin
.tools
.common
import import_component
39 # It's actually kind of annoying how sqlalchemy-migrate does this, if
40 # I understand it right, but whatever. Anyway, don't remove this :P
42 # We could do migration calls more manually instead of relying on
43 # this import-based meddling...
44 from migrate
import changeset
46 _log
= logging
.getLogger(__name__
)
49 class User(Base
, UserMixin
):
51 TODO: We should consider moving some rarely used fields
52 into some sort of "shadow" table.
54 __tablename__
= "core__users"
56 id = Column(Integer
, primary_key
=True)
57 username
= Column(Unicode
, nullable
=False, unique
=True)
58 email
= Column(Unicode
, nullable
=False)
59 created
= Column(DateTime
, nullable
=False, default
=datetime
.datetime
.now
)
60 pw_hash
= Column(Unicode
, nullable
=False)
61 email_verified
= Column(Boolean
, default
=False)
62 status
= Column(Unicode
, default
=u
"needs_email_verification", nullable
=False)
63 # Intented to be nullable=False, but migrations would not work for it
64 # set to nullable=True implicitly.
65 wants_comment_notification
= Column(Boolean
, default
=True)
66 license_preference
= Column(Unicode
)
67 verification_key
= Column(Unicode
)
68 is_admin
= Column(Boolean
, default
=False, nullable
=False)
70 bio
= Column(UnicodeText
) # ??
71 fp_verification_key
= Column(Unicode
)
72 fp_token_expire
= Column(DateTime
)
75 # plugin data would be in a separate model
78 return '<{0} #{1} {2} {3} "{4}">'.format(
79 self
.__class
__.__name
__,
81 'verified' if self
.email_verified
else 'non-verified',
82 'admin' if self
.is_admin
else 'user',
85 def delete(self
, **kwargs
):
86 """Deletes a User and all related entries/comments/files/..."""
87 # Collections get deleted by relationships.
89 media_entries
= MediaEntry
.query
.filter(MediaEntry
.uploader
== self
.id)
90 for media
in media_entries
:
91 # TODO: Make sure that "MediaEntry.delete()" also deletes
92 # all related files/Comments
93 media
.delete(del_orphan_tags
=False, commit
=False)
95 # Delete now unused tags
96 # TODO: import here due to cyclic imports!!! This cries for refactoring
97 from mediagoblin
.db
.util
import clean_orphan_tags
98 clean_orphan_tags(commit
=False)
100 # Delete user, pass through commit=False/True in kwargs
101 super(User
, self
).delete(**kwargs
)
102 _log
.info('Deleted user "{0}" account'.format(self
.username
))
105 class MediaEntry(Base
, MediaEntryMixin
):
107 TODO: Consider fetching the media_files using join
109 __tablename__
= "core__media_entries"
111 id = Column(Integer
, primary_key
=True)
112 uploader
= Column(Integer
, ForeignKey(User
.id), nullable
=False, index
=True)
113 title
= Column(Unicode
, nullable
=False)
114 slug
= Column(Unicode
)
115 created
= Column(DateTime
, nullable
=False, default
=datetime
.datetime
.now
,
117 description
= Column(UnicodeText
) # ??
118 media_type
= Column(Unicode
, nullable
=False)
119 state
= Column(Unicode
, default
=u
'unprocessed', nullable
=False)
120 # or use sqlalchemy.types.Enum?
121 license
= Column(Unicode
)
122 collected
= Column(Integer
, default
=0)
124 fail_error
= Column(Unicode
)
125 fail_metadata
= Column(JSONEncoded
)
127 transcoding_progress
= Column(SmallInteger
)
129 queued_media_file
= Column(PathTupleWithSlashes
)
131 queued_task_id
= Column(Unicode
)
134 UniqueConstraint('uploader', 'slug'),
137 get_uploader
= relationship(User
)
139 media_files_helper
= relationship("MediaFile",
140 collection_class
=attribute_mapped_collection("name"),
141 cascade
="all, delete-orphan"
143 media_files
= association_proxy('media_files_helper', 'file_path',
144 creator
=lambda k
, v
: MediaFile(name
=k
, file_path
=v
)
147 attachment_files_helper
= relationship("MediaAttachmentFile",
148 order_by
="MediaAttachmentFile.created"
150 attachment_files
= association_proxy("attachment_files_helper", "dict_view",
151 creator
=lambda v
: MediaAttachmentFile(
152 name
=v
["name"], filepath
=v
["filepath"])
155 tags_helper
= relationship("MediaTag",
156 cascade
="all, delete-orphan" # should be automatically deleted
158 tags
= association_proxy("tags_helper", "dict_view",
159 creator
=lambda v
: MediaTag(name
=v
["name"], slug
=v
["slug"])
162 collections_helper
= relationship("CollectionItem",
163 cascade
="all, delete-orphan"
165 collections
= association_proxy("collections_helper", "in_collection")
170 def get_comments(self
, ascending
=False):
171 order_col
= MediaComment
.created
173 order_col
= desc(order_col
)
174 return MediaComment
.query
.filter_by(
175 media_entry
=self
.id).order_by(order_col
)
177 def url_to_prev(self
, urlgen
):
178 """get the next 'newer' entry by this user"""
179 media
= MediaEntry
.query
.filter(
180 (MediaEntry
.uploader
== self
.uploader
)
181 & (MediaEntry
.state
== u
'processed')
182 & (MediaEntry
.id > self
.id)).order_by(MediaEntry
.id).first()
184 if media
is not None:
185 return media
.url_for_self(urlgen
)
187 def url_to_next(self
, urlgen
):
188 """get the next 'older' entry by this user"""
189 media
= MediaEntry
.query
.filter(
190 (MediaEntry
.uploader
== self
.uploader
)
191 & (MediaEntry
.state
== u
'processed')
192 & (MediaEntry
.id < self
.id)).order_by(desc(MediaEntry
.id)).first()
194 if media
is not None:
195 return media
.url_for_self(urlgen
)
198 def media_data(self
):
199 return getattr(self
, self
.media_data_ref
)
201 def media_data_init(self
, **kwargs
):
203 Initialize or update the contents of a media entry's media_data row
205 media_data
= self
.media_data
207 if media_data
is None:
208 # Get the correct table:
209 table
= import_component(self
.media_type
+ '.models:DATA_MODEL')
210 # No media data, so actually add a new one
211 media_data
= table(**kwargs
)
212 # Get the relationship set up.
213 media_data
.get_media_entry
= self
215 # Update old media data
216 for field
, value
in kwargs
.iteritems():
217 setattr(media_data
, field
, value
)
220 def media_data_ref(self
):
221 return import_component(self
.media_type
+ '.models:BACKREF_NAME')
224 safe_title
= self
.title
.encode('ascii', 'replace')
226 return '<{classname} {id}: {title}>'.format(
227 classname
=self
.__class
__.__name
__,
231 def delete(self
, del_orphan_tags
=True, **kwargs
):
232 """Delete MediaEntry and all related files/attachments/comments
234 This will *not* automatically delete unused collections, which
237 :param del_orphan_tags: True/false if we delete unused Tags too
238 :param commit: True/False if this should end the db transaction"""
239 # User's CollectionItems are automatically deleted via "cascade".
240 # Delete all the associated comments
241 for comment
in self
.get_comments():
242 comment
.delete(commit
=False)
244 # Delete all related files/attachments
246 delete_media_files(self
)
247 except OSError, error
:
248 # Returns list of files we failed to delete
249 _log
.error('No such files from the user "{1}" to delete: '
250 '{0}'.format(str(error
), self
.get_uploader
))
251 _log
.info('Deleted Media entry id "{0}"'.format(self
.id))
252 # Related MediaTag's are automatically cleaned, but we might
253 # want to clean out unused Tag's too.
255 # TODO: Import here due to cyclic imports!!!
256 # This cries for refactoring
257 from mediagoblin
.db
.util
import clean_orphan_tags
258 clean_orphan_tags(commit
=False)
259 # pass through commit=False/True in kwargs
260 super(MediaEntry
, self
).delete(**kwargs
)
263 class FileKeynames(Base
):
265 keywords for various places.
266 currently the MediaFile keys
268 __tablename__
= "core__file_keynames"
269 id = Column(Integer
, primary_key
=True)
270 name
= Column(Unicode
, unique
=True)
273 return "<FileKeyname %r: %r>" % (self
.id, self
.name
)
276 def find_or_new(cls
, name
):
277 t
= cls
.query
.filter_by(name
=name
).first()
280 return cls(name
=name
)
283 class MediaFile(Base
):
285 TODO: Highly consider moving "name" into a new table.
286 TODO: Consider preloading said table in software
288 __tablename__
= "core__mediafiles"
290 media_entry
= Column(
291 Integer
, ForeignKey(MediaEntry
.id),
293 name_id
= Column(SmallInteger
, ForeignKey(FileKeynames
.id), nullable
=False)
294 file_path
= Column(PathTupleWithSlashes
)
297 PrimaryKeyConstraint('media_entry', 'name_id'),
301 return "<MediaFile %s: %r>" % (self
.name
, self
.file_path
)
303 name_helper
= relationship(FileKeynames
, lazy
="joined", innerjoin
=True)
304 name
= association_proxy('name_helper', 'name',
305 creator
=FileKeynames
.find_or_new
309 class MediaAttachmentFile(Base
):
310 __tablename__
= "core__attachment_files"
312 id = Column(Integer
, primary_key
=True)
313 media_entry
= Column(
314 Integer
, ForeignKey(MediaEntry
.id),
316 name
= Column(Unicode
, nullable
=False)
317 filepath
= Column(PathTupleWithSlashes
)
318 created
= Column(DateTime
, nullable
=False, default
=datetime
.datetime
.now
)
322 """A dict like view on this object"""
323 return DictReadAttrProxy(self
)
327 __tablename__
= "core__tags"
329 id = Column(Integer
, primary_key
=True)
330 slug
= Column(Unicode
, nullable
=False, unique
=True)
333 return "<Tag %r: %r>" % (self
.id, self
.slug
)
336 def find_or_new(cls
, slug
):
337 t
= cls
.query
.filter_by(slug
=slug
).first()
340 return cls(slug
=slug
)
343 class MediaTag(Base
):
344 __tablename__
= "core__media_tags"
346 id = Column(Integer
, primary_key
=True)
347 media_entry
= Column(
348 Integer
, ForeignKey(MediaEntry
.id),
349 nullable
=False, index
=True)
350 tag
= Column(Integer
, ForeignKey(Tag
.id), nullable
=False, index
=True)
351 name
= Column(Unicode
)
352 # created = Column(DateTime, nullable=False, default=datetime.datetime.now)
355 UniqueConstraint('tag', 'media_entry'),
358 tag_helper
= relationship(Tag
)
359 slug
= association_proxy('tag_helper', 'slug',
360 creator
=Tag
.find_or_new
363 def __init__(self
, name
=None, slug
=None):
368 self
.tag_helper
= Tag
.find_or_new(slug
)
372 """A dict like view on this object"""
373 return DictReadAttrProxy(self
)
376 class MediaComment(Base
, MediaCommentMixin
):
377 __tablename__
= "core__media_comments"
379 id = Column(Integer
, primary_key
=True)
380 media_entry
= Column(
381 Integer
, ForeignKey(MediaEntry
.id), nullable
=False, index
=True)
382 author
= Column(Integer
, ForeignKey(User
.id), nullable
=False)
383 created
= Column(DateTime
, nullable
=False, default
=datetime
.datetime
.now
)
384 content
= Column(UnicodeText
, nullable
=False)
386 # Cascade: Comments are owned by their creator. So do the full thing.
387 # lazy=dynamic: People might post a *lot* of comments, so make
388 # the "posted_comments" a query-like thing.
389 get_author
= relationship(User
,
390 backref
=backref("posted_comments",
392 cascade
="all, delete-orphan"))
395 class Collection(Base
, CollectionMixin
):
396 """An 'album' or 'set' of media by a user.
398 On deletion, contained CollectionItems get automatically reaped via
400 __tablename__
= "core__collections"
402 id = Column(Integer
, primary_key
=True)
403 title
= Column(Unicode
, nullable
=False)
404 slug
= Column(Unicode
)
405 created
= Column(DateTime
, nullable
=False, default
=datetime
.datetime
.now
,
407 description
= Column(UnicodeText
)
408 creator
= Column(Integer
, ForeignKey(User
.id), nullable
=False)
409 # TODO: No of items in Collection. Badly named, can we migrate to num_items?
410 items
= Column(Integer
, default
=0)
412 # Cascade: Collections are owned by their creator. So do the full thing.
413 get_creator
= relationship(User
,
414 backref
=backref("collections",
415 cascade
="all, delete-orphan"))
417 def get_collection_items(self
, ascending
=False):
418 #TODO, is this still needed with self.collection_items being available?
419 order_col
= CollectionItem
.position
421 order_col
= desc(order_col
)
422 return CollectionItem
.query
.filter_by(
423 collection
=self
.id).order_by(order_col
)
426 class CollectionItem(Base
, CollectionItemMixin
):
427 __tablename__
= "core__collection_items"
429 id = Column(Integer
, primary_key
=True)
430 media_entry
= Column(
431 Integer
, ForeignKey(MediaEntry
.id), nullable
=False, index
=True)
432 collection
= Column(Integer
, ForeignKey(Collection
.id), nullable
=False)
433 note
= Column(UnicodeText
, nullable
=True)
434 added
= Column(DateTime
, nullable
=False, default
=datetime
.datetime
.now
)
435 position
= Column(Integer
)
437 # Cascade: CollectionItems are owned by their Collection. So do the full thing.
438 in_collection
= relationship(Collection
,
441 cascade
="all, delete-orphan"))
443 get_media_entry
= relationship(MediaEntry
)
446 UniqueConstraint('collection', 'media_entry'),
451 """A dict like view on this object"""
452 return DictReadAttrProxy(self
)
455 class ProcessingMetaData(Base
):
456 __tablename__
= 'core__processing_metadata'
458 id = Column(Integer
, primary_key
=True)
459 media_entry_id
= Column(Integer
, ForeignKey(MediaEntry
.id), nullable
=False,
461 media_entry
= relationship(MediaEntry
,
462 backref
=backref('processing_metadata',
463 cascade
='all, delete-orphan'))
464 callback_url
= Column(Unicode
)
468 """A dict like view on this object"""
469 return DictReadAttrProxy(self
)
473 User
, MediaEntry
, Tag
, MediaTag
, MediaComment
, Collection
, CollectionItem
, MediaFile
, FileKeynames
,
474 MediaAttachmentFile
, ProcessingMetaData
]
477 ######################################################
478 # Special, migrations-tracking table
480 # Not listed in MODELS because this is special and not
481 # really migrated, but used for migrations (for now)
482 ######################################################
484 class MigrationData(Base
):
485 __tablename__
= "core__migrations"
487 name
= Column(Unicode
, primary_key
=True)
488 version
= Column(Integer
, nullable
=False, default
=0)
490 ######################################################
493 def show_table_init(engine_uri
):
494 if engine_uri
is None:
495 engine_uri
= 'sqlite:///:memory:'
496 from sqlalchemy
import create_engine
497 engine
= create_engine(engine_uri
, echo
=True)
499 Base
.metadata
.create_all(engine
)
502 if __name__
== '__main__':