remote control server will be silently restarted if crashed

Author: s-n-g

docs/headless.html

@@ -74,7 +74,7 @@ <h2 id="goal">Goal <span style="padding-left: 10px;"><sup style="font-size: 50%"
 <p>“<strong>Screen</strong> is a full-screen window manager that multiplexes a physical terminal between several processes (typically interactive shells)… Programs continue to run when their window is currently not visible and even when the whole screen session <strong>is detached from the user’s terminal</strong>.”</p>
 <p><strong>PyRadio</strong> users <a target="_blank" href="https://github.com/Wikinaut">Wikinaut</a> and <a target="_blank" href="https://github.com/aleksandr-sabitov">aleksandr-sabitov</a> on <a target="_blank" href="https://github.com/coderholic/pyradio/issues/184">github</a> have come up with the idea to use this approach to run the application on their headless Raspberry Pi, so kudos to them!</p>
 <h3 id="usage">Usage</h3>
-<p>After the program is started, the only way to interact with it is through its integrated web server. Please refref to the relevant document for more info on the <a href="server.html">remote control server</a>.</p>
+<p>After the program is started, the only way to interact with it is through its integrated web server. Please refer to the relevant document for more info on the <a href="server.html">remote control server</a>.</p>
 <p>The web server can be accessed either through a terminal (address <strong>http://ip:port</strong>) using wget or curl, or through a web browser (address <strong>http://ip:port/html</strong>).</p>
 <p>The ip and port will be set using the <strong>–headless</strong> command line option.</p>
 <p>The ip can either be:</p>
@@ -84,14 +84,16 @@ <h3 id="usage">Usage</h3>
 <li><strong>lan</strong><br />
 The server will be accessible by any system on the LAN. The ip is the one assigned to the network interface of the system.</li>
 <li>An actual <strong>IP</strong><br />
-This is in case when a machine has more than one network interfaces and the **lan* setting is ambigous.</li>
+This is in case when a machine has more than one network interfaces and the <strong>lan</strong> setting is ambiguous.</li>
 </ol>
 <p>For example:</p>
 <ul>
 <li><p>using <strong>–headless lan:12345</strong><br />
 will make the web server listen to the network interface IP address, port 12345.</p></li>
 <li><p>using <strong>–headless 192.168.122.101:4567</strong><br />
-will make the web server listen to the IP 192.168.122.101, port 4567.</p></li>
+will make the web server listen to the IP 192.168.122.101, port 4567.<br />
+<br />
+If the IP is not assigned to any network interfaces, the default (<strong>localhost:1111</strong>) will be silently used; please always check the server’s address with the command: <strong>pyradio –addr</strong>.</p></li>
 <li><p>using <strong>–headless localhost:23456</strong><br />
 will make the web server listen to 127.0.0.1, port 23456</p></li>
 <li><p>using <strong>–headless auto</strong><br />
@@ -121,6 +123,7 @@ <h3 id="how-it-works">How it works</h3>
 <li><p>we cannot start a second headless server, and</p></li>
 <li><p>we can get info about the server running.</p></li>
 </ul>
+<p>The “headless server lock file” is saved as <em>~/.config/pyeadio/data/server-headles.txt</em> and will contain the IP address and port the servers is listening to. This is especially useful in case a user script needs to get this info (instead of parsing the output of the command <strong>pyradio –addr</strong>).</p>
 <h2 id="installation">Installation <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
 <p>By the term “installation”, we mean that we set up things in such a way, that after we log into the system, we find <strong>PyRadio</strong> ready to accept connections.</p>
 <p>So, the installation can be as easy as adding a line in a configuration file (or the startup section of the <em>desktop environment</em>) or as hard as adding a system service.</p>

docs/headless.md

@@ -39,7 +39,7 @@ Now, **PyRadio** is a **terminal application**; it actually **needs** a terminal
 
 ### Usage
 
-After the program is started, the only way to interact with it is through its integrated web server. Please refref to the relevant document for more info on the [remote control server](server.md).
+After the program is started, the only way to interact with it is through its integrated web server. Please refer to the relevant document for more info on the [remote control server](server.md).
 
 The web server can be accessed either through a terminal (address **http://ip:port**) using `wget` or `curl`, or through a web browser (address **http://ip:port/html**).
 
@@ -52,15 +52,17 @@ The server will be accessible only by programs running in the system. The `ip` i
 2. **lan** \
 The server will be accessible by any system on the LAN. The `ip` is the one assigned to the network interface of the system.
 3. An actual **IP** \
-This is in case when a machine has more than one network interfaces and the **lan* setting is ambigous.
+This is in case when a machine has more than one network interfaces and the **lan** setting is ambiguous.
 
 For example:
 
 - using **--headless lan:12345** \
 will make the web server listen to the network interface IP address, port 12345.
 
 - using **--headless 192.168.122.101:4567** \
-will make the web server listen to the IP 192.168.122.101, port 4567.
+will make the web server listen to the IP 192.168.122.101, port 4567. \
+\
+If the IP is not assigned to any network interfaces, the default (**localhost:1111**) will be silently used; please always check the server's address with the command: **pyradio --addr**.
 
 - using **--headless localhost:23456** \
 will make the web server listen to 127.0.0.1, port 23456
@@ -109,6 +111,8 @@ It will create a "headless server lock file", though, so that
 
 - we can get info about the server running.
 
+The "headless server lock file" is saved as *~/.config/pyeadio/data/server-headles.txt* and will contain the IP address and port the servers is listening to. This is especially useful in case a user script needs to get this info (instead of parsing the output of the command **pyradio --addr**).
+
 ## Installation
 
 By the term "installation", we mean that we set up things in such a way, that after we log into the system, we find **PyRadio** ready to accept connections.

docs/pyradio_server.1

@@ -274,6 +274,8 @@ PyRadio 0.9.2.20
   Status: In playback
 .br
     Station (id=5): "Classical Christmas FM"
+.br
+    Title: Patti Page - Jingle bells
 .br
   Selection (id=5): "Classical Christmas FM"\fB
 

docs/server.html

@@ -50,6 +50,7 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
 <li><a href="#web-interface-buttons">Web Interface buttons</a></li>
 </ul></li>
 <li><a href="#using-the-text-server">Using the Text Server</a></li>
+<li><a href="#server-lock-file">Server lock file</a></li>
 <li><a href="#examples">Examples</a></li>
 <li><a href="#text-vs.-web-commands">Text vs. Web commands</a></li>
 </ul></li>
@@ -69,7 +70,7 @@ <h2 id="remote-control-server">Remote Control Server <span style="padding-left:
 <li><p><strong>Server IP</strong><br />
 This can either be <strong>localhost</strong> (the server will be accessible from the current system only) or <strong>LAN</strong> (the server will be accessible from any PC on the local network).<br />
 <br />
-If the machine has more that one interface (network card), the actual IPs will be available for selection.</p></li>
+If the machine has more that one interface (network card), the actual IPs will be available for selection as well.</p></li>
 <li><p><strong>Server Port</strong><br />
 This is the port the server is listening to. Any free port number between 1025 and 65535 can be set here (default value is 9998).</p></li>
 <li><p><strong>Auto-start Server</strong><br />
@@ -160,6 +161,8 @@ <h3 id="using-the-text-server">Using the Text Server</h3>
 /search_radio_browser/x     /srb/x     execute search item x
                                          (x comes from /lrb)</pre>
 <p>The “<strong>Restricted Commands</strong>” will not work in <strong>Playlist mode</strong>; the “<strong>Global Commands</strong>” will work everywhere.</p>
+<h3 id="server-lock-file">Server lock file</h3>
+<p>When the server is up and running, a “server lock file” will be created; the file is named <strong>~/.config/pyradio/data/server.txt</strong> and contains the IP address and port the server is listening to; this is especially useful for user scripts that want to get hold of this information.</p>
 <h3 id="examples">Examples</h3>
 <p>The following commands will increase / decrease the volume and mute the player:</p>
 <pre>$ curl http://192.168.122.4:9998/vu
@@ -205,6 +208,7 @@ <h3 id="examples">Examples</h3>
     Search: Name: christmas, Order: votes, Reverse: true
   Status: In playback
     Station (id=5): &quot;Classical Christmas FM&quot;
+    Title: Patti Page - Jingle bells
   Selection (id=5): &quot;Classical Christmas FM&quot;</pre>
 <h3 id="text-vs.-web-commands">Text vs. Web commands</h3>
 <p>On first glance, the difference between a <strong>Text</strong> and a <strong>Web</strong> command is the <em>/html</em> part that exists in the later.</p>

docs/server.md

@@ -7,6 +7,7 @@
     * [Using the Web Server](#using-the-web-server)
         * [Web Interface buttons](#web-interface-buttons)
     * [Using the Text Server](#using-the-text-server)
+    * [Server lock file](#server-lock-file)
     * [Examples](#examples)
     * [Text vs. Web commands](#text-vs.-web-commands)
 
@@ -29,7 +30,7 @@ The options one can set are:
 1. **Server IP** \
 This can either be **localhost** (the server will be accessible from the current system only) or **LAN** (the server will be accessible from any PC on the local network). \
 \
-If the machine has more that one interface (network card), the actual IPs will be available for selection.
+If the machine has more that one interface (network card), the actual IPs will be available for selection as well.
 
 2. **Server Port** \
 This is the port the server is listening to. Any free port number between 1025 and 65535 can be set here (default value is 9998).
@@ -157,6 +158,10 @@ Restricted Commands (Main mode only)
 
 The "**Restricted Commands**" will not work in **Playlist mode**; the "**Global Commands**" will work everywhere.
 
+### Server lock file
+
+When the server is up and running, a "server lock file" will be created; the file is named **~/.config/pyradio/data/server.txt** and contains the IP address and port the server is listening to; this is especially useful for user scripts that want to get hold of this information.
+
 ### Examples
 
 The following commands will increase / decrease the volume and mute the player:
@@ -231,6 +236,7 @@ PyRadio 0.9.2.20
     Search: Name: christmas, Order: votes, Reverse: true
   Status: In playback
     Station (id=5): "Classical Christmas FM"
+    Title: Patti Page - Jingle bells
   Selection (id=5): "Classical Christmas FM"
 ```
 

pyradio/radio.py

@@ -816,6 +816,8 @@ def _text_info(self):
         if self.player.isPlaying():
             out.append('  Status: In playback {}'.format('(muted)' if self.player.muted else ''))
             out.append('    Station (id={0}): "{1}"'.format(self.playing+1, self.stations[self.playing][0]))
+            if self.stations[self.playing][0] not in self.log.song_title:
+                out.append('    Title: {}'.format(self.log.song_title))
         else:
             out.append('  Status: Idle')
         out.append('  Selection (id={0}): "{1}"'.format(self.selection+1, self.stations[self.selection][0]))
@@ -865,6 +867,7 @@ def _set_text_volume(self, vol):
         if self.player.isPlaying() and \
                 not self.player.muted:
             ivol = int(vol)
+            # self._remote_control_server._send_text('Volume set!')
             self.player.set_volume(vol)
             sleep(.1)
             return 'Volume set to: {}'.format(vol)
@@ -3678,6 +3681,13 @@ def _print_session_locked(self):
                         is_message=True)
 
     def _print_remote_control_server_error(self, msg=None):
+        ''' restart the srver instead of displaying
+            a message and terminate '''
+        self._remote_control_server = self._remote_control_server_thread = None
+        self._restart_remote_control_server()
+        if logger.isEnabledFor(logging.DEBUG):
+            logger.debug('Remote Control server crashed! Restarting...')
+        return
         if msg:
             self._server_error_msg = str(msg)
         txt = r'''
@@ -3698,6 +3708,13 @@ def _print_remote_control_server_error(self, msg=None):
         self._remote_control_server = self._remote_control_server_thread = None
 
     def _print_remote_control_server_dead_error(self, msg=None):
+        ''' restart the srver instead of displaying
+            a message and terminate '''
+        self._remote_control_server = self._remote_control_server_thread = None
+        self._restart_remote_control_server()
+        if logger.isEnabledFor(logging.DEBUG):
+            logger.debug('Remote Control server crashed! Restarting...')
+        return
         if msg:
             self._server_dead_msg = str(msg)
         txt = '''

pyradio/server.py

@@ -945,15 +945,14 @@ def start_remote_control_server(
                 self.client_socket, address = server.accept()
                 request = self.client_socket.recv(1024)
             except socket.error as e:
-                if logger.isEnabledFor(logger.ERROR):
-                    logger.error('Server accept error: "{}"'.format(e))
                 self._remove_report_file()
                 dead_func(e)
                 break
             self.error = None
             self._handle_client_connection(address, request)
             if self.error is not None:
-                self.client_socket.close()
+                # self.client_socket.close()
+                self._remove_report_file()
                 dead_func(self.error)
                 break
             if self._path == '/quit':