- pyradio_client:

    - the "i" / "info" response has been beautified
    - the IP and PORT will only be printed as a response to the "i" / "info" command, provided that the -s command line parameter has not been used
- adding referer stations' support
- updating docs

Author: s-n-g

docs/index.html

@@ -119,6 +119,10 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
 <li><a href="#player-detection-/-selection">Player detection / selection</a>
 <ul>
 <li><a href="#changing-player-mid-session">Changing player mid-session</a></li>
+<li><a href="#specifying-a-station&#39;s-referer-url">Specifying a station’s Referer URL</a>
+<ul>
+<li><a href="#a-note-of-caution">A note of caution</a></li>
+</ul></li>
 <li><a href="#extra-player-parameters">Extra Player Parameters</a>
 <ul>
 <li><a href="#using-the-configuration-window">Using the Configuration Window</a></li>
@@ -1762,6 +1766,17 @@ <h3 id="changing-player-mid-session">Changing player mid-session</h3>
 <p>Pressing “<strong>\m</strong>” will bring up the “<em>Switch Media Player</em>” window, where a different player can be activated.</p>
 <p>If <strong>recording is on</strong> while using the previously activated player, it will remain on with the newly activated one. This actually means that the recording will stop when the old player is stopped and resumed when the new player is activated (creating a new recorder file). There is just one exception to that; selecting <strong>VLC</strong> is not possible on <strong>Windows</strong>, since <strong>VLC</strong> does not support recording on this platform.</p>
 <p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> The activated player will not be saved; <strong>PyRadio</strong> will still use the player defined at its config next time it is executed.</p>
+<h3 id="specifying-a-stations-referer-url">Specifying a station’s Referer URL</h3>
+<p>Although <strong>PyRadio</strong> is meant to be a readio station player, it can also be used to listen to video stations transmitting m3u8 playlists (HTTP Live Streaming or HLS).</p>
+<p>The thing with these transmissions is that usually a <strong>Referer URL</strong> has to be provided so that the connection does not fail.</p>
+<p><strong>PyRadio</strong> now does support the declaration of a <strong>Referer URL</strong> for individual stations; it does it in an “anorthodox” way, but it is possible.</p>
+<p>So, let us imagine that a station called “<em>My video station</em>” has been added to a playlist. The user tries to play it but it fails; the referer URL is missing.</p>
+<p>To rectify the situation, a file containing the referer URL would have to be saved in the config directory: its name must be the name of the station as it is in the playlist, followed by the “<strong>.referer.txt</strong>” extension.</p>
+<p>In our example above, the file will have to be named:</p>
+<p><strong>“My video station.referer.txt”</strong></p>
+<h4 id="a-note-of-caution">A note of caution</h4>
+<p>If such a file has been created for a station, please do not rename the station in the playlist manually; the “link” to the referer file will be lost.</p>
+<p>Rename the station using <strong>PyRadio</strong> rename functionality and save the playlist instead; the referer file will be renamed as well.</p>
 <h3 id="extra-player-parameters">Extra Player Parameters</h3>
 <p>All three supported players can accept a significant number of “<em>command line options</em>”, which are well documented and accessible through man pages (on linux and MacOs) or the documentation (on Windows).</p>
 <p><strong>PyRadio</strong> uses some of these parameters in order to execute and communicate with the players. In particular, the following parameters are in use <strong>by default</strong>:</p>

docs/index.md

@@ -82,6 +82,8 @@ To ensure the correct operation, please take these actions:
     * [Global encoding declaration](#global-encoding-declaration)
 * [Player detection / selection](#player-detection-/-selection)
     * [Changing player mid-session](#changing-player-mid-session)
+    * [Specifying a station's Referer URL](#specifying-a-station's-referer-url)
+        * [A note of caution](#a-note-of-caution)
     * [Extra Player Parameters](#extra-player-parameters)
         * [Using the Configuration Window](#using-the-configuration-window)
 * [Player connection protocol](#player-connection-protocol)
@@ -747,6 +749,28 @@ If **recording is on** while using the previously activated player, it will rema
 
 **Note:** The activated player will not be saved; **PyRadio** will still use the player defined at its config next time it is executed.
 
+### Specifying a station's Referer URL
+
+Although **PyRadio** is meant to be a readio station player, it can also be used to listen to video stations transmitting m3u8 playlists (HTTP Live Streaming or HLS).
+
+The thing with these transmissions is that usually a **Referer URL** has to be provided so that the connection does not fail.
+
+**PyRadio** now does support the declaration of a **Referer URL** for individual stations; it does it in an "anorthodox" way, but it is possible.
+
+So, let us imagine that a station called "*My video station*" has been added to a playlist. The user tries to play it but it fails; the referer URL is missing.
+
+To rectify the situation, a file containing the referer URL would have to be saved in the config directory: its name must be the name of the station as it is in the playlist, followed by the "**.referer.txt**" extension.
+
+In our example above, the file will have to be named:
+
+**"My video station.referer.txt"**
+
+#### A note of caution
+
+If such a file has been created for a station, please do not rename the station in the playlist manually; the "link" to the referer file will be lost.
+
+Rename the station using **PyRadio** rename functionality and save the playlist instead; the referer file will be renamed as well.
+
 ### Extra Player Parameters
 
 All three supported players can accept a significant number of "*command line options*", which are well documented and accessible through man pages (on linux and MacOs) or the documentation (on Windows).

docs/pyradio.1

@@ -837,6 +837,37 @@ Pressing "\fI\\m\fR" will bring up the "\fBSwitch Media Player\fR" window, where
 .IP \fBNote\fR
 The activated player will not be saved; **PyRadio** will still use the player defined at its config next time it is executed.
 
+
+
+
+
+.SH Specifying a station's Referer URL
+
+Although \fBpyradio\fR is meant to be a readio station player, it can also be used to listen to video stations transmitting m3u8 playlists (HTTP Live Streaming or HLS).
+
+The thing with these transmissions is that usually a \fBReferer URL\fR has to be provided so that the connection does not fail.
+
+\fBpyradio\fR now does support the declaration of a \fBReferer URL\fR for individual stations; it does it in an "anorthodox" way, but it is possible.
+
+So, let us imagine that a station called "\fIMy video station\fR" has been added to a playlist. The user tries to play it but it fails; the referer URL is missing.
+
+To rectify the situation, a file containing the referer URL would have to be saved in the config directory: its name must be the name of the station as it is in the playlist, followed by the "\fB.referer.txt\fR" extension.
+
+In our example above, the file will have to be named:
+
+.RS
+"\fIMy video station.referer.txt\fR"
+.RE
+
+\fBA note of caution\fR
+.RS
+If such a file has been created for a station, please do not rename the station in the playlist manually; the "link" to the referer file will be lost.
+
+Rename the station using \fBpyradio\fR rename functionality and save the playlist instead; the referer file will be renamed as well.
+.RE
+
+
+
 .SH Extra Player Parameters
 
 All three supported players can accept a significant number of "\fIcommand line parameters\fR", which are well documented and accessible through man pages (on linux and macOs) or the documentation (on Windows).

pyradio/client.py

@@ -101,19 +101,21 @@ def last_reply(self):
                     return self._last_reply.split('<b>')[1][:-6]
                 except IndexError:
                     return 'Error retrieving title!'
-            elif self._last_command in ('i', 'info') and \
-                    self._discovered:
-                out = self._last_reply.splitlines()
-                out.insert(1, '  Server: ' + self._host + ':' + self._port)
-                self._last_reply = '\n'.join(out)
+            elif self._last_command in ('i', 'info'):
+                if self._discovered:
+                    out = self._last_reply.splitlines()
+                    out.insert(1, '  Server: ' + self._host + ':' + self._port)
+                    self._last_reply = '\n'.join(out) + '\n'
+                if 'Title: ' in self._last_reply:
+                    self._last_reply = re.sub(r'Title: "([^"]*)"', r'Title: "[red3]\1[/red3]"', self._last_reply)
+                self._last_reply = self._last_reply.replace(r'PyRadio', r'[magenta]PyRadio[/magenta]')
+                self._last_reply = self._last_reply.replace(r'headless', r'[blue]headless[/blue]')
             if 'retry: ' in self._last_reply:
                 self._last_reply = 'Command executed\n'
             return self._last_reply
         # empty reply
         if self._type == -1:
             return 'Command executed\n'
-        else:
-            return server_id + 'Command Executed\n'
 
     def _get_files(self):
         if self._files is None:

pyradio/config.py

@@ -166,6 +166,8 @@ class PyRadioStations(object):
 
     show_no_themes_message = True
 
+    renamed_stations = []
+
     def __init__(self, stationFile='', user_config_dir=None):
         if platform.startswith('win'):
             self._open_string_id = 1
@@ -857,6 +859,25 @@ def save_playlist_file(self, stationFile=''):
                 logger.debug('Cannot rename playlist file...')
             return -2
         self.dirty_playlist = False
+        if self.renamed_stations:
+            for n in self.renamed_stations:
+                chk_referer_file = path.join(self.stations_dir, n[0] + '.referer.txt')
+                if path.exists(chk_referer_file):
+                    new_referer_file = path.join(self.stations_dir, n[1] + '.referer.txt')
+                    try:
+                        rename(chk_referer_file, new_referer_file)
+                        if logger.isEnabledFor(logging.DEBUG):
+                            logger.debug('referer file renamed from "{}" to "{}"'.format(
+                                path.basename(chk_referer_file),
+                                path.basename(new_referer_file)
+                                ))
+                    except:
+                        pass
+                        if logger.isEnabledFor(logging.DEBUG):
+                            logger.debug('failed to rename referer file from "{}" to "{}"'.format(
+                                path.basename(chk_referer_file),
+                                path.basename(new_referer_file)
+                                ))
         return 0
 
     def _format_playlist_row(self, a_row):

pyradio/player.py

@@ -2022,7 +2022,7 @@ def play(self,
             self._station_encoding = self.config_encoding
         opts = []
         isPlayList = streamUrl.split("?")[0][-3:] in ['m3u', 'pls']
-        opts, self.monitor_opts = self._buildStartOpts(streamUrl, isPlayList)
+        opts, self.monitor_opts = self._buildStartOpts(name, streamUrl, isPlayList)
         self.stop_mpv_status_update_thread = False
         if logger.isEnabledFor(logging.INFO):
             try:
@@ -2282,7 +2282,7 @@ def _killall(self, name):
             except:
                 pass
 
-    def _buildStartOpts(self, streamUrl, playList):
+    def _buildStartOpts(self, streamName, streamUrl, playList):
         pass
 
     def _write_silenced_profile(self):
@@ -2315,6 +2315,17 @@ def _write_silenced_profile(self):
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('Cannot wirte [silent] profile in: "{}"'.format(self.config_files[0]))
 
+    def _get_referer(self, streamName):
+        referer = None
+        ref = os.path.join(self._cnf.xdg.stations_dir, streamName + '.referer.txt')
+        if os.path.exists(ref):
+            try:
+                with open(ref, 'r', encoding='utf-8') as f:
+                    referer = f.read().strip()
+            except:
+                pass
+        return referer
+
     def togglePause(self):
         if self.PLAYER_NAME == 'mpv':
             self.paused = self._pause()
@@ -2493,7 +2504,7 @@ def save_volume(self):
             self.volume = -2
         return self._do_save_volume(self.profile_token + '\nvolume={}\n')
 
-    def _buildStartOpts(self, streamUrl, playList=False):
+    def _buildStartOpts(self, streamName, streamUrl, playList=False):
         # logger.error('\n\nself._recording = {}'.format(self._recording))
         # logger.error('self.profile_name = "{}"'.format(self.profile_name))
         ''' Builds the options to pass to mpv subprocess.'''
@@ -2553,11 +2564,9 @@ def _buildStartOpts(self, streamUrl, playList=False):
             if logger.isEnabledFor(logging.DEBUG):
                 logger.debug('---=== Starting Recording: "{}" ===---',format(self.recording_filename))
 
-        # ##################################################################
-        # if streamUrl == r'https://player-culturaam.stream.uol.com.br/live/culturaam.m3u8' or \
-        #         streamUrl == r'http://player-culturaam.stream.uol.com.br/live/culturaam.m3u8':
-        #     opts.append(r'--http-header-fields="User-Agent: PyRadio,Referer: https://cultura.uol.com.br/aovivo/67_ao-vivo-radio-cultura-brasil.html"')
-        # ##################################################################
+        referer = self._get_referer(streamName)
+        if referer is not None:
+            opts.append(r'--http-header-fields="User-Agent: ' + self._cnf.user_agent_string + r',Referer:' + referer)
 
         if playList:
             if newerMpv:
@@ -2981,14 +2990,19 @@ def save_volume(self):
             return 0
         return self._do_save_volume(self.profile_token + '\nvolstep=1\nvolume={}\n')
 
-    def _buildStartOpts(self, streamUrl, playList=False):
+    def _buildStartOpts(self, streamName, streamUrl, playList=False):
         ''' Builds the options to pass to mplayer subprocess.'''
         opts = [self.PLAYER_CMD, '-vo', 'null', '-msglevel', 'all=6']
         if self._cnf.buffering_data:
             opts.extend(self._cnf.buffering_data)
         # opts = [self.PLAYER_CMD, '-vo', 'null']
         monitor_opts = None
 
+        referer = self._get_referer(streamName)
+        if referer is not None:
+            opts.append(r'-http-header-fields')
+            opts.append(r'Referer: ' + referer)
+
         ''' Do I have user profile in config?
             If so, can I use it?
         '''
@@ -3322,7 +3336,7 @@ def set_volume(self, vol):
     def save_volume(self):
         return self._do_save_volume('{}')
 
-    def _buildStartOpts(self, streamUrl, playList=False):
+    def _buildStartOpts(self, streamName, streamUrl, playList=False):
         ''' Builds the options to pass to vlc subprocess.'''
         #opts = [self.PLAYER_CMD, "-Irc", "--quiet", streamUrl]
         monitor_opts = None
@@ -3384,6 +3398,13 @@ def _buildStartOpts(self, streamUrl, playList=False):
         if self._cnf.buffering_data:
             opts.extend(self._cnf.buffering_data)
 
+        referer = self._get_referer(streamName)
+        if referer is not None:
+            opts.append('--http-user-agent')
+            opts.append(self._cnf.user_agent_string)
+            opts.append(r'--http-referrer')
+            opts.append(referer)
+
         ''' this will set the profile too '''
         if self.params[0] > 1:
             params = self.params[self.params[0]]

pyradio/radio.py

@@ -817,7 +817,7 @@ def _text_info(self):
             # logger.error('self.log.song_title: {}'.format(self.log.song_title))
             # logger.error('============================')
             if self.stations[self.playing][0] not in self.log.song_title:
-                out.append('    Title: {}'.format(fix_chars(self.log.song_title)))
+                out.append('    Title: "{}"'.format(fix_chars(self.log.song_title)))
         else:
             out.append('  Status: Idle')
         out.append('  Selection (id={0}): "{1}"'.format(self.selection+1, self.stations[self.selection][0]))
@@ -3719,6 +3719,7 @@ def _open_playlist(self, a_url=None):
             Parameters:
                 a_url:  this should be an online service url
         '''
+        self._cnf.renamed_stations = []
         self._cnf.save_station_position(self.startPos, self.selection, self.playing)
         self._set_active_stations()
         self._update_status_bar_right()
@@ -7211,7 +7212,9 @@ def keypress(self, char):
                             self._station_editor.new_station[0]
                         )
                         self._cnf.dirty_playlist = True
+                    self._cnf.renamed_stations.append([self.stations[self.selection][0], ''])
                     self.stations[self.selection] = self._station_editor.new_station
+                    self._cnf.renamed_stations[-1][-1] = self.stations[self.selection][0]
                     if self.selection == self.playing:
                         self._last_played_station = self._station_editor.new_station
                 else:
@@ -8315,6 +8318,10 @@ def keypress(self, char):
             self._update_status_bar_right()
             icy_data_name = self.player.icy_data('icy-name')
             if char == ord('r') and self.stations[self.playing][0] != icy_data_name:
+                self._cnf.renamed_stations.append([
+                    self.stations[self.playing][0],
+                    icy_data_name
+                ])
                 self._cnf.stations_history.rename_station(
                     self._cnf.station_title,
                     self.stations[self.playing][0],

pyradio/server.py

@@ -1411,7 +1411,7 @@ def _handle_client_connection(self, address, request):
                                 self._commands['/jump'](ret)
                                 self._send_raw('<div class="alert alert-success">Playing <b>{}</b></div>'.format(self.lists()[0][-1][ret-1][0]))
                             else:
-                                self._send_text(' Playing station: {}'.format(self.lists()[0][-1][ret-1][0]))
+                                self._send_text(' Playing station: "{}"'.format(self.lists()[0][-1][ret-1][0]))
                                 self._commands['/jump'](ret)
                     has_error = False
             else:

pyradio/xdg.py

@@ -120,6 +120,9 @@ def _get_files(self):
         flag_files.extend([x[0] for x in self.files_to_state])
 
         self.files_to_other = [[x, self._replace_dir_in_path(x, self.other_dir) ] for x in files_in_path if x not in flag_files]
+        for n in range(len(self.files_to_other)-1, -1, -1):
+            if self.files_to_other[0][0].endswith('.referer.txt'):
+                self.files_to_other.pop(n)
 
     def _get_max_length(self):
         to_print = []