broadcasts.py 41.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#
#  engine
#
#  Playout Daemon for autoradio project
#
#
#  Copyright (C) 2017-2018 Gottfried Gaisbauer <gottfried.gaisbauer@servus.at>
#
#  This file is part of engine.
#
#  engine is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  any later version.
#
#  engine 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 General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with engine. If not, see <http://www.gnu.org/licenses/>.
#
24

25
import sys
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
26
import time
27
28
import logging
import datetime
29

30
31
import sqlalchemy as sa

David Trattnig's avatar
David Trattnig committed
32
33
34
35
36
37
from sqlalchemy.ext.declarative         import declarative_base
from sqlalchemy                         import orm, func, BigInteger, Boolean, Column, DateTime, Integer, String, ForeignKey, ForeignKeyConstraint
from sqlalchemy.orm                     import relationship
from sqlalchemy.sql.expression          import false, true
from sqlalchemy.ext.hybrid              import hybrid_property, hybrid_method
from sqlalchemy.orm                     import relationship
38

David Trattnig's avatar
David Trattnig committed
39
from sqlalchemy                         import create_engine
40

David Trattnig's avatar
David Trattnig committed
41
from modules.base.enum                  import Channel, ChannelType
David Trattnig's avatar
David Trattnig committed
42
from modules.base.config                import AuraConfig
David Trattnig's avatar
David Trattnig committed
43
from modules.base.utils                 import SimpleUtil, EngineUtil
David Trattnig's avatar
David Trattnig committed
44

45

David Trattnig's avatar
David Trattnig committed
46
47
48
# Init Config
config = AuraConfig()

David Trattnig's avatar
David Trattnig committed
49
# Initialize DB Model and session
David Trattnig's avatar
David Trattnig committed
50
engine = sa.create_engine(config.get_database_uri())
51
52
53
54
55
56
57
58
Base = declarative_base()
Base.metadata.bind = engine

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


59
60

class AuraDatabaseModel():
61
62
63
64
65
    """
    AuraDataBaseModel.

    Holding all tables and relationships for the engine.
    """
66
67
    logger = None

68

69
    def __init__(self):
70
71
72
        """
        Constructor.
        """
73
74
        self.logger = logging.getLogger("AuraEngine")

75

76
    def store(self, add=False, commit=False):
77
78
79
        """
        Store to the database
        """
80
        if add:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
81
            DB.session.add(self)
82
        if commit:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
83
            DB.session.commit()
84

85

86
    def delete(self, commit=False):
87
88
89
        """
        Delete from the database
        """
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
90
        DB.session.delete(self)
91
        if commit:
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
92
            DB.session.commit()
93

94

95
96
    def _asdict(self):
        return self.__dict__
97

98

99
100
    @staticmethod
    def recreate_db(systemexit = False):
101
102
103
        """
        Re-creates the database for developments purposes.
        """
104
105
        manualschedule = Schedule()
        manualschedule.schedule_id = 0
106
        manualschedule.show_name = "Manual Show"
107
108
109
110
        Base.metadata.drop_all()
        Base.metadata.create_all()

        
111
112
113
114
        # 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
115
        DB.session.commit()
116

117
118
        if systemexit:
            sys.exit(0)
119

120

121
122

#
123
#   SCHEDULES & PLAYLISTS
124
125
#

126

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
127
class Schedule(DB.Model, AuraDatabaseModel):
128
    """
129
130
    One specific Schedule for a show on a timeslot.
    Holding references to playlists and fallback-playlists.
131
    """
132
    __tablename__ = 'schedule'
Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
133

134
135
136
137
138
139
    # 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)
140

141
    show_id = Column(Integer)
142
143
    show_name = Column(String(256))
    show_hosts = Column(String(256))
144
    funding_category = Column(String(256))
145
146
147
148
149
150
    comment = Column(String(512))
    languages = Column(String(256))
    type = Column(String(256))
    category = Column(String(256))
    topic = Column(String(256))
    musicfocus = Column(String(256))
151
152
153

    is_repetition = Column(Boolean())

154
    playlist_id = Column(Integer) #, ForeignKey("playlist.playlist_id"))
David Trattnig's avatar
David Trattnig committed
155
    schedule_fallback_id = Column(Integer)
156
157
158
    show_fallback_id = Column(Integer)
    station_fallback_id = Column(Integer)

159
160
161
    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
162
163
    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)",
164
165
166
167
168
169
170
                            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")
171

172

173
174
175
176
    @staticmethod
    def select_show_on_datetime(datetime):
        return DB.session.query(Schedule).filter(Schedule.schedule_start == datetime).first()

177

178
    @staticmethod
179
180
181
182
183
184
185
186
187
188
189
190
191
192
    def select_programme(date_from=datetime.date.today()):
        """
        Select all schedules starting from `date_from` or from today if no 
        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()
193

194
        return schedules
195

196

David Trattnig's avatar
David Trattnig committed
197
198
199
200
201
202
203
204
205
206
207
208
209
210
    @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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    @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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
    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,
                "type": self.type,
                "host": self.show_hosts
            },

            "playlist": playlist
        }


260
261
262
263
    def __str__(self):
        """
        String representation of the object.
        """
David Trattnig's avatar
David Trattnig committed
264
265
266
267
268
        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)


269

270
class Playlist(DB.Model, AuraDatabaseModel):
271
272
273
    """
    The playlist containing playlist entries.
    """
274
275
276
277
278
279
280
281
282
283
284
285
    __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)
286
    entry_count = Column(Integer)    
287

288

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

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

        return all_entries

303

304
    @staticmethod
305
    def select_playlist_for_schedule(datetime, playlist_id):
306
307
308
309
310
311
312
313
314
315
316
317
318
        """
        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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
        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
333

334

335
336
    @staticmethod
    def select_playlist(playlist_id):
337
338
339
340
341
342
343
344
345
        """
        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
        """
346
347
        return DB.session.query(Playlist).filter(Playlist.playlist_id == playlist_id).order_by(Playlist.schedule_start).all()
    
348

349
350
    @hybrid_property
    def start_unix(self):
351
352
353
        """
        Start time of the playlist in UNIX time.
        """
354
355
        return time.mktime(self.schedule_start.timetuple())

356

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
    @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


380
381
382
383
384
385
386
387
388
389
390
391
392
393
    @hybrid_property
    def current_entry(self):
        """
        Retrieves the entry to be played at the very, current point in time.
        """
        now_unix = SimpleUtil.timestamp()

        for entry in self.entries:
            if entry.start_unix < now_unix < entry.end_unix:
                return entry
        
        return None


David Trattnig's avatar
David Trattnig committed
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
    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


411
412
413
414
    def __str__(self):
        """
        String representation of the object.
        """
David Trattnig's avatar
David Trattnig committed
415
416
417
418
        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))

419
420


421
class PlaylistEntry(DB.Model, AuraDatabaseModel):
422
423
424
    """
    Playlist entries are the individual items of a playlist such as audio files.
    """
425
    __tablename__ = 'playlist_entry'
426

427
428
    # primary keys
    artificial_id = Column(Integer, primary_key=True)
429

430
431
432
    # foreign keys
    artificial_playlist_id = Column(Integer, ForeignKey("playlist.artificial_id"))
    entry_num = Column(Integer) # , primary_key=True)
433

434
435
436
    uri = Column(String(1024))
    duration = Column(BigInteger)
    filename = Column(String(1024))
437
    entry_start = Column(DateTime)
438

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

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
443
    @staticmethod
444
445
    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()
446

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

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

    @hybrid_property
    def end_unix(self):
        return time.mktime(self.entry_start.timetuple()) + self.duration
458

459
    @hybrid_property
460
461
    def volume(self):
        return 100
462

463
464
    @hybrid_property
    def type(self):
465
        return EngineUtil.get_channel_type(self.uri)
466

467
468
469
    @hybrid_property
    def channel(self):
        type = EngineUtil.get_channel_type(self.uri)
David Trattnig's avatar
David Trattnig committed
470
        if type == ChannelType.FILESYSTEM:
471
            return Channel.FILESYSTEM_A
David Trattnig's avatar
David Trattnig committed
472
        elif type == ChannelType.STREAM:
473
474
475
476
            return Channel.STREAM_A
        else:
            return "foo:bar"
        #FIXME Extend & finalize!!
477

478
479
480
481
482
483
484
485
486
487
488
489
490
491
    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


David Trattnig's avatar
David Trattnig committed
492
493
    def get_next_entries(self):
        """
494
        Retrieves all following entries as part of the current entry's playlist.
David Trattnig's avatar
David Trattnig committed
495
496
497
498
499
500
501
502
503
504

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

Gottfried Gaisbauer's avatar
Gottfried Gaisbauer committed
505

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

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

David Trattnig's avatar
David Trattnig committed
529

530

531

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

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

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

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

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

551

552
553
554
555
556
557
558
559
560
561
562
563

#
#   TRACK SERVICE
#


class TrackService(DB.Model, AuraDatabaseModel):
    """
    TrackService holding track-service items consisting of
    """
    __tablename__ = 'trackservice'

564
    # Primary keys
565
    id = Column(Integer, primary_key=True, autoincrement=True)
566
567

    # Foreign keys
568
    track_start = Column(DateTime)
David Trattnig's avatar
David Trattnig committed
569
    track_end = Column(DateTime) # Currently not used, maybe later for timing checks and multi-entry avoidance.
570
571
572
    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)
573
574

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

    fallback_type = Column(Integer, default=0)
580
581


582
    def __init__(self, entry, fallback_type=0):
583
584
585
        """
        Initializes a trackservice entry based on a playlist entry.
        """
586
        self.track_start = datetime.datetime.now()
David Trattnig's avatar
David Trattnig committed
587
588
        # if entry.duration:
        #     self.track_end = self.track_start + datetime.timedelta(seconds=entry.duration)
589
590
591
592
593
594
        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
David Trattnig's avatar
David Trattnig committed
595
            self.schedule = entry.playlist.schedule
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
        else:
            self.single_entry = entry


    @hybrid_property
    def track(self):
        """
        Retrieves the track information as a dictionary.
        
        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 local audio-file 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
617

618

David Trattnig's avatar
David Trattnig committed
619
620
621
622
623
624
625
626
627
628
629
630
    @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
David Trattnig's avatar
David Trattnig committed
631
            show_info["host"] = self.schedule.show_hosts
David Trattnig's avatar
David Trattnig committed
632
633
634
635
636
637
638
639
        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")
        
        return show_info


640
    @staticmethod
641
    def select_one(id):
642
643
644
        """
        Select one specific track-service item by ID. 
        """
David Trattnig's avatar
David Trattnig committed
645
        DB.session.commit() # Required since independend session is used.
646
647
648
649
650
651
652
653
654
        track = DB.session.query(TrackService).filter(TrackService.id == id).first()
        return track


    @staticmethod
    def select_current():
        """
        Selects the currently playing track.
        """
655
        now = datetime.datetime.now()
David Trattnig's avatar
David Trattnig committed
656
        DB.session.commit() # Required since independend session is used.
657
        track = DB.session.query(TrackService).\
David Trattnig's avatar
David Trattnig committed
658
            filter(TrackService.track_start <= str(now)).\
659
            order_by(TrackService.track_start.desc()).first()
660
661
662
663
664
665
        return track


    @staticmethod
    def select_last_hours(n):
        """
666
        Selects the tracks playing in the past (`n`) hours.
667
668
        """
        last_hours = datetime.datetime.today() - datetime.timedelta(hours=n)
David Trattnig's avatar
David Trattnig committed
669
        DB.session.commit() # Required since independend session is used.
670
671
672
673
674
        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

675
676
677
678
679
680
681

    @staticmethod
    def select_by_day(day):
        """
        Select the track-service items for a day.
        """
        day_plus_one = day + datetime.timedelta(days=1)
David Trattnig's avatar
David Trattnig committed
682
        DB.session.commit() # Required since independend session is used.
683
684
685
686
687
688
689
690
        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()
        
        res = []
        for item in tracks:
            if item.track: res.append(item)
        return res
691
692
    

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

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



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
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'

    # Primary keys
    id = Column(Integer, primary_key=True)
    
    # Relationships
    trackservice_id = Column(Integer) #, ForeignKey("trackservice.id"))
    meta_data_id = Column(Integer) #, ForeignKey("trackservice.id"))

    trackservice = relationship("TrackService", uselist=False, back_populates="single_entry")
    meta_data = relationship("SingleEntryMetaData", uselist=False, back_populates="entry")

    # Data
    uri = Column(String(1024))
    duration = Column(BigInteger)
    filename = Column(String(1024))
    entry_start = Column(DateTime)


735
736
737
738
    @hybrid_property
    def entry_end(self):
        return self.entry_start + datetime.timedelta(seconds=self.duration)

739
740
741
742
743
744
745
746
747
748
749
750
751
752
    @hybrid_property
    def start_unix(self):
        return time.mktime(self.entry_start.timetuple())

    @hybrid_property
    def end_unix(self):
        return time.mktime(self.entry_start.timetuple()) + self.duration

    @hybrid_property
    def volume(self):
        return 100

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

    @hybrid_property
    def channel(self):
        type = EngineUtil.get_channel_type(self.uri)
David Trattnig's avatar
David Trattnig committed
758
        if type == ChannelType.FILESYSTEM:
759
            return Channel.FILESYSTEM_A
David Trattnig's avatar
David Trattnig committed
760
        elif type == ChannelType.STREAM:
761
762
763
764
            return Channel.STREAM_A
        else:
            return "foo:bar"
        #FIXME Extend & finalize!!
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812


    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


    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.filename[-15:]
        return "SingleEntry ID#%s [%s - %s | %ssec | Track: ...%s]" % (str(self.id), time_start, time_end, self.duration, track)



class SingleEntryMetaData(DB.Model, AuraDatabaseModel):
    """
    Metadata for a autonomous entry such as the artist and track name.
    """
    __tablename__ = "single_entry_metadata"

    id = Column(Integer, primary_key=True)
    single_entry_id = Column(Integer, ForeignKey("single_entry.id"))

    artist = Column(String(256))
    title = Column(String(256))
    album = Column(String(256))

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

    @staticmethod
    def select_metadata_for_entry(single_entry_id):
        return DB.session.query(SingleEntry).filter(SingleEntryMetaData.id == single_entry_id).first()



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
893
894
895
896
897
898
899
900


#
#   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)

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



901
# ------------------------------------------------------------------------------------------ #
902
903
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
951
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
#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))
    #
    # filename = ""
    # 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"):
    #         self.type = ScheduleEntryType.STREAM
    #     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()