aboutsummaryrefslogtreecommitdiff
path: root/wqflask/wqflask/model.py
blob: 5321e420bece55a7e77d97cc31914bc8d9e3064e (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
from __future__ import print_function, division, absolute_import

import uuid
import datetime

import simplejson as json

from flask import request
from flask.ext.sqlalchemy import SQLAlchemy

from wqflask import app

import sqlalchemy

from sqlalchemy import (Column, Integer, String, Table, ForeignKey, Unicode, Boolean, DateTime,
                        Text, Index)
from sqlalchemy.orm import relationship, backref

from wqflask.database import Base, init_db



# Define models
#roles_users = Table('roles_users',
#        Column('user_id', Integer(), ForeignKey('user.the_id')),
#        Column('role_id', Integer(), ForeignKey('role.the_id')))

#class Role(Base):
#    __tablename__ = "role"
#    id = Column(Unicode(36), primary_key=True, default=lambda: unicode(uuid.uuid4()))
#    name = Column(Unicode(80), unique=True, nullable=False)
#    description = Column(Unicode(255))

class User(Base):
    __tablename__ = "user"
    id = Column(Unicode(36), primary_key=True, default=lambda: unicode(uuid.uuid4()))
    email_address = Column(Unicode(50), unique=True, nullable=False)

    # Todo: Turn on strict mode for Mysql
    password = Column(Text, nullable=False)

    full_name = Column(Unicode(50))
    organization = Column(Unicode(50))

    active = Column(Boolean(), nullable=False, default=True)

    registration_info = Column(Text)   # json detailing when they were registered, etc.

    confirmed = Column(Text) # json detailing when they confirmed, etc.

    superuser = Column(Text) # json detailing when they became a superuser, otherwise empty
                             # if not superuser

    logins = relationship("Login",
                          order_by="desc(Login.timestamp)",
                          lazy='dynamic', # Necessary for filter in login_count
                          foreign_keys="Login.user",
                          )

    user_collections = relationship("UserCollection",
                          order_by="asc(UserCollection.name)",
                          lazy='dynamic',
                          )

    def display_num_collections(self):
        """
        Returns the number of collections or a blank string if there are zero.


        Because this is so unimportant...we wrap the whole thing in a try/expect...last thing we
        want is a webpage not to be displayed because of an error here

        Importand TODO: use redis to cache this, don't want to be constantly computing it

        """
        try:
            num = len(list(self.user_collections))
            return display_collapsible(num)
        except Exception as why:
            print("Couldn't display_num_collections:", why)
            return ""


    def get_collection_by_name(self, collection_name):
        try:
            collect = self.user_collections.filter_by(name=collection_name).first()
        except  sqlalchemy.orm.exc.NoResultFound:
            collect = None
        return collect

    @property
    def name_and_org(self):
        """Nice shortcut for printing out who the user is"""
        if self.organization:
            return "{} from {}".format(self.full_name, self.organization)
        else:
            return self.full_name

    @property
    def login_count(self):
        return self.logins.filter_by(successful=True).count()


    @property
    def confirmed_at(self):
        if self.confirmed:
            confirmed_info = json.loads(self.confirmed)
            return confirmed_info['timestamp']
        else:
            return None

    @property
    def superuser_info(self):
        if self.superuser:
            return json.loads(self.superuser)
        else:
            return None

    @property
    def crowner(self):
        """If made superuser, returns object of person who did the crowning"""
        if self.superuser:
            superuser_info = json.loads(self.superuser)
            crowner = User.query.get(superuser_info['crowned_by'])
            return crowner
        else:
            return None

    @property
    def most_recent_login(self):
        try:
            return self.logins[0]
        except IndexError:
            return None


    #roles = relationship('Role', secondary=roles_users,
    #                        backref=backref('users', lazy='dynamic'))


class Login(Base):
    __tablename__ = "login"
    id = Column(Unicode(36), primary_key=True, default=lambda: unicode(uuid.uuid4()))
    user = Column(Unicode(36), ForeignKey('user.id'))
    timestamp = Column(DateTime(), default=lambda: datetime.datetime.utcnow())
    ip_address = Column(Unicode(39))
    successful = Column(Boolean(), nullable=False)  # False if wrong password was entered
    session_id = Column(Text)  # Set only if successfully logged in, otherwise should be blank

    # Set to user who assumes identity if this was a login for debugging purposes by a superuser
    assumed_by = Column(Unicode(36), ForeignKey('user.id'))

    def __init__(self, user):
        self.user = user.id
        self.ip_address = request.remote_addr

##################################################################################################

class UserCollection(Base):
    __tablename__ = "user_collection"
    id = Column(Unicode(36), primary_key=True, default=lambda: unicode(uuid.uuid4()))
    user = Column(Unicode(36), ForeignKey('user.id'))

    # I'd prefer this to not have a length, but for the index below it needs one
    name = Column(Unicode(50))
    created_timestamp = Column(DateTime(), default=lambda: datetime.datetime.utcnow())
    changed_timestamp = Column(DateTime(), default=lambda: datetime.datetime.utcnow())
    members = Column(Text)  # We're going to store them as a json list

    # This index ensures a user doesn't have more than one collection with the same name
    __table_args__ = (Index('usercollection_index', "user", "name"), )

    @property
    def num_members(self):
        try:
            return len(json.loads(self.members))
        except:
            return 0

    #@property
    #def display_num_members(self):
    #    return display_collapsible(self.num_members)

    def members_as_set(self):
        return set(json.loads(self.members))


def display_collapsible(number):
    if number:
        return number
    else:
        return ""


def user_uuid():
    """Unique cookie for a user"""
    user_uuid = request.cookies.get('user_uuid')