models.py 15.7 KB
Newer Older
David Haynes's avatar
David Haynes committed
1
2
3
4
5
6
7
8
"""
api/models.py

Define the objects that will be stored in the database and later served through
the API.

https://docs.djangoproject.com/en/1.11/topics/db/models/
"""
9
10
11
12
13
14
15
16
# Future Imports
from __future__ import (absolute_import, division, print_function,
                        unicode_literals)

# Python stdlib Imports
import datetime

# Django Imports
17
from django.db import models
David Haynes's avatar
David Haynes committed
18
from django.contrib.gis.db.models import PointField
19
from django.contrib.auth.models import User
20
from django.core.validators import RegexValidator
David Haynes's avatar
David Haynes committed
21
from django.utils import timezone
David Haynes's avatar
David Haynes committed
22
23

# Other Imports
Ben Waters's avatar
Ben Waters committed
24
from model_utils.models import TimeStampedModel
25
from autoslug import AutoSlugField
26
from taggit.managers import TaggableManager
Tyler Hallada's avatar
Tyler Hallada committed
27

Ben Waters's avatar
Ben Waters committed
28
class Category(TimeStampedModel):
29
    """
David Haynes's avatar
David Haynes committed
30
31
32
33
34
35
36
    Represents the "category" that a Facility falls under. A Category is a
    grouping of Facilities that serve a common/similar purpose.

    ex.
    - Dining
    - Gyms
    - Study areas (Libraries, The Ridge, JC, etc)
37
    """
David Haynes's avatar
David Haynes committed
38
    # The name of the category
39
40
41
42
43
    name = models.CharField(max_length=100)

    class Meta:
        verbose_name = "category"
        verbose_name_plural = "categories"
44
        # Sort by name in admin view.
45
46
        ordering = ['name']

47
    def __str__(self):
David Haynes's avatar
David Haynes committed
48
49
50
51
        """
        String representation of a Category object.
        """
        return self.name
52

David Haynes's avatar
David Haynes committed
53
54
class Location(TimeStampedModel):
    """
55
    Represents a specific location that a Facility can be found.
David Haynes's avatar
David Haynes committed
56
    """
57
58
59
60
61
62
63
    CAMPUS_LOCATIONS = (
        # (set in model, human readable version)
        ("prince william", "Prince William County Science and Technology"),
        ("korea", "Mason Korea"),
        ("fairfax", "Fairfax"),
        ("arlington", "Arlington")
    )
64
65
    # The building that the facility is located in (on campus).
    building = models.CharField(max_length=100)
66
67
68
69
    friendly_building = models.CharField('Building Abbreviation',
                                         help_text="Example: Exploratory Hall becomes EXPL",
                                         blank=True,
                                         max_length=10)
70
71
    # The physical address of the facility.
    address = models.CharField(max_length=100)
72
73
    campus_region = models.CharField(choices=CAMPUS_LOCATIONS,
                                     max_length=100, default="fairfax")
74
    # Boolean for whether or not the location is "on campus" or not.
David Haynes's avatar
David Haynes committed
75
    on_campus = models.BooleanField(default=True)
David Haynes's avatar
David Haynes committed
76
77
    # A GeoJson coordinate pair that represents the physical location
    coordinate_location = PointField()
David Haynes's avatar
David Haynes committed
78

79
80
81
82
83
84
85
86
87
88
89
90
    class Meta:
        verbose_name = "location"
        verbose_name_plural = "locations"

    def __str__(self):
        """
        String representation of a Location object.
        """
        return 'Found in %s at %s | On Campus: %s' % (self.building,
                                                      self.address,
                                                      self.on_campus)

Ben Waters's avatar
Ben Waters committed
91
class Facility(TimeStampedModel):
David Haynes's avatar
David Haynes committed
92
    """
David Haynes's avatar
David Haynes committed
93
94
95
    Represents a specific facility location. A Facility is some type of
    establishment that has a schedule of open hours and a location that serves
    a specific purpose that can be categorized.
David Haynes's avatar
David Haynes committed
96
97
    """
    # The name of the Facility
David Haynes's avatar
David Haynes committed
98
    facility_name = models.CharField(max_length=100)
David Haynes's avatar
David Haynes committed
99
    # Instead of id
100
    slug = AutoSlugField(populate_from='facility_name', unique=True)
101

David Haynes's avatar
David Haynes committed
102
    # The category that this facility can be grouped with
103
    facility_category = models.ForeignKey('Category',
David Haynes's avatar
David Haynes committed
104
                                          related_name="categories")
David Haynes's avatar
David Haynes committed
105
    # The location object that relates to this facility
106
107
    facility_location = models.ForeignKey('Location',
                                          related_name="facilities")
108

109
110
111
112
113
    # A note that can be left on a Facility to provide some additional
    # information.
    note = models.TextField('Facility Note', blank=True,
                            help_text="Additional information that is sent with this Facility.")

114
115
116
117
118
    # A link to the logo image for this Facility
    logo = models.URLField('Logo URL', blank=True,
                           default="https://imgur.com/q2Phkn9.png",
                           help_text="The absolute URL to the logo image for this Facility.")

David Haynes's avatar
David Haynes committed
119
    # The User(s) that claim ownership over this facility
120
    owners = models.ManyToManyField(User)
David Haynes's avatar
David Haynes committed
121
122

    # The schedule that is defaulted to if no special schedule is in effect
123
    main_schedule = models.ForeignKey('Schedule',
David Haynes's avatar
David Haynes committed
124
125
                                      related_name='facility_main')
    # A schedule that has a specific start and end date
126
    special_schedules = models.ManyToManyField('Schedule',
David Haynes's avatar
David Haynes committed
127
128
                                               related_name='facility_special',
                                               blank=True,
David Haynes's avatar
David Haynes committed
129
130
                                               help_text="This schedule will come into effect only for its specified duration.")

131
132
133
    # URL, if it exists, to the Tapingo page that is associated with this
    # facility
    tapingo_url = models.URLField(blank=True, validators=[RegexValidator(regex='^https:\/\/www.tapingo.com\/',
David Haynes's avatar
David Haynes committed
134
                                                                         message='The link is not a valid tapingo link. Example: https://www.tapingo.com/order/restaurant/starbucks-gmu-johnson/',
135
                                                                         code='invalid_tapingo_url')])
136
137
138
    # A comma seperate list of words that neatly an aptly describe the product
    # that this facility produces. (ex. for Taco Bell: mexican, taco, cheap)
    facility_product_tags = TaggableManager()
David Haynes's avatar
David Haynes committed
139

David Haynes's avatar
David Haynes committed
140
    def is_open(self):
141
        """
142
        Return true if this facility is currently open.
143

David Haynes's avatar
David Haynes committed
144
145
        First checks any valid special schedules and then checks the main,
        default, schedule.
146
        """
David Haynes's avatar
David Haynes committed
147
        # Get the current date
148
        today = datetime.datetime.today().date()
David Haynes's avatar
David Haynes committed
149
        # Check special schedules first, loop through all of them
150
151
152
        for schedule in self.special_schedules.all():
            # Special schedules must have valid_start and valid_end set
            if schedule.valid_start and schedule.valid_end:
David Haynes's avatar
David Haynes committed
153
                # If a special schedule in in effect
154
                if schedule.valid_start <= today <= schedule.valid_end:
David Haynes's avatar
David Haynes committed
155
156
157
158
                    # Check if the facility is open or not based on that 
                    # special schedule
                    if schedule.is_open_now():
                        # Open
159
                        return True
160
                    else:
David Haynes's avatar
David Haynes committed
161
                        # Closed
162
                        return False
David Haynes's avatar
David Haynes committed
163
164
165
166
        # If no special schedule is in effect then check if the facility is
        # open using the main_schedule
        if self.main_schedule.is_open_now():
            # Open
167
            return True
David Haynes's avatar
David Haynes committed
168
169
170
171
        else:
            # Closed
            return False

172
    def clean_schedules(self):
173
174
        """
        Loop through every special_schedule and remove entries that have
175
        expired as well as promote special schedules to main if necessary.
176
177
178
        """
        for special_schedule in self.special_schedules.all():
            # If it ends before today
179
            if special_schedule.valid_end < datetime.date.today() and special_schedule.schedule_for_removal:
180
                self.special_schedules.remove(special_schedule)
181
            elif special_schedule.promote_to_main:
182
183
                if special_schedule.valid_start < datetime.date.today() and special_schedule.valid_end >= datetime.date.today():
                    self.main_schedule = special_schedule
184

David Haynes's avatar
David Haynes committed
185
186
187
188
    class Meta:
        verbose_name = "facility"
        verbose_name_plural = "facilities"
        # Sort by name in admin view
David Haynes's avatar
David Haynes committed
189
        ordering = ['facility_name']
190

191
    def __str__(self):
David Haynes's avatar
David Haynes committed
192
193
194
        """
        String representation of a Facility object.
        """
David Haynes's avatar
David Haynes committed
195
        return self.facility_name
196

Ben Waters's avatar
Ben Waters committed
197
class Schedule(TimeStampedModel):
198
    """
David Haynes's avatar
David Haynes committed
199
200
    A period of time between two dates that represents the beginning and end of
    a "schedule" or rather, a collection of open times for a facility.
201
    """
David Haynes's avatar
David Haynes committed
202
    # The name of the schedule
Tyler Hallada's avatar
Tyler Hallada committed
203
    name = models.CharField(max_length=100)
David Haynes's avatar
David Haynes committed
204
205

    # The start date of the schedule
206
    # (inclusive)
207
208
    valid_start = models.DateTimeField('Start Date', null=True, blank=True,
                                       help_text="Date & time that this schedule goes into effect")
David Haynes's avatar
David Haynes committed
209
210
    # The end date of the schedule
    # (inclusive)
211
212
213
    valid_end = models.DateTimeField('End Date', null=True, blank=True,
                                     help_text="Last date & time that this schedule is in effect")

David Haynes's avatar
David Haynes committed
214
215
216
    # Boolean for if this schedule is 24 hours
    twenty_four_hours = models.BooleanField('24 hour schedule?', blank=True,
                                            default=False, help_text="Toggle to True if the Facility is open 24 hours. You do not need to specify any Open Times, it will always be displayed as open.")
217

218
    # Boolean for if this schedule should never be removed.
219
220
221
222
223
224
225
226
    schedule_for_removal = models.BooleanField('Schedule for removal?',
                                               blank=False, default=True,
                                               help_text="Toggle to False if the schedule should never be removed in the backend. By default, all schedules are automatically deleted after they have expired.")
    # Boolean for if this schedule should become the main schedule at the point
    # it goes live 
    promote_to_main = models.BooleanField('Schedule for promotion?',
                                          blank=False, default=False,
                                          help_text="Upon the start of the schedule, it will be promoted to become the main schedule of the Facility it is attached to rather than a special schedule.")
227

David Haynes's avatar
David Haynes committed
228
    def is_open_now(self):
229
230
231
        """
        Return true if this schedule is open right now.
        """
David Haynes's avatar
David Haynes committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
        # If the schedule is a 24 hour one, then it's open.
        if self.twenty_four_hours:
            return True
        # Otherwise let's check if it's open.
        else:
            # Loop through all the open times that correspond to this schedule
            for open_time in OpenTime.objects.filter(schedule=self):
                # If the current time we are looking at is open, then the schedule 
                # will say that the facility is open
                if open_time.is_open_now():
                    # Open
                    return True
            # Closed (all open times are not open)
            return False
246

David Haynes's avatar
David Haynes committed
247
248
249
250
    class Meta:
        # Sort by name in admin view
        ordering = ['name']

251
    def __str__(self):
David Haynes's avatar
David Haynes committed
252
253
254
        """
        String representation of a Schedule object.
        """
255
256
257
        return self.name


Ben Waters's avatar
Ben Waters committed
258
class OpenTime(TimeStampedModel):
259
    """
David Haynes's avatar
David Haynes committed
260
261
262
    Represents a time period when a Facility is open.

    Monday = 0, Sunday = 6.
263
    """
David Haynes's avatar
David Haynes committed
264
    # Define integer constants to represent days of the week
265
266
267
268
269
270
271
272
    MONDAY = 0
    TUESDAY = 1
    WEDNESDAY = 2
    THURSDAY = 3
    FRIDAY = 4
    SATURDAY = 5
    SUNDAY = 6

David Haynes's avatar
David Haynes committed
273
    # Tuple that ties a day of the week with an integer representation
274
275
276
277
278
279
280
281
282
283
    DAY_CHOICES = (
        (MONDAY, 'Monday'),
        (TUESDAY, 'Tuesday'),
        (WEDNESDAY, 'Wednesday'),
        (THURSDAY, 'Thursday'),
        (FRIDAY, 'Friday'),
        (SATURDAY, 'Saturday'),
        (SUNDAY, 'Sunday'),
    )

David Haynes's avatar
David Haynes committed
284
    # The schedule that this period of open time is a part of
285
    schedule = models.ForeignKey('Schedule', related_name='open_times')
David Haynes's avatar
David Haynes committed
286
287

    # The day that the open time begins on
288
    start_day = models.IntegerField(default=0, choices=DAY_CHOICES)
David Haynes's avatar
David Haynes committed
289
    # The day that the open time ends on
290
    end_day = models.IntegerField(default=0, choices=DAY_CHOICES)
David Haynes's avatar
David Haynes committed
291
292
293
294

    # The time of day that the open time begins at
    start_time = models.TimeField()
    # The time of day that the open time ends
295
296
    end_time = models.TimeField()

David Haynes's avatar
David Haynes committed
297
    def is_open_now(self):
298
        """
David Haynes's avatar
David Haynes committed
299
        Return true if the current time is this OpenTime's range.
300
        """
David Haynes's avatar
David Haynes committed
301
        # Get the current datetime
302
        today = datetime.datetime.today()
David Haynes's avatar
David Haynes committed
303
        # Check that the start occurs before the end
304
        if self.start_day <= self.end_day:
David Haynes's avatar
David Haynes committed
305
            # If today is the start_day
306
            if self.start_day == today.weekday():
David Haynes's avatar
David Haynes committed
307
                # If the start_time has not occurred
308
                if self.start_time > today.time():
David Haynes's avatar
David Haynes committed
309
                    # Closed
310
                    return False
David Haynes's avatar
David Haynes committed
311
            # If the start_day has not occurred
312
            elif self.start_day > today.weekday():
David Haynes's avatar
David Haynes committed
313
                # Closed
314
                return False
David Haynes's avatar
David Haynes committed
315
            # If the end_day is today
316
            if self.end_day == today.weekday():
David Haynes's avatar
David Haynes committed
317
                # If the end_time has already occurred
318
                if self.end_time < today.time():
David Haynes's avatar
David Haynes committed
319
                    # Closed
320
                    return False
David Haynes's avatar
David Haynes committed
321
            # If the end_day has already occurred
322
            elif self.end_day < today.weekday():
David Haynes's avatar
David Haynes committed
323
                # Closed
324
                return False
David Haynes's avatar
David Haynes committed
325
        # The end_day > start_day
326
        else:
David Haynes's avatar
David Haynes committed
327
            # If today is the start_day
328
            if self.start_day == today.weekday():
David Haynes's avatar
David Haynes committed
329
                # If the start_time has not occurred
330
                if self.start_time > today.time():
David Haynes's avatar
David Haynes committed
331
                    # Closed
332
                    return False
David Haynes's avatar
David Haynes committed
333
            # If the end_day is today
334
            if self.end_day == today.weekday():
David Haynes's avatar
David Haynes committed
335
                # If the end_time has already occurred
336
                if self.end_time < today.time():
David Haynes's avatar
David Haynes committed
337
                    # Closed
338
                    return False
David Haynes's avatar
David Haynes committed
339
340
            # If the current date takes place after the end_date but before
            # start_day
341
            if self.end_day < today.weekday() < self.start_day:
David Haynes's avatar
David Haynes committed
342
                # Closed
343
                return False
David Haynes's avatar
David Haynes committed
344
        # All checks passed, it's Open
345
        return True
346

347
    def __str__(self):
David Haynes's avatar
David Haynes committed
348
349
350
        """
        String representation of a OpenTime object.
        """
351
        weekdays = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday',
352
                    'Saturday', 'Sunday']
353
        return '%s %s to %s %s' % (weekdays[self.start_day],
354
355
356
357
                                   self.start_time.strftime("%H:%M:%S"),
                                   # to
                                   weekdays[self.end_day],
                                   self.end_time.strftime("%H:%M:%S"))
David Haynes's avatar
David Haynes committed
358
359
360
361
362
363
364
365
366
367

class Alert(TimeStampedModel):
    """
    Some type of notification that is displayed to clients that conveys a
    message. Past examples include: random closings, modified schedules being
    in effect, election reminder, advertising for other SRCT projects.

    Alerts last for a period of time until the information is no longer dank.
    """
    # Define string constants to represent urgency tag levels
368
369
370
371
    INFO = 'info'  # SRCT announcements
    MINOR = 'minor'  # Holiday hours are in effect
    MAJOR = 'major'  # The hungry patriot is closed today
    EMERGENCY = 'emergency'  # Extreme weather
David Haynes's avatar
David Haynes committed
372

David Haynes's avatar
David Haynes committed
373
    # Tuple that ties a urgency tag with a string representation
David Haynes's avatar
David Haynes committed
374
375
    URGENCY_CHOICES = (
        (INFO, 'Info'),
376
        (MINOR, 'Minor'),
David Haynes's avatar
David Haynes committed
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
        (MAJOR, 'Major'),
        (EMERGENCY, 'Emergency'),
    )

    # The urgency tag for this Alert
    urgency_tag = models.CharField(max_length=10, default='Info',
                                   choices=URGENCY_CHOICES)

    # The text that is displayed that describes the Alert
    message = models.CharField(max_length=140)

    # The date + time that the alert will be start being served
    start_datetime = models.DateTimeField()

    # The date + time that the alert will stop being served
    end_datetime = models.DateTimeField()

David Haynes's avatar
David Haynes committed
394
395
396
397
398
399
400
401
    def is_active(self):
        """
        Check if the current Alert object is active (Alert-able).
        """
        # Get the current datetime
        now = timezone.now()
        return self.start_datetime < now < self.end_datetime

David Haynes's avatar
David Haynes committed
402
403
404
405
    def __str__(self):
        """
        String representation of an Alert object.
        """
David Haynes's avatar
David Haynes committed
406
        return "%s" % (self.message)