mediagoblin/db/sql/models.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   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.
   8 #
   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.
  13 #
  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/>.
  16
  17 """
  18 TODO: indexes on foreignkeys, where useful.
  19 """
  20
  21
  22 import datetime
  23 import sys
  24
  25 from sqlalchemy import (
  26     Column, Integer, Unicode, UnicodeText, DateTime, Boolean, ForeignKey,
  27     UniqueConstraint, PrimaryKeyConstraint, SmallInteger)
  28 from sqlalchemy.orm import relationship
  29 from sqlalchemy.orm.collections import attribute_mapped_collection
  30 from sqlalchemy.sql.expression import desc
  31 from sqlalchemy.ext.associationproxy import association_proxy
  32 from sqlalchemy.util import memoized_property
  33
  34 from mediagoblin.db.sql.extratypes import PathTupleWithSlashes, JSONEncoded
  35 from mediagoblin.db.sql.base import Base, DictReadAttrProxy
  36 from mediagoblin.db.mixin import UserMixin, MediaEntryMixin, MediaCommentMixin
  37 from mediagoblin.db.sql.base import Session
  38
  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
  41 #
  42 # We could do migration calls more manually instead of relying on
  43 # this import-based meddling...
  44 from migrate import changeset
  45
  46
  47 class SimpleFieldAlias(object):
  48     """An alias for any field"""
  49     def __init__(self, fieldname):
  50         self.fieldname = fieldname
  51
  52     def __get__(self, instance, cls):
  53         return getattr(instance, self.fieldname)
  54
  55     def __set__(self, instance, val):
  56         setattr(instance, self.fieldname, val)
  57
  58
  59 class User(Base, UserMixin):
  60     """
  61     TODO: We should consider moving some rarely used fields
  62     into some sort of "shadow" table.
  63     """
  64     __tablename__ = "core__users"
  65
  66     id = Column(Integer, primary_key=True)
  67     username = Column(Unicode, nullable=False, unique=True)
  68     email = Column(Unicode, nullable=False)
  69     created = Column(DateTime, nullable=False, default=datetime.datetime.now)
  70     pw_hash = Column(Unicode, nullable=False)
  71     email_verified = Column(Boolean, default=False)
  72     status = Column(Unicode, default=u"needs_email_verification", nullable=False)
  73     verification_key = Column(Unicode)
  74     is_admin = Column(Boolean, default=False, nullable=False)
  75     url = Column(Unicode)
  76     bio = Column(UnicodeText)  # ??
  77     fp_verification_key = Column(Unicode)
  78     fp_token_expire = Column(DateTime)
  79
  80     ## TODO
  81     # plugin data would be in a separate model
  82
  83     _id = SimpleFieldAlias("id")
  84
  85
  86 class MediaEntry(Base, MediaEntryMixin):
  87     """
  88     TODO: Consider fetching the media_files using join
  89     """
  90     __tablename__ = "core__media_entries"
  91
  92     id = Column(Integer, primary_key=True)
  93     uploader = Column(Integer, ForeignKey(User.id), nullable=False, index=True)
  94     title = Column(Unicode, nullable=False)
  95     slug = Column(Unicode)
  96     created = Column(DateTime, nullable=False, default=datetime.datetime.now,
  97         index=True)
  98     description = Column(UnicodeText) # ??
  99     media_type = Column(Unicode, nullable=False)
 100     state = Column(Unicode, default=u'unprocessed', nullable=False)
 101         # or use sqlalchemy.types.Enum?
 102     license = Column(Unicode)
 103
 104     fail_error = Column(Unicode)
 105     fail_metadata = Column(JSONEncoded)
 106
 107     queued_media_file = Column(PathTupleWithSlashes)
 108
 109     queued_task_id = Column(Unicode)
 110
 111     __table_args__ = (
 112         UniqueConstraint('uploader', 'slug'),
 113         {})
 114
 115     get_uploader = relationship(User)
 116
 117     media_files_helper = relationship("MediaFile",
 118         collection_class=attribute_mapped_collection("name"),
 119         cascade="all, delete-orphan"
 120         )
 121     media_files = association_proxy('media_files_helper', 'file_path',
 122         creator=lambda k, v: MediaFile(name=k, file_path=v)
 123         )
 124
 125     attachment_files_helper = relationship("MediaAttachmentFile",
 126         cascade="all, delete-orphan",
 127         order_by="MediaAttachmentFile.created"
 128         )
 129     attachment_files = association_proxy("attachment_files_helper", "dict_view",
 130         creator=lambda v: MediaAttachmentFile(
 131             name=v["name"], filepath=v["filepath"])
 132         )
 133
 134     tags_helper = relationship("MediaTag",
 135         cascade="all, delete-orphan"
 136         )
 137     tags = association_proxy("tags_helper", "dict_view",
 138         creator=lambda v: MediaTag(name=v["name"], slug=v["slug"])
 139         )
 140
 141     ## TODO
 142     # media_data
 143     # fail_error
 144
 145     _id = SimpleFieldAlias("id")
 146
 147     def get_comments(self, ascending=False):
 148         order_col = MediaComment.created
 149         if not ascending:
 150             order_col = desc(order_col)
 151         return MediaComment.query.filter_by(
 152             media_entry=self.id).order_by(order_col)
 153
 154     def url_to_prev(self, urlgen):
 155         """get the next 'newer' entry by this user"""
 156         media = MediaEntry.query.filter(
 157             (MediaEntry.uploader == self.uploader)
 158             & (MediaEntry.state == 'processed')
 159             & (MediaEntry.id > self.id)).order_by(MediaEntry.id).first()
 160
 161         if media is not None:
 162             return media.url_for_self(urlgen)
 163
 164     def url_to_next(self, urlgen):
 165         """get the next 'older' entry by this user"""
 166         media = MediaEntry.query.filter(
 167             (MediaEntry.uploader == self.uploader)
 168             & (MediaEntry.state == 'processed')
 169             & (MediaEntry.id < self.id)).order_by(desc(MediaEntry.id)).first()
 170
 171         if media is not None:
 172             return media.url_for_self(urlgen)
 173
 174     #@memoized_property
 175     @property
 176     def media_data(self):
 177         session = Session()
 178
 179         return session.query(self.media_data_table).filter_by(
 180             media_entry=self.id).first()
 181
 182     def media_data_init(self, **kwargs):
 183         """
 184         Initialize or update the contents of a media entry's media_data row
 185         """
 186         session = Session()
 187
 188         media_data = session.query(self.media_data_table).filter_by(
 189             media_entry=self.id).first()
 190
 191         # No media data, so actually add a new one
 192         if media_data is None:
 193             media_data = self.media_data_table(
 194                 media_entry=self.id,
 195                 **kwargs)
 196             session.add(media_data)
 197         # Update old media data
 198         else:
 199             for field, value in kwargs.iteritems():
 200                 setattr(media_data, field, value)
 201
 202     @memoized_property
 203     def media_data_table(self):
 204         # TODO: memoize this
 205         models_module = self.media_type + '.models'
 206         __import__(models_module)
 207         return sys.modules[models_module].DATA_MODEL
 208
 209
 210 class FileKeynames(Base):
 211     """
 212     keywords for various places.
 213     currently the MediaFile keys
 214     """
 215     __tablename__ = "core__file_keynames"
 216     id = Column(Integer, primary_key=True)
 217     name = Column(Unicode, unique=True)
 218
 219     def __repr__(self):
 220         return "<FileKeyname %r: %r>" % (self.id, self.name)
 221
 222     @classmethod
 223     def find_or_new(cls, name):
 224         t = cls.query.filter_by(name=name).first()
 225         if t is not None:
 226             return t
 227         return cls(name=name)
 228
 229
 230 class MediaFile(Base):
 231     """
 232     TODO: Highly consider moving "name" into a new table.
 233     TODO: Consider preloading said table in software
 234     """
 235     __tablename__ = "core__mediafiles"
 236
 237     media_entry = Column(
 238         Integer, ForeignKey(MediaEntry.id),
 239         nullable=False)
 240     name_id = Column(SmallInteger, ForeignKey(FileKeynames.id), nullable=False)
 241     file_path = Column(PathTupleWithSlashes)
 242
 243     __table_args__ = (
 244         PrimaryKeyConstraint('media_entry', 'name_id'),
 245         {})
 246
 247     def __repr__(self):
 248         return "<MediaFile %s: %r>" % (self.name, self.file_path)
 249
 250     name_helper = relationship(FileKeynames, lazy="joined", innerjoin=True)
 251     name = association_proxy('name_helper', 'name',
 252         creator=FileKeynames.find_or_new
 253         )
 254
 255
 256 class MediaAttachmentFile(Base):
 257     __tablename__ = "core__attachment_files"
 258
 259     id = Column(Integer, primary_key=True)
 260     media_entry = Column(
 261         Integer, ForeignKey(MediaEntry.id),
 262         nullable=False)
 263     name = Column(Unicode, nullable=False)
 264     filepath = Column(PathTupleWithSlashes)
 265     created = Column(DateTime, nullable=False, default=datetime.datetime.now)
 266
 267     @property
 268     def dict_view(self):
 269         """A dict like view on this object"""
 270         return DictReadAttrProxy(self)
 271
 272
 273 class Tag(Base):
 274     __tablename__ = "core__tags"
 275
 276     id = Column(Integer, primary_key=True)
 277     slug = Column(Unicode, nullable=False, unique=True)
 278
 279     def __repr__(self):
 280         return "<Tag %r: %r>" % (self.id, self.slug)
 281
 282     @classmethod
 283     def find_or_new(cls, slug):
 284         t = cls.query.filter_by(slug=slug).first()
 285         if t is not None:
 286             return t
 287         return cls(slug=slug)
 288
 289
 290 class MediaTag(Base):
 291     __tablename__ = "core__media_tags"
 292
 293     id = Column(Integer, primary_key=True)
 294     media_entry = Column(
 295         Integer, ForeignKey(MediaEntry.id),
 296         nullable=False, index=True)
 297     tag = Column(Integer, ForeignKey(Tag.id), nullable=False, index=True)
 298     name = Column(Unicode)
 299     # created = Column(DateTime, nullable=False, default=datetime.datetime.now)
 300
 301     __table_args__ = (
 302         UniqueConstraint('tag', 'media_entry'),
 303         {})
 304
 305     tag_helper = relationship(Tag)
 306     slug = association_proxy('tag_helper', 'slug',
 307         creator=Tag.find_or_new
 308         )
 309
 310     def __init__(self, name=None, slug=None):
 311         Base.__init__(self)
 312         if name is not None:
 313             self.name = name
 314         if slug is not None:
 315             self.tag_helper = Tag.find_or_new(slug)
 316
 317     @property
 318     def dict_view(self):
 319         """A dict like view on this object"""
 320         return DictReadAttrProxy(self)
 321
 322
 323 class MediaComment(Base, MediaCommentMixin):
 324     __tablename__ = "core__media_comments"
 325
 326     id = Column(Integer, primary_key=True)
 327     media_entry = Column(
 328         Integer, ForeignKey(MediaEntry.id), nullable=False, index=True)
 329     author = Column(Integer, ForeignKey(User.id), nullable=False)
 330     created = Column(DateTime, nullable=False, default=datetime.datetime.now)
 331     content = Column(UnicodeText, nullable=False)
 332
 333     get_author = relationship(User)
 334
 335     _id = SimpleFieldAlias("id")
 336
 337
 338 MODELS = [
 339     User, MediaEntry, Tag, MediaTag, MediaComment, MediaFile, FileKeynames,
 340     MediaAttachmentFile]
 341
 342
 343 ######################################################
 344 # Special, migrations-tracking table
 345 #
 346 # Not listed in MODELS because this is special and not
 347 # really migrated, but used for migrations (for now)
 348 ######################################################
 349
 350 class MigrationData(Base):
 351     __tablename__ = "core__migrations"
 352
 353     name = Column(Unicode, primary_key=True)
 354     version = Column(Integer, nullable=False, default=0)
 355
 356 ######################################################
 357
 358
 359 def show_table_init(engine_uri):
 360     if engine_uri is None:
 361         engine_uri = 'sqlite:///:memory:'
 362     from sqlalchemy import create_engine
 363     engine = create_engine(engine_uri, echo=True)
 364
 365     Base.metadata.create_all(engine)
 366
 367
 368 if __name__ == '__main__':
 369     from sys import argv
 370     print repr(argv)
 371     if len(argv) == 2:
 372         uri = argv[1]
 373     else:
 374         uri = None
 375     show_table_init(uri)