Commit | Line | Data |
---|---|---|
fbad3a9f | 1 | # GNU MediaGoblin -- federated, autonomous media hosting |
7f4ebeed | 2 | # Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. |
fbad3a9f E |
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 | ||
eea6d276 E |
17 | """ |
18 | TODO: indexes on foreignkeys, where useful. | |
19 | """ | |
20 | ||
fbad3a9f | 21 | |
ccca0fbf CAW |
22 | import datetime |
23 | ||
ccca0fbf CAW |
24 | from sqlalchemy import ( |
25 | Column, Integer, Unicode, UnicodeText, DateTime, Boolean, ForeignKey, | |
26 | UniqueConstraint) | |
88e90f41 | 27 | from sqlalchemy.orm import relationship |
02db7e0a | 28 | from sqlalchemy.orm.collections import attribute_mapped_collection |
c47a03b9 | 29 | from sqlalchemy.sql.expression import desc |
02db7e0a | 30 | from sqlalchemy.ext.associationproxy import association_proxy |
ccca0fbf | 31 | |
02db7e0a | 32 | from mediagoblin.db.sql.extratypes import PathTupleWithSlashes |
de917303 | 33 | from mediagoblin.db.sql.base import Base, DictReadAttrProxy |
f42e49c3 | 34 | from mediagoblin.db.mixin import UserMixin, MediaEntryMixin |
ccca0fbf | 35 | |
7b194a79 | 36 | |
19ed039b E |
37 | class SimpleFieldAlias(object): |
38 | """An alias for any field""" | |
39 | def __init__(self, fieldname): | |
40 | self.fieldname = fieldname | |
41 | ||
42 | def __get__(self, instance, cls): | |
43 | return getattr(instance, self.fieldname) | |
44 | ||
45 | def __set__(self, instance, val): | |
46 | setattr(instance, self.fieldname, val) | |
47 | ||
48 | ||
f42e49c3 | 49 | class User(Base, UserMixin): |
eea6d276 E |
50 | """ |
51 | TODO: We should consider moving some rarely used fields | |
52 | into some sort of "shadow" table. | |
53 | """ | |
ccca0fbf CAW |
54 | __tablename__ = "users" |
55 | ||
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) | |
51fba991 | 61 | email_verified = Column(Boolean, default=False) |
e365f980 | 62 | status = Column(Unicode, default=u"needs_email_verification", nullable=False) |
ccca0fbf CAW |
63 | verification_key = Column(Unicode) |
64 | is_admin = Column(Boolean, default=False, nullable=False) | |
65 | url = Column(Unicode) | |
fbad3a9f | 66 | bio = Column(UnicodeText) # ?? |
ccca0fbf | 67 | fp_verification_key = Column(Unicode) |
7c2c56a5 | 68 | fp_token_expire = Column(DateTime) |
ccca0fbf CAW |
69 | |
70 | ## TODO | |
71 | # plugin data would be in a separate model | |
72 | ||
19ed039b E |
73 | _id = SimpleFieldAlias("id") |
74 | ||
ccca0fbf | 75 | |
f42e49c3 | 76 | class MediaEntry(Base, MediaEntryMixin): |
eea6d276 E |
77 | """ |
78 | TODO: Consider fetching the media_files using join | |
79 | """ | |
ccca0fbf CAW |
80 | __tablename__ = "media_entries" |
81 | ||
82 | id = Column(Integer, primary_key=True) | |
83 | uploader = Column(Integer, ForeignKey('users.id'), nullable=False) | |
7c2c56a5 | 84 | title = Column(Unicode, nullable=False) |
3e907d55 | 85 | slug = Column(Unicode) |
ccca0fbf CAW |
86 | created = Column(DateTime, nullable=False, default=datetime.datetime.now) |
87 | description = Column(UnicodeText) # ?? | |
88 | description_html = Column(UnicodeText) # ?? | |
89 | media_type = Column(Unicode, nullable=False) | |
51fba991 E |
90 | state = Column(Unicode, default=u'unprocessed', nullable=False) |
91 | # or use sqlalchemy.types.Enum? | |
2788e6a1 | 92 | license = Column(Unicode) |
fbad3a9f | 93 | |
ccca0fbf CAW |
94 | fail_error = Column(Unicode) |
95 | fail_metadata = Column(UnicodeText) | |
96 | ||
02db7e0a | 97 | queued_media_file = Column(PathTupleWithSlashes) |
ccca0fbf CAW |
98 | |
99 | queued_task_id = Column(Unicode) | |
100 | ||
101 | __table_args__ = ( | |
102 | UniqueConstraint('uploader', 'slug'), | |
103 | {}) | |
104 | ||
88e90f41 E |
105 | get_uploader = relationship(User) |
106 | ||
02db7e0a E |
107 | media_files_helper = relationship("MediaFile", |
108 | collection_class=attribute_mapped_collection("name"), | |
109 | cascade="all, delete-orphan" | |
110 | ) | |
111 | media_files = association_proxy('media_files_helper', 'file_path', | |
fbad3a9f | 112 | creator=lambda k, v: MediaFile(name=k, file_path=v) |
02db7e0a E |
113 | ) |
114 | ||
de917303 E |
115 | tags_helper = relationship("MediaTag", |
116 | cascade="all, delete-orphan" | |
117 | ) | |
118 | tags = association_proxy("tags_helper", "dict_view", | |
119 | creator=lambda v: MediaTag(name=v["name"], slug=v["slug"]) | |
120 | ) | |
121 | ||
ccca0fbf | 122 | ## TODO |
ccca0fbf CAW |
123 | # media_data |
124 | # attachment_files | |
125 | # fail_error | |
126 | ||
51fba991 E |
127 | _id = SimpleFieldAlias("id") |
128 | ||
02ede858 E |
129 | def get_comments(self, ascending=False): |
130 | order_col = MediaComment.created | |
131 | if not ascending: | |
132 | order_col = desc(order_col) | |
133 | return MediaComment.query.filter_by( | |
134 | media_entry=self.id).order_by(order_col) | |
135 | ||
c47a03b9 E |
136 | def url_to_prev(self, urlgen): |
137 | """get the next 'newer' entry by this user""" | |
138 | media = MediaEntry.query.filter( | |
139 | (MediaEntry.uploader == self.uploader) | |
140 | & (MediaEntry.state == 'processed') | |
141 | & (MediaEntry.id > self.id)).order_by(MediaEntry.id).first() | |
142 | ||
143 | if media is not None: | |
144 | return media.url_for_self(urlgen) | |
145 | ||
146 | def url_to_next(self, urlgen): | |
147 | """get the next 'older' entry by this user""" | |
148 | media = MediaEntry.query.filter( | |
149 | (MediaEntry.uploader == self.uploader) | |
150 | & (MediaEntry.state == 'processed') | |
151 | & (MediaEntry.id < self.id)).order_by(desc(MediaEntry.id)).first() | |
152 | ||
153 | if media is not None: | |
154 | return media.url_for_self(urlgen) | |
155 | ||
ccca0fbf | 156 | |
02db7e0a | 157 | class MediaFile(Base): |
eea6d276 E |
158 | """ |
159 | TODO: Highly consider moving "name" into a new table. | |
160 | TODO: Consider preloading said table in software | |
161 | """ | |
02db7e0a E |
162 | __tablename__ = "mediafiles" |
163 | ||
164 | media_entry = Column( | |
165 | Integer, ForeignKey(MediaEntry.id), | |
166 | nullable=False, primary_key=True) | |
167 | name = Column(Unicode, primary_key=True) | |
168 | file_path = Column(PathTupleWithSlashes) | |
169 | ||
170 | def __repr__(self): | |
171 | return "<MediaFile %s: %r>" % (self.name, self.file_path) | |
172 | ||
173 | ||
ccca0fbf CAW |
174 | class Tag(Base): |
175 | __tablename__ = "tags" | |
176 | ||
177 | id = Column(Integer, primary_key=True) | |
178 | slug = Column(Unicode, nullable=False, unique=True) | |
179 | ||
de917303 E |
180 | def __repr__(self): |
181 | return "<Tag %r: %r>" % (self.id, self.slug) | |
182 | ||
183 | @classmethod | |
184 | def find_or_new(cls, slug): | |
185 | t = cls.query.filter_by(slug=slug).first() | |
186 | if t is not None: | |
187 | return t | |
188 | return cls(slug=slug) | |
189 | ||
ccca0fbf CAW |
190 | |
191 | class MediaTag(Base): | |
192 | __tablename__ = "media_tags" | |
193 | ||
194 | id = Column(Integer, primary_key=True) | |
ccca0fbf | 195 | media_entry = Column( |
de917303 | 196 | Integer, ForeignKey(MediaEntry.id), |
ccca0fbf | 197 | nullable=False) |
de917303 E |
198 | tag = Column(Integer, ForeignKey('tags.id'), nullable=False) |
199 | name = Column(Unicode) | |
ccca0fbf CAW |
200 | # created = Column(DateTime, nullable=False, default=datetime.datetime.now) |
201 | ||
202 | __table_args__ = ( | |
203 | UniqueConstraint('tag', 'media_entry'), | |
204 | {}) | |
205 | ||
de917303 E |
206 | tag_helper = relationship(Tag) |
207 | slug = association_proxy('tag_helper', 'slug', | |
208 | creator=Tag.find_or_new | |
209 | ) | |
210 | ||
211 | def __init__(self, name, slug): | |
212 | Base.__init__(self) | |
213 | self.name = name | |
214 | self.tag_helper = Tag.find_or_new(slug) | |
215 | ||
216 | @property | |
217 | def dict_view(self): | |
218 | """A dict like view on this object""" | |
219 | return DictReadAttrProxy(self) | |
220 | ||
ccca0fbf CAW |
221 | |
222 | class MediaComment(Base): | |
223 | __tablename__ = "media_comments" | |
fbad3a9f | 224 | |
ccca0fbf CAW |
225 | id = Column(Integer, primary_key=True) |
226 | media_entry = Column( | |
227 | Integer, ForeignKey('media_entries.id'), nullable=False) | |
228 | author = Column(Integer, ForeignKey('users.id'), nullable=False) | |
229 | created = Column(DateTime, nullable=False, default=datetime.datetime.now) | |
230 | content = Column(UnicodeText, nullable=False) | |
231 | content_html = Column(UnicodeText) | |
e365f980 | 232 | |
88e90f41 E |
233 | get_author = relationship(User) |
234 | ||
51fba991 E |
235 | _id = SimpleFieldAlias("id") |
236 | ||
e365f980 | 237 | |
eea6d276 E |
238 | def show_table_init(engine_uri): |
239 | if engine_uri is None: | |
240 | engine_uri = 'sqlite:///:memory:' | |
e365f980 | 241 | from sqlalchemy import create_engine |
eea6d276 | 242 | engine = create_engine(engine_uri, echo=True) |
e365f980 E |
243 | |
244 | Base.metadata.create_all(engine) | |
245 | ||
246 | ||
247 | if __name__ == '__main__': | |
eea6d276 E |
248 | from sys import argv |
249 | print repr(argv) | |
250 | if len(argv) == 2: | |
251 | uri = argv[1] | |
252 | else: | |
253 | uri = None | |
254 | show_table_init(uri) |