common.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2020 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
 * Copyright The 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 Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include <eda_base_frame.h>
#include <kiplatform/app.h>
#include <project.h>
#include <common.h>
#include <confirm.h>
#include <env_vars.h>
#include <advanced_config.h>
#include <reporter.h>
#include <macros.h>
#include <string_utils.h>
#include <text_eval/text_eval_wrapper.h>
#include <mutex>
#include <wx/config.h>
#include <wx/log.h>
#include <wx/msgdlg.h>
#include <wx/stdpaths.h>
#include <wx/url.h>
#include <wx/utils.h>
#include <wx/regex.h>

#ifdef _WIN32
#include <windows.h>
#endif


enum Bracket
{
    Bracket_None,
    Bracket_Normal = ')',
    Bracket_Curly = '}',
#ifdef __WINDOWS__
    Bracket_Windows = '%', // yeah, Windows people are a bit strange ;-)
#endif
    Bracket_Max
};

wxString ExpandTextVars( const wxString& aSource, const PROJECT* aProject, int aFlags )
{
    std::function<bool( wxString* )> projectResolver = [&]( wxString* token ) -> bool
    {
        return aProject->TextVarResolver( token );
    };

    return ExpandTextVars( aSource, &projectResolver, aFlags );
}


wxString ExpandTextVars( const wxString& aSource, const std::function<bool( wxString* )>* aResolver, int aFlags,
                         int aDepth )
{
    wxString newbuf;
    size_t   sourceLen = aSource.length();

    newbuf.Alloc( sourceLen ); // best guess (improves performance)

    // Get the maximum recursion depth from advanced config
    const int maxDepth = ADVANCED_CFG::GetCfg().m_ResolveTextRecursionDepth;

    for( size_t i = 0; i < sourceLen; ++i )
    {
        // Skip over existing escape markers without processing their contents
        // This prevents expanding ${} or @{} that are inside escaped expressions
        if( i + 14 <= sourceLen && aSource.Mid( i, 14 ) == wxT( "<<<ESC_DOLLAR:" ) )
        {
            // Copy the entire escape marker including contents until matching closing }
            newbuf.append( wxT( "<<<ESC_DOLLAR:" ) );
            i += 14;

            // Count braces to find the matching closing }
            int braceCount = 1;
            while( i < sourceLen && braceCount > 0 )
            {
                if( aSource[i] == '{' )
                    braceCount++;
                else if( aSource[i] == '}' )
                    braceCount--;

                newbuf.append( aSource[i] );
                i++;
            }
            i--; // Back up one since the for loop will increment
            continue;
        }
        else if( i + 10 <= sourceLen && aSource.Mid( i, 10 ) == wxT( "<<<ESC_AT:" ) )
        {
            // Copy the entire escape marker including contents until matching closing }
            newbuf.append( wxT( "<<<ESC_AT:" ) );
            i += 10;

            // Count braces to find the matching closing }
            int braceCount = 1;
            while( i < sourceLen && braceCount > 0 )
            {
                if( aSource[i] == '{' )
                    braceCount++;
                else if( aSource[i] == '}' )
                    braceCount--;

                newbuf.append( aSource[i] );
                i++;
            }
            i--; // Back up one since the for loop will increment
            continue;
        }

        // Handle escaped variable references: \${...} or \@{...}
        // Replace with escape markers that won't be expanded by multi-pass loops
        // The markers will be converted back to ${...} or @{...} only at the final display stage
        if( aSource[i] == '\\' && i + 1 < sourceLen )
        {
            if( ( aSource[i + 1] == '$' || aSource[i + 1] == '@' ) && i + 2 < sourceLen && aSource[i + 2] == '{' )
            {
                // Replace \${ with <<<ESC_DOLLAR: and \@{ with <<<ESC_AT:
                // Using unique delimiters without braces to avoid confusing the expression evaluator
                if( aSource[i + 1] == '$' )
                    newbuf.append( wxT( "<<<ESC_DOLLAR:" ) );
                else
                    newbuf.append( wxT( "<<<ESC_AT:" ) );
                i += 2;

                // Copy everything until the matching closing brace, including the brace
                int braceDepth = 1;
                for( i = i + 1; i < sourceLen && braceDepth > 0; ++i )
                {
                    if( aSource[i] == '{' )
                        braceDepth++;
                    else if( aSource[i] == '}' )
                        braceDepth--;

                    newbuf.append( aSource[i] );
                }
                i--; // Adjust because loop will increment
                continue;
            }
        }

        if( ( aSource[i] == '$' || aSource[i] == '@' ) && i + 1 < sourceLen && aSource[i + 1] == '{' )
        {
            bool     isMathExpr = ( aSource[i] == '@' );
            wxString token;
            int      braceDepth = 1; // Track brace depth for nested expressions like @{${VAR}}

            for( i = i + 2; i < sourceLen; ++i )
            {
                // Skip over escape markers - don't count their braces
                // This prevents <<<ESC_DOLLAR:X} from interfering with outer brace counting
                if( i + 14 <= sourceLen && aSource.Mid( i, 14 ) == wxT( "<<<ESC_DOLLAR:" ) )
                {
                    token.append( wxT( "<<<ESC_DOLLAR:" ) );
                    i += 14;

                    // Copy contents until matching closing brace (tracking nested braces)
                    int markerBraceCount = 1;

                    while( i < sourceLen && markerBraceCount > 0 )
                    {
                        if( aSource[i] == '{' )
                            markerBraceCount++;
                        else if( aSource[i] == '}' )
                            markerBraceCount--;

                        token.append( aSource[i] );
                        i++;
                    }

                    i--; // Adjust for outer loop increment
                    continue;
                }
                else if( i + 10 <= sourceLen && aSource.Mid( i, 10 ) == wxT( "<<<ESC_AT:" ) )
                {
                    token.append( wxT( "<<<ESC_AT:" ) );
                    i += 10;

                    // Copy contents until matching closing brace (tracking nested braces)
                    int markerBraceCount = 1;

                    while( i < sourceLen && markerBraceCount > 0 )
                    {
                        if( aSource[i] == '{' )
                            markerBraceCount++;
                        else if( aSource[i] == '}' )
                            markerBraceCount--;

                        token.append( aSource[i] );
                        i++;
                    }

                    i--; // Adjust for outer loop increment
                    continue;
                }

                if( aSource[i] == '{' )
                {
                    braceDepth++;
                    token.append( aSource[i] );
                }
                else if( aSource[i] == '}' )
                {
                    braceDepth--;

                    if( braceDepth == 0 )
                        break; // Found the matching closing brace
                    else
                        token.append( aSource[i] );
                }
                else
                {
                    token.append( aSource[i] );
                }
            }

            if( token.IsEmpty() )
                continue;

            // For math expressions @{...}, recursively expand any nested ${...} variables
            // but DON'T evaluate the math - leave that for EvaluateText() called by the user
            if( isMathExpr )
            {
                if( ( token.Contains( wxT( "${" ) ) || token.Contains( wxT( "@{" ) ) ) && aDepth < maxDepth )
                {
                    token = ExpandTextVars( token, aResolver, aFlags, aDepth + 1 );
                }

                // Return the expression with variables expanded but NOT evaluated
                // The caller will use EvaluateText() to handle the math evaluation
                newbuf.append( wxT( "@{" ) + token + wxT( "}" ) );
            }
            else // Variable reference ${...}
            {
                // Recursively expand nested variables BEFORE passing to resolver
                // This ensures innermost variables are expanded first (standard evaluation order)
                if( ( token.Contains( wxT( "${" ) ) || token.Contains( wxT( "@{" ) ) ) && aDepth < maxDepth )
                {
                    token = ExpandTextVars( token, aResolver, aFlags, aDepth + 1 );

                    // Also evaluate math expressions after expanding variables
                    if( token.Contains( wxT( "@{" ) ) )
                    {
                        static EXPRESSION_EVALUATOR evaluator;
                        token = evaluator.Evaluate( token );
                    }
                }

                if( ( aFlags & FOR_ERC_DRC ) == 0
                    && ( token.StartsWith( wxS( "ERC_WARNING" ) ) || token.StartsWith( wxS( "ERC_ERROR" ) )
                         || token.StartsWith( wxS( "DRC_WARNING" ) ) || token.StartsWith( wxS( "DRC_ERROR" ) ) ) )
                {
                    // Only show user-defined warnings/errors during ERC/DRC
                }
                else if( aResolver && ( *aResolver )( &token ) )
                {
                    newbuf.append( token );
                }
                else
                {
                    // Token not resolved: leave the reference unchanged
                    newbuf.append( "${" + token + "}" );
                }
            }
        }
        else
        {
            newbuf.append( aSource[i] );
        }
    }

    return newbuf;
}


wxString ResolveTextVars( const wxString& aSource, const std::function<bool( wxString* )>* aResolver, int& aDepth )
{
    // Multi-pass resolution to handle nested variables like ${J601:UNIT(${ROW})}
    // and math expressions like @{${ROW}-1}
    wxString  text = aSource;
    const int maxDepth = ADVANCED_CFG::GetCfg().m_ResolveTextRecursionDepth;

    static EXPRESSION_EVALUATOR evaluator;

    while( ( text.Contains( wxT( "${" ) ) || text.Contains( wxT( "@{" ) ) ) && ++aDepth <= maxDepth )
    {
        // Always expand when ${} or @{} present to handle escape sequences (\${} and \@{})
        // ExpandTextVars converts escapes to markers and expands ${} variables
        // Don't expand if the only remaining $ or @ are in escape markers like <<<ESC_DOLLAR: or <<<ESC_AT:
        if( text.Contains( wxT( "${" ) ) || text.Contains( wxT( "@{" ) ) )
            text = ExpandTextVars( text, aResolver );

        // Only evaluate if there are @{} expressions present (not escape markers)
        // Don't evaluate if the only remaining @ are in escape markers like <<<ESC_AT:
        if( text.Contains( wxT( "@{" ) ) )
            text = evaluator.Evaluate( text ); // Evaluate math expressions
    }

    return text;
}


wxString GetGeneratedFieldDisplayName( const wxString& aSource )
{
    std::function<bool( wxString* )> tokenExtractor = [&]( wxString* token ) -> bool
    {
        *token = *token; // token value is the token name
        return true;
    };

    return ExpandTextVars( aSource, &tokenExtractor );
}


bool IsGeneratedField( const wxString& aSource )
{
    static wxRegEx expr( wxS( "^\\$\\{\\w*\\}$" ) );
    return expr.Matches( aSource );
}


wxString DescribeRef( const wxString& aRef )
{
    if( aRef.IsEmpty() )
        return wxT( "<i>" ) + _( "unannotated footprint" ) + wxT( " </i>" );
    else
        return EscapeHTML( aRef );
}


//
// Stolen from wxExpandEnvVars and then heavily optimized
//
wxString KIwxExpandEnvVars( const wxString& str, const PROJECT* aProject, std::set<wxString>* aSet = nullptr )
{
    // If the same string is inserted twice, we have a loop
    if( aSet )
    {
        if( auto [_, result] = aSet->insert( str ); !result )
            return str;
    }

    size_t strlen = str.length();

    wxString strResult;
    strResult.Alloc( strlen ); // best guess (improves performance)

    auto getVersionedEnvVar = []( const wxString& aMatch, wxString& aResult ) -> bool
    {
        for( const wxString& var : ENV_VAR::GetPredefinedEnvVars() )
        {
            if( var.Matches( aMatch ) )
            {
                const auto value = ENV_VAR::GetEnvVar<wxString>( var );

                if( !value )
                    continue;

                aResult += *value;
                return true;
            }
        }

        return false;
    };

    for( size_t n = 0; n < strlen; n++ )
    {
        wxUniChar str_n = str[n];

        switch( str_n.GetValue() )
        {
#ifdef __WINDOWS__
        case wxT( '%' ):
#endif // __WINDOWS__
        case wxT( '$' ):
        {
            Bracket bracket;
#ifdef __WINDOWS__
            if( str_n == wxT( '%' ) )
            {
                bracket = Bracket_Windows;
            }
            else
#endif // __WINDOWS__
                if( n == strlen - 1 )
                {
                    bracket = Bracket_None;
                }
                else
                {
                    switch( str[n + 1].GetValue() )
                    {
                    case wxT( '(' ):
                        bracket = Bracket_Normal;
                        str_n = str[++n]; // skip the bracket
                        break;

                    case wxT( '{' ):
                        bracket = Bracket_Curly;
                        str_n = str[++n]; // skip the bracket
                        break;

                    default: bracket = Bracket_None;
                    }
                }

            size_t m = n + 1;

            if( m >= strlen )
                break;

            wxUniChar str_m = str[m];

            while( wxIsalnum( str_m ) || str_m == wxT( '_' ) || str_m == wxT( ':' ) )
            {
                if( ++m == strlen )
                {
                    str_m = 0;
                    break;
                }

                str_m = str[m];
            }

            wxString strVarName( str.c_str() + n + 1, m - n - 1 );

            // NB: use wxGetEnv instead of wxGetenv as otherwise variables
            //     set through wxSetEnv may not be read correctly!
            bool     expanded = false;
            wxString tmp = strVarName;

            if( aProject && aProject->TextVarResolver( &tmp ) )
            {
                strResult += tmp;
                expanded = true;
            }
            else if( wxGetEnv( strVarName, &tmp ) )
            {
                strResult += tmp;
                expanded = true;
            }
            // Replace unmatched older variables with current locations
            // If the user has the older location defined, that will be matched
            // first above.  But if they do not, this will ensure that their board still
            // displays correctly
            else if( strVarName.Contains( "KISYS3DMOD" ) || strVarName.Matches( "KICAD*_3DMODEL_DIR" ) )
            {
                if( getVersionedEnvVar( "KICAD*_3DMODEL_DIR", strResult ) )
                    expanded = true;
            }
            else if( strVarName.Matches( "KICAD*_SYMBOL_DIR" ) )
            {
                if( getVersionedEnvVar( "KICAD*_SYMBOL_DIR", strResult ) )
                    expanded = true;
            }
            else if( strVarName.Matches( "KICAD*_FOOTPRINT_DIR" ) )
            {
                if( getVersionedEnvVar( "KICAD*_FOOTPRINT_DIR", strResult ) )
                    expanded = true;
            }
            else if( strVarName.Matches( "KICAD*_3RD_PARTY" ) )
            {
                if( getVersionedEnvVar( "KICAD*_3RD_PARTY", strResult ) )
                    expanded = true;
            }
            else
            {
                // variable doesn't exist => don't change anything
#ifdef __WINDOWS__
                if( bracket != Bracket_Windows )
#endif
                    if( bracket != Bracket_None )
                        strResult << str[n - 1];

                strResult << str_n << strVarName;
            }

            // check the closing bracket
            if( bracket != Bracket_None )
            {
                if( m == strlen || str_m != (wxChar) bracket )
                {
                    // under MSW it's common to have '%' characters in the registry
                    // and it's annoying to have warnings about them each time, so
                    // ignore them silently if they are not used for env vars
                    //
                    // under Unix, OTOH, this warning could be useful for the user to
                    // understand why isn't the variable expanded as intended
#ifndef __WINDOWS__
                    wxLogWarning( _( "Environment variables expansion failed: missing '%c' "
                                     "at position %u in '%s'." ),
                                  (char) bracket, (unsigned int) ( m + 1 ), str.c_str() );
#endif // __WINDOWS__
                }
                else
                {
                    // skip closing bracket unless the variables wasn't expanded
                    if( !expanded )
                        strResult << (wxChar) bracket;

                    m++;
                }
            }

            n = m - 1; // skip variable name
            str_n = str[n];
        }
        break;

        case wxT( '\\' ):
            // backslash can be used to suppress special meaning of % and $
            if( n < strlen - 1 && ( str[n + 1] == wxT( '%' ) || str[n + 1] == wxT( '$' ) ) )
            {
                str_n = str[++n];
                strResult += str_n;

                break;
            }

            KI_FALLTHROUGH;

        default: strResult += str_n;
        }
    }

    std::set<wxString> loop_check;
    auto               first_pos = strResult.find_first_of( wxS( "{(%" ) );
    auto               last_pos = strResult.find_last_of( wxS( "})%" ) );

    if( first_pos != strResult.npos && last_pos != strResult.npos && first_pos != last_pos )
        strResult = KIwxExpandEnvVars( strResult, aProject, aSet ? aSet : &loop_check );

    return strResult;
}


const wxString ExpandEnvVarSubstitutions( const wxString& aString, const PROJECT* aProject )
{
    // wxGetenv( wchar_t* ) is not re-entrant on linux.
    // Put a lock on multithreaded use of wxGetenv( wchar_t* ), called from wxEpandEnvVars(),
    static std::mutex getenv_mutex;

    std::lock_guard<std::mutex> lock( getenv_mutex );

    // We reserve the right to do this another way, by providing our own member function.
    return KIwxExpandEnvVars( aString, aProject );
}


const wxString ResolveUriByEnvVars( const wxString& aUri, const PROJECT* aProject )
{
    wxString uri = ExpandTextVars( aUri, aProject );

    return ExpandEnvVarSubstitutions( uri, aProject );
}


bool EnsureFileDirectoryExists( wxFileName* aTargetFullFileName, const wxString& aBaseFilename, REPORTER* aReporter )
{
    wxString msg;
    wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();

    // make aTargetFullFileName path, which is relative to aBaseFilename path (if it is not
    // already an absolute path) absolute:
    if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
    {
        if( aReporter )
        {
            msg.Printf( _( "Cannot make path '%s' absolute with respect to '%s'." ), aTargetFullFileName->GetPath(),
                        baseFilePath );
            aReporter->Report( msg, RPT_SEVERITY_ERROR );
        }

        return false;
    }

    // Ensure the path of aTargetFullFileName exists, and create it if needed:
    wxString outputPath( aTargetFullFileName->GetPath() );

    if( !wxFileName::DirExists( outputPath ) )
    {
        // Make every directory provided when the provided path doesn't exist
        if( wxFileName::Mkdir( outputPath, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
        {
            if( aReporter )
            {
                msg.Printf( _( "Output directory '%s' created." ), outputPath );
                aReporter->Report( msg, RPT_SEVERITY_INFO );
                return true;
            }
        }
        else
        {
            if( aReporter )
            {
                msg.Printf( _( "Cannot create output directory '%s'." ), outputPath );
                aReporter->Report( msg, RPT_SEVERITY_ERROR );
            }

            return false;
        }
    }

    return true;
}


wxString EnsureFileExtension( const wxString& aFilename, const wxString& aExtension )
{
    wxString newFilename( aFilename );

    // It's annoying to throw up nag dialogs when the extension isn't right.  Just fix it,
    // but be careful not to destroy existing after-dot-text that isn't actually a bad
    // extension, such as "Schematic_1.1".
    if( newFilename.Lower().AfterLast( '.' ) != aExtension )
    {
        if( !newFilename.EndsWith( '.' ) )
            newFilename.Append( '.' );

        newFilename.Append( aExtension );
    }

    return newFilename;
}


wxString JoinExtensions( const std::vector<std::string>& aExts )
{
    wxString joined;

    for( const std::string& ext : aExts )
    {
        if( !joined.empty() )
            joined << wxS( ", " );

        joined << wxS( "*." ) << ext;
    }

    return joined;
}


/**
 * Performance enhancements to file and directory operations.
 *
 * Note: while it's annoying to have to make copies of wxWidgets stuff and then
 * add platform-specific performance optimizations, the following routines offer
 * SIGNIFICANT performance benefits.
 */

/**
 * A copy of wxMatchWild(), which wxWidgets attributes to Douglas A. Lewis
 * <dalewis@cs.Buffalo.EDU> and ircII's reg.c.
 *
 * This version is modified to skip any encoding conversions (for performance).
 */
bool matchWild( const char* pat, const char* text, bool dot_special )
{
    if( !*text )
    {
        /* Match if both are empty. */
        return !*pat;
    }

    const char *m = pat, *n = text, *ma = nullptr, *na = nullptr;
    int         just = 0, acount = 0, count = 0;

    if( dot_special && ( *n == '.' ) )
    {
        /* Never match so that hidden Unix files
         * are never found. */
        return false;
    }

    for( ;; )
    {
        if( *m == '*' )
        {
            ma = ++m;
            na = n;
            just = 1;
            acount = count;
        }
        else if( *m == '?' )
        {
            m++;

            if( !*n++ )
                return false;
        }
        else
        {
            if( *m == '\\' )
            {
                m++;

                /* Quoting "nothing" is a bad thing */
                if( !*m )
                    return false;
            }

            if( !*m )
            {
                /*
                * If we are out of both strings or we just
                * saw a wildcard, then we can say we have a
                * match
                */
                if( !*n )
                    return true;

                if( just )
                    return true;

                just = 0;
                goto not_matched;
            }

            /*
            * We could check for *n == NULL at this point, but
            * since it's more common to have a character there,
            * check to see if they match first (m and n) and
            * then if they don't match, THEN we can check for
            * the NULL of n
            */
            just = 0;

            if( *m == *n )
            {
                m++;
                count++;
                n++;
            }
            else
            {
            not_matched:

                /*
                 * If there are no more characters in the
                 * string, but we still need to find another
                 * character (*m != NULL), then it will be
                 * impossible to match it
                 */
                if( !*n )
                    return false;

                if( ma )
                {
                    m = ma;
                    n = ++na;
                    count = acount;
                }
                else
                    return false;
            }
        }
    }
}


bool WarnUserIfOperatingSystemUnsupported()
{
    if( !KIPLATFORM::APP::IsOperatingSystemUnsupported() )
        return false;

    KICAD_MESSAGE_DIALOG dialog( nullptr,
                                 _( "This operating system is not supported "
                                    "by KiCad and its dependencies." ),
                                 _( "Unsupported Operating System" ), wxOK | wxICON_EXCLAMATION );

    dialog.SetExtendedMessage( _( "Any issues with KiCad on this system cannot "
                                  "be reported to the official bugtracker." ) );
    dialog.ShowModal();

    return true;
}