idlc/source/idlccompile.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <idlc.hxx>
  21 #include <rtl/alloc.h>
  22 #include <rtl/ustring.hxx>
  23 #include <rtl/strbuf.hxx>
  24 #include <o3tl/safeint.hxx>
  25 #include <o3tl/string_view.hxx>
  26 #include <osl/process.h>
  27 #include <osl/diagnose.h>
  28 #include <osl/thread.h>
  29 #include <osl/file.hxx>
  30
  31 #if defined(_WIN32)
  32 #include <io.h>
  33 #endif
  34
  35 #ifdef  SAL_UNX
  36 #include <errno.h>
  37 #include <unistd.h>
  38 #include <sys/wait.h>
  39 #endif
  40
  41 #include <string.h>
  42
  43 using namespace ::osl;
  44
  45 extern int yyparse();
  46 extern FILE* yyin;
  47 extern int yydebug;
  48
  49 static char tmpFilePattern[512];
  50
  51 bool isFileUrl(std::string_view fileName)
  52 {
  53     return o3tl::starts_with(fileName, "file://");
  54 }
  55
  56 OString convertToAbsoluteSystemPath(const OString& fileName)
  57 {
  58     OUString uSysFileName;
  59     OUString uFileName(fileName.getStr(), fileName.getLength(), osl_getThreadTextEncoding());
  60     if ( isFileUrl(fileName) )
  61     {
  62         if (FileBase::getSystemPathFromFileURL(uFileName, uSysFileName)
  63             != FileBase::E_None)
  64         {
  65             OSL_ASSERT(false);
  66         }
  67     } else
  68     {
  69         OUString uWorkingDir, uUrlFileName, uTmp;
  70         if (osl_getProcessWorkingDir(&uWorkingDir.pData) != osl_Process_E_None)
  71         {
  72             OSL_ASSERT(false);
  73         }
  74         if (FileBase::getFileURLFromSystemPath(uFileName, uTmp)
  75             != FileBase::E_None)
  76         {
  77             OSL_ASSERT(false);
  78         }
  79         if (FileBase::getAbsoluteFileURL(uWorkingDir, uTmp, uUrlFileName)
  80             != FileBase::E_None)
  81         {
  82             OSL_ASSERT(false);
  83         }
  84         if (FileBase::getSystemPathFromFileURL(uUrlFileName, uSysFileName)
  85             != FileBase::E_None)
  86         {
  87             OSL_ASSERT(false);
  88         }
  89     }
  90
  91     return OUStringToOString(uSysFileName, osl_getThreadTextEncoding());
  92 }
  93
  94 OString convertToFileUrl(const OString& fileName)
  95 {
  96     if ( !isFileUrl(fileName) )
  97     {
  98         OString tmp = convertToAbsoluteSystemPath(fileName);
  99         OUString uFileName(tmp.getStr(), tmp.getLength(), osl_getThreadTextEncoding());
 100         OUString uUrlFileName;
 101         if (FileBase::getFileURLFromSystemPath(uFileName, uUrlFileName)
 102             != FileBase::E_None)
 103         {
 104             OSL_ASSERT(false);
 105         }
 106         return OUStringToOString(uUrlFileName, osl_getThreadTextEncoding());
 107     }
 108
 109     return fileName;
 110 }
 111
 112 static OString makeTempName(const OString& prefix)
 113 {
 114     OUString uTmpPath;
 115     OString tmpPath;
 116
 117     if ( osl_getEnvironment(OUString("TMP").pData, &uTmpPath.pData) != osl_Process_E_None )
 118     {
 119         if ( osl_getEnvironment(OUString("TEMP").pData, &uTmpPath.pData) != osl_Process_E_None )
 120         {
 121 #if defined(_WIN32)
 122             tmpPath = OString("c:\\temp");
 123 #else
 124             tmpPath = OString("/tmp");
 125 #endif
 126         }
 127     }
 128
 129     if ( !uTmpPath.isEmpty() )
 130         tmpPath = OUStringToOString(uTmpPath, RTL_TEXTENCODING_UTF8);
 131
 132 #if defined(_WIN32) || defined(SAL_UNX)
 133
 134     OSL_ASSERT( sizeof(tmpFilePattern) >
 135                 o3tl::make_unsigned( tmpPath.getLength()
 136                            + RTL_CONSTASCII_LENGTH( PATH_SEPARATOR )
 137                            + prefix.getLength()
 138                            + RTL_CONSTASCII_LENGTH( "XXXXXX") ) );
 139
 140     tmpFilePattern[ sizeof(tmpFilePattern)-1 ] = '\0';
 141     strncpy(tmpFilePattern, tmpPath.getStr(), sizeof(tmpFilePattern)-1);
 142     strncat(tmpFilePattern, PATH_SEPARATOR, sizeof(tmpFilePattern)-1-strlen(tmpFilePattern));
 143     strncat(tmpFilePattern, prefix.getStr(), sizeof(tmpFilePattern)-1-strlen(tmpFilePattern));
 144     strncat(tmpFilePattern, "XXXXXX", sizeof(tmpFilePattern)-1-strlen(tmpFilePattern));
 145
 146 #ifdef SAL_UNX
 147     // coverity[secure_temp] - https://communities.coverity.com/thread/3179
 148     int nDescriptor = mkstemp(tmpFilePattern);
 149     if( -1 == nDescriptor )
 150     {
 151         fprintf(stderr, "idlc: mkstemp(\"%s\") failed: %s\n", tmpFilePattern, strerror(errno));
 152         exit( 1 );
 153     }
 154     // the file shall later be reopened by stdio functions
 155     close( nDescriptor );
 156 #else
 157     (void) mktemp(tmpFilePattern);
 158 #endif
 159 #endif
 160
 161     return tmpFilePattern;
 162 }
 163
 164 bool copyFile(const OString* source, const OString& target)
 165 {
 166     bool bRet = true;
 167
 168     FILE* pSource = source == nullptr ? stdin : fopen(source->getStr(), "rb");
 169     if ( !pSource )
 170         return false;
 171
 172     FILE* pTarget = fopen(target.getStr(), "wb");
 173     if ( !pTarget )
 174     {
 175         fclose(pSource);
 176         return false;
 177     }
 178
 179     size_t const totalSize = 512;
 180     char   pBuffer[totalSize + 1];
 181
 182     while ( !feof(pSource) )
 183     {
 184         size_t readSize = fread(pBuffer, 1, totalSize, pSource);
 185         if ( readSize > 0 && !ferror(pSource) )
 186         {
 187             if ( (fwrite(pBuffer, 1, readSize, pTarget)) != readSize || ferror(pTarget) )
 188             {
 189                 if (source != nullptr) {
 190                     fclose(pSource);
 191                 }
 192                 fclose(pTarget);
 193                 return false;
 194             }
 195         }
 196     }
 197
 198     if (source != nullptr) {
 199         fclose(pSource);
 200     }
 201     if ( fclose(pTarget) )
 202         bRet = false;
 203
 204     return bRet;
 205 }
 206
 207 sal_Int32 compileFile(const OString * pathname)
 208 {
 209     // preprocess input file
 210     OString tmpFile = makeTempName("idli_");
 211     OString preprocFile = makeTempName("idlf_");
 212
 213     OString fileName;
 214     if (pathname == nullptr) {
 215         fileName = "stdin";
 216     } else {
 217         fileName = *pathname;
 218     }
 219
 220     if ( !copyFile(pathname, tmpFile) )
 221     {
 222           fprintf(stderr, "%s: could not copy %s%s to %s\n",
 223                 idlc()->getOptions()->getProgramName().getStr(),
 224                 pathname == nullptr ? "" : "file ", fileName.getStr(),
 225                 tmpFile.getStr());
 226           exit(99);
 227     }
 228
 229     idlc()->setFileName(fileName);
 230     idlc()->setMainFileName(fileName);
 231     idlc()->setRealFileName(tmpFile);
 232
 233     ::std::vector< OUString> lCppArgs;
 234     lCppArgs.emplace_back("-DIDL");
 235     lCppArgs.emplace_back("-C");
 236 #ifdef SYSTEM_UCPP_IS_GCC
 237     // -nostdinc Do not search the standard system directories for header files
 238     lCppArgs.emplace_back("-nostdinc");
 239     // with gcc cpp, even when not explicitly including anything, /usr/include/stdc-predef.h
 240     // gets inserted without -nostdinc
 241 #else
 242     // -zI Do not use the standard (compile-time) include path.
 243     lCppArgs.emplace_back("-zI");
 244 #endif
 245
 246     Options* pOptions = idlc()->getOptions();
 247
 248     OString filePath;
 249     sal_Int32 index = fileName.lastIndexOf(SEPARATOR);
 250
 251     if ( index > 0)
 252     {
 253         filePath = fileName.copy(0, index);
 254
 255         if ( !filePath.isEmpty() )
 256         {
 257             OString cppArgs = "-I" + filePath;
 258             lCppArgs.push_back(OStringToOUString(
 259                 cppArgs.replace('\\', '/'),
 260                 RTL_TEXTENCODING_UTF8));
 261         }
 262     }
 263
 264     if ( pOptions->isValid("-D") )
 265     {
 266         OString token, dOpt = pOptions->getOption("-D");
 267         sal_Int32 nIndex = 0;
 268         do
 269         {
 270             token = dOpt.getToken( 0, ' ', nIndex );
 271             if (token.getLength())
 272                 lCppArgs.push_back("-D" + OStringToOUString(token, RTL_TEXTENCODING_UTF8));
 273         } while( nIndex != -1 );
 274     }
 275
 276     if ( pOptions->isValid("-I") )
 277     {
 278         OString token, incOpt = pOptions->getOption("-I");
 279         sal_Int32 nIndex = 0;
 280         do
 281         {
 282             token = incOpt.getToken( 0, ' ', nIndex );
 283             if (token.getLength())
 284                 lCppArgs.push_back("-I" + OStringToOUString(token, RTL_TEXTENCODING_UTF8));
 285         } while( nIndex != -1 );
 286     }
 287
 288     lCppArgs.emplace_back("-o");
 289
 290     lCppArgs.push_back(OStringToOUString(preprocFile, RTL_TEXTENCODING_UTF8));
 291
 292     lCppArgs.push_back(OStringToOUString(tmpFile, RTL_TEXTENCODING_UTF8));
 293
 294     OUString cpp;
 295     OUString startDir;
 296 #ifndef SYSTEM_UCPP
 297     if (osl_getExecutableFile(&cpp.pData) != osl_Process_E_None) {
 298         OSL_ASSERT(false);
 299     }
 300
 301     sal_Int32 idx= cpp.lastIndexOf("idlc");
 302     cpp = cpp.copy(0, idx);
 303
 304 #if defined(_WIN32)
 305     cpp += "ucpp.exe";
 306 #else
 307     cpp += "ucpp";
 308 #endif
 309 #else // SYSTEM_UCPP
 310     cpp = OUString(UCPP);
 311 #endif
 312     oslProcess      hProcess = nullptr;
 313     oslProcessError procError = osl_Process_E_None;
 314
 315     const int nCmdArgs = lCppArgs.size();
 316     std::unique_ptr<rtl_uString*[]> pCmdArgs(new rtl_uString*[nCmdArgs]);
 317
 318     int i = 0;
 319     for (auto const& elem : lCppArgs)
 320     {
 321         pCmdArgs[i++] = elem.pData;
 322     }
 323
 324     procError = osl_executeProcess( cpp.pData, pCmdArgs.get(), nCmdArgs, osl_Process_WAIT,
 325                                     nullptr, startDir.pData, nullptr, 0, &hProcess );
 326
 327     oslProcessInfo hInfo;
 328     hInfo.Size = sal_uInt32(sizeof(oslProcessInfo));
 329     if (osl_getProcessInfo(hProcess, osl_Process_EXITCODE, &hInfo)
 330         != osl_Process_E_None)
 331     {
 332         OSL_ASSERT(false);
 333     }
 334
 335     if ( procError || (hInfo.Code != 0) )
 336     {
 337         if ( procError != osl_Process_E_None )
 338             fprintf(stderr, "%s: starting preprocessor failed\n", pOptions->getProgramName().getStr());
 339         else
 340             fprintf(stderr, "%s: preprocessing %s%s failed\n",
 341                     pOptions->getProgramName().getStr(),
 342                     pathname == nullptr ? "" : "file ", fileName.getStr());
 343
 344         osl_freeProcessHandle(hProcess);
 345         exit(hInfo.Code ? hInfo.Code : 99);
 346     }
 347     osl_freeProcessHandle(hProcess);
 348
 349     if (unlink(tmpFile.getStr()) != 0)
 350     {
 351         fprintf(stderr, "%s: Could not remove cpp input file %s\n",
 352                  pOptions->getProgramName().getStr(), tmpFile.getStr());
 353         exit(99);
 354     }
 355
 356     if ( pOptions->isValid("-E") )
 357     {
 358         if (unlink(preprocFile.getStr()) != 0)
 359         {
 360             fprintf(stderr, "%s: Could not remove parser input file %s\n",
 361                        pOptions->getProgramName().getStr(), preprocFile.getStr());
 362             exit(99);
 363         }
 364         exit(0);
 365     }
 366
 367     // parse file
 368     yyin = fopen(preprocFile.getStr(), "r");
 369     if (yyin == nullptr)
 370     {
 371         fprintf(stderr, "%s: Could not open cpp output file %s\n",
 372                    pOptions->getProgramName().getStr(), preprocFile.getStr());
 373         exit(99);
 374     }
 375
 376     //yydebug = 0 no trace information
 377     //yydebug = 1 parser produce trace information
 378     yydebug = 0;
 379
 380     yyparse();
 381     sal_Int32 nErrors = idlc()->getErrorCount();
 382
 383     fclose(yyin);
 384     if (unlink(preprocFile.getStr()) != 0)
 385     {
 386         fprintf(stderr, "%s: Could not remove parser input file %s\n",
 387                 pOptions->getProgramName().getStr(), preprocFile.getStr());
 388         exit(99);
 389     }
 390
 391     return nErrors;
 392 }
 393
 394 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */