Improve editing values with {return} in text fields; Add hyperlink detection.

common/lib_tree_model_adapter.cpp

@@ -433,7 +433,7 @@ void LIB_TREE_MODEL_ADAPTER::FinishTreeInitialization()
     for( ; idx < m_columns.size() - 1; idx++ )
     {
         wxASSERT( m_colIdxMap.count( idx ) );
-    
+
         col    = m_columns[idx];
         header = m_colIdxMap[idx];
 
@@ -537,14 +537,15 @@ void LIB_TREE_MODEL_ADAPTER::GetValue( wxVariant&              aVariant,
 
     LIB_TREE_NODE* node = ToNode( aItem );
     wxCHECK( node, /* void */ );
+    wxString valueStr;
 
     switch( aCol )
     {
     case NAME_COL:
         if( node->m_Pinned )
-            aVariant = GetPinningSymbol() + UnescapeString( node->m_Name );
+            valueStr = GetPinningSymbol() + UnescapeString( node->m_Name );
         else
-            aVariant = UnescapeString( node->m_Name );
+            valueStr = UnescapeString( node->m_Name );
 
         break;
 
@@ -554,15 +555,19 @@ void LIB_TREE_MODEL_ADAPTER::GetValue( wxVariant&              aVariant,
             const wxString& key = m_colIdxMap.at( aCol );
 
             if( node->m_Fields.count( key ) )
-                aVariant = node->m_Fields.at( key );
+                valueStr = UnescapeString( node->m_Fields.at( key ) );
             else if( key == wxT( "Description" ) )
-                aVariant = node->m_Desc;
+                valueStr = UnescapeString( node->m_Desc );
             else
-                aVariant = wxEmptyString;
+                valueStr = wxEmptyString;
         }
 
         break;
     }
+
+    valueStr.Replace( wxS( "\n" ), wxS( " " ) ); // Clear line breaks
+
+    aVariant = valueStr;
 }
 
 

common/string_utils.cpp

@@ -33,6 +33,7 @@
 #include <richio.h>                        // StrPrintf
 #include <string_utils.h>
 #include <fmt/chrono.h>
+#include <wx/regex.h>
 
 
 /**
@@ -548,6 +549,26 @@ wxString UnescapeHTML( const wxString& aString )
 }
 
 
+wxString RemoveHTMLTags( const wxString& aInput )
+{
+    wxString str = aInput;
+    wxRegEx( wxS( "<[^>]*>" ) ).ReplaceAll( &str, wxEmptyString );
+
+    return str;
+}
+
+
+wxString LinkifyHTML( wxString aStr )
+{
+    wxRegEx regex( wxS( "\\b(https?|ftp|file)://([-\\w+&@#/%?=~|!:,.;]*[^.<>\\s\u00b6])" ),
+                   wxRE_ICASE );
+
+    regex.ReplaceAll( &aStr, "<a href=\"\\0\">\\0</a>" );
+
+    return aStr;
+}
+
+
 bool NoPrintableChars( const wxString& aString )
 {
     wxString tmp = aString;

eeschema/dialogs/dialog_field_properties.cpp

@@ -302,11 +302,11 @@ bool DIALOG_FIELD_PROPERTIES::TransferDataToWindow()
 {
     if( m_TextCtrl->IsShown() )
     {
-        m_TextCtrl->SetValue( m_text );
+        m_TextCtrl->SetValue( EscapeString( m_text, CTX_LINE ) );
     }
     else if( m_StyledTextCtrl->IsShown() )
     {
-        m_StyledTextCtrl->SetValue( m_text );
+        m_StyledTextCtrl->SetValue( EscapeString( m_text, CTX_LINE ) );
         m_StyledTextCtrl->EmptyUndoBuffer();
     }
 
@@ -349,9 +349,9 @@ bool DIALOG_FIELD_PROPERTIES::TransferDataToWindow()
 bool DIALOG_FIELD_PROPERTIES::TransferDataFromWindow()
 {
     if( m_TextCtrl->IsShown() )
-        m_text = m_TextCtrl->GetValue();
+        m_text = UnescapeString( m_TextCtrl->GetValue() );
     else if( m_StyledTextCtrl->IsShown() )
-        m_text = m_StyledTextCtrl->GetValue();
+        m_text = UnescapeString( m_StyledTextCtrl->GetValue() );
 
     if( m_fieldId == REFERENCE_FIELD )
     {

eeschema/fields_grid_table.cpp

@@ -561,7 +561,7 @@ wxString FIELDS_GRID_TABLE<T>::GetValue( int aRow, int aCol )
         }
 
     case FDC_VALUE:
-        return UnescapeString( field.GetText() );
+        return EscapeString( UnescapeString( field.GetText() ), CTX_LINE );
 
     case FDC_SHOWN:
         return StringFromBool( field.IsVisible() );
@@ -696,7 +696,7 @@ void FIELDS_GRID_TABLE<T>::SetValue( int aRow, int aCol, const wxString &aValue
             value = EscapeString( value, CTX_LIBID );
         }
 
-        field.SetText( value );
+        field.SetText( UnescapeString( value ) );
         break;
     }
 

eeschema/generate_alias_info.cpp

@@ -138,9 +138,15 @@ protected:
 
     void SetHtmlDesc()
     {
-        wxString raw_desc = m_symbol->GetDescription();
+        wxString esc_desc = EscapeHTML( UnescapeString( m_symbol->GetDescription() ) );
 
-        m_html.Replace( wxS( "__DESC__" ), wxString::Format( DescFormat, EscapeHTML( raw_desc ) ) );
+        // Add line breaks
+        esc_desc.Replace( wxS( "\n" ), wxS( "<br>" ) );
+
+        // Add links
+        esc_desc = LinkifyHTML( esc_desc );
+
+        m_html.Replace( wxS( "__DESC__" ), wxString::Format( DescFormat, esc_desc ) );
     }
 
 

eeschema/symbol_tree_synchronizing_adapter.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2017 CERN
- * Copyright (C) 2019-2022 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.txt for contributors.
  * @author Maciej Suminski <maciej.suminski@cern.ch>
  *
  * This program is free software; you can redistribute it and/or
@@ -279,12 +279,18 @@ void SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue( wxVariant& aVariant, wxDataVie
                 node->m_Desc = m_frame->GetCurSymbol()->GetDescription();
             }
 
+            wxString valueStr;
+
             if( node->m_Fields.count( key ) )
-                aVariant = node->m_Fields.at( key );
+                valueStr = node->m_Fields.at( key );
             else if( key == wxT( "Description" ) )
-                aVariant = node->m_Desc;
+                valueStr = node->m_Desc;
             else
-                aVariant = wxEmptyString;
+                valueStr = wxEmptyString;
+
+            valueStr.Replace( wxS( "\n" ), wxS( " " ) ); // Clear line breaks
+
+            aVariant = valueStr;
         }
         break;
     }

include/string_utils.h

@@ -129,6 +129,19 @@ KICOMMON_API wxString EscapeHTML( const wxString& aString );
  */
 KICOMMON_API wxString UnescapeHTML( const wxString& aString );
 
+/**
+ * Removes HTML tags from a string.
+ *
+ * Do not use for filtering potentially malicious inputs and rendering as HTML
+ * without escaping.
+ */
+KICOMMON_API wxString RemoveHTMLTags( const wxString& aInput );
+
+/**
+ * Wraps links in HTML <a href=""></a> tags.
+ */
+KICOMMON_API wxString LinkifyHTML( wxString aStr );
+
 /**
  * Read one line line from \a aFile.
  *

pcbnew/dialogs/dialog_footprint_properties_fp_editor.cpp

@@ -254,7 +254,7 @@ bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow()
 
     m_FootprintNameCtrl->ChangeValue( footprintName );
 
-    m_DocCtrl->SetValue( m_footprint->GetLibDescription() );
+    m_DocCtrl->SetValue( EscapeString( m_footprint->GetLibDescription(), CTX_LINE ) );
     m_KeywordCtrl->SetValue( m_footprint->GetKeywords() );
 
     if( !wxDialog::TransferDataToWindow() )
@@ -492,7 +492,7 @@ bool DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow()
     fpID.SetLibItemName( m_FootprintNameCtrl->GetValue() );
     m_footprint->SetFPID( fpID );
 
-    m_footprint->SetLibDescription( m_DocCtrl->GetValue() );
+    m_footprint->SetLibDescription( UnescapeString( m_DocCtrl->GetValue() ) );
     m_footprint->SetKeywords( m_KeywordCtrl->GetValue() );
 
     // Update fields

pcbnew/fp_tree_synchronizing_adapter.cpp

@@ -198,6 +198,7 @@ void FP_TREE_SYNCHRONIZING_ADAPTER::GetValue( wxVariant& aVariant, wxDataViewIte
     switch( aCol )
     {
     case NAME_COL:
+    {
         if( node->m_LibId == m_frame->GetLoadedFPID() && !m_frame->IsCurrentFPFromBoard() )
         {
             // Do not use GetLoadedFPID(); it returns m_footprintNameWhenLoaded.
@@ -220,8 +221,10 @@ void FP_TREE_SYNCHRONIZING_ADAPTER::GetValue( wxVariant& aVariant, wxDataViewIte
         }
 
         break;
+    }
 
     case DESC_COL:
+    {
         if( node->m_LibId == m_frame->GetLoadedFPID() && !m_frame->IsCurrentFPFromBoard() )
         {
             node->m_Desc = m_frame->GetBoard()->GetFirstFootprint()->GetLibDescription();
@@ -241,10 +244,14 @@ void FP_TREE_SYNCHRONIZING_ADAPTER::GetValue( wxVariant& aVariant, wxDataViewIte
             }
         }
 
-        aVariant = node->m_Desc;
+        wxString descStr = UnescapeString( node->m_Desc );
-        break;
+        descStr.Replace( wxS( "\n" ), wxS( " " ) ); // Clear line breaks
 
-    default:    // column == -1 is used for default Compare function
+        aVariant = descStr;
+        break;
+    }
+
+    default: // column == -1 is used for default Compare function
         aVariant = node->m_Name;
         break;
     }

pcbnew/generate_footprint_info.cpp

@@ -2,7 +2,7 @@
  * This program source code file is part of KiCad, a free EDA CAD application.
  *
  * Copyright (C) 2017 Chris Pavlina <pavlina.chris@gmail.com>
- * Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
+ * Copyright (C) 2017-2023 KiCad Developers, see AUTHORS.txt for contributors.
  *
  * This program is free software: you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -118,12 +118,18 @@ public:
 
                     doc += ch;
                 }
-
-                    desc.Replace( doc, _( "doc url" ) );
             }
 
+            wxString esc_desc = EscapeHTML( UnescapeString( desc ) );
+
+            // Add line breaks
+            esc_desc.Replace( wxS( "\n" ), wxS( "<br>" ) );
+
+            // Add links
+            esc_desc = LinkifyHTML( esc_desc );
+
+            m_html.Replace( "__DESC__", esc_desc );
             m_html.Replace( "__NAME__", EscapeHTML( name ) );
-            m_html.Replace( "__DESC__", EscapeHTML( desc ) );
 
             wxString keywordsHtml = KeywordsFormat;
             keywordsHtml.Replace( "__KEYWORDS__", EscapeHTML( keywords ) );