models.py 42 KB
Newer Older
1
#
David Trattnig's avatar
David Trattnig committed
2
# Aura Engine (https://gitlab.servus.at/aura/engine)
3
#
David Trattnig's avatar
David Trattnig committed
4
# Copyright (C) 2017-2020 - The Aura Engine Team.
5
#
David Trattnig's avatar
David Trattnig committed
6
7
8
9
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
10
#
David Trattnig's avatar
David Trattnig committed
11
12
13
14
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
15
#
David Trattnig's avatar
David Trattnig committed
16
17
18
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

19

20
import sys
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
21
import time
22
23
import logging
import datetime
24

25
26
import sqlalchemy as sa

David Trattnig's avatar
David Trattnig committed
27
from sqlalchemy.ext.declarative         import declarative_base
David Trattnig's avatar
David Trattnig committed
28
29
from sqlalchemy                         import orm
from sqlalchemy                         import BigInteger, Boolean, Column, DateTime, Integer, String, ForeignKey
David Trattnig's avatar
David Trattnig committed
30
from sqlalchemy.orm                     import relationship
David Trattnig's avatar
David Trattnig committed
31
from sqlalchemy.ext.hybrid              import hybrid_property
32

33

David Trattnig's avatar
David Trattnig committed
34
from modules.scheduling.types           import PlaylistType
David Trattnig's avatar
David Trattnig committed
35
from modules.base.config                import AuraConfig
David Trattnig's avatar
David Trattnig committed
36
from modules.base.utils                 import SimpleUtil, EngineUtil
David Trattnig's avatar
David Trattnig committed
37

38

David Trattnig's avatar
David Trattnig committed
39

David Trattnig's avatar
David Trattnig committed
40
41
42
# Init Config
config = AuraConfig()

David Trattnig's avatar
David Trattnig committed
43
# Initialize DB Model and session
David Trattnig's avatar
David Trattnig committed
44
engine = sa.create_engine(config.get_database_uri())
45
46
47
48
49
50
51
52
Base = declarative_base()
Base.metadata.bind = engine

class DB():
    session = orm.scoped_session(orm.sessionmaker())(bind=engine)
    Model = Base


53
54

class AuraDatabaseModel():
55
56
57
58
59
    """
    AuraDataBaseModel.

    Holding all tables and relationships for the engine.
    """
60
61
    logger = None

62

63
    def __init__(self):
64
65
66
        """
        Constructor.
        """
67
68
        self.logger = logging.getLogger("AuraEngine")

69

70
    def store(self, add=False, commit=False):
71
72
73
        """
        Store to the database
        """
74
        if add:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
75
            DB.session.add(self)
76
        if commit:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
77
            DB.session.commit()
78

79

80
    def delete(self, commit=False):
81
82
83
        """
        Delete from the database
        """
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
84
        DB.session.delete(self)
85
        if commit:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
86
            DB.session.commit()
87

88

89
90
    def _asdict(self):
        return self.__dict__
91

92

93
94
    @staticmethod
    def recreate_db(systemexit = False):
95
96
97
        """
        Re-creates the database for developments purposes.
        """
98
99
        manualschedule = Schedule()
        manualschedule.schedule_id = 0
100
        manualschedule.show_name = "Manual Show"
101
102
103
104
        Base.metadata.drop_all()
        Base.metadata.create_all()

        
105
106
107
108
        # self.logger.debug("inserting manual scheduling possibility and fallback trackservice schedule")
        # DB.session.add(manualschedule)
        # db.session.add(fallback_trackservice_schedule)
        # self.logger.debug("all created. commiting...")
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
109
        DB.session.commit()
110

111
112
        if systemexit:
            sys.exit(0)
113

114

115
116

#
117
#   SCHEDULES & PLAYLISTS
118
119
#

120

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
121
class Schedule(DB.Model, AuraDatabaseModel):
122
    """
123
124
    One specific Schedule for a show on a timeslot.
    Holding references to playlists and fallback-playlists.
125
    """
126
    __tablename__ = 'schedule'
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
127

128
129
130
131
132
133
    # Primary keys
    id = Column(Integer, primary_key=True, autoincrement=True)

    schedule_start = Column(DateTime, unique=True, index=True)
    schedule_end = Column(DateTime, unique=True, index=True)
    schedule_id = Column(Integer, unique=True)
134

135
    show_id = Column(Integer)
136
137
    show_name = Column(String(256))
    show_hosts = Column(String(256))
138
    funding_category = Column(String(256))
139
140
141
142
143
144
    comment = Column(String(512))
    languages = Column(String(256))
    type = Column(String(256))
    category = Column(String(256))
    topic = Column(String(256))
    musicfocus = Column(String(256))
145
146
147

    is_repetition = Column(Boolean())

148
    playlist_id = Column(Integer) #, ForeignKey("playlist.playlist_id"))
David Trattnig's avatar
David Trattnig committed
149
    schedule_fallback_id = Column(Integer)
150
151
    show_fallback_id = Column(Integer)
    station_fallback_id = Column(Integer)
152
    fallback_state = PlaylistType.DEFAULT
David Trattnig's avatar
David Trattnig committed
153
154
    
    fadeouttimer = None # Used to fade-out the schedule, even when entries are longer
155

156
157
158
    playlist = relationship("Playlist",
                            primaryjoin="and_(Schedule.schedule_start==Playlist.schedule_start, Schedule.playlist_id==Playlist.playlist_id, Schedule.show_name==Playlist.show_name)",
                            back_populates="schedule")
David Trattnig's avatar
David Trattnig committed
159
160
    schedule_fallback = relationship("Playlist",
                            primaryjoin="and_(Schedule.schedule_start==Playlist.schedule_start, Schedule.schedule_fallback_id==Playlist.playlist_id, Schedule.show_name==Playlist.show_name)",
161
162
163
164
165
166
167
                            back_populates="schedule")
    show_fallback = relationship("Playlist",
                            primaryjoin="and_(Schedule.schedule_start==Playlist.schedule_start, Schedule.show_fallback_id==Playlist.playlist_id, Schedule.show_name==Playlist.show_name)",
                            back_populates="schedule")
    station_fallback = relationship("Playlist",
                            primaryjoin="and_(Schedule.schedule_start==Playlist.schedule_start, Schedule.station_fallback_id==Playlist.playlist_id, Schedule.show_name==Playlist.show_name)",
                            back_populates="schedule")
168

169

170
    @staticmethod
171
172
    def select_show_on_datetime(date_time):
        return DB.session.query(Schedule).filter(Schedule.schedule_start == date_time).first()
173

174

175
    @staticmethod
176
177
    def select_programme(date_from=datetime.date.today()):
        """
178
        Select all schedules starting from `date_from` or from today if no
179
180
181
182
183
184
185
186
187
188
189
        parameter is passed.

        Args:
            date_from (datetime):   Select schedules from this date and time on

        Returns:
            ([Schedule]):           List of schedules
        """
        schedules = DB.session.query(Schedule).\
            filter(Schedule.schedule_start >= date_from).\
            order_by(Schedule.schedule_start).all()
190

191
        return schedules
192

193

David Trattnig's avatar
David Trattnig committed
194
195
196
197
198
199
200
201
202
203
204
205
206
207
    @staticmethod
    def select_upcoming(n):
        """
        Selects the (`n`) upcoming schedules.
        """
        now = datetime.datetime.now()
        DB.session.commit() # Required since independend session is used.
        schedules = DB.session.query(Schedule).\
            filter(Schedule.schedule_start > str(now)).\
            order_by(Schedule.schedule_start.asc()).limit(n).all()
        
        return schedules


David Trattnig's avatar
David Trattnig committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
    @hybrid_property
    def start_unix(self):
        """
        Start time of the schedule in UNIX time.
        """
        return time.mktime(self.schedule_start.timetuple())


    @hybrid_property
    def end_unix(self):
        """
        End time of the schedule in UNIX time.
        """
        return time.mktime(self.schedule_end.timetuple())


David Trattnig's avatar
David Trattnig committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
    def as_dict(self):
        """
        Returns the schedule as a dictionary for serialization.
        """
        playlist = self.playlist

        return {
            "schedule_id": self.schedule_id,        
            "schedule_start": self.schedule_start.isoformat(),
            "schedule_end": self.schedule_end.isoformat(),

            "topic": self.topic,
            "musicfocus": self.musicfocus,
            "funding_category": self.funding_category,
            "is_repetition": self.is_repetition,
            "category": self.category,
            "languages": self.languages,
            "comment": self.comment,
            "playlist_id": self.playlist_id,
            "schedule_fallback_id": self.schedule_fallback_id,
            "show_fallback_id": self.show_fallback_id,
            "station_fallback_id": self.station_fallback_id,

            "show": {
                "name": self.show_name,
249
                "type": self.get_type(),
David Trattnig's avatar
David Trattnig committed
250
251
252
253
254
255
256
                "host": self.show_hosts
            },

            "playlist": playlist
        }


257
258
259
260
    def __str__(self):
        """
        String representation of the object.
        """
David Trattnig's avatar
David Trattnig committed
261
262
263
264
265
        time_start = SimpleUtil.fmt_time(self.start_unix)
        time_end = SimpleUtil.fmt_time(self.end_unix)
        return "ID#%s [Show: %s, ShowID: %s | %s - %s ]" % (str(self.schedule_id), self.show_name, str(self.show_id), time_start, time_end)


266

267
class Playlist(DB.Model, AuraDatabaseModel):
268
269
270
    """
    The playlist containing playlist entries.
    """
271
272
273
274
275
276
277
278
279
280
281
282
    __tablename__ = 'playlist'

    # pk,fk
    artificial_id = Column(Integer, primary_key=True)
    schedule_start = Column(DateTime, ForeignKey("schedule.schedule_start"))
    # relationships
    schedule = relationship("Schedule", uselist=False, back_populates="playlist")
    entries = relationship("PlaylistEntry", back_populates="playlist")
    # data
    playlist_id = Column(Integer, autoincrement=False)  # , ForeignKey("schedule.playlist_id"))
    show_name = Column(String(256))
    fallback_type = Column(Integer)
283
    entry_count = Column(Integer)
284

285

286
287
    @staticmethod
    def select_all():
288
289
290
        """
        Fetches all entries
        """
291
        all_entries = DB.session.query(Playlist).filter(Playlist.fallback_type == 0).all()
292
293
294
295
296
297
298
299

        cnt = 0
        for entry in all_entries:
            entry.programme_index = cnt
            cnt = cnt + 1

        return all_entries

300

301
    @staticmethod
302
    def select_playlist_for_schedule(datetime, playlist_id):
303
304
305
306
307
308
309
310
311
312
313
314
315
        """
        Retrieves the playlist for the given schedule identified by `start_date` and `playlist_id`

        Args:
            start_date (datetime):  Date and time when the playlist is scheduled
            playlist_id (Integer):  The ID of the playlist

        Returns:
            (Playlist):             The playlist, if existing for schedule

        Raises:
            Exception:              In case there a inconsistent database state, such es multiple playlists for given date/time.
        """
David Trattnig's avatar
David Trattnig committed
316
317
318
319
320
321
322
323
324
325
326
327
328
329
        playlist = None
        playlists = DB.session.query(Playlist).filter(Playlist.schedule_start == datetime).all()
        # FIXME There are unknown issues with the native SQL query by ID
        # playlists = DB.session.query(Playlist).filter(Playlist.schedule_start == datetime and Playlist.playlist_id == playlist_id).all()
        
        for p in playlists:
            if p.playlist_id == playlist_id:
                playlist = p
        # if playlists and len(playlists) > 1:
        #     raise Exception("Inconsistent Database State: Multiple playlists for given schedule '%s' and playlist id#%d available!" % (str(datetime), playlist_id))
        # if not playlists:
        #     return None
        # return playlists[0]
        return playlist
330

331

332
333
    @staticmethod
    def select_playlist(playlist_id):
334
335
336
337
338
339
340
341
342
        """
        Retrieves all paylists for that given playlist ID.

        Args:
            playlist_id (Integer):  The ID of the playlist
        
        Returns:
            (Array<Playlist>):      An array holding the playlists
        """
343
344
        return DB.session.query(Playlist).filter(Playlist.playlist_id == playlist_id).order_by(Playlist.schedule_start).all()
    
345

346
347
348
349
350
351
352
353
354
355
356
    @staticmethod
    def is_empty():
        """
        Checks if the given is empty
        """
        try:
            return not DB.session.query(Playlist).one_or_none()
        except sa.orm.exc.MultipleResultsFound:
            return False


357
358
    @hybrid_property
    def start_unix(self):
359
360
361
        """
        Start time of the playlist in UNIX time.
        """
362
363
        return time.mktime(self.schedule_start.timetuple())

364

365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
    @hybrid_property
    def end_unix(self):
        """
        End time of the playlist in UNIX time.
        """
        return time.mktime(self.schedule_start.timetuple()) + self.duration


    @hybrid_property
    def duration(self):
        """
        Returns the total length of the playlist in seconds.

        Returns:
            (Integer):  Length in seconds
        """
        total = 0

        for entry in self.entries:
            total += entry.duration
        return total


David Trattnig's avatar
David Trattnig committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
    def as_dict(self):
        """
        Returns the playlist as a dictionary for serialization.
        """
        entries = []
        for e in self.entries:
            entries.append(e.as_dict())

        playlist = {
            "playlist_id": self.playlist_id,
            "fallback_type": self.fallback_type,
            "entry_count": self.entry_count,
            "entries": entries
        }
        return playlist


405
406
407
408
    def __str__(self):
        """
        String representation of the object.
        """
David Trattnig's avatar
David Trattnig committed
409
410
411
412
        time_start = SimpleUtil.fmt_time(self.start_unix)
        time_end = SimpleUtil.fmt_time(self.end_unix)
        return "ID#%s [items: %s | %s - %s]" % (str(self.playlist_id), str(self.entry_count), str(time_start), str(time_end))

413
414


415
class PlaylistEntry(DB.Model, AuraDatabaseModel):
416
417
418
    """
    Playlist entries are the individual items of a playlist such as audio files.
    """
419
    __tablename__ = 'playlist_entry'
420

421
422
    # primary keys
    artificial_id = Column(Integer, primary_key=True)
423

424
425
426
    # foreign keys
    artificial_playlist_id = Column(Integer, ForeignKey("playlist.artificial_id"))
    entry_num = Column(Integer) # , primary_key=True)
427

428
429
    uri = Column(String(1024))
    duration = Column(BigInteger)
430
    source = Column(String(1024))
431
    entry_start = Column(DateTime)
432
    entry_start_actual = None # Assigned when the entry is actually played
433
    channel = None # Assigned when entry is actually played
434
    queue_state = None # Assigned when entry is about to be queued    
David Trattnig's avatar
David Trattnig committed
435
    status = None # Assigned when state changes
David Trattnig's avatar
David Trattnig committed
436
437
438
439
    
    switchtimer = None
    loadtimer = None
    fadeouttimer = None
440

441
442
    # relationships
    playlist = relationship("Playlist", uselist=False, back_populates="entries")
443
    meta_data = relationship("PlaylistEntryMetaData", uselist=False, back_populates="entry")
444

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
445
    @staticmethod
446
447
    def select_playlistentry_for_playlist(artificial_playlist_id, entry_num):
        return DB.session.query(PlaylistEntry).filter(PlaylistEntry.artificial_playlist_id == artificial_playlist_id, PlaylistEntry.entry_num == entry_num).first()
448

449
450
451
452
    @hybrid_property
    def entry_end(self):
        return self.entry_start + datetime.timedelta(seconds=self.duration)

453
454
455
456
457
458
    @hybrid_property
    def start_unix(self):
        return time.mktime(self.entry_start.timetuple())

    @hybrid_property
    def end_unix(self):
459
        return time.mktime(self.entry_end.timetuple())
460

461
    @hybrid_property
462
    def volume(self):
463
        return 100 # FIXME Make DB Column
464

465
    def get_type(self):
466
        return EngineUtil.get_channel_type(self.uri)
467

468

469
470
471
472
473
474
475
476
477
478
479
480
481
482
    def get_prev_entries(self):
        """
        Retrieves all previous entries as part of the current entry's playlist.

        Returns:
            (List):     List of PlaylistEntry
        """
        prev_entries = []
        for entry in self.playlist.entries:
            if entry.entry_start < self.entry_start:
                prev_entries.append(entry)
        return prev_entries


483
    def get_next_entries(self, schedule_sensitive=True):
David Trattnig's avatar
David Trattnig committed
484
        """
485
        Retrieves all following entries as part of the current entry's playlist.
David Trattnig's avatar
David Trattnig committed
486

487
488
489
490
        Args:
            schedule_sensitive (Boolean):   If `True` entries which start after \
                the end of the schedule are excluded

David Trattnig's avatar
David Trattnig committed
491
492
493
494
495
496
        Returns:
            (List):     List of PlaylistEntry
        """
        next_entries = []
        for entry in self.playlist.entries:
            if entry.entry_start > self.entry_start:
497
498
499
500
501
                if schedule_sensitive:
                    if entry.entry_start < self.playlist.schedule.schedule_end:
                        next_entries.append(entry)
                else:
                    next_entries.append(entry)
David Trattnig's avatar
David Trattnig committed
502
503
        return next_entries

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
504

505
506
507
508
509
510
    def as_dict(self):
        """
        Returns the entry as a dictionary for serialization.
        """
        if self.meta_data:
            return {
David Trattnig's avatar
David Trattnig committed
511
                "id": self.artificial_id,
512
513
514
515
516
517
518
                "duration": self.duration,
                "artist": self.meta_data.artist,
                "album": self.meta_data.album,
                "title": self.meta_data.title
            }
        return None

519
520
521
522
    def __str__(self):
        """
        String representation of the object.
        """
David Trattnig's avatar
David Trattnig committed
523
524
        time_start = SimpleUtil.fmt_time(self.start_unix)
        time_end = SimpleUtil.fmt_time(self.end_unix)
525
526
        track = self.source[-25:]
        return "PlaylistEntry #%s [%s - %s | %ssec | Source: ...%s]" % (str(self.artificial_id), time_start, time_end, self.duration, track)
527

David Trattnig's avatar
David Trattnig committed
528

529

530

531
class PlaylistEntryMetaData(DB.Model, AuraDatabaseModel):
532
533
534
    """
    Metadata for a playlist entry such as the artist and track name.
    """
535
    __tablename__ = "playlist_entry_metadata"
536

537
538
    artificial_id = Column(Integer, primary_key=True)
    artificial_entry_id = Column(Integer, ForeignKey("playlist_entry.artificial_id"))
539

540
541
542
    artist = Column(String(256))
    title = Column(String(256))
    album = Column(String(256))
543

544
    entry = relationship("PlaylistEntry", uselist=False, back_populates="meta_data")
545

546
547
548
    @staticmethod
    def select_metadata_for_entry(artificial_playlistentry_id):
        return DB.session.query(PlaylistEntry).filter(PlaylistEntryMetaData.artificial_entry_id == artificial_playlistentry_id).first()
549

550

551
552
553
554
555
556

#
#   TRACK SERVICE
#


557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
# class TrackService(DB.Model, AuraDatabaseModel):
#     """
#     TrackService holding track-service items consisting of
#     """
#     __tablename__ = 'trackservice'

#     # Primary keys
#     id = Column(Integer, primary_key=True, autoincrement=True)

#     # Foreign keys
#     track_start = Column(DateTime)
#     track_end = Column(DateTime) # Currently not used, maybe later for timing checks and multi-entry avoidance.
#     artificial_schedule_id = Column(Integer, ForeignKey("schedule.id"))
#     artificial_playlist_entry_id = Column(Integer, ForeignKey("playlist_entry.artificial_id"), nullable=True)
#     single_entry_id = Column(Integer, ForeignKey("single_entry.id"), nullable=True)

#     # Data
#     schedule = relationship("Schedule", foreign_keys=[artificial_schedule_id], lazy="joined")
#     playlist_entry = relationship("PlaylistEntry", primaryjoin="and_(TrackService.artificial_playlist_entry_id==PlaylistEntry.artificial_id)", lazy="joined")
#     single_entry = relationship("SingleEntry", foreign_keys=[single_entry_id], lazy="joined")

#     fallback_type = Column(Integer, default=0)


#     def __init__(self, entry, fallback_type=0):
#         """
#         Initializes a trackservice entry based on a playlist entry.
#         """
#         self.track_start = datetime.datetime.now()
#         # if entry.duration:
#         #     self.track_end = self.track_start + datetime.timedelta(seconds=entry.duration)
#         self.fallback_type = fallback_type

#         if fallback_type < 4:
#             self.schedule_start = entry.playlist.schedule_start
#             self.artificial_playlist_entry_id = entry.artificial_id
#             self.playlist_entry = entry
#             self.schedule = entry.playlist.schedule
#         else:
#             self.single_entry = entry


#     @hybrid_property
#     def track(self):
#         """
#         Retrieves the track information as a dictionary.
603
        
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
#         Depending on possible fallback scenarios either `playlist_entry` or `single_entry` is used as a basis:

#             - Scenario 1: No fallback, all info is gathered via the playlist entry
#             - Scenario 2: Fallback-type > 0, info is also gathered via the defined playlist entry
#             - Scenario 3: This type of fallback didn't get scheduled; a single entry is played
#         """
#         if self.playlist_entry:
#             return self.playlist_entry.as_dict()
#         elif self.single_entry:
#             return self.single_entry.as_dict()
#         else:
#             return None


#     @hybrid_property
#     def show(self):
#         """
#         Retrieves show information based on the related schedule. If no schedule
#         is available (e.g. when the engine is in a fallback state), then the default
#         show properties from `AuraConfig` are returned.
#         """
#         show_info = {}

#         if self.schedule:
#             show_info["name"] = self.schedule.show_name
#             show_info["type"] = self.schedule.type
#             show_info["host"] = self.schedule.show_hosts
#         elif self.fallback_type == 4:
#             show_info["name"] = config.get("fallback_show_name")
#             show_info["type"] = config.get("fallback_show_type")
#             show_info["host"] = config.get("fallback_show_host")
David Trattnig's avatar
David Trattnig committed
635
        
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
#         return show_info


#     @staticmethod
#     def select_one(id):
#         """
#         Select one specific track-service item by ID. 
#         """
#         DB.session.commit() # Required since independend session is used.
#         track = DB.session.query(TrackService).filter(TrackService.id == id).first()
#         return track


#     @staticmethod
#     def select_current():
#         """
#         Selects the currently playing track.
#         """
#         now = datetime.datetime.now()
#         DB.session.commit() # Required since independend session is used.
#         track = DB.session.query(TrackService).\
#             filter(TrackService.track_start <= str(now)).\
#             order_by(TrackService.track_start.desc()).first()
#         return track


#     @staticmethod
#     def select_last_hours(n):
#         """
#         Selects the tracks playing in the past (`n`) hours.
#         """
#         last_hours = datetime.datetime.today() - datetime.timedelta(hours=n)
#         DB.session.commit() # Required since independend session is used.
#         tracks = DB.session.query(TrackService).filter(TrackService.track_start >= str(last_hours)).all()
#         for track in tracks:
#             track = TrackService.select_one(track.id)
#         return tracks


#     @staticmethod
#     def select_by_day(day):
#         """
#         Select the track-service items for a day.
#         """
#         day_plus_one = day + datetime.timedelta(days=1)
#         DB.session.commit() # Required since independend session is used.
#         tracks = DB.session.query(TrackService).\
#             filter(TrackService.track_start >= str(day), TrackService.track_start < str(day_plus_one)).\
#             order_by(TrackService.track_start.desc()).all()
685
        
686
687
688
689
#         res = []
#         for item in tracks:
#             if item.track: res.append(item)
#         return res
690
691
    

692
693
694
695
696
697
698
699
700
#     @staticmethod
#     def select_by_range(from_day, to_day):
#         """
#         Selects the track-service items for a day range.
#         """
#         DB.session.commit()
#         tracks = DB.session.query(TrackService).filter(TrackService.track_start >= str(from_day),
#                                                        TrackService.track_start < str(to_day)).all()
#         return tracks
701
702
    

703
704
705
706
707
#     def __str__(self):
#         """
#         Convert to String.
#         """
#         return "TrackID: #%s [track_start: %s, artificial_playlist_entry_id: %s]" % (str(self.id), str(self.track_start), str(self.artificial_playlist_entry_id))
708
709
710



711
712
713
714
715
# class SingleEntry(DB.Model, AuraDatabaseModel):
#     """
#     An entry played in case of e.g. a local fallback or custom programming without a playlist nor schedule.
#     """
#     __tablename__ = 'single_entry'
716

717
718
#     # Primary keys
#     id = Column(Integer, primary_key=True)
719
    
720
721
722
#     # Relationships
#     trackservice_id = Column(Integer) #, ForeignKey("trackservice.id"))
#     meta_data_id = Column(Integer) #, ForeignKey("trackservice.id"))
723

724
725
#     trackservice = relationship("TrackService", uselist=False, back_populates="single_entry")
#     meta_data = relationship("SingleEntryMetaData", uselist=False, back_populates="entry")
726

727
728
729
730
731
#     # Data
#     uri = Column(String(1024))
#     duration = Column(BigInteger)
#     source = Column(String(1024))
#     entry_start = Column(DateTime)
732

733
734
735
#     queue_state = None # Assigned when entry is about to be queued
#     channel = None # Assigned when entry is actually played
#     status = None # Assigned when state changes
David Trattnig's avatar
David Trattnig committed
736

737

738
739
740
#     @hybrid_property
#     def entry_end(self):
#         return self.entry_start + datetime.timedelta(seconds=self.duration)
741

742
743
744
#     @hybrid_property
#     def start_unix(self):
#         return time.mktime(self.entry_start.timetuple())
745

746
747
748
#     @hybrid_property
#     def end_unix(self):
#         return time.mktime(self.entry_start.timetuple()) + self.duration
749

750
751
752
#     @hybrid_property
#     def volume(self):
#         return 100
753

754
755
756
#     @hybrid_property
#     def type(self):
#         return EngineUtil.get_channel_type(self.uri)
757

758

759
760
761
762
763
764
765
766
767
768
769
770
#     def as_dict(self):
#         """
#         Returns the entry as a dictionary for serialization.
#         """
#         if self.meta_data:
#             return {
#                 "duration": self.duration,
#                 "artist": self.meta_data.artist,
#                 "album": self.meta_data.album,
#                 "title": self.meta_data.title
#             }
#         return None
771
772


773
774
775
776
777
778
779
780
#     def __str__(self):
#         """
#         String representation of the object.
#         """
#         time_start = SimpleUtil.fmt_time(self.start_unix)
#         time_end = SimpleUtil.fmt_time(self.end_unix)
#         track = self.source[-25:]
#         return "SingleEntry #%s [%s - %s | %ssec | Source: ...%s]" % (str(self.id), time_start, time_end, self.duration, track)
781
782
783



784
785
786
787
788
# class SingleEntryMetaData(DB.Model, AuraDatabaseModel):
#     """
#     Metadata for a autonomous entry such as the artist and track name.
#     """
#     __tablename__ = "single_entry_metadata"
789

790
791
#     id = Column(Integer, primary_key=True)
#     single_entry_id = Column(Integer, ForeignKey("single_entry.id"))
792

793
794
795
#     artist = Column(String(256))
#     title = Column(String(256))
#     album = Column(String(256))
796

797
#     entry = relationship("SingleEntry", uselist=False, back_populates="meta_data")
798

799
800
801
#     @staticmethod
#     def select_metadata_for_entry(single_entry_id):
#         return DB.session.query(SingleEntry).filter(SingleEntryMetaData.id == single_entry_id).first()
802
803
804



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892


#
#   LEGACY CLASSES
#



# ------------------------------------------------------------------------------------------ #
# class Schedule(DB.Model, AuraDatabaseModel):
#     """
#     One specific Schedule for a show on a timeslot
#     """
#     __tablename__ = 'schedule'
#
#     # primary and foreign keys
#     schedule_start = Column(DateTime, primary_key=True)
#
#     schedule_end = Column(DateTime)
#     schedule_id = Column(Integer) #, primary_key=True, autoincrement=False)
#     show_id = Column(Integer)  # well, in fact not needed..
#     show_name = Column(String(256))
#     show_hosts = Column(String(256))
#     funding_category = Column(String(256))
#     comment = Column(String(512))
#     languages = Column(String(256))
#     type = Column(String(256))
#     category = Column(String(256))
#     topic = Column(String(256))
#     musicfocus = Column(String(256))
#
#     is_repetition = Column(Boolean())
#
#     playlist_id = Column(Integer, ForeignKey("playlist.playlist_id"))
#     timeslot_fallback_id = Column(Integer)
#     show_fallback_id = Column(Integer)
#     station_fallback_id = Column(Integer)
#
#     playlist = relationship("Playlist", foreign_keys=[playlist_id], lazy="joined")
#  #    timeslot_fallback = relationship("Playlist", foreign_keys=[timeslot_fallback_id], lazy="joined")
#  #    show_fallback = relationship("Playlist", foreign_keys=[show_fallback_id], lazy="joined")
#  #    station_fallback = relationship("Playlist", foreign_keys=[station_fallback_id], lazy="joined")
#
#     @staticmethod
#     def select_all():
#          # fetching all entries
#         all_entries = DB.session.query(Schedule).filter().order_by(Schedule.schedule_start).all()
#         return all_entries
#
#     @staticmethod
#     def select_by_id(id):
#         entry = DB.session.query(Schedule).filter(Schedule.schedule_id == id).first()
#         return entry
#     @staticmethod
#     def select_act_programme():
#          #DB.session.query(Schedule).filter
#          # fetching all from today to ..
#         today = datetime.date.today()
#         all_entries = DB.session.query(Schedule).filter(Schedule.schedule_start >= today).order_by(Schedule.schedule_start).all()
#
#         return all_entries
#

#
#     @staticmethod
#     def drop_the_future(timedelta):
#         then = datetime.datetime.now() + timedelta
#
#         # is this really necessary?
#         future_entries = DB.session.query(Schedule).filter(Schedule.schedule_start > then)
#         for e in future_entries:
#             e.delete()
#         DB.session.commit()
#
#     def get_length(self):
#         sec1 = int(datetime.datetime.strptime(self.start[0:16].replace(" ", "T"), "%Y-%m-%dT%H:%M").strftime("%s"))
#         sec2 = int(datetime.datetime.strptime(self.end[0:16].replace(" ", "T"), "%Y-%m-%dT%H:%M").strftime("%s"))
#         len = sec2 - sec1
#         return len
#
#     # ------------------------------------------------------------------------------------------ #
#     def __str__(self):
#         return "ScheduleID: #" + str(self.schedule_id) + " Showname: " + self.show_name + " starts @ " + str(self.schedule_start)

# ------------------------------------------------------------------------------------------ #



893
# ------------------------------------------------------------------------------------------ #
894
895
896
897
898
899
900
901
902
#class PlaylistEntry(DB.Model, AuraDatabaseModel):
    # __tablename__ = 'playlist_entry'
    #
    # # primary and foreign keys
    # playlist_id = Column(Integer, ForeignKey("playlist.playlist_id"), primary_key=True, nullable=False, autoincrement=True)
    # entry_num = Column(Integer, primary_key=True, nullable=False, autoincrement=False)
    #
    # uri = Column(String(1024))
    #
903
    # source = ""
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
    # cleansource = ""
    # cleanprotocol = ""
    # type = None
    # fadeintimer = None
    # fadeouttimer = None
    # switchtimer = None
    #
    # meta_data = relationship("PlaylistEntryMetaData", primaryjoin="and_(PlaylistEntry.playlist_id==PlaylistEntryMetaData.playlist_id, PlaylistEntry.entry_num==PlaylistEntryMetaData.entry_num)", lazy="joined")
    #
    # # normal constructor
    # def __init__(self, **kwargs):
    #     super(PlaylistEntry, self).__init__(**kwargs)
    #     self.calc_unix_times()
    #     self.define_clean_source()
    #
    # # constructor like - called from sqlalchemy
    # @orm.reconstructor
    # def reconstructor(self):
    #     self.calc_unix_times()
    #     self.define_clean_source()
    #     self.set_entry_type()
    #
    # def define_clean_source(self):
    #     if self.uri is None:
    #         return None
    #
    #     if self.uri.startswith("http"):
    #         self.cleanprotocol = self.uri[:7]
    #         self.cleansource = self.uri
    #
    #     elif self.uri.startswith("linein"):
    #         self.cleanprotocol = self.uri[:9]
    #         self.cleansource = self.uri[9:]
    #
    #     elif self.uri.startswith("pool") or self.uri.startswith("file") or self.uri.startswith("live"):
    #         self.cleanprotocol = self.uri[:7]
    #         self.cleansource = self.uri[7:]
    #
    #     elif self.uri.startswith("playlist"):
    #         self.cleanprotocol = self.uri[:11]
    #         self.cleansource = self.uri[11:]
    #
    #     else:
    #         self.logger.error("Unknown source protocol")
    #
    # def set_entry_type(self):
    #     if self.uri.startswith("http"):
David Trattnig's avatar
David Trattnig committed
951
    #         self.type = ScheduleEntryType.HTTP
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
    #     if self.uri.startswith("pool") or self.uri.startswith("playlist") or self.uri.startswith("file"):
    #         self.type = ScheduleEntryType.FILESYSTEM
    #     if self.uri.startswith("live") or self.uri.startswith("linein"):
    #         if self.cleansource == "0":
    #             self.type = ScheduleEntryType.LIVE_0
    #         elif self.cleansource == "1":
    #             self.type = ScheduleEntryType.LIVE_1
    #         elif self.cleansource == "2":
    #             self.type = ScheduleEntryType.LIVE_2
    #         elif self.cleansource == "3":
    #             self.type = ScheduleEntryType.LIVE_3
    #         elif self.cleansource == "4":
    #             self.type = ScheduleEntryType.LIVE_4




    # def calc_unix_times(self):
    #     if self.entry_start is not None:
    #         self.entry_start_unix = time.mktime(self.entry_start.timetuple())
    #
    #
    #
    # # ------------------------------------------------------------------------------------------ #
    # @staticmethod
    # def select_all():
    #     # fetching all entries
    #     all_entries = DB.session.query(Playlist).filter(Playlist.fallback_type == 0).order_by(Playlist.entry_start).all()
    #
    #     cnt = 0
    #     for entry in all_entries:
    #         entry.programme_index = cnt
    #         cnt = cnt + 1
    #
    #     return all_entries
    #
    # @staticmethod
    # def select_act_programme(include_act_playing = True):
    #     # fetching all from today to ..
    #     today = datetime.date.today()
    #     all_entries = DB.session.query(Playlist).filter(Playlist.entry_start >= today, Playlist.fallback_type == 0).order_by(Playlist.entry_start).all()
    #
    #     cnt = 0
    #     for entry in all_entries:
    #         entry.programme_index = cnt
    #         cnt = cnt + 1
    #
    #     return all_entries
    #