updating documents, adding server{md,html}

Author: s-n-g

README.html

@@ -150,6 +150,7 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
 <ul>
 <li><a href="#updating-a-pre-0.8.9-installation">Updating a pre 0.8.9 installation</a></li>
 </ul></li>
+<li><a href="#remote-control-server">Remote Control Server</a></li>
 <li><a href="#cleaning-up">Cleaning up</a></li>
 <li><a href="#debug-mode">Debug mode</a></li>
 <li><a href="#reporting-bugs">Reporting bugs</a></li>
@@ -170,6 +171,7 @@ <h2 id="features">Features <span style="padding-left: 10px;"><sup style="font-si
 <li>Search function</li>
 <li>Theming support</li>
 <li><a href="radio-browser.html">RadioBrowser</a> support</li>
+<li>Remote Control</li>
 <li>Easy installation / updating</li>
 <li>Runs on Linux, macOS and Windows</li>
 </ul>
@@ -1595,7 +1597,7 @@ <h2 id="titles-logging">Titles logging <span style="padding-left: 10px;"><sup st
 <li>using the -lt (--log-titles) command line option, or</li>
 <li>by pressing “<strong>W</strong>” while in the <strong>Main</strong>, the <strong>Playlist</strong> or the <strong>Register</strong> mode.</li>
 </ol>
-<p>The titles are written in a file called pyradio-titles.log which is saved at <strong>PyRadio</strong> configuration directory.</p>
+<p>The titles are written in a file called <em>pyradio-titles.log</em> which is saved at <strong>PyRadio</strong> configuration directory.</p>
 <p>Log file sample:</p>
 <pre>Apr 18 (Mon) 13:12 | &gt;&gt;&gt; Station: Lounge (Illinois Street Lounge - SomaFM)
 Apr 18 (Mon) 13:12 |     Jack Costanzo - La Cumparsa, Harlem Nocturne
@@ -1669,6 +1671,9 @@ <h3 id="updating-a-pre-0.8.9-installation">Updating a pre 0.8.9 installation</h3
 <p><strong>Note</strong>: If you have neither <em>wget</em> or <em>curl</em> installed, or you are on Windows, just right click on <a target="_blank" href="https://raw.githubusercontent.com/coderholic/pyradio/master/pyradio/install.py">this link</a> and use your browser “<strong>Save link as</strong>” menu entry to save the file in your home folder.</p>
 <p>Finally, execute the command:</p>
 <pre>python install.py --force</pre>
+<h2 id="remote-control-server">Remote Control Server <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><strong>PyRadio</strong> can be controlled remotely using normal http requests either form the command line (with <em>curl</em> for example) or from a browser.</p>
+<p>For more information, please refer to <a href="server.html">the relevant page</a>.</p>
 <h2 id="cleaning-up">Cleaning up <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><strong>PyRadio</strong> will uninstall all previously installed versions when updated (using the <strong>-U</strong> command line option), so no extra steps are needed any more to house keep your system.</p>
 <h2 id="debug-mode">Debug mode <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
@@ -1709,8 +1714,8 @@ <h2 id="packaging-pyradio">Packaging PyRadio <span style="padding-left: 10px;"><
 <p>to have notifications every 60 seconds, for example. You can use any value here, starting from 30 to 300 (meaning every 30 seconds up to 5 minutes), using a step of 30.</p>
 <p>Finally, make sure you install:</p>
 <ul>
-<li>devel/pyradio.png to /usr/share/icons or /usr/local/share/icons or any other suitable location.</li>
-<li>devel/pyradio.desktop to /usr/share/applications or /usr/local/share/applications or any other suitable location.</li>
+<li><em>devel/pyradio.png</em> to <em>/usr/share/icons</em> or <em>/usr/local/share/icons</em> or any other suitable location.</li>
+<li><em>devel/pyradio.desktop</em> to <em>/usr/share/applications</em> or <em>/usr/local/share/applications</em> or any other suitable location.</li>
 </ul>
 <h2 id="todo">TODO <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
 <ul class="task-list">

README.md

@@ -76,6 +76,7 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
     * [Session unlocking](#session-unlocking)
 * [Update notification](#update-notification)
     * [Updating a pre 0.8.9 installation](#updating-a-pre-0.8.9-installation)
+* [Remote Control Server](#remote-control-server)
 * [Cleaning up](#cleaning-up)
 * [Debug mode](#debug-mode)
 * [Reporting bugs](#reporting-bugs)
@@ -98,6 +99,7 @@ Ben Dowling - [https://github.com/coderholic](https://github.com/coderholic)
  - Search function
  - Theming support
  - [RadioBrowser](radio-browser.md) support
+ - Remote Control
  - Easy installation / updating
  - Runs on Linux, macOS and Windows
 
@@ -1087,7 +1089,7 @@ The function can be enabled:
 1. using the `-lt` (`--log-titles`) command line option, or
 2. by pressing "**W**" while in the **Main**, the **Playlist** or the **Register** mode.
 
-The titles are written in a file called `pyradio-titles.log` which is saved at **PyRadio** configuration directory.
+The titles are written in a file called *pyradio-titles.log* which is saved at **PyRadio** configuration directory.
 
 Log file sample:
 
@@ -1216,6 +1218,12 @@ Finally, execute the command:
 
     python install.py --force
 
+## Remote Control Server
+
+**PyRadio** can be controlled remotely using normal http requests either form the command line (with *curl* for example) or from a browser.
+
+For more information, please refer to [the relevant page](server.md).
+
 ## Cleaning up
 
 **PyRadio** will uninstall all previously installed versions when updated (using the **-U** command line option), so no extra steps are needed any more to house keep your system.
@@ -1285,8 +1293,8 @@ to have notifications every 60 seconds, for example. You can use any value here,
 
 Finally, make sure you install:
 
-- `devel/pyradio.png` to `/usr/share/icons` or `/usr/local/share/icons` or any other suitable location.
-- `devel/pyradio.desktop` to `/usr/share/applications` or `/usr/local/share/applications` or any other suitable location.
+- *devel/pyradio.png* to */usr/share/icons* or */usr/local/share/icons* or any other suitable location.
+- *devel/pyradio.desktop* to */usr/share/applications* or */usr/local/share/applications* or any other suitable location.
 
 ## TODO
 

desktop-notification.html

@@ -146,7 +146,7 @@ <h2 id="on-windows-7">On Windows 7 <span style="padding-left: 10px;"><sup style=
 
 <p>If you are on <strong>Windows 7</strong>, you will have a differently looking notification (shown above).</p>
 <p>If you click on the little tool-like “icon” next to the “X”, you get to the “<strong>Notification Area Icons</strong>”, the notifications configuration window. A couple of options are available, and again, I do not know how easy it will be to enable the notification if disabled once.</p>
-<p><a href="https://members.hellug.gr/sng/pyradio/win7-icons.jpg" target="_blank"><img style="width: 574px" src="https://members.hellug.gr/sng/pyradio/win7-icons.jpg" alt="Windows 7 Nontification Icons" /></a></p>
+<p><a href="https://members.hellug.gr/sng/pyradio/win7-icons.jpg" target="_blank"><img style="width: 482px" src="https://members.hellug.gr/sng/pyradio/win7-icons.jpg" alt="Windows 7 Nontification Icons" /></a></p>
 
 <p>Again, Window considers that the program sending the notifications is <strong>Python</strong>, not <strong>PyRadio</strong>, so that’s what you will be changing.</p>
 </body>

devel/pre-commit

@@ -34,7 +34,7 @@ sed -i 's/\t/    /g' Changelog
 
 
 # Create HTML file from md files
-for afile in README.md build.md windows.md windows-mplayer.md windows-mpv.md radio-browser.md desktop-notification.md
+for afile in README.md build.md windows.md windows-mplayer.md windows-mpv.md radio-browser.md desktop-notification.md server.md
 do
 #[ -z "$(git status | grep ${afile})" ] || {
     out=${afile/%.md/.html}
@@ -52,6 +52,8 @@ do
         echo '% PyRadio RadioBrowser Implementation' > tmp.md
     elif [ "$afile" = "desktop-notification.md" ];then
         echo '% PyRadio Desktop Notifications' > tmp.md
+    elif [ "$afile" = "server.md" ];then
+        echo '% PyRadio Remote Control Server' > tmp.md
     fi
     cat ${afile} >> tmp.md
     pandoc --wrap=none -s -t html tmp.md -o ${out} || {
@@ -132,7 +134,10 @@ do
         sed -i -e '/win-notif/s/src=/style="width: 411px" src=/' "$out"
         sed -i -e '/win7-notif/s/src=/style="width: 411px" src=/' "$out"
         sed -i -e '/win-python-props/s/src=/style="width: 574px" src=/' "$out"
-        sed -i -e '/win7-icons.jpg/s/src=/style="width: 574px" src=/' "$out"
+        sed -i -e '/win7-icons.jpg/s/src=/style="width: 482px" src=/' "$out"
+    fi
+    if [ "$out" = "server.html" ];then
+        sed -i -e '/server-on.jpg/s/src=/style="width: 574px" src=/' "$out"
     fi
 
     sed -i '/^<[Aa]/s|.*|<p>&</p>|' "$out"

pyradio.1

@@ -1,5 +1,5 @@
 .\" Copyright (C) 2011 Ben Dowling <http://www.coderholic.com/pyradio>
-.\" Copyright (C) 2018 Spiros Georgaras <[email protected]>
+.\" Copyright (C) 2018-2023 Spiros Georgaras <[email protected]>
 .\" This manual is freely distributable under the terms of the GPL.
 .\"
 .TH pyradio 1 "November 2022" pyradio
@@ -1595,4 +1595,4 @@ You can see a complete list of contributors at
 
 .SH See also
 
-    pyradio_rb(1)
+    pyradio_rb(1) pyradio_server(1)

pyradio/config.py

@@ -2989,6 +2989,7 @@ def configure_logger(self, debug=None, titles=None):
 
         logging.raiseExceptions = False
         logging.lastResort = None
+        # logger.info('self.log_titles = {}'.format(self.log_titles))
 
     def tag_title(self, the_log):
         ''' tags a title

pyradio/config_window.py

@@ -88,9 +88,9 @@ class PyRadioConfigWindow(object):
     '|', 'Default value: True'])
     _help_text.append(['Specify whether you will be asked to save a modified playlist whenever it needs saving.', '|', 'Default value: False'])
     _help_text.append(None)
-    _help_text.append(['This is the IP for the Remote Control Server.', '|', 'Available options:', '- localhost', '  PyRadio will be accessible from within the current system only.', '- LAN', '  PyRadio will be accessible from any computer in the local network.', '|', 'One can see the active IP using the "\s" command from the program\'s Main Window.', '|', 'Use "Space", "h/Left", "l/Right" to change the value.','|', 'Default value: localhost'])
+    _help_text.append(['This is the IP for the Remote Control Server.', '|', 'Available options:', '- localhost', '  PyRadio will be accessible from within the current system only.', '- LAN', '  PyRadio will be accessible from any computer in the local network.', '|', 'One can see the active IP using the "\s" command from the program\'s Main Window.', '|', 'Use "Space", "Enter", "l/Right" to change the value.','|', 'Default value: localhost'])
     _help_text.append(
-        ['This is the port used by the Remote Control Server (the port the server is listening to).', '|', 'Please make sure that a "free" port is specified here, to avoid any conflicts with existing services and daemons.', '|', 'None of the one-letter commands will work here; use the arrows (and PgUp / PgDn) to move to other fields.', '|', 'If an invalid port number is inserted, the cursor will not move to another field.', '|', 'Valid values: 1025-65535', 'Default value: 9998'])
+        ['This is the port used by the Remote Control Server (the port the server is listening to).', '|', 'Please make sure that a "free" port is specified here, to avoid any conflicts with existing services and daemons.', '|', 'If an invalid port number is inserted, the cursor will not move to another field.', '|', 'Valid values: 1025-65535', 'Default value: 9998'])
     _help_text.append(['If set to True, the Server wiil be automatically started when PyRadio starts.', 'If set to False, one can start the Server using the "\s" command from the Main program window.', '|', 'Default value: False'])
     _help_text.append(None)
     _help_text.append(['This options will open the configuration window for the RadioBrowser Online Stations Directory.', '|', "In order to use RadioBrowser, python's requests module must be installed."])
@@ -752,7 +752,7 @@ def keypress(self, char):
                 return -1, []
 
         elif val[0] == 'remote_control_server_ip':
-            if char in (curses.KEY_RIGHT, ord('l'), ord(' ')):
+            if char in (curses.KEY_RIGHT, ord('l'), ord(' '), ord('\n'), curses.KEY_ENTER):
                 if self._config_options[val[0]][1] == 'localhost':
                     self._config_options[val[0]][1] = 'LAN'
                     disp = 'LAN      '

pyradio/log.py

@@ -309,9 +309,9 @@ def _set_web_title(self, msg):
                 #         'abnormal' in msg:
                 #    title = msg
                 if msg.startswith('Playing: ') or \
-                        'abnormal' in msg:
-                    title = msg
-                elif msg.startswith('Failed to'):
+                    msg.startswith('Connecting to: ') or \
+                        'abnormal' in msg or \
+                        msg.startswith('Failed to'):
                     title = msg
                     with self._song_title_lock:
                         old_song_title = self._song_title

pyradio/radio.py

@@ -1510,8 +1510,10 @@ def ctrl_c_handler(self, signum, frame):
         terminates at program exit.
         If that causes problems, uncomment lines
         '''
-        # if self._remote_control_server:
-        #     self._remote_control_server.close_server()
+        while self._remote_control_server is not None:
+            ret, _ = self._remote_control_server.close_server()
+            if ret:
+                self._remote_control_server = None
         self.restore_colors()
 
     def _wait_for_threads(self):
@@ -9275,7 +9277,7 @@ def _start_remote_control_server(self):
         If that causes problems, commane the following line
         and uncomment lines in ctrl_c_handler()
         '''
-        self._remote_control_server_thread.daemon = True
+        # self._remote_control_server_thread.daemon = True
         self._remote_control_server_thread.start()
 
     def _stop_remote_control_server(self):