remote control server can now accept rela IP:PORT, same thing for headles function

s-n-g · s-n-g · commit f52f49c773d8 · 2024-01-03T23:40:25.000+02:00
diff --git a/docs/headless.html b/docs/headless.html
@@ -39,7 +39,7 @@
 <body>
 <header id="title-block-header">
 </header>
-<h1 style="color: SaddleBrown" id="pyradio-headless-operation">PyRadio Headless Operation</h1>
+<p># PyRadio Headless Operation</p>
 <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
 <!-- vim-markdown-toc Marked -->
 <ul>
@@ -83,11 +83,15 @@ <h3 id="usage">Usage</h3>
 The server will be accessible only by programs running in the system. The ip is 127.0.0.1.</li>
 <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>
 </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>
 <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 />
diff --git a/docs/headless.md b/docs/headless.md
@@ -1,4 +1,4 @@
-# PyRadio Headless Operation
+\fR# PyRadio Headless Operation
 
 ## Table of Contents
 <!-- vim-markdown-toc Marked -->
@@ -51,12 +51,17 @@ The `ip` can either be:
 The server will be accessible only by programs running in the system. The `ip` is 127.0.0.1.
 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.
 
 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.
+
 - using **--headless localhost:23456** \
 will make the web server listen to 127.0.0.1, port 23456
 
diff --git a/docs/pyradio_server.1 b/docs/pyradio_server.1
@@ -25,6 +25,8 @@ The options one can set are:
 .IP 1.\ \fBServer\ IP
 This can either be \fIlocalhost\fR (the server will be accessible from the current system only) or \fILAN\fR (the server will be accessible from any PC on the local network).
 
+If the machine has more that one interface (network card), the actual \fIIPs\fR will be available for selection.
+
 .IP 2.\ \fBServer\ 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).
 
diff --git a/docs/server.html b/docs/server.html
@@ -67,7 +67,9 @@ <h2 id="remote-control-server">Remote Control Server <span style="padding-left:
 <p>The options one can set are:</p>
 <ol type="1">
 <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).</p></li>
+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>
 <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 />
diff --git a/docs/server.md b/docs/server.md
@@ -27,7 +27,9 @@ Setting the **Remote Control Server** options ins the config file, especially se
 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).
+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.
 
 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).
diff --git a/pyradio/config.py b/pyradio/config.py
@@ -6,7 +6,7 @@
 import curses
 import collections
 import json
-import socket
+# import socket
 from os import path, getenv, makedirs, remove, rename, readlink, SEEK_END, SEEK_CUR, environ, getpid
 from sys import platform
 from time import ctime, sleep
@@ -27,6 +27,7 @@
 from .install import get_github_long_description
 from .common import is_rasberrypi
 from .player import pywhich
+from .server import IPsWithNumbers
 HAS_REQUESTS = True
 
 try:
@@ -71,10 +72,18 @@ def to_ip_port(string):
             if sp[0] == 'lan' or sp[0] == 'localhost':
                 host = sp[0]
             else:
-                try:
-                    x = socket.inet_pton(socket.AF_INET, sp[0])
+                x = IPsWithNumbers(
+                        default_ip=sp[0],
+                        fat=True
+                )
+                if x.current() == sp[0]:
                     host = sp[0]
-                except:
+                    # try:
+                    #     x = socket.inet_pton(socket.AF_INET, sp[0])
+                    #     host = sp[0]
+                    # except:
+                    #     return 'localhost', '11111'
+                else:
                     return 'localhost', '11111'
             try:
                 x = int(sp[1])
@@ -2096,13 +2105,18 @@ def read_config(self):
                            'vlc_parameter'):
                 self._config_to_params(sp)
             elif sp[0] == 'remote_control_server_ip':
-                hosts = ('localhost', 'LAN', 'lan')
+                # hosts = ('localhost', 'LAN', 'lan')
                 sp[1] = sp[1].strip()
-                x = [r for r in hosts if r == sp[1]]
-                if x:
-                    self.opts['remote_control_server_ip'][1] = x[0]
-                else:
-                    self.opts['remote_control_server_ip'][1] = 'localhost'
+                nip = IPsWithNumbers(
+                        default_ip=sp[1]
+                )
+                self.opts['remote_control_server_ip'][1] = nip.current()
+                nip = None
+                # x = [r for r in hosts if r == sp[1]]
+                # if x:
+                #     self.opts['remote_control_server_ip'][1] = x[0]
+                # else:
+                #     self.opts['remote_control_server_ip'][1] = 'localhost'
             elif sp[0] == 'remote_control_server_port':
                 try:
                      x = int(sp[1])
diff --git a/pyradio/config_window.py b/pyradio/config_window.py
@@ -12,6 +12,7 @@
 from .cjkwrap import cjklen
 from .encodings import *
 from .themes import *
+from .server import IPsWithNumbers
 from .simple_curses_widgets import SimpleCursesLineEdit, SimpleCursesHorizontalPushButtons, SimpleCursesMenu
 import logging
 import locale
@@ -88,7 +89,7 @@ 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.', '|', r'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 IP for the Remote Control Server.', '|', 'Available options:', '- localhost : PyRadio will be accessible from within the current system only.', '- lsn : PyRadio will be accessible from any computer in the local network.', '- IP : In case the system has more than one interfaces.', '|', '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.', '|', '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.', r'If set to False, one can start the Server using the "\s" command from the Main program window.', '|', 'Default value: False'])
@@ -190,6 +191,9 @@ def __init__(self, parent, config,
         for a_key in self._cnf.saved_params.keys():
             if self._cnf.saved_params[a_key] != self._cnf.params[a_key]:
                 self._cnf.dirty_config = True
+        self.nip = IPsWithNumbers(
+                default_ip=self._config_options['remote_control_server_ip'][1]
+        )
 
     def __del__(self):
         self._toggle_transparency_function = None
@@ -803,12 +807,14 @@ def keypress(self, char):
 
         elif val[0] == 'remote_control_server_ip':
             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      '
-                else:
-                    self._config_options[val[0]][1] = 'localhost'
-                    disp = 'localhost'
+                self._config_options[val[0]][1] = self.nip.next()
+                disp = self._config_options[val[0]][1].ljust(15)
+                # if self._config_options[val[0]][1] == 'localhost':
+                #     self._config_options[val[0]][1] = 'LAN'
+                #     disp = 'LAN      '
+                # else:
+                #     self._config_options[val[0]][1] = 'localhost'
+                #     disp = 'localhost'
                 self._win.addstr(
                     Y, 3 + len(val[1][0]),
                     disp, curses.color_pair(6)
diff --git a/pyradio/edit.py b/pyradio/edit.py
@@ -14,6 +14,7 @@
 from .simple_curses_widgets import SimpleCursesLineEdit, SimpleCursesCheckBox, SimpleCursesHorizontalPushButtons, DisabledWidget
 from .player import PlayerCache
 from .log import Log
+from .server import IPsWithNumbers
 
 import locale
 locale.setlocale(locale.LC_ALL, '')    # set your locale
@@ -1472,13 +1473,16 @@ class PyRadioServerWindow(object):
 
     _win = _editor = None
 
+    _nips = None
+
     def __init__(
             self,
             parent,
             config,
             port_number_error_message=None,
             global_functions=None
     ):
+        self._nips = IPsWithNumbers()
         self._cnf = config
         self._parent = parent
         self._win = None
@@ -1488,7 +1492,8 @@ def __init__(
         self._showed = False
         self._selection = 0
         self._field_x = 4 +  len('Server Port: ')
-        self._the_ip = self._cnf.active_remote_control_server_ip
+        self._the_ip = self._nips.validate_ip(self._cnf.active_remote_control_server_ip)
+        self._nips.set(self._the_ip)
         self._the_port = self._cnf.active_remote_control_server_port
         self._editor = None
         self._port_number_error_message = port_number_error_message
@@ -1537,7 +1542,6 @@ def show(self, parent=None):
             self._win.addstr(self._the_ip.ljust(self._field_width, ' '), curses.color_pair(10))
         self._win.addstr(5, 4, 'Server Port: ', curses.color_pair(10))
 
-
         try:
             self._win.addstr(7, 3, '─' * (self.maxX - 6), curses.color_pair(3))
         except:
@@ -1628,25 +1632,31 @@ def keypress(self, char):
                 char in (
                     ord(' '), ord('\n'),
                     curses.KEY_ENTER,
-                    ord('h'), ord('l'),
-                    curses.KEY_LEFT,
+                    ord('l'),
                     curses.KEY_RIGHT,
                 ):
-            if self._the_ip == 'localhost':
-                self._the_ip = 'LAN'
-            else:
-                self._the_ip = 'localhost'
+            self._the_ip = self._nips.next()
+            self._win.addstr(4, self._field_x, self._the_ip.ljust(self._field_width), curses.color_pair(6))
+            self._refresh()
+        elif self._selection == 0 and \
+                char in (
+                    ord('h'),
+                    curses.KEY_LEFT,
+                ):
+            self._the_ip = self._nips.previous()
             self._win.addstr(4, self._field_x, self._the_ip.ljust(self._field_width), curses.color_pair(6))
             self._refresh()
 
         elif char == ord('r'):
             self._the_ip = self._cnf.active_remote_control_server_ip
+            self._nips.set(self._the_ip)
             self._the_port = self._cnf.active_remote_control_server_port
             self._editor.string = self._the_port
             self._refresh()
 
         elif char == ord('d'):
             self._the_ip = 'localhost'
+            self._nips.set('localhost')
             self._the_port = '9998'
             self._editor.string = self._the_port
             self._refresh()
diff --git a/pyradio/main.py b/pyradio/main.py
@@ -335,7 +335,7 @@ def shell():
     else:
         gr_headless = parser.add_argument_group('• Headless operation')
         gr_headless.add_argument('--headless', default=None, metavar=('IP_AND_PORT', ),
-                                 help='Start in headless mode. IP_AND_PORT can be a) auto (use localhost:11111), b) localhost:XXXXX (access the web server through localhost) or c) lan:XXXXX (access the web server through the LAN). XXXXX can be any port number above 1025. Please make sure it is different than the one set in the configuration file.')
+                                 help='Start in headless mode. IP_AND_PORT can be a) auto (use localhost:11111), b) localhost:XXXXX (access the web server through localhost), c) lan:XXXXX (access the web server through the LAN) or d) IP_ADDRESS:XXXX (the IP_ADDRESS must be an assigned to one of the network interfaces). XXXXX can be any port number above 1025. Please make sure it is different than the one set in the configuration file.')
         gr_headless.add_argument('--address', action='store_true',
                                 help='Show remote control server address.')
         gr_headless.add_argument('-fd', '--free-dead-headless-server', action='store_true',
diff --git a/pyradio/server.py b/pyradio/server.py
@@ -71,13 +71,14 @@ def _get_linux_ips(self):
         for n in interfaces:
             iface=netifaces.ifaddresses(n).get(netifaces.AF_INET)
             if iface:
-                # dirty way to get real interfaces
-                if 'broadcast' in str(iface):
-                    if version_info[0] > 2:
-                        out.append(iface[0]['addr'])
-                    else:
-                        out.append(iface[0]['addr'].encode('utf-8'))
-        return out
+                for entry in iface:
+                    # dirty way to get real interfaces
+                    if 'broadcast' in str(entry):
+                        if version_info[0] > 2:
+                            out.append(entry['addr'])
+                        else:
+                            out.append(entry['addr'].encode('utf-8'))
+        return sorted(list(set(out)))
 
     def _get_win_ips(self):
         out = ['127.0.0.1']
@@ -94,6 +95,55 @@ def _get_win_ips(self):
         return out
 
 
+class IPsWithNumbers(object):
+
+    def __init__(self, default_ip=None, fat=False):
+        self._ips = ['localhost', 'lan']
+        ips = IPs()
+        if fat or len(ips.IPs) > 2:
+            self._ips.extend(ips.IPs[1:])
+        self._index = 0
+        if default_ip:
+            try:
+                self._index = self._ips.index(default_ip.lower())
+            except ValueError:
+                pass
+
+    def set(self, new_ip):
+        try:
+            self._index = self._ips.index(new_ip.lower())
+        except ValueError:
+            pass
+        return self._ips[self._index]
+
+    def current(self):
+        return self._ips[self._index]
+
+    def next(self):
+        self._index += 1
+        if self._index >= len(self._ips):
+            self._index = 0
+        return self._ips[self._index]
+
+    def previous(self):
+        self._index -= 1
+        if self._index <0:
+            self._index = len(self._ips) - 1
+        return self._ips[self._index]
+
+    def ip_exists(self, ip):
+        try:
+            x = self._ips.index(ip.lower())
+            return True
+        except ValueError:
+            return False
+
+    def validate_ip(self, ip):
+        ''' if ip is in the list of ips, return it
+            else return localhost
+        '''
+        return ip.lower() if self.ip_exists(ip) else 'localhost'
+
 class PyRadioServer(object):
     _filter_string = '''
                     <script>
