models.py 14.9 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
173
174
175
176
177
178
    def clean_special_schedules(self):
        """
        Loop through every special_schedule and remove entries that have
        expired.
        """
        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
181
                self.special_schedules.remove(special_schedule)

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

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

Ben Waters's avatar
Ben Waters committed
194
class Schedule(TimeStampedModel):
195
    """
David Haynes's avatar
David Haynes committed
196
197
    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.
198
    """
David Haynes's avatar
David Haynes committed
199
    # The name of the schedule
Tyler Hallada's avatar
Tyler Hallada committed
200
    name = models.CharField(max_length=100)
David Haynes's avatar
David Haynes committed
201
202

    # The start date of the schedule
203
    # (inclusive)
204
205
    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
206
207
    # The end date of the schedule
    # (inclusive)
208
209
210
    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
211
212
213
    # 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.")
214

215
216
217
218
    # Boolean for if this schedule should never be removed.
    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.")

David Haynes's avatar
David Haynes committed
219
    def is_open_now(self):
220
221
222
        """
        Return true if this schedule is open right now.
        """
David Haynes's avatar
David Haynes committed
223
224
225
226
227
228
229
230
231
232
233
234
235
236
        # 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
237

David Haynes's avatar
David Haynes committed
238
239
240
241
    class Meta:
        # Sort by name in admin view
        ordering = ['name']

242
    def __str__(self):
David Haynes's avatar
David Haynes committed
243
244
245
        """
        String representation of a Schedule object.
        """
246
247
248
        return self.name


Ben Waters's avatar
Ben Waters committed
249
class OpenTime(TimeStampedModel):
250
    """
David Haynes's avatar
David Haynes committed
251
252
253
    Represents a time period when a Facility is open.

    Monday = 0, Sunday = 6.
254
    """
David Haynes's avatar
David Haynes committed
255
    # Define integer constants to represent days of the week
256
257
258
259
260
261
262
263
    MONDAY = 0
    TUESDAY = 1
    WEDNESDAY = 2
    THURSDAY = 3
    FRIDAY = 4
    SATURDAY = 5
    SUNDAY = 6

David Haynes's avatar
David Haynes committed
264
    # Tuple that ties a day of the week with an integer representation
265
266
267
268
269
270
271
272
273
274
    DAY_CHOICES = (
        (MONDAY, 'Monday'),
        (TUESDAY, 'Tuesday'),
        (WEDNESDAY, 'Wednesday'),
        (THURSDAY, 'Thursday'),
        (FRIDAY, 'Friday'),
        (SATURDAY, 'Saturday'),
        (SUNDAY, 'Sunday'),
    )

David Haynes's avatar
David Haynes committed
275
    # The schedule that this period of open time is a part of
276
    schedule = models.ForeignKey('Schedule', related_name='open_times')
David Haynes's avatar
David Haynes committed
277
278

    # The day that the open time begins on
279
    start_day = models.IntegerField(default=0, choices=DAY_CHOICES)
David Haynes's avatar
David Haynes committed
280
    # The day that the open time ends on
281
    end_day = models.IntegerField(default=0, choices=DAY_CHOICES)
David Haynes's avatar
David Haynes committed
282
283
284
285

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

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

338
    def __str__(self):
David Haynes's avatar
David Haynes committed
339
340
341
        """
        String representation of a OpenTime object.
        """
342
        weekdays = ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday',
343
                    'Saturday', 'Sunday']
344
        return '%s %s to %s %s' % (weekdays[self.start_day],
345
346
347
348
                                   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
349
350
351
352
353
354
355
356
357
358

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
359
360
361
362
    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
363

David Haynes's avatar
David Haynes committed
364
    # Tuple that ties a urgency tag with a string representation
David Haynes's avatar
David Haynes committed
365
366
    URGENCY_CHOICES = (
        (INFO, 'Info'),
367
        (MINOR, 'Minor'),
David Haynes's avatar
David Haynes committed
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
        (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
385
386
387
388
389
390
391
392
    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
393
394
395
396
    def __str__(self):
        """
        String representation of an Alert object.
        """
David Haynes's avatar
David Haynes committed
397
        return "%s" % (self.message)