Adding editor validation and error reporting

Author: s-n-g

pyradio/edit.py

@@ -4,6 +4,11 @@
 from time import sleep
 import logging
 from sys import version_info
+try:
+    # python 3
+    from urllib.parse import urlparse
+except ImportError:
+    from urlparse import urlparse
 from .simple_curses_widgets import SimpleCursesLineEdit
 from .log import Log
 
@@ -403,12 +408,33 @@ def _update_focus(self):
             self._line_editor[1].focused = True
 
     def _return_station(self):
-        if self._encoding == 'utf-8':
-            self._encoding = ''
-        self.new_station = [ self._line_editor[0].string, self._line_editor[1].string, self._encoding ]
+        ret = self._validate()
+        if ret == 1:
+            if self._encoding == 'utf-8':
+                self._encoding = ''
+            self.new_station = [ self._line_editor[0].string.strip(), self._line_editor[1].string.strip(), self._encoding ]
+        return ret
+
+    def _validate(self):
+        if not self._line_editor[0].string.strip():
+            return -2
+        url = urlparse(self._line_editor[1].string.strip())
+        if not (url.scheme and url.netloc):
+            return -3
+        if url.scheme not in ('http', 'https'):
+            return -3
+        if url.netloc != 'localhost':
+            dot = url.netloc.find('.')
+            if dot == -1:
+                return -3
+            elif dot > len(url.netloc) - 3:
+                return -3
+        return 1
 
     def keypress(self, char):
         """ Returns:
+                -3: url is invalid
+                -2: Station name is empty
                 -1: Cancel (new_station = None)
                  0: go on
                  1: Ok     (new_station holds data)
@@ -438,8 +464,7 @@ def keypress(self, char):
                     return 3
                 elif self._focus == 3:
                     # ok
-                    self._return_station()
-                    ret = 1
+                    return self._return_station()
                 elif self._focus == 4:
                     # cancel
                     self.new_station = None
@@ -448,8 +473,7 @@ def keypress(self, char):
                 self.new_station = None
                 ret = -1
             elif char == ord('s') and self._focus > 1:
-                self._return_station
-                ret = -1
+                return self._return_station()
             elif char == ord('q') and self._focus > 1:
                 self.new_station = None
                 ret = -1

pyradio/radio.py

@@ -188,6 +188,8 @@ def __init__(self, pyradio_config, play=False, req_player='', theme=''):
                 self.ws.ADD_STATION_MODE: self._show_station_editor,
                 self.ws.EDIT_STATION_MODE: self._show_station_editor,
                 self.ws.LINE_EDITOR_HELP: self._show_line_editor_help,
+                self.ws.EDIT_STATION_NAME_ERROR: self._print_editor_name_error,
+                self.ws.EDIT_STATION_URL_ERROR: self._print_editor_url_error,
                 }
 
         """ list of help functions """
@@ -1479,6 +1481,28 @@ def _print_save_playlist_error_2(self):
                 prompt = ' Press any key ',
                 is_message=True)
 
+    def _print_editor_name_error(self):
+        txt = '''Station Name is empty!
+
+            Please provide a Station Name.
+            '''
+        self._show_help(txt,
+                mode_to_set = self.ws.EDIT_STATION_NAME_ERROR,
+                caption = ' Error ',
+                prompt = ' Press any key ',
+                is_message=True)
+
+    def _print_editor_url_error(self):
+        txt = '''Station URL is invalid!
+
+            Please provide a valid Station URL.
+            '''
+        self._show_help(txt,
+                mode_to_set = self.ws.EDIT_STATION_URL_ERROR,
+                caption = ' Error ',
+                prompt = ' Press any key ',
+                is_message=True)
+
     def _print_ask_to_create_theme(self):
         txt ='''You have requested to edit a |read-only| theme,
             which is not possible. Do you want to create a
@@ -2002,7 +2026,8 @@ def keypress(self, char):
                     self.refreshBody()
                 return
 
-        elif char in (ord('t'), ):
+        elif char in (ord('t'), ) and \
+                self.ws.operation_mode not in (self.ws.EDIT_STATION_MODE, self.ws.ADD_STATION_MODE):
             # only open it on main modes
             if self.ws.window_mode != self.ws.THEME_MODE and  \
                     self.ws.operation_mode <= self.ws.SEARCH_PLAYLIST_MODE and \
@@ -2198,7 +2223,11 @@ def keypress(self, char):
                 self.volume_functions[chr(char)]()
                 return
             ret = self._station_editor.keypress(char)
-            if ret == -1:
+            if ret == -3:
+                self._print_editor_url_error()
+            elif ret == -2:
+                self._print_editor_name_error()
+            elif ret == -1:
                 # Cancel
                 self.ws.close_window()
                 self._station_editor = None
@@ -2674,11 +2703,11 @@ def keypress(self, char):
                     self.helpWin = None
                     if self.ws.operation_mode == self.ws.MAIN_HELP_MODE:
                         self.ws.close_window()
-                        self.refreshBody()
+                        #self.refreshBody()
                         self._show_main_help_page_2()
                     else:
                         self.ws.close_window()
-                        self.refreshBody()
+                        #self.refreshBody()
                         self._show_main_help()
                     return
             if logger.isEnabledFor(logging.DEBUG):
@@ -2824,6 +2853,7 @@ def keypress(self, char):
                 return
 
             if self.ws.operation_mode == self.ws.NORMAL_MODE:
+                logger.error('DE here')
                 if char in ( ord('a'), ord('A') ):
                     self._station_editor = PyRadioEditor(self.stations, self.selection, self.bodyWin)
                     if char == ord('A'):

pyradio/window_stack.py

@@ -59,6 +59,8 @@ class Window_Stack_Constants(object):
     FOREIGN_PLAYLIST_MESSAGE_MODE = 301
     FOREIGN_PLAYLIST_COPY_ERROR_MODE = 302
     CONFIG_SAVE_ERROR_MODE = 303
+    EDIT_STATION_NAME_ERROR = 304
+    EDIT_STATION_URL_ERROR = 305
     THEME_MODE = 400
     UPDATE_NOTIFICATION_MODE = 1000
     SESSION_LOCKED_MODE = 1001
@@ -119,6 +121,8 @@ class Window_Stack_Constants(object):
             ADD_STATION_MODE: 'ADD_STATION_MODE',
             EDIT_STATION_MODE: 'EDIT_STATION_MODE',
             LINE_EDITOR_HELP: 'LINE_EDITOR_HELP',
+            EDIT_STATION_NAME_ERROR: 'EDIT_STATION_NAME_ERROR',
+            EDIT_STATION_URL_ERROR: 'EDIT_STATION_URL_ERROR',
             }
 
     ''' When PASSIVE_WINDOWS target is one of them,
@@ -151,6 +155,8 @@ class Window_Stack_Constants(object):
             THEME_HELP_MODE,
             SEARCH_HELP_MODE,
             LINE_EDITOR_HELP,
+            EDIT_STATION_NAME_ERROR,
+            EDIT_STATION_URL_ERROR,
             )
 
     def __init__(self):