cmFileCommand.cxx 115 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #include "cmFileCommand.h"
  4. #include <algorithm>
  5. #include <cassert>
  6. #include <cctype>
  7. #include <cmath>
  8. #include <cstdio>
  9. #include <cstdlib>
  10. #include <map>
  11. #include <set>
  12. #include <sstream>
  13. #include <utility>
  14. #include <vector>
  15. #include <cm/memory>
  16. #include <cm/string_view>
  17. #include <cmext/algorithm>
  18. #include <cmext/string_view>
  19. #include <cm3p/kwiml/int.h>
  20. #include "cmsys/FStream.hxx"
  21. #include "cmsys/Glob.hxx"
  22. #include "cmsys/RegularExpression.hxx"
  23. #include "cm_sys_stat.h"
  24. #include "cmAlgorithms.h"
  25. #include "cmArgumentParser.h"
  26. #include "cmCMakePath.h"
  27. #include "cmCryptoHash.h"
  28. #include "cmExecutionStatus.h"
  29. #include "cmFSPermissions.h"
  30. #include "cmFileCopier.h"
  31. #include "cmFileInstaller.h"
  32. #include "cmFileLockPool.h"
  33. #include "cmFileTimes.h"
  34. #include "cmGeneratedFileStream.h"
  35. #include "cmGeneratorExpression.h"
  36. #include "cmGlobalGenerator.h"
  37. #include "cmHexFileConverter.h"
  38. #include "cmListFileCache.h"
  39. #include "cmMakefile.h"
  40. #include "cmMessageType.h"
  41. #include "cmNewLineStyle.h"
  42. #include "cmPolicies.h"
  43. #include "cmProperty.h"
  44. #include "cmRange.h"
  45. #include "cmRuntimeDependencyArchive.h"
  46. #include "cmState.h"
  47. #include "cmStringAlgorithms.h"
  48. #include "cmSubcommandTable.h"
  49. #include "cmSystemTools.h"
  50. #include "cmTimestamp.h"
  51. #include "cmWorkingDirectory.h"
  52. #include "cmake.h"
  53. #if !defined(CMAKE_BOOTSTRAP)
  54. # include <cm3p/curl/curl.h>
  55. # include "cmCurl.h"
  56. # include "cmFileLockResult.h"
  57. #endif
  58. #if defined(CMake_USE_ELF_PARSER)
  59. # include "cmELF.h"
  60. #endif
  61. #if defined(_WIN32)
  62. # include <windows.h>
  63. #endif
  64. namespace {
  65. #if defined(_WIN32)
  66. // libcurl doesn't support file:// urls for unicode filenames on Windows.
  67. // Convert string from UTF-8 to ACP if this is a file:// URL.
  68. std::string fix_file_url_windows(const std::string& url)
  69. {
  70. std::string ret = url;
  71. if (strncmp(url.c_str(), "file://", 7) == 0) {
  72. std::wstring wurl = cmsys::Encoding::ToWide(url);
  73. if (!wurl.empty()) {
  74. int mblen =
  75. WideCharToMultiByte(CP_ACP, 0, wurl.c_str(), -1, NULL, 0, NULL, NULL);
  76. if (mblen > 0) {
  77. std::vector<char> chars(mblen);
  78. mblen = WideCharToMultiByte(CP_ACP, 0, wurl.c_str(), -1, &chars[0],
  79. mblen, NULL, NULL);
  80. if (mblen > 0) {
  81. ret = &chars[0];
  82. }
  83. }
  84. }
  85. }
  86. return ret;
  87. }
  88. #endif
  89. bool HandleWriteImpl(std::vector<std::string> const& args, bool append,
  90. cmExecutionStatus& status)
  91. {
  92. auto i = args.begin();
  93. i++; // Get rid of subcommand
  94. std::string fileName = *i;
  95. if (!cmsys::SystemTools::FileIsFullPath(*i)) {
  96. fileName =
  97. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', *i);
  98. }
  99. i++;
  100. if (!status.GetMakefile().CanIWriteThisFile(fileName)) {
  101. std::string e =
  102. "attempted to write a file: " + fileName + " into a source directory.";
  103. status.SetError(e);
  104. cmSystemTools::SetFatalErrorOccured();
  105. return false;
  106. }
  107. std::string dir = cmSystemTools::GetFilenamePath(fileName);
  108. cmSystemTools::MakeDirectory(dir);
  109. mode_t mode = 0;
  110. bool writable = false;
  111. // Set permissions to writable
  112. if (cmSystemTools::GetPermissions(fileName, mode)) {
  113. #if defined(_MSC_VER) || defined(__MINGW32__)
  114. writable = (mode & S_IWRITE) != 0;
  115. mode_t newMode = mode | S_IWRITE;
  116. #else
  117. writable = mode & S_IWUSR;
  118. mode_t newMode = mode | S_IWUSR | S_IWGRP;
  119. #endif
  120. if (!writable) {
  121. cmSystemTools::SetPermissions(fileName, newMode);
  122. }
  123. }
  124. // If GetPermissions fails, pretend like it is ok. File open will fail if
  125. // the file is not writable
  126. cmsys::ofstream file(fileName.c_str(),
  127. append ? std::ios::app : std::ios::out);
  128. if (!file) {
  129. std::string error =
  130. cmStrCat("failed to open for writing (",
  131. cmSystemTools::GetLastSystemError(), "):\n ", fileName);
  132. status.SetError(error);
  133. return false;
  134. }
  135. std::string message = cmJoin(cmMakeRange(i, args.end()), std::string());
  136. file << message;
  137. if (!file) {
  138. std::string error =
  139. cmStrCat("write failed (", cmSystemTools::GetLastSystemError(), "):\n ",
  140. fileName);
  141. status.SetError(error);
  142. return false;
  143. }
  144. file.close();
  145. if (mode && !writable) {
  146. cmSystemTools::SetPermissions(fileName, mode);
  147. }
  148. return true;
  149. }
  150. bool HandleWriteCommand(std::vector<std::string> const& args,
  151. cmExecutionStatus& status)
  152. {
  153. return HandleWriteImpl(args, false, status);
  154. }
  155. bool HandleAppendCommand(std::vector<std::string> const& args,
  156. cmExecutionStatus& status)
  157. {
  158. return HandleWriteImpl(args, true, status);
  159. }
  160. bool HandleReadCommand(std::vector<std::string> const& args,
  161. cmExecutionStatus& status)
  162. {
  163. if (args.size() < 3) {
  164. status.SetError("READ must be called with at least two additional "
  165. "arguments");
  166. return false;
  167. }
  168. std::string const& fileNameArg = args[1];
  169. std::string const& variable = args[2];
  170. struct Arguments
  171. {
  172. std::string Offset;
  173. std::string Limit;
  174. bool Hex = false;
  175. };
  176. static auto const parser = cmArgumentParser<Arguments>{}
  177. .Bind("OFFSET"_s, &Arguments::Offset)
  178. .Bind("LIMIT"_s, &Arguments::Limit)
  179. .Bind("HEX"_s, &Arguments::Hex);
  180. Arguments const arguments = parser.Parse(cmMakeRange(args).advance(3));
  181. std::string fileName = fileNameArg;
  182. if (!cmsys::SystemTools::FileIsFullPath(fileName)) {
  183. fileName = cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/',
  184. fileNameArg);
  185. }
  186. // Open the specified file.
  187. #if defined(_WIN32) || defined(__CYGWIN__)
  188. cmsys::ifstream file(fileName.c_str(),
  189. arguments.Hex ? (std::ios::binary | std::ios::in)
  190. : std::ios::in);
  191. #else
  192. cmsys::ifstream file(fileName.c_str());
  193. #endif
  194. if (!file) {
  195. std::string error =
  196. cmStrCat("failed to open for reading (",
  197. cmSystemTools::GetLastSystemError(), "):\n ", fileName);
  198. status.SetError(error);
  199. return false;
  200. }
  201. // is there a limit?
  202. long sizeLimit = -1;
  203. if (!arguments.Limit.empty()) {
  204. sizeLimit = atoi(arguments.Limit.c_str());
  205. }
  206. // is there an offset?
  207. long offset = 0;
  208. if (!arguments.Offset.empty()) {
  209. offset = atoi(arguments.Offset.c_str());
  210. }
  211. file.seekg(offset, std::ios::beg); // explicit ios::beg for IBM VisualAge 6
  212. std::string output;
  213. if (arguments.Hex) {
  214. // Convert part of the file into hex code
  215. char c;
  216. while ((sizeLimit != 0) && (file.get(c))) {
  217. char hex[4];
  218. sprintf(hex, "%.2x", c & 0xff);
  219. output += hex;
  220. if (sizeLimit > 0) {
  221. sizeLimit--;
  222. }
  223. }
  224. } else {
  225. std::string line;
  226. bool has_newline = false;
  227. while (
  228. sizeLimit != 0 &&
  229. cmSystemTools::GetLineFromStream(file, line, &has_newline, sizeLimit)) {
  230. if (sizeLimit > 0) {
  231. sizeLimit = sizeLimit - static_cast<long>(line.size());
  232. if (has_newline) {
  233. sizeLimit--;
  234. }
  235. if (sizeLimit < 0) {
  236. sizeLimit = 0;
  237. }
  238. }
  239. output += line;
  240. if (has_newline) {
  241. output += "\n";
  242. }
  243. }
  244. }
  245. status.GetMakefile().AddDefinition(variable, output);
  246. return true;
  247. }
  248. bool HandleHashCommand(std::vector<std::string> const& args,
  249. cmExecutionStatus& status)
  250. {
  251. #if !defined(CMAKE_BOOTSTRAP)
  252. if (args.size() != 3) {
  253. status.SetError(
  254. cmStrCat(args[0], " requires a file name and output variable"));
  255. return false;
  256. }
  257. std::unique_ptr<cmCryptoHash> hash(cmCryptoHash::New(args[0]));
  258. if (hash) {
  259. std::string out = hash->HashFile(args[1]);
  260. if (!out.empty()) {
  261. status.GetMakefile().AddDefinition(args[2], out);
  262. return true;
  263. }
  264. status.SetError(cmStrCat(args[0], " failed to read file \"", args[1],
  265. "\": ", cmSystemTools::GetLastSystemError()));
  266. }
  267. return false;
  268. #else
  269. status.SetError(cmStrCat(args[0], " not available during bootstrap"));
  270. return false;
  271. #endif
  272. }
  273. bool HandleStringsCommand(std::vector<std::string> const& args,
  274. cmExecutionStatus& status)
  275. {
  276. if (args.size() < 3) {
  277. status.SetError("STRINGS requires a file name and output variable");
  278. return false;
  279. }
  280. // Get the file to read.
  281. std::string fileName = args[1];
  282. if (!cmsys::SystemTools::FileIsFullPath(fileName)) {
  283. fileName =
  284. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', args[1]);
  285. }
  286. // Get the variable in which to store the results.
  287. std::string outVar = args[2];
  288. // Parse the options.
  289. enum
  290. {
  291. arg_none,
  292. arg_limit_input,
  293. arg_limit_output,
  294. arg_limit_count,
  295. arg_length_minimum,
  296. arg_length_maximum,
  297. arg_maximum,
  298. arg_regex,
  299. arg_encoding
  300. };
  301. unsigned int minlen = 0;
  302. unsigned int maxlen = 0;
  303. int limit_input = -1;
  304. int limit_output = -1;
  305. unsigned int limit_count = 0;
  306. cmsys::RegularExpression regex;
  307. bool have_regex = false;
  308. bool newline_consume = false;
  309. bool hex_conversion_enabled = true;
  310. enum
  311. {
  312. encoding_none = cmsys::FStream::BOM_None,
  313. encoding_utf8 = cmsys::FStream::BOM_UTF8,
  314. encoding_utf16le = cmsys::FStream::BOM_UTF16LE,
  315. encoding_utf16be = cmsys::FStream::BOM_UTF16BE,
  316. encoding_utf32le = cmsys::FStream::BOM_UTF32LE,
  317. encoding_utf32be = cmsys::FStream::BOM_UTF32BE
  318. };
  319. int encoding = encoding_none;
  320. int arg_mode = arg_none;
  321. for (unsigned int i = 3; i < args.size(); ++i) {
  322. if (args[i] == "LIMIT_INPUT") {
  323. arg_mode = arg_limit_input;
  324. } else if (args[i] == "LIMIT_OUTPUT") {
  325. arg_mode = arg_limit_output;
  326. } else if (args[i] == "LIMIT_COUNT") {
  327. arg_mode = arg_limit_count;
  328. } else if (args[i] == "LENGTH_MINIMUM") {
  329. arg_mode = arg_length_minimum;
  330. } else if (args[i] == "LENGTH_MAXIMUM") {
  331. arg_mode = arg_length_maximum;
  332. } else if (args[i] == "REGEX") {
  333. arg_mode = arg_regex;
  334. } else if (args[i] == "NEWLINE_CONSUME") {
  335. newline_consume = true;
  336. arg_mode = arg_none;
  337. } else if (args[i] == "NO_HEX_CONVERSION") {
  338. hex_conversion_enabled = false;
  339. arg_mode = arg_none;
  340. } else if (args[i] == "ENCODING") {
  341. arg_mode = arg_encoding;
  342. } else if (arg_mode == arg_limit_input) {
  343. if (sscanf(args[i].c_str(), "%d", &limit_input) != 1 ||
  344. limit_input < 0) {
  345. status.SetError(cmStrCat("STRINGS option LIMIT_INPUT value \"",
  346. args[i], "\" is not an unsigned integer."));
  347. return false;
  348. }
  349. arg_mode = arg_none;
  350. } else if (arg_mode == arg_limit_output) {
  351. if (sscanf(args[i].c_str(), "%d", &limit_output) != 1 ||
  352. limit_output < 0) {
  353. status.SetError(cmStrCat("STRINGS option LIMIT_OUTPUT value \"",
  354. args[i], "\" is not an unsigned integer."));
  355. return false;
  356. }
  357. arg_mode = arg_none;
  358. } else if (arg_mode == arg_limit_count) {
  359. int count;
  360. if (sscanf(args[i].c_str(), "%d", &count) != 1 || count < 0) {
  361. status.SetError(cmStrCat("STRINGS option LIMIT_COUNT value \"",
  362. args[i], "\" is not an unsigned integer."));
  363. return false;
  364. }
  365. limit_count = count;
  366. arg_mode = arg_none;
  367. } else if (arg_mode == arg_length_minimum) {
  368. int len;
  369. if (sscanf(args[i].c_str(), "%d", &len) != 1 || len < 0) {
  370. status.SetError(cmStrCat("STRINGS option LENGTH_MINIMUM value \"",
  371. args[i], "\" is not an unsigned integer."));
  372. return false;
  373. }
  374. minlen = len;
  375. arg_mode = arg_none;
  376. } else if (arg_mode == arg_length_maximum) {
  377. int len;
  378. if (sscanf(args[i].c_str(), "%d", &len) != 1 || len < 0) {
  379. status.SetError(cmStrCat("STRINGS option LENGTH_MAXIMUM value \"",
  380. args[i], "\" is not an unsigned integer."));
  381. return false;
  382. }
  383. maxlen = len;
  384. arg_mode = arg_none;
  385. } else if (arg_mode == arg_regex) {
  386. if (!regex.compile(args[i])) {
  387. status.SetError(cmStrCat("STRINGS option REGEX value \"", args[i],
  388. "\" could not be compiled."));
  389. return false;
  390. }
  391. have_regex = true;
  392. arg_mode = arg_none;
  393. } else if (arg_mode == arg_encoding) {
  394. if (args[i] == "UTF-8") {
  395. encoding = encoding_utf8;
  396. } else if (args[i] == "UTF-16LE") {
  397. encoding = encoding_utf16le;
  398. } else if (args[i] == "UTF-16BE") {
  399. encoding = encoding_utf16be;
  400. } else if (args[i] == "UTF-32LE") {
  401. encoding = encoding_utf32le;
  402. } else if (args[i] == "UTF-32BE") {
  403. encoding = encoding_utf32be;
  404. } else {
  405. status.SetError(cmStrCat("STRINGS option ENCODING \"", args[i],
  406. "\" not recognized."));
  407. return false;
  408. }
  409. arg_mode = arg_none;
  410. } else {
  411. status.SetError(
  412. cmStrCat("STRINGS given unknown argument \"", args[i], "\""));
  413. return false;
  414. }
  415. }
  416. if (hex_conversion_enabled) {
  417. // TODO: should work without temp file, but just on a memory buffer
  418. std::string binaryFileName =
  419. cmStrCat(status.GetMakefile().GetCurrentBinaryDirectory(),
  420. "/CMakeFiles/FileCommandStringsBinaryFile");
  421. if (cmHexFileConverter::TryConvert(fileName, binaryFileName)) {
  422. fileName = binaryFileName;
  423. }
  424. }
  425. // Open the specified file.
  426. #if defined(_WIN32) || defined(__CYGWIN__)
  427. cmsys::ifstream fin(fileName.c_str(), std::ios::in | std::ios::binary);
  428. #else
  429. cmsys::ifstream fin(fileName.c_str());
  430. #endif
  431. if (!fin) {
  432. status.SetError(
  433. cmStrCat("STRINGS file \"", fileName, "\" cannot be read."));
  434. return false;
  435. }
  436. // If BOM is found and encoding was not specified, use the BOM
  437. int bom_found = cmsys::FStream::ReadBOM(fin);
  438. if (encoding == encoding_none && bom_found != cmsys::FStream::BOM_None) {
  439. encoding = bom_found;
  440. }
  441. unsigned int bytes_rem = 0;
  442. if (encoding == encoding_utf16le || encoding == encoding_utf16be) {
  443. bytes_rem = 1;
  444. }
  445. if (encoding == encoding_utf32le || encoding == encoding_utf32be) {
  446. bytes_rem = 3;
  447. }
  448. // Parse strings out of the file.
  449. int output_size = 0;
  450. std::vector<std::string> strings;
  451. std::string s;
  452. while ((!limit_count || strings.size() < limit_count) &&
  453. (limit_input < 0 || static_cast<int>(fin.tellg()) < limit_input) &&
  454. fin) {
  455. std::string current_str;
  456. int c = fin.get();
  457. for (unsigned int i = 0; i < bytes_rem; ++i) {
  458. int c1 = fin.get();
  459. if (!fin) {
  460. fin.putback(static_cast<char>(c1));
  461. break;
  462. }
  463. c = (c << 8) | c1;
  464. }
  465. if (encoding == encoding_utf16le) {
  466. c = ((c & 0xFF) << 8) | ((c & 0xFF00) >> 8);
  467. } else if (encoding == encoding_utf32le) {
  468. c = (((c & 0xFF) << 24) | ((c & 0xFF00) << 8) | ((c & 0xFF0000) >> 8) |
  469. ((c & 0xFF000000) >> 24));
  470. }
  471. if (c == '\r') {
  472. // Ignore CR character to make output always have UNIX newlines.
  473. continue;
  474. }
  475. if (c >= 0 && c <= 0xFF &&
  476. (isprint(c) || c == '\t' || (c == '\n' && newline_consume))) {
  477. // This is an ASCII character that may be part of a string.
  478. // Cast added to avoid compiler warning. Cast is ok because
  479. // c is guaranteed to fit in char by the above if...
  480. current_str += static_cast<char>(c);
  481. } else if (encoding == encoding_utf8) {
  482. // Check for UTF-8 encoded string (up to 4 octets)
  483. static const unsigned char utf8_check_table[3][2] = {
  484. { 0xE0, 0xC0 },
  485. { 0xF0, 0xE0 },
  486. { 0xF8, 0xF0 },
  487. };
  488. // how many octets are there?
  489. unsigned int num_utf8_bytes = 0;
  490. for (unsigned int j = 0; num_utf8_bytes == 0 && j < 3; j++) {
  491. if ((c & utf8_check_table[j][0]) == utf8_check_table[j][1]) {
  492. num_utf8_bytes = j + 2;
  493. }
  494. }
  495. // get subsequent octets and check that they are valid
  496. for (unsigned int j = 0; j < num_utf8_bytes; j++) {
  497. if (j != 0) {
  498. c = fin.get();
  499. if (!fin || (c & 0xC0) != 0x80) {
  500. fin.putback(static_cast<char>(c));
  501. break;
  502. }
  503. }
  504. current_str += static_cast<char>(c);
  505. }
  506. // if this was an invalid utf8 sequence, discard the data, and put
  507. // back subsequent characters
  508. if ((current_str.length() != num_utf8_bytes)) {
  509. for (unsigned int j = 0; j < current_str.size() - 1; j++) {
  510. fin.putback(current_str[current_str.size() - 1 - j]);
  511. }
  512. current_str.clear();
  513. }
  514. }
  515. if (c == '\n' && !newline_consume) {
  516. // The current line has been terminated. Check if the current
  517. // string matches the requirements. The length may now be as
  518. // low as zero since blank lines are allowed.
  519. if (s.length() >= minlen && (!have_regex || regex.find(s))) {
  520. output_size += static_cast<int>(s.size()) + 1;
  521. if (limit_output >= 0 && output_size >= limit_output) {
  522. s.clear();
  523. break;
  524. }
  525. strings.push_back(s);
  526. }
  527. // Reset the string to empty.
  528. s.clear();
  529. } else if (current_str.empty()) {
  530. // A non-string character has been found. Check if the current
  531. // string matches the requirements. We require that the length
  532. // be at least one no matter what the user specified.
  533. if (s.length() >= minlen && !s.empty() &&
  534. (!have_regex || regex.find(s))) {
  535. output_size += static_cast<int>(s.size()) + 1;
  536. if (limit_output >= 0 && output_size >= limit_output) {
  537. s.clear();
  538. break;
  539. }
  540. strings.push_back(s);
  541. }
  542. // Reset the string to empty.
  543. s.clear();
  544. } else {
  545. s += current_str;
  546. }
  547. if (maxlen > 0 && s.size() == maxlen) {
  548. // Terminate a string if the maximum length is reached.
  549. if (s.length() >= minlen && (!have_regex || regex.find(s))) {
  550. output_size += static_cast<int>(s.size()) + 1;
  551. if (limit_output >= 0 && output_size >= limit_output) {
  552. s.clear();
  553. break;
  554. }
  555. strings.push_back(s);
  556. }
  557. s.clear();
  558. }
  559. }
  560. // If there is a non-empty current string we have hit the end of the
  561. // input file or the input size limit. Check if the current string
  562. // matches the requirements.
  563. if ((!limit_count || strings.size() < limit_count) && !s.empty() &&
  564. s.length() >= minlen && (!have_regex || regex.find(s))) {
  565. output_size += static_cast<int>(s.size()) + 1;
  566. if (limit_output < 0 || output_size < limit_output) {
  567. strings.push_back(s);
  568. }
  569. }
  570. // Encode the result in a CMake list.
  571. const char* sep = "";
  572. std::string output;
  573. for (std::string const& sr : strings) {
  574. // Separate the strings in the output to make it a list.
  575. output += sep;
  576. sep = ";";
  577. // Store the string in the output, but escape semicolons to
  578. // make sure it is a list.
  579. for (char i : sr) {
  580. if (i == ';') {
  581. output += '\\';
  582. }
  583. output += i;
  584. }
  585. }
  586. // Save the output in a makefile variable.
  587. status.GetMakefile().AddDefinition(outVar, output);
  588. return true;
  589. }
  590. bool HandleGlobImpl(std::vector<std::string> const& args, bool recurse,
  591. cmExecutionStatus& status)
  592. {
  593. // File commands has at least one argument
  594. assert(args.size() > 1);
  595. auto i = args.begin();
  596. i++; // Get rid of subcommand
  597. std::string variable = *i;
  598. i++;
  599. cmsys::Glob g;
  600. g.SetRecurse(recurse);
  601. bool explicitFollowSymlinks = false;
  602. cmPolicies::PolicyStatus policyStatus =
  603. status.GetMakefile().GetPolicyStatus(cmPolicies::CMP0009);
  604. if (recurse) {
  605. switch (policyStatus) {
  606. case cmPolicies::REQUIRED_IF_USED:
  607. case cmPolicies::REQUIRED_ALWAYS:
  608. case cmPolicies::NEW:
  609. g.RecurseThroughSymlinksOff();
  610. break;
  611. case cmPolicies::OLD:
  612. case cmPolicies::WARN:
  613. g.RecurseThroughSymlinksOn();
  614. break;
  615. }
  616. }
  617. cmake* cm = status.GetMakefile().GetCMakeInstance();
  618. std::vector<std::string> files;
  619. bool configureDepends = false;
  620. bool warnConfigureLate = false;
  621. bool warnFollowedSymlinks = false;
  622. const cmake::WorkingMode workingMode = cm->GetWorkingMode();
  623. while (i != args.end()) {
  624. if (*i == "LIST_DIRECTORIES") {
  625. ++i; // skip LIST_DIRECTORIES
  626. if (i != args.end()) {
  627. if (cmIsOn(*i)) {
  628. g.SetListDirs(true);
  629. g.SetRecurseListDirs(true);
  630. } else if (cmIsOff(*i)) {
  631. g.SetListDirs(false);
  632. g.SetRecurseListDirs(false);
  633. } else {
  634. status.SetError("LIST_DIRECTORIES missing bool value.");
  635. return false;
  636. }
  637. ++i;
  638. } else {
  639. status.SetError("LIST_DIRECTORIES missing bool value.");
  640. return false;
  641. }
  642. } else if (*i == "FOLLOW_SYMLINKS") {
  643. ++i; // skip FOLLOW_SYMLINKS
  644. if (recurse) {
  645. explicitFollowSymlinks = true;
  646. g.RecurseThroughSymlinksOn();
  647. if (i == args.end()) {
  648. status.SetError(
  649. "GLOB_RECURSE requires a glob expression after FOLLOW_SYMLINKS.");
  650. return false;
  651. }
  652. }
  653. } else if (*i == "RELATIVE") {
  654. ++i; // skip RELATIVE
  655. if (i == args.end()) {
  656. status.SetError("GLOB requires a directory after the RELATIVE tag.");
  657. return false;
  658. }
  659. g.SetRelative(i->c_str());
  660. ++i;
  661. if (i == args.end()) {
  662. status.SetError(
  663. "GLOB requires a glob expression after the directory.");
  664. return false;
  665. }
  666. } else if (*i == "CONFIGURE_DEPENDS") {
  667. // Generated build system depends on glob results
  668. if (!configureDepends && warnConfigureLate) {
  669. status.GetMakefile().IssueMessage(
  670. MessageType::AUTHOR_WARNING,
  671. "CONFIGURE_DEPENDS flag was given after a glob expression was "
  672. "already evaluated.");
  673. }
  674. if (workingMode != cmake::NORMAL_MODE) {
  675. status.GetMakefile().IssueMessage(
  676. MessageType::FATAL_ERROR,
  677. "CONFIGURE_DEPENDS is invalid for script and find package modes.");
  678. return false;
  679. }
  680. configureDepends = true;
  681. ++i;
  682. if (i == args.end()) {
  683. status.SetError(
  684. "GLOB requires a glob expression after CONFIGURE_DEPENDS.");
  685. return false;
  686. }
  687. } else {
  688. std::string expr = *i;
  689. if (!cmsys::SystemTools::FileIsFullPath(*i)) {
  690. expr = status.GetMakefile().GetCurrentSourceDirectory();
  691. // Handle script mode
  692. if (!expr.empty()) {
  693. expr += "/" + *i;
  694. } else {
  695. expr = *i;
  696. }
  697. }
  698. cmsys::Glob::GlobMessages globMessages;
  699. g.FindFiles(expr, &globMessages);
  700. if (!globMessages.empty()) {
  701. bool shouldExit = false;
  702. for (cmsys::Glob::Message const& globMessage : globMessages) {
  703. if (globMessage.type == cmsys::Glob::cyclicRecursion) {
  704. status.GetMakefile().IssueMessage(
  705. MessageType::AUTHOR_WARNING,
  706. "Cyclic recursion detected while globbing for '" + *i + "':\n" +
  707. globMessage.content);
  708. } else if (globMessage.type == cmsys::Glob::error) {
  709. status.GetMakefile().IssueMessage(
  710. MessageType::FATAL_ERROR,
  711. "Error has occurred while globbing for '" + *i + "' - " +
  712. globMessage.content);
  713. shouldExit = true;
  714. } else if (cm->GetDebugOutput() || cm->GetTrace()) {
  715. status.GetMakefile().IssueMessage(
  716. MessageType::LOG,
  717. cmStrCat("Globbing for\n ", *i, "\nEncountered an error:\n ",
  718. globMessage.content));
  719. }
  720. }
  721. if (shouldExit) {
  722. return false;
  723. }
  724. }
  725. if (recurse && !explicitFollowSymlinks &&
  726. g.GetFollowedSymlinkCount() != 0) {
  727. warnFollowedSymlinks = true;
  728. }
  729. std::vector<std::string>& foundFiles = g.GetFiles();
  730. cm::append(files, foundFiles);
  731. if (configureDepends) {
  732. std::sort(foundFiles.begin(), foundFiles.end());
  733. foundFiles.erase(std::unique(foundFiles.begin(), foundFiles.end()),
  734. foundFiles.end());
  735. cm->AddGlobCacheEntry(
  736. recurse, (recurse ? g.GetRecurseListDirs() : g.GetListDirs()),
  737. (recurse ? g.GetRecurseThroughSymlinks() : false),
  738. (g.GetRelative() ? g.GetRelative() : ""), expr, foundFiles, variable,
  739. status.GetMakefile().GetBacktrace());
  740. } else {
  741. warnConfigureLate = true;
  742. }
  743. ++i;
  744. }
  745. }
  746. switch (policyStatus) {
  747. case cmPolicies::REQUIRED_IF_USED:
  748. case cmPolicies::REQUIRED_ALWAYS:
  749. case cmPolicies::NEW:
  750. // Correct behavior, yay!
  751. break;
  752. case cmPolicies::OLD:
  753. // Probably not really the expected behavior, but the author explicitly
  754. // asked for the old behavior... no warning.
  755. case cmPolicies::WARN:
  756. // Possibly unexpected old behavior *and* we actually traversed
  757. // symlinks without being explicitly asked to: warn the author.
  758. if (warnFollowedSymlinks) {
  759. status.GetMakefile().IssueMessage(
  760. MessageType::AUTHOR_WARNING,
  761. cmPolicies::GetPolicyWarning(cmPolicies::CMP0009));
  762. }
  763. break;
  764. }
  765. std::sort(files.begin(), files.end());
  766. files.erase(std::unique(files.begin(), files.end()), files.end());
  767. status.GetMakefile().AddDefinition(variable, cmJoin(files, ";"));
  768. return true;
  769. }
  770. bool HandleGlobCommand(std::vector<std::string> const& args,
  771. cmExecutionStatus& status)
  772. {
  773. return HandleGlobImpl(args, false, status);
  774. }
  775. bool HandleGlobRecurseCommand(std::vector<std::string> const& args,
  776. cmExecutionStatus& status)
  777. {
  778. return HandleGlobImpl(args, true, status);
  779. }
  780. bool HandleMakeDirectoryCommand(std::vector<std::string> const& args,
  781. cmExecutionStatus& status)
  782. {
  783. // File command has at least one argument
  784. assert(args.size() > 1);
  785. std::string expr;
  786. for (std::string const& arg :
  787. cmMakeRange(args).advance(1)) // Get rid of subcommand
  788. {
  789. const std::string* cdir = &arg;
  790. if (!cmsys::SystemTools::FileIsFullPath(arg)) {
  791. expr =
  792. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', arg);
  793. cdir = &expr;
  794. }
  795. if (!status.GetMakefile().CanIWriteThisFile(*cdir)) {
  796. std::string e = "attempted to create a directory: " + *cdir +
  797. " into a source directory.";
  798. status.SetError(e);
  799. cmSystemTools::SetFatalErrorOccured();
  800. return false;
  801. }
  802. if (!cmSystemTools::MakeDirectory(*cdir)) {
  803. std::string error = "problem creating directory: " + *cdir;
  804. status.SetError(error);
  805. return false;
  806. }
  807. }
  808. return true;
  809. }
  810. bool HandleTouchImpl(std::vector<std::string> const& args, bool create,
  811. cmExecutionStatus& status)
  812. {
  813. // File command has at least one argument
  814. assert(args.size() > 1);
  815. for (std::string const& arg :
  816. cmMakeRange(args).advance(1)) // Get rid of subcommand
  817. {
  818. std::string tfile = arg;
  819. if (!cmsys::SystemTools::FileIsFullPath(tfile)) {
  820. tfile =
  821. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', arg);
  822. }
  823. if (!status.GetMakefile().CanIWriteThisFile(tfile)) {
  824. std::string e =
  825. "attempted to touch a file: " + tfile + " in a source directory.";
  826. status.SetError(e);
  827. cmSystemTools::SetFatalErrorOccured();
  828. return false;
  829. }
  830. if (!cmSystemTools::Touch(tfile, create)) {
  831. std::string error = "problem touching file: " + tfile;
  832. status.SetError(error);
  833. return false;
  834. }
  835. }
  836. return true;
  837. }
  838. bool HandleTouchCommand(std::vector<std::string> const& args,
  839. cmExecutionStatus& status)
  840. {
  841. return HandleTouchImpl(args, true, status);
  842. }
  843. bool HandleTouchNocreateCommand(std::vector<std::string> const& args,
  844. cmExecutionStatus& status)
  845. {
  846. return HandleTouchImpl(args, false, status);
  847. }
  848. bool HandleDifferentCommand(std::vector<std::string> const& args,
  849. cmExecutionStatus& status)
  850. {
  851. /*
  852. FILE(DIFFERENT <variable> FILES <lhs> <rhs>)
  853. */
  854. // Evaluate arguments.
  855. const char* file_lhs = nullptr;
  856. const char* file_rhs = nullptr;
  857. const char* var = nullptr;
  858. enum Doing
  859. {
  860. DoingNone,
  861. DoingVar,
  862. DoingFileLHS,
  863. DoingFileRHS
  864. };
  865. Doing doing = DoingVar;
  866. for (unsigned int i = 1; i < args.size(); ++i) {
  867. if (args[i] == "FILES") {
  868. doing = DoingFileLHS;
  869. } else if (doing == DoingVar) {
  870. var = args[i].c_str();
  871. doing = DoingNone;
  872. } else if (doing == DoingFileLHS) {
  873. file_lhs = args[i].c_str();
  874. doing = DoingFileRHS;
  875. } else if (doing == DoingFileRHS) {
  876. file_rhs = args[i].c_str();
  877. doing = DoingNone;
  878. } else {
  879. status.SetError(cmStrCat("DIFFERENT given unknown argument ", args[i]));
  880. return false;
  881. }
  882. }
  883. if (!var) {
  884. status.SetError("DIFFERENT not given result variable name.");
  885. return false;
  886. }
  887. if (!file_lhs || !file_rhs) {
  888. status.SetError("DIFFERENT not given FILES option with two file names.");
  889. return false;
  890. }
  891. // Compare the files.
  892. const char* result =
  893. cmSystemTools::FilesDiffer(file_lhs, file_rhs) ? "1" : "0";
  894. status.GetMakefile().AddDefinition(var, result);
  895. return true;
  896. }
  897. bool HandleCopyCommand(std::vector<std::string> const& args,
  898. cmExecutionStatus& status)
  899. {
  900. cmFileCopier copier(status);
  901. return copier.Run(args);
  902. }
  903. bool HandleRPathChangeCommand(std::vector<std::string> const& args,
  904. cmExecutionStatus& status)
  905. {
  906. // Evaluate arguments.
  907. std::string file;
  908. const char* oldRPath = nullptr;
  909. const char* newRPath = nullptr;
  910. bool removeEnvironmentRPath = false;
  911. enum Doing
  912. {
  913. DoingNone,
  914. DoingFile,
  915. DoingOld,
  916. DoingNew
  917. };
  918. Doing doing = DoingNone;
  919. for (unsigned int i = 1; i < args.size(); ++i) {
  920. if (args[i] == "OLD_RPATH") {
  921. doing = DoingOld;
  922. } else if (args[i] == "NEW_RPATH") {
  923. doing = DoingNew;
  924. } else if (args[i] == "FILE") {
  925. doing = DoingFile;
  926. } else if (args[i] == "INSTALL_REMOVE_ENVIRONMENT_RPATH") {
  927. removeEnvironmentRPath = true;
  928. } else if (doing == DoingFile) {
  929. file = args[i];
  930. doing = DoingNone;
  931. } else if (doing == DoingOld) {
  932. oldRPath = args[i].c_str();
  933. doing = DoingNone;
  934. } else if (doing == DoingNew) {
  935. newRPath = args[i].c_str();
  936. doing = DoingNone;
  937. } else {
  938. status.SetError(
  939. cmStrCat("RPATH_CHANGE given unknown argument ", args[i]));
  940. return false;
  941. }
  942. }
  943. if (file.empty()) {
  944. status.SetError("RPATH_CHANGE not given FILE option.");
  945. return false;
  946. }
  947. if (!oldRPath) {
  948. status.SetError("RPATH_CHANGE not given OLD_RPATH option.");
  949. return false;
  950. }
  951. if (!newRPath) {
  952. status.SetError("RPATH_CHANGE not given NEW_RPATH option.");
  953. return false;
  954. }
  955. if (!cmSystemTools::FileExists(file, true)) {
  956. status.SetError(
  957. cmStrCat("RPATH_CHANGE given FILE \"", file, "\" that does not exist."));
  958. return false;
  959. }
  960. bool success = true;
  961. cmFileTimes const ft(file);
  962. std::string emsg;
  963. bool changed;
  964. if (!cmSystemTools::ChangeRPath(file, oldRPath, newRPath,
  965. removeEnvironmentRPath, &emsg, &changed)) {
  966. status.SetError(cmStrCat("RPATH_CHANGE could not write new RPATH:\n ",
  967. newRPath, "\nto the file:\n ", file, "\n",
  968. emsg));
  969. success = false;
  970. }
  971. if (success) {
  972. if (changed) {
  973. std::string message =
  974. cmStrCat("Set runtime path of \"", file, "\" to \"", newRPath, '"');
  975. status.GetMakefile().DisplayStatus(message, -1);
  976. }
  977. ft.Store(file);
  978. }
  979. return success;
  980. }
  981. bool HandleRPathRemoveCommand(std::vector<std::string> const& args,
  982. cmExecutionStatus& status)
  983. {
  984. // Evaluate arguments.
  985. std::string file;
  986. enum Doing
  987. {
  988. DoingNone,
  989. DoingFile
  990. };
  991. Doing doing = DoingNone;
  992. for (unsigned int i = 1; i < args.size(); ++i) {
  993. if (args[i] == "FILE") {
  994. doing = DoingFile;
  995. } else if (doing == DoingFile) {
  996. file = args[i];
  997. doing = DoingNone;
  998. } else {
  999. status.SetError(
  1000. cmStrCat("RPATH_REMOVE given unknown argument ", args[i]));
  1001. return false;
  1002. }
  1003. }
  1004. if (file.empty()) {
  1005. status.SetError("RPATH_REMOVE not given FILE option.");
  1006. return false;
  1007. }
  1008. if (!cmSystemTools::FileExists(file, true)) {
  1009. status.SetError(
  1010. cmStrCat("RPATH_REMOVE given FILE \"", file, "\" that does not exist."));
  1011. return false;
  1012. }
  1013. bool success = true;
  1014. cmFileTimes const ft(file);
  1015. std::string emsg;
  1016. bool removed;
  1017. if (!cmSystemTools::RemoveRPath(file, &emsg, &removed)) {
  1018. status.SetError(
  1019. cmStrCat("RPATH_REMOVE could not remove RPATH from file: \n ", file,
  1020. "\n", emsg));
  1021. success = false;
  1022. }
  1023. if (success) {
  1024. if (removed) {
  1025. std::string message =
  1026. cmStrCat("Removed runtime path from \"", file, '"');
  1027. status.GetMakefile().DisplayStatus(message, -1);
  1028. }
  1029. ft.Store(file);
  1030. }
  1031. return success;
  1032. }
  1033. bool HandleRPathCheckCommand(std::vector<std::string> const& args,
  1034. cmExecutionStatus& status)
  1035. {
  1036. // Evaluate arguments.
  1037. std::string file;
  1038. const char* rpath = nullptr;
  1039. enum Doing
  1040. {
  1041. DoingNone,
  1042. DoingFile,
  1043. DoingRPath
  1044. };
  1045. Doing doing = DoingNone;
  1046. for (unsigned int i = 1; i < args.size(); ++i) {
  1047. if (args[i] == "RPATH") {
  1048. doing = DoingRPath;
  1049. } else if (args[i] == "FILE") {
  1050. doing = DoingFile;
  1051. } else if (doing == DoingFile) {
  1052. file = args[i];
  1053. doing = DoingNone;
  1054. } else if (doing == DoingRPath) {
  1055. rpath = args[i].c_str();
  1056. doing = DoingNone;
  1057. } else {
  1058. status.SetError(
  1059. cmStrCat("RPATH_CHECK given unknown argument ", args[i]));
  1060. return false;
  1061. }
  1062. }
  1063. if (file.empty()) {
  1064. status.SetError("RPATH_CHECK not given FILE option.");
  1065. return false;
  1066. }
  1067. if (!rpath) {
  1068. status.SetError("RPATH_CHECK not given RPATH option.");
  1069. return false;
  1070. }
  1071. // If the file exists but does not have the desired RPath then
  1072. // delete it. This is used during installation to re-install a file
  1073. // if its RPath will change.
  1074. if (cmSystemTools::FileExists(file, true) &&
  1075. !cmSystemTools::CheckRPath(file, rpath)) {
  1076. cmSystemTools::RemoveFile(file);
  1077. }
  1078. return true;
  1079. }
  1080. bool HandleReadElfCommand(std::vector<std::string> const& args,
  1081. cmExecutionStatus& status)
  1082. {
  1083. if (args.size() < 4) {
  1084. status.SetError("READ_ELF must be called with at least three additional "
  1085. "arguments.");
  1086. return false;
  1087. }
  1088. std::string const& fileNameArg = args[1];
  1089. struct Arguments
  1090. {
  1091. std::string RPath;
  1092. std::string RunPath;
  1093. std::string Error;
  1094. };
  1095. static auto const parser = cmArgumentParser<Arguments>{}
  1096. .Bind("RPATH"_s, &Arguments::RPath)
  1097. .Bind("RUNPATH"_s, &Arguments::RunPath)
  1098. .Bind("CAPTURE_ERROR"_s, &Arguments::Error);
  1099. Arguments const arguments = parser.Parse(cmMakeRange(args).advance(2));
  1100. if (!cmSystemTools::FileExists(fileNameArg, true)) {
  1101. status.SetError(cmStrCat("READ_ELF given FILE \"", fileNameArg,
  1102. "\" that does not exist."));
  1103. return false;
  1104. }
  1105. #if defined(CMake_USE_ELF_PARSER)
  1106. cmELF elf(fileNameArg.c_str());
  1107. if (!arguments.RPath.empty()) {
  1108. if (cmELF::StringEntry const* se_rpath = elf.GetRPath()) {
  1109. std::string rpath(se_rpath->Value);
  1110. std::replace(rpath.begin(), rpath.end(), ':', ';');
  1111. status.GetMakefile().AddDefinition(arguments.RPath, rpath);
  1112. }
  1113. }
  1114. if (!arguments.RunPath.empty()) {
  1115. if (cmELF::StringEntry const* se_runpath = elf.GetRunPath()) {
  1116. std::string runpath(se_runpath->Value);
  1117. std::replace(runpath.begin(), runpath.end(), ':', ';');
  1118. status.GetMakefile().AddDefinition(arguments.RunPath, runpath);
  1119. }
  1120. }
  1121. return true;
  1122. #else
  1123. std::string error = "ELF parser not available on this platform.";
  1124. if (arguments.Error.empty()) {
  1125. status.SetError(error);
  1126. return false;
  1127. }
  1128. status.GetMakefile().AddDefinition(arguments.Error, error);
  1129. return true;
  1130. #endif
  1131. }
  1132. bool HandleInstallCommand(std::vector<std::string> const& args,
  1133. cmExecutionStatus& status)
  1134. {
  1135. cmFileInstaller installer(status);
  1136. return installer.Run(args);
  1137. }
  1138. bool HandleRealPathCommand(std::vector<std::string> const& args,
  1139. cmExecutionStatus& status)
  1140. {
  1141. if (args.size() < 3) {
  1142. status.SetError("REAL_PATH requires a path and an output variable");
  1143. return false;
  1144. }
  1145. struct Arguments
  1146. {
  1147. std::string BaseDirectory;
  1148. };
  1149. static auto const parser = cmArgumentParser<Arguments>{}.Bind(
  1150. "BASE_DIRECTORY"_s, &Arguments::BaseDirectory);
  1151. std::vector<std::string> unparsedArguments;
  1152. std::vector<std::string> keywordsMissingValue;
  1153. std::vector<std::string> parsedKeywords;
  1154. auto arguments =
  1155. parser.Parse(cmMakeRange(args).advance(3), &unparsedArguments,
  1156. &keywordsMissingValue, &parsedKeywords);
  1157. if (!unparsedArguments.empty()) {
  1158. status.SetError("REAL_PATH called with unexpected arguments");
  1159. return false;
  1160. }
  1161. if (!keywordsMissingValue.empty()) {
  1162. status.SetError("BASE_DIRECTORY requires a value");
  1163. return false;
  1164. }
  1165. if (parsedKeywords.empty()) {
  1166. arguments.BaseDirectory = status.GetMakefile().GetCurrentSourceDirectory();
  1167. }
  1168. cmCMakePath path(args[1]);
  1169. path = path.Absolute(arguments.BaseDirectory).Normal();
  1170. auto realPath = cmSystemTools::GetRealPath(path.GenericString());
  1171. status.GetMakefile().AddDefinition(args[2], realPath);
  1172. return true;
  1173. }
  1174. bool HandleRelativePathCommand(std::vector<std::string> const& args,
  1175. cmExecutionStatus& status)
  1176. {
  1177. if (args.size() != 4) {
  1178. status.SetError("RELATIVE_PATH called with incorrect number of arguments");
  1179. return false;
  1180. }
  1181. const std::string& outVar = args[1];
  1182. const std::string& directoryName = args[2];
  1183. const std::string& fileName = args[3];
  1184. if (!cmSystemTools::FileIsFullPath(directoryName)) {
  1185. std::string errstring =
  1186. "RELATIVE_PATH must be passed a full path to the directory: " +
  1187. directoryName;
  1188. status.SetError(errstring);
  1189. return false;
  1190. }
  1191. if (!cmSystemTools::FileIsFullPath(fileName)) {
  1192. std::string errstring =
  1193. "RELATIVE_PATH must be passed a full path to the file: " + fileName;
  1194. status.SetError(errstring);
  1195. return false;
  1196. }
  1197. std::string res = cmSystemTools::RelativePath(directoryName, fileName);
  1198. status.GetMakefile().AddDefinition(outVar, res);
  1199. return true;
  1200. }
  1201. bool HandleRename(std::vector<std::string> const& args,
  1202. cmExecutionStatus& status)
  1203. {
  1204. if (args.size() < 3) {
  1205. status.SetError("RENAME must be called with at least two additional "
  1206. "arguments");
  1207. return false;
  1208. }
  1209. // Compute full path for old and new names.
  1210. std::string oldname = args[1];
  1211. if (!cmsys::SystemTools::FileIsFullPath(oldname)) {
  1212. oldname =
  1213. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', args[1]);
  1214. }
  1215. std::string newname = args[2];
  1216. if (!cmsys::SystemTools::FileIsFullPath(newname)) {
  1217. newname =
  1218. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', args[2]);
  1219. }
  1220. struct Arguments
  1221. {
  1222. bool NoReplace = false;
  1223. std::string Result;
  1224. };
  1225. static auto const parser = cmArgumentParser<Arguments>{}
  1226. .Bind("NO_REPLACE"_s, &Arguments::NoReplace)
  1227. .Bind("RESULT"_s, &Arguments::Result);
  1228. std::vector<std::string> unconsumedArgs;
  1229. Arguments const arguments =
  1230. parser.Parse(cmMakeRange(args).advance(3), &unconsumedArgs);
  1231. if (!unconsumedArgs.empty()) {
  1232. status.SetError("RENAME unknown argument:\n " + unconsumedArgs.front());
  1233. return false;
  1234. }
  1235. std::string err;
  1236. switch (cmSystemTools::RenameFile(oldname, newname,
  1237. arguments.NoReplace
  1238. ? cmSystemTools::Replace::No
  1239. : cmSystemTools::Replace::Yes,
  1240. &err)) {
  1241. case cmSystemTools::RenameResult::Success:
  1242. if (!arguments.Result.empty()) {
  1243. status.GetMakefile().AddDefinition(arguments.Result, "0");
  1244. }
  1245. return true;
  1246. case cmSystemTools::RenameResult::NoReplace:
  1247. if (!arguments.Result.empty()) {
  1248. err = "NO_REPLACE";
  1249. } else {
  1250. err = "path not replaced";
  1251. }
  1252. CM_FALLTHROUGH;
  1253. case cmSystemTools::RenameResult::Failure:
  1254. if (!arguments.Result.empty()) {
  1255. status.GetMakefile().AddDefinition(arguments.Result, err);
  1256. return true;
  1257. }
  1258. break;
  1259. }
  1260. status.SetError(cmStrCat("RENAME failed to rename\n ", oldname, "\nto\n ",
  1261. newname, "\nbecause: ", err, "\n"));
  1262. return false;
  1263. }
  1264. bool HandleCopyFile(std::vector<std::string> const& args,
  1265. cmExecutionStatus& status)
  1266. {
  1267. if (args.size() < 3) {
  1268. status.SetError("COPY_FILE must be called with at least two additional "
  1269. "arguments");
  1270. return false;
  1271. }
  1272. // Compute full path for old and new names.
  1273. std::string oldname = args[1];
  1274. if (!cmsys::SystemTools::FileIsFullPath(oldname)) {
  1275. oldname =
  1276. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', args[1]);
  1277. }
  1278. std::string newname = args[2];
  1279. if (!cmsys::SystemTools::FileIsFullPath(newname)) {
  1280. newname =
  1281. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', args[2]);
  1282. }
  1283. struct Arguments
  1284. {
  1285. bool OnlyIfDifferent = false;
  1286. std::string Result;
  1287. };
  1288. static auto const parser =
  1289. cmArgumentParser<Arguments>{}
  1290. .Bind("ONLY_IF_DIFFERENT"_s, &Arguments::OnlyIfDifferent)
  1291. .Bind("RESULT"_s, &Arguments::Result);
  1292. std::vector<std::string> unconsumedArgs;
  1293. Arguments const arguments =
  1294. parser.Parse(cmMakeRange(args).advance(3), &unconsumedArgs);
  1295. if (!unconsumedArgs.empty()) {
  1296. status.SetError("COPY_FILE unknown argument:\n " +
  1297. unconsumedArgs.front());
  1298. return false;
  1299. }
  1300. bool result = true;
  1301. if (cmsys::SystemTools::FileIsDirectory(oldname)) {
  1302. if (!arguments.Result.empty()) {
  1303. status.GetMakefile().AddDefinition(arguments.Result,
  1304. "cannot copy a directory");
  1305. } else {
  1306. status.SetError(
  1307. cmStrCat("COPY_FILE cannot copy a directory\n ", oldname));
  1308. result = false;
  1309. }
  1310. return result;
  1311. }
  1312. if (cmsys::SystemTools::FileIsDirectory(newname)) {
  1313. if (!arguments.Result.empty()) {
  1314. status.GetMakefile().AddDefinition(arguments.Result,
  1315. "cannot copy to a directory");
  1316. } else {
  1317. status.SetError(
  1318. cmStrCat("COPY_FILE cannot copy to a directory\n ", newname));
  1319. result = false;
  1320. }
  1321. return result;
  1322. }
  1323. cmSystemTools::CopyWhen when;
  1324. if (arguments.OnlyIfDifferent) {
  1325. when = cmSystemTools::CopyWhen::OnlyIfDifferent;
  1326. } else {
  1327. when = cmSystemTools::CopyWhen::Always;
  1328. }
  1329. std::string err;
  1330. if (cmSystemTools::CopySingleFile(oldname, newname, when, &err) ==
  1331. cmSystemTools::CopyResult::Success) {
  1332. if (!arguments.Result.empty()) {
  1333. status.GetMakefile().AddDefinition(arguments.Result, "0");
  1334. }
  1335. } else {
  1336. if (!arguments.Result.empty()) {
  1337. status.GetMakefile().AddDefinition(arguments.Result, err);
  1338. } else {
  1339. status.SetError(cmStrCat("COPY_FILE failed to copy\n ", oldname,
  1340. "\nto\n ", newname, "\nbecause: ", err, "\n"));
  1341. result = false;
  1342. }
  1343. }
  1344. return result;
  1345. }
  1346. bool HandleRemoveImpl(std::vector<std::string> const& args, bool recurse,
  1347. cmExecutionStatus& status)
  1348. {
  1349. std::string message;
  1350. for (std::string const& arg :
  1351. cmMakeRange(args).advance(1)) // Get rid of subcommand
  1352. {
  1353. std::string fileName = arg;
  1354. if (fileName.empty()) {
  1355. std::string const r = recurse ? "REMOVE_RECURSE" : "REMOVE";
  1356. status.GetMakefile().IssueMessage(
  1357. MessageType::AUTHOR_WARNING, "Ignoring empty file name in " + r + ".");
  1358. continue;
  1359. }
  1360. if (!cmsys::SystemTools::FileIsFullPath(fileName)) {
  1361. fileName =
  1362. cmStrCat(status.GetMakefile().GetCurrentSourceDirectory(), '/', arg);
  1363. }
  1364. if (cmSystemTools::FileIsDirectory(fileName) &&
  1365. !cmSystemTools::FileIsSymlink(fileName) && recurse) {
  1366. cmSystemTools::RepeatedRemoveDirectory(fileName);
  1367. } else {
  1368. cmSystemTools::RemoveFile(fileName);
  1369. }
  1370. }
  1371. return true;
  1372. }
  1373. bool HandleRemove(std::vector<std::string> const& args,
  1374. cmExecutionStatus& status)
  1375. {
  1376. return HandleRemoveImpl(args, false, status);
  1377. }
  1378. bool HandleRemoveRecurse(std::vector<std::string> const& args,
  1379. cmExecutionStatus& status)
  1380. {
  1381. return HandleRemoveImpl(args, true, status);
  1382. }
  1383. std::string ToNativePath(const std::string& path)
  1384. {
  1385. const auto& outPath = cmSystemTools::ConvertToOutputPath(path);
  1386. if (outPath.size() > 1 && outPath.front() == '\"' &&
  1387. outPath.back() == '\"') {
  1388. return outPath.substr(1, outPath.size() - 2);
  1389. }
  1390. return outPath;
  1391. }
  1392. std::string ToCMakePath(const std::string& path)
  1393. {
  1394. auto temp = path;
  1395. cmSystemTools::ConvertToUnixSlashes(temp);
  1396. return temp;
  1397. }
  1398. bool HandlePathCommand(std::vector<std::string> const& args,
  1399. std::string (*convert)(std::string const&),
  1400. cmExecutionStatus& status)
  1401. {
  1402. if (args.size() != 3) {
  1403. status.SetError("FILE([TO_CMAKE_PATH|TO_NATIVE_PATH] path result) must be "
  1404. "called with exactly three arguments.");
  1405. return false;
  1406. }
  1407. #if defined(_WIN32) && !defined(__CYGWIN__)
  1408. char pathSep = ';';
  1409. #else
  1410. char pathSep = ':';
  1411. #endif
  1412. std::vector<std::string> path = cmSystemTools::SplitString(args[1], pathSep);
  1413. std::string value = cmJoin(cmMakeRange(path).transform(convert), ";");
  1414. status.GetMakefile().AddDefinition(args[2], value);
  1415. return true;
  1416. }
  1417. bool HandleCMakePathCommand(std::vector<std::string> const& args,
  1418. cmExecutionStatus& status)
  1419. {
  1420. return HandlePathCommand(args, ToCMakePath, status);
  1421. }
  1422. bool HandleNativePathCommand(std::vector<std::string> const& args,
  1423. cmExecutionStatus& status)
  1424. {
  1425. return HandlePathCommand(args, ToNativePath, status);
  1426. }
  1427. #if !defined(CMAKE_BOOTSTRAP)
  1428. // Stuff for curl download/upload
  1429. using cmFileCommandVectorOfChar = std::vector<char>;
  1430. size_t cmWriteToFileCallback(void* ptr, size_t size, size_t nmemb, void* data)
  1431. {
  1432. int realsize = static_cast<int>(size * nmemb);
  1433. cmsys::ofstream* fout = static_cast<cmsys::ofstream*>(data);
  1434. if (fout) {
  1435. const char* chPtr = static_cast<char*>(ptr);
  1436. fout->write(chPtr, realsize);
  1437. }
  1438. return realsize;
  1439. }
  1440. size_t cmWriteToMemoryCallback(void* ptr, size_t size, size_t nmemb,
  1441. void* data)
  1442. {
  1443. int realsize = static_cast<int>(size * nmemb);
  1444. const char* chPtr = static_cast<char*>(ptr);
  1445. cm::append(*static_cast<cmFileCommandVectorOfChar*>(data), chPtr,
  1446. chPtr + realsize);
  1447. return realsize;
  1448. }
  1449. size_t cmFileCommandCurlDebugCallback(CURL*, curl_infotype type, char* chPtr,
  1450. size_t size, void* data)
  1451. {
  1452. cmFileCommandVectorOfChar& vec =
  1453. *static_cast<cmFileCommandVectorOfChar*>(data);
  1454. switch (type) {
  1455. case CURLINFO_TEXT:
  1456. case CURLINFO_HEADER_IN:
  1457. case CURLINFO_HEADER_OUT:
  1458. cm::append(vec, chPtr, chPtr + size);
  1459. break;
  1460. case CURLINFO_DATA_IN:
  1461. case CURLINFO_DATA_OUT:
  1462. case CURLINFO_SSL_DATA_IN:
  1463. case CURLINFO_SSL_DATA_OUT: {
  1464. char buf[128];
  1465. int n = sprintf(buf, "[%" KWIML_INT_PRIu64 " bytes data]\n",
  1466. static_cast<KWIML_INT_uint64_t>(size));
  1467. if (n > 0) {
  1468. cm::append(vec, buf, buf + n);
  1469. }
  1470. } break;
  1471. default:
  1472. break;
  1473. }
  1474. return 0;
  1475. }
  1476. class cURLProgressHelper
  1477. {
  1478. public:
  1479. cURLProgressHelper(cmMakefile* mf, const char* text)
  1480. : Makefile(mf)
  1481. , Text(text)
  1482. {
  1483. }
  1484. bool UpdatePercentage(double value, double total, std::string& status)
  1485. {
  1486. long OldPercentage = this->CurrentPercentage;
  1487. if (total > 0.0) {
  1488. this->CurrentPercentage = std::lround(value / total * 100.0);
  1489. if (this->CurrentPercentage > 100) {
  1490. // Avoid extra progress reports for unexpected data beyond total.
  1491. this->CurrentPercentage = 100;
  1492. }
  1493. }
  1494. bool updated = (OldPercentage != this->CurrentPercentage);
  1495. if (updated) {
  1496. status =
  1497. cmStrCat("[", this->Text, " ", this->CurrentPercentage, "% complete]");
  1498. }
  1499. return updated;
  1500. }
  1501. cmMakefile* GetMakefile() { return this->Makefile; }
  1502. private:
  1503. long CurrentPercentage = -1;
  1504. cmMakefile* Makefile;
  1505. std::string Text;
  1506. };
  1507. int cmFileDownloadProgressCallback(void* clientp, double dltotal, double dlnow,
  1508. double ultotal, double ulnow)
  1509. {
  1510. cURLProgressHelper* helper = reinterpret_cast<cURLProgressHelper*>(clientp);
  1511. static_cast<void>(ultotal);
  1512. static_cast<void>(ulnow);
  1513. std::string status;
  1514. if (helper->UpdatePercentage(dlnow, dltotal, status)) {
  1515. cmMakefile* mf = helper->GetMakefile();
  1516. mf->DisplayStatus(status, -1);
  1517. }
  1518. return 0;
  1519. }
  1520. int cmFileUploadProgressCallback(void* clientp, double dltotal, double dlnow,
  1521. double ultotal, double ulnow)
  1522. {
  1523. cURLProgressHelper* helper = reinterpret_cast<cURLProgressHelper*>(clientp);
  1524. static_cast<void>(dltotal);
  1525. static_cast<void>(dlnow);
  1526. std::string status;
  1527. if (helper->UpdatePercentage(ulnow, ultotal, status)) {
  1528. cmMakefile* mf = helper->GetMakefile();
  1529. mf->DisplayStatus(status, -1);
  1530. }
  1531. return 0;
  1532. }
  1533. class cURLEasyGuard
  1534. {
  1535. public:
  1536. cURLEasyGuard(CURL* easy)
  1537. : Easy(easy)
  1538. {
  1539. }
  1540. ~cURLEasyGuard()
  1541. {
  1542. if (this->Easy) {
  1543. ::curl_easy_cleanup(this->Easy);
  1544. }
  1545. }
  1546. cURLEasyGuard(const cURLEasyGuard&) = delete;
  1547. cURLEasyGuard& operator=(const cURLEasyGuard&) = delete;
  1548. void release() { this->Easy = nullptr; }
  1549. private:
  1550. ::CURL* Easy;
  1551. };
  1552. #endif
  1553. #define check_curl_result(result, errstr) \
  1554. do { \
  1555. if (result != CURLE_OK) { \
  1556. std::string e(errstr); \
  1557. e += ::curl_easy_strerror(result); \
  1558. status.SetError(e); \
  1559. return false; \
  1560. } \
  1561. } while (false)
  1562. bool HandleDownloadCommand(std::vector<std::string> const& args,
  1563. cmExecutionStatus& status)
  1564. {
  1565. #if !defined(CMAKE_BOOTSTRAP)
  1566. auto i = args.begin();
  1567. if (args.size() < 2) {
  1568. status.SetError("DOWNLOAD must be called with at least two arguments.");
  1569. return false;
  1570. }
  1571. ++i; // Get rid of subcommand
  1572. std::string url = *i;
  1573. ++i;
  1574. std::string file;
  1575. long timeout = 0;
  1576. long inactivity_timeout = 0;
  1577. std::string logVar;
  1578. std::string statusVar;
  1579. bool tls_verify = status.GetMakefile().IsOn("CMAKE_TLS_VERIFY");
  1580. cmProp cainfo = status.GetMakefile().GetDefinition("CMAKE_TLS_CAINFO");
  1581. std::string netrc_level =
  1582. status.GetMakefile().GetSafeDefinition("CMAKE_NETRC");
  1583. std::string netrc_file =
  1584. status.GetMakefile().GetSafeDefinition("CMAKE_NETRC_FILE");
  1585. std::string expectedHash;
  1586. std::string hashMatchMSG;
  1587. std::unique_ptr<cmCryptoHash> hash;
  1588. bool showProgress = false;
  1589. std::string userpwd;
  1590. std::vector<std::string> curl_headers;
  1591. while (i != args.end()) {
  1592. if (*i == "TIMEOUT") {
  1593. ++i;
  1594. if (i != args.end()) {
  1595. timeout = atol(i->c_str());
  1596. } else {
  1597. status.SetError("DOWNLOAD missing time for TIMEOUT.");
  1598. return false;
  1599. }
  1600. } else if (*i == "INACTIVITY_TIMEOUT") {
  1601. ++i;
  1602. if (i != args.end()) {
  1603. inactivity_timeout = atol(i->c_str());
  1604. } else {
  1605. status.SetError("DOWNLOAD missing time for INACTIVITY_TIMEOUT.");
  1606. return false;
  1607. }
  1608. } else if (*i == "LOG") {
  1609. ++i;
  1610. if (i == args.end()) {
  1611. status.SetError("DOWNLOAD missing VAR for LOG.");
  1612. return false;
  1613. }
  1614. logVar = *i;
  1615. } else if (*i == "STATUS") {
  1616. ++i;
  1617. if (i == args.end()) {
  1618. status.SetError("DOWNLOAD missing VAR for STATUS.");
  1619. return false;
  1620. }
  1621. statusVar = *i;
  1622. } else if (*i == "TLS_VERIFY") {
  1623. ++i;
  1624. if (i != args.end()) {
  1625. tls_verify = cmIsOn(*i);
  1626. } else {
  1627. status.SetError("DOWNLOAD missing bool value for TLS_VERIFY.");
  1628. return false;
  1629. }
  1630. } else if (*i == "TLS_CAINFO") {
  1631. ++i;
  1632. if (i != args.end()) {
  1633. cainfo = &(*i);
  1634. } else {
  1635. status.SetError("DOWNLOAD missing file value for TLS_CAINFO.");
  1636. return false;
  1637. }
  1638. } else if (*i == "NETRC_FILE") {
  1639. ++i;
  1640. if (i != args.end()) {
  1641. netrc_file = *i;
  1642. } else {
  1643. status.SetError("DOWNLOAD missing file value for NETRC_FILE.");
  1644. return false;
  1645. }
  1646. } else if (*i == "NETRC") {
  1647. ++i;
  1648. if (i != args.end()) {
  1649. netrc_level = *i;
  1650. } else {
  1651. status.SetError("DOWNLOAD missing level value for NETRC.");
  1652. return false;
  1653. }
  1654. } else if (*i == "EXPECTED_MD5") {
  1655. ++i;
  1656. if (i == args.end()) {
  1657. status.SetError("DOWNLOAD missing sum value for EXPECTED_MD5.");
  1658. return false;
  1659. }
  1660. hash = cm::make_unique<cmCryptoHash>(cmCryptoHash::AlgoMD5);
  1661. hashMatchMSG = "MD5 sum";
  1662. expectedHash = cmSystemTools::LowerCase(*i);
  1663. } else if (*i == "SHOW_PROGRESS") {
  1664. showProgress = true;
  1665. } else if (*i == "EXPECTED_HASH") {
  1666. ++i;
  1667. if (i == args.end()) {
  1668. status.SetError("DOWNLOAD missing ALGO=value for EXPECTED_HASH.");
  1669. return false;
  1670. }
  1671. std::string::size_type pos = i->find("=");
  1672. if (pos == std::string::npos) {
  1673. std::string err =
  1674. cmStrCat("DOWNLOAD EXPECTED_HASH expects ALGO=value but got: ", *i);
  1675. status.SetError(err);
  1676. return false;
  1677. }
  1678. std::string algo = i->substr(0, pos);
  1679. expectedHash = cmSystemTools::LowerCase(i->substr(pos + 1));
  1680. hash = std::unique_ptr<cmCryptoHash>(cmCryptoHash::New(algo));
  1681. if (!hash) {
  1682. std::string err =
  1683. cmStrCat("DOWNLOAD EXPECTED_HASH given unknown ALGO: ", algo);
  1684. status.SetError(err);
  1685. return false;
  1686. }
  1687. hashMatchMSG = algo + " hash";
  1688. } else if (*i == "USERPWD") {
  1689. ++i;
  1690. if (i == args.end()) {
  1691. status.SetError("DOWNLOAD missing string for USERPWD.");
  1692. return false;
  1693. }
  1694. userpwd = *i;
  1695. } else if (*i == "HTTPHEADER") {
  1696. ++i;
  1697. if (i == args.end()) {
  1698. status.SetError("DOWNLOAD missing string for HTTPHEADER.");
  1699. return false;
  1700. }
  1701. curl_headers.push_back(*i);
  1702. } else if (file.empty()) {
  1703. file = *i;
  1704. } else {
  1705. // Do not return error for compatibility reason.
  1706. std::string err = cmStrCat("Unexpected argument: ", *i);
  1707. status.GetMakefile().IssueMessage(MessageType::AUTHOR_WARNING, err);
  1708. }
  1709. ++i;
  1710. }
  1711. // Can't calculate hash if we don't save the file.
  1712. // TODO Incrementally calculate hash in the write callback as the file is
  1713. // being downloaded so this check can be relaxed.
  1714. if (file.empty() && hash) {
  1715. status.SetError("DOWNLOAD cannot calculate hash if file is not saved.");
  1716. return false;
  1717. }
  1718. // If file exists already, and caller specified an expected md5 or sha,
  1719. // and the existing file already has the expected hash, then simply
  1720. // return.
  1721. //
  1722. if (!file.empty() && cmSystemTools::FileExists(file) && hash.get()) {
  1723. std::string msg;
  1724. std::string actualHash = hash->HashFile(file);
  1725. if (actualHash == expectedHash) {
  1726. msg = cmStrCat("returning early; file already exists with expected ",
  1727. hashMatchMSG, '"');
  1728. if (!statusVar.empty()) {
  1729. status.GetMakefile().AddDefinition(statusVar, cmStrCat(0, ";\"", msg));
  1730. }
  1731. return true;
  1732. }
  1733. }
  1734. // Make sure parent directory exists so we can write to the file
  1735. // as we receive downloaded bits from curl...
  1736. //
  1737. if (!file.empty()) {
  1738. std::string dir = cmSystemTools::GetFilenamePath(file);
  1739. if (!dir.empty() && !cmSystemTools::FileExists(dir) &&
  1740. !cmSystemTools::MakeDirectory(dir)) {
  1741. std::string errstring = "DOWNLOAD error: cannot create directory '" +
  1742. dir +
  1743. "' - Specify file by full path name and verify that you "
  1744. "have directory creation and file write privileges.";
  1745. status.SetError(errstring);
  1746. return false;
  1747. }
  1748. }
  1749. cmsys::ofstream fout;
  1750. if (!file.empty()) {
  1751. fout.open(file.c_str(), std::ios::binary);
  1752. if (!fout) {
  1753. status.SetError("DOWNLOAD cannot open file for write.");
  1754. return false;
  1755. }
  1756. }
  1757. # if defined(_WIN32)
  1758. url = fix_file_url_windows(url);
  1759. # endif
  1760. ::CURL* curl;
  1761. ::curl_global_init(CURL_GLOBAL_DEFAULT);
  1762. curl = ::curl_easy_init();
  1763. if (!curl) {
  1764. status.SetError("DOWNLOAD error initializing curl.");
  1765. return false;
  1766. }
  1767. cURLEasyGuard g_curl(curl);
  1768. ::CURLcode res = ::curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  1769. check_curl_result(res, "DOWNLOAD cannot set url: ");
  1770. // enable HTTP ERROR parsing
  1771. res = ::curl_easy_setopt(curl, CURLOPT_FAILONERROR, 1);
  1772. check_curl_result(res, "DOWNLOAD cannot set http failure option: ");
  1773. res = ::curl_easy_setopt(curl, CURLOPT_USERAGENT, "curl/" LIBCURL_VERSION);
  1774. check_curl_result(res, "DOWNLOAD cannot set user agent option: ");
  1775. res = ::curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, cmWriteToFileCallback);
  1776. check_curl_result(res, "DOWNLOAD cannot set write function: ");
  1777. res = ::curl_easy_setopt(curl, CURLOPT_DEBUGFUNCTION,
  1778. cmFileCommandCurlDebugCallback);
  1779. check_curl_result(res, "DOWNLOAD cannot set debug function: ");
  1780. // check to see if TLS verification is requested
  1781. if (tls_verify) {
  1782. res = ::curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1);
  1783. check_curl_result(res, "DOWNLOAD cannot set TLS/SSL Verify on: ");
  1784. } else {
  1785. res = ::curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0);
  1786. check_curl_result(res, "DOWNLOAD cannot set TLS/SSL Verify off: ");
  1787. }
  1788. // check to see if a CAINFO file has been specified
  1789. // command arg comes first
  1790. std::string const& cainfo_err = cmCurlSetCAInfo(curl, cmToCStr(cainfo));
  1791. if (!cainfo_err.empty()) {
  1792. status.SetError(cainfo_err);
  1793. return false;
  1794. }
  1795. // check to see if netrc parameters have been specified
  1796. // local command args takes precedence over CMAKE_NETRC*
  1797. netrc_level = cmSystemTools::UpperCase(netrc_level);
  1798. std::string const& netrc_option_err =
  1799. cmCurlSetNETRCOption(curl, netrc_level, netrc_file);
  1800. if (!netrc_option_err.empty()) {
  1801. status.SetError(netrc_option_err);
  1802. return false;
  1803. }
  1804. cmFileCommandVectorOfChar chunkDebug;
  1805. res = ::curl_easy_setopt(curl, CURLOPT_WRITEDATA,
  1806. file.empty() ? nullptr : &fout);
  1807. check_curl_result(res, "DOWNLOAD cannot set write data: ");
  1808. res = ::curl_easy_setopt(curl, CURLOPT_DEBUGDATA, &chunkDebug);
  1809. check_curl_result(res, "DOWNLOAD cannot set debug data: ");
  1810. res = ::curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  1811. check_curl_result(res, "DOWNLOAD cannot set follow-redirect option: ");
  1812. if (!logVar.empty()) {
  1813. res = ::curl_easy_setopt(curl, CURLOPT_VERBOSE, 1);
  1814. check_curl_result(res, "DOWNLOAD cannot set verbose: ");
  1815. }
  1816. if (timeout > 0) {
  1817. res = ::curl_easy_setopt(curl, CURLOPT_TIMEOUT, timeout);
  1818. check_curl_result(res, "DOWNLOAD cannot set timeout: ");
  1819. }
  1820. if (inactivity_timeout > 0) {
  1821. // Give up if there is no progress for a long time.
  1822. ::curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 1);
  1823. ::curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, inactivity_timeout);
  1824. }
  1825. // Need the progress helper's scope to last through the duration of
  1826. // the curl_easy_perform call... so this object is declared at function
  1827. // scope intentionally, rather than inside the "if(showProgress)"
  1828. // block...
  1829. //
  1830. cURLProgressHelper helper(&status.GetMakefile(), "download");
  1831. if (showProgress) {
  1832. res = ::curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0);
  1833. check_curl_result(res, "DOWNLOAD cannot set noprogress value: ");
  1834. res = ::curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION,
  1835. cmFileDownloadProgressCallback);
  1836. check_curl_result(res, "DOWNLOAD cannot set progress function: ");
  1837. res = ::curl_easy_setopt(curl, CURLOPT_PROGRESSDATA,
  1838. reinterpret_cast<void*>(&helper));
  1839. check_curl_result(res, "DOWNLOAD cannot set progress data: ");
  1840. }
  1841. if (!userpwd.empty()) {
  1842. res = ::curl_easy_setopt(curl, CURLOPT_USERPWD, userpwd.c_str());
  1843. check_curl_result(res, "DOWNLOAD cannot set user password: ");
  1844. }
  1845. struct curl_slist* headers = nullptr;
  1846. for (std::string const& h : curl_headers) {
  1847. headers = ::curl_slist_append(headers, h.c_str());
  1848. }
  1849. ::curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  1850. res = ::curl_easy_perform(curl);
  1851. ::curl_slist_free_all(headers);
  1852. /* always cleanup */
  1853. g_curl.release();
  1854. ::curl_easy_cleanup(curl);
  1855. if (!statusVar.empty()) {
  1856. status.GetMakefile().AddDefinition(
  1857. statusVar,
  1858. cmStrCat(static_cast<int>(res), ";\"", ::curl_easy_strerror(res), "\""));
  1859. }
  1860. ::curl_global_cleanup();
  1861. // Explicitly flush/close so we can measure the md5 accurately.
  1862. //
  1863. if (!file.empty()) {
  1864. fout.flush();
  1865. fout.close();
  1866. }
  1867. // Verify MD5 sum if requested:
  1868. //
  1869. if (hash) {
  1870. std::string actualHash = hash->HashFile(file);
  1871. if (actualHash.empty()) {
  1872. status.SetError("DOWNLOAD cannot compute hash on downloaded file");
  1873. return false;
  1874. }
  1875. if (expectedHash != actualHash) {
  1876. if (!statusVar.empty() && res == 0) {
  1877. status.GetMakefile().AddDefinition(statusVar,
  1878. "1;HASH mismatch: "
  1879. "expected: " +
  1880. expectedHash +
  1881. " actual: " + actualHash);
  1882. }
  1883. status.SetError(cmStrCat("DOWNLOAD HASH mismatch\n"
  1884. " for file: [",
  1885. file,
  1886. "]\n"
  1887. " expected hash: [",
  1888. expectedHash,
  1889. "]\n"
  1890. " actual hash: [",
  1891. actualHash,
  1892. "]\n"
  1893. " status: [",
  1894. static_cast<int>(res), ";\"",
  1895. ::curl_easy_strerror(res), "\"]\n"));
  1896. return false;
  1897. }
  1898. }
  1899. if (!logVar.empty()) {
  1900. chunkDebug.push_back(0);
  1901. status.GetMakefile().AddDefinition(logVar, chunkDebug.data());
  1902. }
  1903. return true;
  1904. #else
  1905. status.SetError("DOWNLOAD not supported by bootstrap cmake.");
  1906. return false;
  1907. #endif
  1908. }
  1909. bool HandleUploadCommand(std::vector<std::string> const& args,
  1910. cmExecutionStatus& status)
  1911. {
  1912. #if !defined(CMAKE_BOOTSTRAP)
  1913. if (args.size() < 3) {
  1914. status.SetError("UPLOAD must be called with at least three arguments.");
  1915. return false;
  1916. }
  1917. auto i = args.begin();
  1918. ++i;
  1919. std::string filename = *i;
  1920. ++i;
  1921. std::string url = *i;
  1922. ++i;
  1923. long timeout = 0;
  1924. long inactivity_timeout = 0;
  1925. std::string logVar;
  1926. std::string statusVar;
  1927. bool showProgress = false;
  1928. bool tls_verify = status.GetMakefile().IsOn("CMAKE_TLS_VERIFY");
  1929. cmProp cainfo = status.GetMakefile().GetDefinition("CMAKE_TLS_CAINFO");
  1930. std::string userpwd;
  1931. std::string netrc_level =
  1932. status.GetMakefile().GetSafeDefinition("CMAKE_NETRC");
  1933. std::string netrc_file =
  1934. status.GetMakefile().GetSafeDefinition("CMAKE_NETRC_FILE");
  1935. std::vector<std::string> curl_headers;
  1936. while (i != args.end()) {
  1937. if (*i == "TIMEOUT") {
  1938. ++i;
  1939. if (i != args.end()) {
  1940. timeout = atol(i->c_str());
  1941. } else {
  1942. status.SetError("UPLOAD missing time for TIMEOUT.");
  1943. return false;
  1944. }
  1945. } else if (*i == "INACTIVITY_TIMEOUT") {
  1946. ++i;
  1947. if (i != args.end()) {
  1948. inactivity_timeout = atol(i->c_str());
  1949. } else {
  1950. status.SetError("UPLOAD missing time for INACTIVITY_TIMEOUT.");
  1951. return false;
  1952. }
  1953. } else if (*i == "LOG") {
  1954. ++i;
  1955. if (i == args.end()) {
  1956. status.SetError("UPLOAD missing VAR for LOG.");
  1957. return false;
  1958. }
  1959. logVar = *i;
  1960. } else if (*i == "STATUS") {
  1961. ++i;
  1962. if (i == args.end()) {
  1963. status.SetError("UPLOAD missing VAR for STATUS.");
  1964. return false;
  1965. }
  1966. statusVar = *i;
  1967. } else if (*i == "SHOW_PROGRESS") {
  1968. showProgress = true;
  1969. } else if (*i == "TLS_VERIFY") {
  1970. ++i;
  1971. if (i != args.end()) {
  1972. tls_verify = cmIsOn(*i);
  1973. } else {
  1974. status.SetError("UPLOAD missing bool value for TLS_VERIFY.");
  1975. return false;
  1976. }
  1977. } else if (*i == "TLS_CAINFO") {
  1978. ++i;
  1979. if (i != args.end()) {
  1980. cainfo = &(*i);
  1981. } else {
  1982. status.SetError("UPLOAD missing file value for TLS_CAINFO.");
  1983. return false;
  1984. }
  1985. } else if (*i == "NETRC_FILE") {
  1986. ++i;
  1987. if (i != args.end()) {
  1988. netrc_file = *i;
  1989. } else {
  1990. status.SetError("UPLOAD missing file value for NETRC_FILE.");
  1991. return false;
  1992. }
  1993. } else if (*i == "NETRC") {
  1994. ++i;
  1995. if (i != args.end()) {
  1996. netrc_level = *i;
  1997. } else {
  1998. status.SetError("UPLOAD missing level value for NETRC.");
  1999. return false;
  2000. }
  2001. } else if (*i == "USERPWD") {
  2002. ++i;
  2003. if (i == args.end()) {
  2004. status.SetError("UPLOAD missing string for USERPWD.");
  2005. return false;
  2006. }
  2007. userpwd = *i;
  2008. } else if (*i == "HTTPHEADER") {
  2009. ++i;
  2010. if (i == args.end()) {
  2011. status.SetError("UPLOAD missing string for HTTPHEADER.");
  2012. return false;
  2013. }
  2014. curl_headers.push_back(*i);
  2015. } else {
  2016. // Do not return error for compatibility reason.
  2017. std::string err = cmStrCat("Unexpected argument: ", *i);
  2018. status.GetMakefile().IssueMessage(MessageType::AUTHOR_WARNING, err);
  2019. }
  2020. ++i;
  2021. }
  2022. // Open file for reading:
  2023. //
  2024. FILE* fin = cmsys::SystemTools::Fopen(filename, "rb");
  2025. if (!fin) {
  2026. std::string errStr =
  2027. cmStrCat("UPLOAD cannot open file '", filename, "' for reading.");
  2028. status.SetError(errStr);
  2029. return false;
  2030. }
  2031. unsigned long file_size = cmsys::SystemTools::FileLength(filename);
  2032. # if defined(_WIN32)
  2033. url = fix_file_url_windows(url);
  2034. # endif
  2035. ::CURL* curl;
  2036. ::curl_global_init(CURL_GLOBAL_DEFAULT);
  2037. curl = ::curl_easy_init();
  2038. if (!curl) {
  2039. status.SetError("UPLOAD error initializing curl.");
  2040. fclose(fin);
  2041. return false;
  2042. }
  2043. cURLEasyGuard g_curl(curl);
  2044. // enable HTTP ERROR parsing
  2045. ::CURLcode res = ::curl_easy_setopt(curl, CURLOPT_FAILONERROR, 1);
  2046. check_curl_result(res, "UPLOAD cannot set fail on error flag: ");
  2047. // enable uploading
  2048. res = ::curl_easy_setopt(curl, CURLOPT_UPLOAD, 1);
  2049. check_curl_result(res, "UPLOAD cannot set upload flag: ");
  2050. res = ::curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  2051. check_curl_result(res, "UPLOAD cannot set url: ");
  2052. res =
  2053. ::curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, cmWriteToMemoryCallback);
  2054. check_curl_result(res, "UPLOAD cannot set write function: ");
  2055. res = ::curl_easy_setopt(curl, CURLOPT_DEBUGFUNCTION,
  2056. cmFileCommandCurlDebugCallback);
  2057. check_curl_result(res, "UPLOAD cannot set debug function: ");
  2058. // check to see if TLS verification is requested
  2059. if (tls_verify) {
  2060. res = ::curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1);
  2061. check_curl_result(res, "UPLOAD cannot set TLS/SSL Verify on: ");
  2062. } else {
  2063. res = ::curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0);
  2064. check_curl_result(res, "UPLOAD cannot set TLS/SSL Verify off: ");
  2065. }
  2066. // check to see if a CAINFO file has been specified
  2067. // command arg comes first
  2068. std::string const& cainfo_err = cmCurlSetCAInfo(curl, cmToCStr(cainfo));
  2069. if (!cainfo_err.empty()) {
  2070. status.SetError(cainfo_err);
  2071. return false;
  2072. }
  2073. cmFileCommandVectorOfChar chunkResponse;
  2074. cmFileCommandVectorOfChar chunkDebug;
  2075. res = ::curl_easy_setopt(curl, CURLOPT_WRITEDATA, &chunkResponse);
  2076. check_curl_result(res, "UPLOAD cannot set write data: ");
  2077. res = ::curl_easy_setopt(curl, CURLOPT_DEBUGDATA, &chunkDebug);
  2078. check_curl_result(res, "UPLOAD cannot set debug data: ");
  2079. res = ::curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  2080. check_curl_result(res, "UPLOAD cannot set follow-redirect option: ");
  2081. if (!logVar.empty()) {
  2082. res = ::curl_easy_setopt(curl, CURLOPT_VERBOSE, 1);
  2083. check_curl_result(res, "UPLOAD cannot set verbose: ");
  2084. }
  2085. if (timeout > 0) {
  2086. res = ::curl_easy_setopt(curl, CURLOPT_TIMEOUT, timeout);
  2087. check_curl_result(res, "UPLOAD cannot set timeout: ");
  2088. }
  2089. if (inactivity_timeout > 0) {
  2090. // Give up if there is no progress for a long time.
  2091. ::curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 1);
  2092. ::curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, inactivity_timeout);
  2093. }
  2094. // Need the progress helper's scope to last through the duration of
  2095. // the curl_easy_perform call... so this object is declared at function
  2096. // scope intentionally, rather than inside the "if(showProgress)"
  2097. // block...
  2098. //
  2099. cURLProgressHelper helper(&status.GetMakefile(), "upload");
  2100. if (showProgress) {
  2101. res = ::curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0);
  2102. check_curl_result(res, "UPLOAD cannot set noprogress value: ");
  2103. res = ::curl_easy_setopt(curl, CURLOPT_PROGRESSFUNCTION,
  2104. cmFileUploadProgressCallback);
  2105. check_curl_result(res, "UPLOAD cannot set progress function: ");
  2106. res = ::curl_easy_setopt(curl, CURLOPT_PROGRESSDATA,
  2107. reinterpret_cast<void*>(&helper));
  2108. check_curl_result(res, "UPLOAD cannot set progress data: ");
  2109. }
  2110. // now specify which file to upload
  2111. res = ::curl_easy_setopt(curl, CURLOPT_INFILE, fin);
  2112. check_curl_result(res, "UPLOAD cannot set input file: ");
  2113. // and give the size of the upload (optional)
  2114. res =
  2115. ::curl_easy_setopt(curl, CURLOPT_INFILESIZE, static_cast<long>(file_size));
  2116. check_curl_result(res, "UPLOAD cannot set input file size: ");
  2117. if (!userpwd.empty()) {
  2118. res = ::curl_easy_setopt(curl, CURLOPT_USERPWD, userpwd.c_str());
  2119. check_curl_result(res, "UPLOAD cannot set user password: ");
  2120. }
  2121. // check to see if netrc parameters have been specified
  2122. // local command args takes precedence over CMAKE_NETRC*
  2123. netrc_level = cmSystemTools::UpperCase(netrc_level);
  2124. std::string const& netrc_option_err =
  2125. cmCurlSetNETRCOption(curl, netrc_level, netrc_file);
  2126. if (!netrc_option_err.empty()) {
  2127. status.SetError(netrc_option_err);
  2128. return false;
  2129. }
  2130. struct curl_slist* headers = nullptr;
  2131. for (std::string const& h : curl_headers) {
  2132. headers = ::curl_slist_append(headers, h.c_str());
  2133. }
  2134. ::curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  2135. res = ::curl_easy_perform(curl);
  2136. ::curl_slist_free_all(headers);
  2137. /* always cleanup */
  2138. g_curl.release();
  2139. ::curl_easy_cleanup(curl);
  2140. if (!statusVar.empty()) {
  2141. status.GetMakefile().AddDefinition(
  2142. statusVar,
  2143. cmStrCat(static_cast<int>(res), ";\"", ::curl_easy_strerror(res), "\""));
  2144. }
  2145. ::curl_global_cleanup();
  2146. fclose(fin);
  2147. fin = nullptr;
  2148. if (!logVar.empty()) {
  2149. std::string log;
  2150. if (!chunkResponse.empty()) {
  2151. chunkResponse.push_back(0);
  2152. log += "Response:\n";
  2153. log += chunkResponse.data();
  2154. log += "\n";
  2155. }
  2156. if (!chunkDebug.empty()) {
  2157. chunkDebug.push_back(0);
  2158. log += "Debug:\n";
  2159. log += chunkDebug.data();
  2160. log += "\n";
  2161. }
  2162. status.GetMakefile().AddDefinition(logVar, log);
  2163. }
  2164. return true;
  2165. #else
  2166. status.SetError("UPLOAD not supported by bootstrap cmake.");
  2167. return false;
  2168. #endif
  2169. }
  2170. void AddEvaluationFile(const std::string& inputName,
  2171. const std::string& targetName,
  2172. const std::string& outputExpr,
  2173. const std::string& condition, bool inputIsContent,
  2174. const std::string& newLineCharacter, mode_t permissions,
  2175. cmExecutionStatus& status)
  2176. {
  2177. cmListFileBacktrace lfbt = status.GetMakefile().GetBacktrace();
  2178. cmGeneratorExpression outputGe(lfbt);
  2179. std::unique_ptr<cmCompiledGeneratorExpression> outputCge =
  2180. outputGe.Parse(outputExpr);
  2181. cmGeneratorExpression conditionGe(lfbt);
  2182. std::unique_ptr<cmCompiledGeneratorExpression> conditionCge =
  2183. conditionGe.Parse(condition);
  2184. status.GetMakefile().AddEvaluationFile(
  2185. inputName, targetName, std::move(outputCge), std::move(conditionCge),
  2186. newLineCharacter, permissions, inputIsContent);
  2187. }
  2188. bool HandleGenerateCommand(std::vector<std::string> const& args,
  2189. cmExecutionStatus& status)
  2190. {
  2191. if (args.size() < 5) {
  2192. status.SetError("Incorrect arguments to GENERATE subcommand.");
  2193. return false;
  2194. }
  2195. struct Arguments
  2196. {
  2197. std::string Output;
  2198. std::string Input;
  2199. std::string Content;
  2200. std::string Condition;
  2201. std::string Target;
  2202. std::string NewLineStyle;
  2203. bool NoSourcePermissions = false;
  2204. bool UseSourcePermissions = false;
  2205. std::vector<std::string> FilePermissions;
  2206. };
  2207. static auto const parser =
  2208. cmArgumentParser<Arguments>{}
  2209. .Bind("OUTPUT"_s, &Arguments::Output)
  2210. .Bind("INPUT"_s, &Arguments::Input)
  2211. .Bind("CONTENT"_s, &Arguments::Content)
  2212. .Bind("CONDITION"_s, &Arguments::Condition)
  2213. .Bind("TARGET"_s, &Arguments::Target)
  2214. .Bind("NO_SOURCE_PERMISSIONS"_s, &Arguments::NoSourcePermissions)
  2215. .Bind("USE_SOURCE_PERMISSIONS"_s, &Arguments::UseSourcePermissions)
  2216. .Bind("FILE_PERMISSIONS"_s, &Arguments::FilePermissions)
  2217. .Bind("NEWLINE_STYLE"_s, &Arguments::NewLineStyle);
  2218. std::vector<std::string> unparsedArguments;
  2219. std::vector<std::string> keywordsMissingValues;
  2220. std::vector<std::string> parsedKeywords;
  2221. Arguments const arguments =
  2222. parser.Parse(cmMakeRange(args).advance(1), &unparsedArguments,
  2223. &keywordsMissingValues, &parsedKeywords);
  2224. if (!keywordsMissingValues.empty()) {
  2225. status.SetError("Incorrect arguments to GENERATE subcommand.");
  2226. return false;
  2227. }
  2228. if (!unparsedArguments.empty()) {
  2229. status.SetError("Unknown argument to GENERATE subcommand.");
  2230. return false;
  2231. }
  2232. bool mandatoryOptionsSpecified = false;
  2233. if (parsedKeywords.size() > 1) {
  2234. const bool outputOprionSpecified = parsedKeywords[0] == "OUTPUT"_s;
  2235. const bool inputOrContentSpecified =
  2236. parsedKeywords[1] == "INPUT"_s || parsedKeywords[1] == "CONTENT"_s;
  2237. if (outputOprionSpecified && inputOrContentSpecified) {
  2238. mandatoryOptionsSpecified = true;
  2239. }
  2240. }
  2241. if (!mandatoryOptionsSpecified) {
  2242. status.SetError("Incorrect arguments to GENERATE subcommand.");
  2243. return false;
  2244. }
  2245. const bool conditionOptionSpecified =
  2246. std::find(parsedKeywords.begin(), parsedKeywords.end(), "CONDITION"_s) !=
  2247. parsedKeywords.end();
  2248. if (conditionOptionSpecified && arguments.Condition.empty()) {
  2249. status.SetError("CONDITION of sub-command GENERATE must not be empty "
  2250. "if specified.");
  2251. return false;
  2252. }
  2253. const bool targetOptionSpecified =
  2254. std::find(parsedKeywords.begin(), parsedKeywords.end(), "TARGET"_s) !=
  2255. parsedKeywords.end();
  2256. if (targetOptionSpecified && arguments.Target.empty()) {
  2257. status.SetError("TARGET of sub-command GENERATE must not be empty "
  2258. "if specified.");
  2259. return false;
  2260. }
  2261. const bool outputOptionSpecified =
  2262. std::find(parsedKeywords.begin(), parsedKeywords.end(), "OUTPUT"_s) !=
  2263. parsedKeywords.end();
  2264. if (outputOptionSpecified && parsedKeywords[0] != "OUTPUT"_s) {
  2265. status.SetError("Incorrect arguments to GENERATE subcommand.");
  2266. return false;
  2267. }
  2268. const bool inputIsContent = parsedKeywords[1] != "INPUT"_s;
  2269. if (inputIsContent && parsedKeywords[1] != "CONTENT") {
  2270. status.SetError("Unknown argument to GENERATE subcommand.");
  2271. }
  2272. const bool newLineStyleSpecified =
  2273. std::find(parsedKeywords.begin(), parsedKeywords.end(),
  2274. "NEWLINE_STYLE"_s) != parsedKeywords.end();
  2275. cmNewLineStyle newLineStyle;
  2276. if (newLineStyleSpecified) {
  2277. std::string errorMessage;
  2278. if (!newLineStyle.ReadFromArguments(args, errorMessage)) {
  2279. status.SetError(cmStrCat("GENERATE ", errorMessage));
  2280. return false;
  2281. }
  2282. }
  2283. std::string input = arguments.Input;
  2284. if (inputIsContent) {
  2285. input = arguments.Content;
  2286. }
  2287. if (arguments.NoSourcePermissions && arguments.UseSourcePermissions) {
  2288. status.SetError("given both NO_SOURCE_PERMISSIONS and "
  2289. "USE_SOURCE_PERMISSIONS. Only one option allowed.");
  2290. return false;
  2291. }
  2292. if (!arguments.FilePermissions.empty()) {
  2293. if (arguments.NoSourcePermissions) {
  2294. status.SetError("given both NO_SOURCE_PERMISSIONS and "
  2295. "FILE_PERMISSIONS. Only one option allowed.");
  2296. return false;
  2297. }
  2298. if (arguments.UseSourcePermissions) {
  2299. status.SetError("given both USE_SOURCE_PERMISSIONS and "
  2300. "FILE_PERMISSIONS. Only one option allowed.");
  2301. return false;
  2302. }
  2303. }
  2304. if (arguments.UseSourcePermissions) {
  2305. if (inputIsContent) {
  2306. status.SetError("given USE_SOURCE_PERMISSIONS without a file INPUT.");
  2307. return false;
  2308. }
  2309. }
  2310. mode_t permissions = 0;
  2311. if (arguments.NoSourcePermissions) {
  2312. permissions |= cmFSPermissions::mode_owner_read;
  2313. permissions |= cmFSPermissions::mode_owner_write;
  2314. permissions |= cmFSPermissions::mode_group_read;
  2315. permissions |= cmFSPermissions::mode_world_read;
  2316. }
  2317. if (!arguments.FilePermissions.empty()) {
  2318. std::vector<std::string> invalidOptions;
  2319. for (auto const& e : arguments.FilePermissions) {
  2320. if (!cmFSPermissions::stringToModeT(e, permissions)) {
  2321. invalidOptions.push_back(e);
  2322. }
  2323. }
  2324. if (!invalidOptions.empty()) {
  2325. std::ostringstream oss;
  2326. oss << "given invalid permission ";
  2327. for (auto i = 0u; i < invalidOptions.size(); i++) {
  2328. if (i == 0u) {
  2329. oss << "\"" << invalidOptions[i] << "\"";
  2330. } else {
  2331. oss << ",\"" << invalidOptions[i] << "\"";
  2332. }
  2333. }
  2334. oss << ".";
  2335. status.SetError(oss.str());
  2336. return false;
  2337. }
  2338. }
  2339. AddEvaluationFile(input, arguments.Target, arguments.Output,
  2340. arguments.Condition, inputIsContent,
  2341. newLineStyle.GetCharacters(), permissions, status);
  2342. return true;
  2343. }
  2344. bool HandleLockCommand(std::vector<std::string> const& args,
  2345. cmExecutionStatus& status)
  2346. {
  2347. #if !defined(CMAKE_BOOTSTRAP)
  2348. // Default values
  2349. bool directory = false;
  2350. bool release = false;
  2351. enum Guard
  2352. {
  2353. GUARD_FUNCTION,
  2354. GUARD_FILE,
  2355. GUARD_PROCESS
  2356. };
  2357. Guard guard = GUARD_PROCESS;
  2358. std::string resultVariable;
  2359. unsigned long timeout = static_cast<unsigned long>(-1);
  2360. // Parse arguments
  2361. if (args.size() < 2) {
  2362. status.GetMakefile().IssueMessage(
  2363. MessageType::FATAL_ERROR,
  2364. "sub-command LOCK requires at least two arguments.");
  2365. return false;
  2366. }
  2367. std::string path = args[1];
  2368. for (unsigned i = 2; i < args.size(); ++i) {
  2369. if (args[i] == "DIRECTORY") {
  2370. directory = true;
  2371. } else if (args[i] == "RELEASE") {
  2372. release = true;
  2373. } else if (args[i] == "GUARD") {
  2374. ++i;
  2375. const char* merr = "expected FUNCTION, FILE or PROCESS after GUARD";
  2376. if (i >= args.size()) {
  2377. status.GetMakefile().IssueMessage(MessageType::FATAL_ERROR, merr);
  2378. return false;
  2379. }
  2380. if (args[i] == "FUNCTION") {
  2381. guard = GUARD_FUNCTION;
  2382. } else if (args[i] == "FILE") {
  2383. guard = GUARD_FILE;
  2384. } else if (args[i] == "PROCESS") {
  2385. guard = GUARD_PROCESS;
  2386. } else {
  2387. status.GetMakefile().IssueMessage(
  2388. MessageType::FATAL_ERROR,
  2389. cmStrCat(merr, ", but got:\n \"", args[i], "\"."));
  2390. return false;
  2391. }
  2392. } else if (args[i] == "RESULT_VARIABLE") {
  2393. ++i;
  2394. if (i >= args.size()) {
  2395. status.GetMakefile().IssueMessage(
  2396. MessageType::FATAL_ERROR,
  2397. "expected variable name after RESULT_VARIABLE");
  2398. return false;
  2399. }
  2400. resultVariable = args[i];
  2401. } else if (args[i] == "TIMEOUT") {
  2402. ++i;
  2403. if (i >= args.size()) {
  2404. status.GetMakefile().IssueMessage(
  2405. MessageType::FATAL_ERROR, "expected timeout value after TIMEOUT");
  2406. return false;
  2407. }
  2408. long scanned;
  2409. if (!cmStrToLong(args[i], &scanned) || scanned < 0) {
  2410. status.GetMakefile().IssueMessage(
  2411. MessageType::FATAL_ERROR,
  2412. cmStrCat("TIMEOUT value \"", args[i],
  2413. "\" is not an unsigned integer."));
  2414. return false;
  2415. }
  2416. timeout = static_cast<unsigned long>(scanned);
  2417. } else {
  2418. status.GetMakefile().IssueMessage(
  2419. MessageType::FATAL_ERROR,
  2420. cmStrCat("expected DIRECTORY, RELEASE, GUARD, RESULT_VARIABLE or ",
  2421. "TIMEOUT\nbut got: \"", args[i], "\"."));
  2422. return false;
  2423. }
  2424. }
  2425. if (directory) {
  2426. path += "/cmake.lock";
  2427. }
  2428. // Unify path (remove '//', '/../', ...)
  2429. path = cmSystemTools::CollapseFullPath(
  2430. path, status.GetMakefile().GetCurrentSourceDirectory());
  2431. // Create file and directories if needed
  2432. std::string parentDir = cmSystemTools::GetParentDirectory(path);
  2433. if (!cmSystemTools::MakeDirectory(parentDir)) {
  2434. status.GetMakefile().IssueMessage(
  2435. MessageType::FATAL_ERROR,
  2436. cmStrCat("directory\n \"", parentDir,
  2437. "\"\ncreation failed (check permissions)."));
  2438. cmSystemTools::SetFatalErrorOccured();
  2439. return false;
  2440. }
  2441. FILE* file = cmsys::SystemTools::Fopen(path, "w");
  2442. if (!file) {
  2443. status.GetMakefile().IssueMessage(
  2444. MessageType::FATAL_ERROR,
  2445. cmStrCat("file\n \"", path,
  2446. "\"\ncreation failed (check permissions)."));
  2447. cmSystemTools::SetFatalErrorOccured();
  2448. return false;
  2449. }
  2450. fclose(file);
  2451. // Actual lock/unlock
  2452. cmFileLockPool& lockPool =
  2453. status.GetMakefile().GetGlobalGenerator()->GetFileLockPool();
  2454. cmFileLockResult fileLockResult(cmFileLockResult::MakeOk());
  2455. if (release) {
  2456. fileLockResult = lockPool.Release(path);
  2457. } else {
  2458. switch (guard) {
  2459. case GUARD_FUNCTION:
  2460. fileLockResult = lockPool.LockFunctionScope(path, timeout);
  2461. break;
  2462. case GUARD_FILE:
  2463. fileLockResult = lockPool.LockFileScope(path, timeout);
  2464. break;
  2465. case GUARD_PROCESS:
  2466. fileLockResult = lockPool.LockProcessScope(path, timeout);
  2467. break;
  2468. default:
  2469. cmSystemTools::SetFatalErrorOccured();
  2470. return false;
  2471. }
  2472. }
  2473. const std::string result = fileLockResult.GetOutputMessage();
  2474. if (resultVariable.empty() && !fileLockResult.IsOk()) {
  2475. status.GetMakefile().IssueMessage(
  2476. MessageType::FATAL_ERROR,
  2477. cmStrCat("error locking file\n \"", path, "\"\n", result, "."));
  2478. cmSystemTools::SetFatalErrorOccured();
  2479. return false;
  2480. }
  2481. if (!resultVariable.empty()) {
  2482. status.GetMakefile().AddDefinition(resultVariable, result);
  2483. }
  2484. return true;
  2485. #else
  2486. static_cast<void>(args);
  2487. status.SetError("sub-command LOCK not implemented in bootstrap cmake");
  2488. return false;
  2489. #endif
  2490. }
  2491. bool HandleTimestampCommand(std::vector<std::string> const& args,
  2492. cmExecutionStatus& status)
  2493. {
  2494. if (args.size() < 3) {
  2495. status.SetError("sub-command TIMESTAMP requires at least two arguments.");
  2496. return false;
  2497. }
  2498. if (args.size() > 5) {
  2499. status.SetError("sub-command TIMESTAMP takes at most four arguments.");
  2500. return false;
  2501. }
  2502. unsigned int argsIndex = 1;
  2503. const std::string& filename = args[argsIndex++];
  2504. const std::string& outputVariable = args[argsIndex++];
  2505. std::string formatString;
  2506. if (args.size() > argsIndex && args[argsIndex] != "UTC") {
  2507. formatString = args[argsIndex++];
  2508. }
  2509. bool utcFlag = false;
  2510. if (args.size() > argsIndex) {
  2511. if (args[argsIndex] == "UTC") {
  2512. utcFlag = true;
  2513. } else {
  2514. std::string e = " TIMESTAMP sub-command does not recognize option " +
  2515. args[argsIndex] + ".";
  2516. status.SetError(e);
  2517. return false;
  2518. }
  2519. }
  2520. cmTimestamp timestamp;
  2521. std::string result =
  2522. timestamp.FileModificationTime(filename.c_str(), formatString, utcFlag);
  2523. status.GetMakefile().AddDefinition(outputVariable, result);
  2524. return true;
  2525. }
  2526. bool HandleSizeCommand(std::vector<std::string> const& args,
  2527. cmExecutionStatus& status)
  2528. {
  2529. if (args.size() != 3) {
  2530. status.SetError(
  2531. cmStrCat(args[0], " requires a file name and output variable"));
  2532. return false;
  2533. }
  2534. unsigned int argsIndex = 1;
  2535. const std::string& filename = args[argsIndex++];
  2536. const std::string& outputVariable = args[argsIndex++];
  2537. if (!cmSystemTools::FileExists(filename, true)) {
  2538. status.SetError(
  2539. cmStrCat("SIZE requested of path that is not readable:\n ", filename));
  2540. return false;
  2541. }
  2542. status.GetMakefile().AddDefinition(
  2543. outputVariable, std::to_string(cmSystemTools::FileLength(filename)));
  2544. return true;
  2545. }
  2546. bool HandleReadSymlinkCommand(std::vector<std::string> const& args,
  2547. cmExecutionStatus& status)
  2548. {
  2549. if (args.size() != 3) {
  2550. status.SetError(
  2551. cmStrCat(args[0], " requires a file name and output variable"));
  2552. return false;
  2553. }
  2554. const std::string& filename = args[1];
  2555. const std::string& outputVariable = args[2];
  2556. std::string result;
  2557. if (!cmSystemTools::ReadSymlink(filename, result)) {
  2558. status.SetError(cmStrCat(
  2559. "READ_SYMLINK requested of path that is not a symlink:\n ", filename));
  2560. return false;
  2561. }
  2562. status.GetMakefile().AddDefinition(outputVariable, result);
  2563. return true;
  2564. }
  2565. bool HandleCreateLinkCommand(std::vector<std::string> const& args,
  2566. cmExecutionStatus& status)
  2567. {
  2568. if (args.size() < 3) {
  2569. status.SetError("CREATE_LINK must be called with at least two additional "
  2570. "arguments");
  2571. return false;
  2572. }
  2573. std::string const& fileName = args[1];
  2574. std::string const& newFileName = args[2];
  2575. struct Arguments
  2576. {
  2577. std::string Result;
  2578. bool CopyOnError = false;
  2579. bool Symbolic = false;
  2580. };
  2581. static auto const parser =
  2582. cmArgumentParser<Arguments>{}
  2583. .Bind("RESULT"_s, &Arguments::Result)
  2584. .Bind("COPY_ON_ERROR"_s, &Arguments::CopyOnError)
  2585. .Bind("SYMBOLIC"_s, &Arguments::Symbolic);
  2586. std::vector<std::string> unconsumedArgs;
  2587. Arguments const arguments =
  2588. parser.Parse(cmMakeRange(args).advance(3), &unconsumedArgs);
  2589. if (!unconsumedArgs.empty()) {
  2590. status.SetError("unknown argument: \"" + unconsumedArgs.front() + '\"');
  2591. return false;
  2592. }
  2593. // The system error message generated in the operation.
  2594. std::string result;
  2595. // Check if the paths are distinct.
  2596. if (fileName == newFileName) {
  2597. result = "CREATE_LINK cannot use same file and newfile";
  2598. if (!arguments.Result.empty()) {
  2599. status.GetMakefile().AddDefinition(arguments.Result, result);
  2600. return true;
  2601. }
  2602. status.SetError(result);
  2603. return false;
  2604. }
  2605. // Hard link requires original file to exist.
  2606. if (!arguments.Symbolic && !cmSystemTools::FileExists(fileName)) {
  2607. result = "Cannot hard link \'" + fileName + "\' as it does not exist.";
  2608. if (!arguments.Result.empty()) {
  2609. status.GetMakefile().AddDefinition(arguments.Result, result);
  2610. return true;
  2611. }
  2612. status.SetError(result);
  2613. return false;
  2614. }
  2615. // Check if the new file already exists and remove it.
  2616. if ((cmSystemTools::FileExists(newFileName) ||
  2617. cmSystemTools::FileIsSymlink(newFileName)) &&
  2618. !cmSystemTools::RemoveFile(newFileName)) {
  2619. std::ostringstream e;
  2620. e << "Failed to create link '" << newFileName
  2621. << "' because existing path cannot be removed: "
  2622. << cmSystemTools::GetLastSystemError() << "\n";
  2623. if (!arguments.Result.empty()) {
  2624. status.GetMakefile().AddDefinition(arguments.Result, e.str());
  2625. return true;
  2626. }
  2627. status.SetError(e.str());
  2628. return false;
  2629. }
  2630. // Whether the operation completed successfully.
  2631. bool completed = false;
  2632. // Check if the command requires a symbolic link.
  2633. if (arguments.Symbolic) {
  2634. completed = cmSystemTools::CreateSymlink(fileName, newFileName, &result);
  2635. } else {
  2636. completed = cmSystemTools::CreateLink(fileName, newFileName, &result);
  2637. }
  2638. // Check if copy-on-error is enabled in the arguments.
  2639. if (!completed && arguments.CopyOnError) {
  2640. cmsys::Status copied =
  2641. cmsys::SystemTools::CopyFileAlways(fileName, newFileName);
  2642. if (copied) {
  2643. completed = true;
  2644. } else {
  2645. result = "Copy failed: " + copied.GetString();
  2646. }
  2647. }
  2648. // Check if the operation was successful.
  2649. if (completed) {
  2650. result = "0";
  2651. } else if (arguments.Result.empty()) {
  2652. // The operation failed and the result is not reported in a variable.
  2653. status.SetError(result);
  2654. return false;
  2655. }
  2656. if (!arguments.Result.empty()) {
  2657. status.GetMakefile().AddDefinition(arguments.Result, result);
  2658. }
  2659. return true;
  2660. }
  2661. bool HandleGetRuntimeDependenciesCommand(std::vector<std::string> const& args,
  2662. cmExecutionStatus& status)
  2663. {
  2664. static const std::set<std::string> supportedPlatforms = { "Windows", "Linux",
  2665. "Darwin" };
  2666. std::string platform =
  2667. status.GetMakefile().GetSafeDefinition("CMAKE_HOST_SYSTEM_NAME");
  2668. if (!supportedPlatforms.count(platform)) {
  2669. status.SetError(
  2670. cmStrCat("GET_RUNTIME_DEPENDENCIES is not supported on system \"",
  2671. platform, "\""));
  2672. cmSystemTools::SetFatalErrorOccured();
  2673. return false;
  2674. }
  2675. if (status.GetMakefile().GetState()->GetMode() == cmState::Project) {
  2676. status.GetMakefile().IssueMessage(
  2677. MessageType::AUTHOR_WARNING,
  2678. "You have used file(GET_RUNTIME_DEPENDENCIES)"
  2679. " in project mode. This is probably not what "
  2680. "you intended to do. Instead, please consider"
  2681. " using it in an install(CODE) or "
  2682. "install(SCRIPT) command. For example:"
  2683. "\n install(CODE [["
  2684. "\n file(GET_RUNTIME_DEPENDENCIES"
  2685. "\n # ..."
  2686. "\n )"
  2687. "\n ]])");
  2688. }
  2689. struct Arguments
  2690. {
  2691. std::string ResolvedDependenciesVar;
  2692. std::string UnresolvedDependenciesVar;
  2693. std::string ConflictingDependenciesPrefix;
  2694. std::string BundleExecutable;
  2695. std::vector<std::string> Executables;
  2696. std::vector<std::string> Libraries;
  2697. std::vector<std::string> Directories;
  2698. std::vector<std::string> Modules;
  2699. std::vector<std::string> PreIncludeRegexes;
  2700. std::vector<std::string> PreExcludeRegexes;
  2701. std::vector<std::string> PostIncludeRegexes;
  2702. std::vector<std::string> PostExcludeRegexes;
  2703. };
  2704. static auto const parser =
  2705. cmArgumentParser<Arguments>{}
  2706. .Bind("RESOLVED_DEPENDENCIES_VAR"_s, &Arguments::ResolvedDependenciesVar)
  2707. .Bind("UNRESOLVED_DEPENDENCIES_VAR"_s,
  2708. &Arguments::UnresolvedDependenciesVar)
  2709. .Bind("CONFLICTING_DEPENDENCIES_PREFIX"_s,
  2710. &Arguments::ConflictingDependenciesPrefix)
  2711. .Bind("BUNDLE_EXECUTABLE"_s, &Arguments::BundleExecutable)
  2712. .Bind("EXECUTABLES"_s, &Arguments::Executables)
  2713. .Bind("LIBRARIES"_s, &Arguments::Libraries)
  2714. .Bind("MODULES"_s, &Arguments::Modules)
  2715. .Bind("DIRECTORIES"_s, &Arguments::Directories)
  2716. .Bind("PRE_INCLUDE_REGEXES"_s, &Arguments::PreIncludeRegexes)
  2717. .Bind("PRE_EXCLUDE_REGEXES"_s, &Arguments::PreExcludeRegexes)
  2718. .Bind("POST_INCLUDE_REGEXES"_s, &Arguments::PostIncludeRegexes)
  2719. .Bind("POST_EXCLUDE_REGEXES"_s, &Arguments::PostExcludeRegexes);
  2720. std::vector<std::string> unrecognizedArguments;
  2721. std::vector<std::string> keywordsMissingValues;
  2722. auto parsedArgs =
  2723. parser.Parse(cmMakeRange(args).advance(1), &unrecognizedArguments,
  2724. &keywordsMissingValues);
  2725. auto argIt = unrecognizedArguments.begin();
  2726. if (argIt != unrecognizedArguments.end()) {
  2727. status.SetError(cmStrCat("Unrecognized argument: \"", *argIt, "\""));
  2728. cmSystemTools::SetFatalErrorOccured();
  2729. return false;
  2730. }
  2731. const std::vector<std::string> LIST_ARGS = { "DIRECTORIES",
  2732. "EXECUTABLES",
  2733. "LIBRARIES",
  2734. "MODULES",
  2735. "POST_EXCLUDE_REGEXES",
  2736. "POST_INCLUDE_REGEXES",
  2737. "PRE_EXCLUDE_REGEXES",
  2738. "PRE_INCLUDE_REGEXES" };
  2739. auto kwbegin = keywordsMissingValues.cbegin();
  2740. auto kwend = cmRemoveMatching(keywordsMissingValues, LIST_ARGS);
  2741. if (kwend != kwbegin) {
  2742. status.SetError(cmStrCat("Keywords missing values:\n ",
  2743. cmJoin(cmMakeRange(kwbegin, kwend), "\n ")));
  2744. cmSystemTools::SetFatalErrorOccured();
  2745. return false;
  2746. }
  2747. cmRuntimeDependencyArchive archive(
  2748. status, parsedArgs.Directories, parsedArgs.BundleExecutable,
  2749. parsedArgs.PreIncludeRegexes, parsedArgs.PreExcludeRegexes,
  2750. parsedArgs.PostIncludeRegexes, parsedArgs.PostExcludeRegexes);
  2751. if (!archive.Prepare()) {
  2752. cmSystemTools::SetFatalErrorOccured();
  2753. return false;
  2754. }
  2755. if (!archive.GetRuntimeDependencies(
  2756. parsedArgs.Executables, parsedArgs.Libraries, parsedArgs.Modules)) {
  2757. cmSystemTools::SetFatalErrorOccured();
  2758. return false;
  2759. }
  2760. std::vector<std::string> deps;
  2761. std::vector<std::string> unresolvedDeps;
  2762. std::vector<std::string> conflictingDeps;
  2763. for (auto const& val : archive.GetResolvedPaths()) {
  2764. bool unique = true;
  2765. auto it = val.second.begin();
  2766. assert(it != val.second.end());
  2767. auto const& firstPath = *it;
  2768. while (++it != val.second.end()) {
  2769. if (!cmSystemTools::SameFile(firstPath, *it)) {
  2770. unique = false;
  2771. break;
  2772. }
  2773. }
  2774. if (unique) {
  2775. deps.push_back(firstPath);
  2776. } else if (!parsedArgs.ConflictingDependenciesPrefix.empty()) {
  2777. conflictingDeps.push_back(val.first);
  2778. std::vector<std::string> paths;
  2779. paths.insert(paths.begin(), val.second.begin(), val.second.end());
  2780. std::string varName =
  2781. parsedArgs.ConflictingDependenciesPrefix + "_" + val.first;
  2782. std::string pathsStr = cmJoin(paths, ";");
  2783. status.GetMakefile().AddDefinition(varName, pathsStr);
  2784. } else {
  2785. std::ostringstream e;
  2786. e << "Multiple conflicting paths found for " << val.first << ":";
  2787. for (auto const& path : val.second) {
  2788. e << "\n " << path;
  2789. }
  2790. status.SetError(e.str());
  2791. cmSystemTools::SetFatalErrorOccured();
  2792. return false;
  2793. }
  2794. }
  2795. if (!archive.GetUnresolvedPaths().empty()) {
  2796. if (!parsedArgs.UnresolvedDependenciesVar.empty()) {
  2797. unresolvedDeps.insert(unresolvedDeps.begin(),
  2798. archive.GetUnresolvedPaths().begin(),
  2799. archive.GetUnresolvedPaths().end());
  2800. } else {
  2801. auto it = archive.GetUnresolvedPaths().begin();
  2802. assert(it != archive.GetUnresolvedPaths().end());
  2803. status.SetError(cmStrCat("Could not resolve file ", *it));
  2804. cmSystemTools::SetFatalErrorOccured();
  2805. return false;
  2806. }
  2807. }
  2808. if (!parsedArgs.ResolvedDependenciesVar.empty()) {
  2809. std::string val = cmJoin(deps, ";");
  2810. status.GetMakefile().AddDefinition(parsedArgs.ResolvedDependenciesVar,
  2811. val);
  2812. }
  2813. if (!parsedArgs.UnresolvedDependenciesVar.empty()) {
  2814. std::string val = cmJoin(unresolvedDeps, ";");
  2815. status.GetMakefile().AddDefinition(parsedArgs.UnresolvedDependenciesVar,
  2816. val);
  2817. }
  2818. if (!parsedArgs.ConflictingDependenciesPrefix.empty()) {
  2819. std::string val = cmJoin(conflictingDeps, ";");
  2820. status.GetMakefile().AddDefinition(
  2821. parsedArgs.ConflictingDependenciesPrefix + "_FILENAMES", val);
  2822. }
  2823. return true;
  2824. }
  2825. bool HandleConfigureCommand(std::vector<std::string> const& args,
  2826. cmExecutionStatus& status)
  2827. {
  2828. struct Arguments
  2829. {
  2830. std::string Output;
  2831. std::string Content;
  2832. bool EscapeQuotes = false;
  2833. bool AtOnly = false;
  2834. std::string NewlineStyle;
  2835. };
  2836. static auto const parser =
  2837. cmArgumentParser<Arguments>{}
  2838. .Bind("OUTPUT"_s, &Arguments::Output)
  2839. .Bind("CONTENT"_s, &Arguments::Content)
  2840. .Bind("ESCAPE_QUOTES"_s, &Arguments::EscapeQuotes)
  2841. .Bind("@ONLY"_s, &Arguments::AtOnly)
  2842. .Bind("NEWLINE_STYLE"_s, &Arguments::NewlineStyle);
  2843. std::vector<std::string> unrecognizedArguments;
  2844. std::vector<std::string> keywordsMissingArguments;
  2845. std::vector<std::string> parsedKeywords;
  2846. auto parsedArgs =
  2847. parser.Parse(cmMakeRange(args).advance(1), &unrecognizedArguments,
  2848. &keywordsMissingArguments, &parsedKeywords);
  2849. auto argIt = unrecognizedArguments.begin();
  2850. if (argIt != unrecognizedArguments.end()) {
  2851. status.SetError(
  2852. cmStrCat("CONFIGURE Unrecognized argument: \"", *argIt, "\""));
  2853. cmSystemTools::SetFatalErrorOccured();
  2854. return false;
  2855. }
  2856. std::vector<std::string> mandatoryOptions{ "OUTPUT", "CONTENT" };
  2857. for (auto const& e : mandatoryOptions) {
  2858. const bool optionHasNoValue =
  2859. std::find(keywordsMissingArguments.begin(),
  2860. keywordsMissingArguments.end(),
  2861. e) != keywordsMissingArguments.end();
  2862. if (optionHasNoValue) {
  2863. status.SetError(cmStrCat("CONFIGURE ", e, " option needs a value."));
  2864. cmSystemTools::SetFatalErrorOccured();
  2865. return false;
  2866. }
  2867. }
  2868. for (auto const& e : mandatoryOptions) {
  2869. const bool optionGiven =
  2870. std::find(parsedKeywords.begin(), parsedKeywords.end(), e) !=
  2871. parsedKeywords.end();
  2872. if (!optionGiven) {
  2873. status.SetError(cmStrCat("CONFIGURE ", e, " option is mandatory."));
  2874. cmSystemTools::SetFatalErrorOccured();
  2875. return false;
  2876. }
  2877. }
  2878. std::string errorMessage;
  2879. cmNewLineStyle newLineStyle;
  2880. if (!newLineStyle.ReadFromArguments(args, errorMessage)) {
  2881. status.SetError(cmStrCat("CONFIGURE ", errorMessage));
  2882. return false;
  2883. }
  2884. // Check for generator expressions
  2885. std::string outputFile = cmSystemTools::CollapseFullPath(
  2886. parsedArgs.Output, status.GetMakefile().GetCurrentBinaryDirectory());
  2887. std::string::size_type pos = outputFile.find_first_of("<>");
  2888. if (pos != std::string::npos) {
  2889. status.SetError(cmStrCat("CONFIGURE called with OUTPUT containing a \"",
  2890. outputFile[pos],
  2891. "\". This character is not allowed."));
  2892. return false;
  2893. }
  2894. cmMakefile& makeFile = status.GetMakefile();
  2895. if (!makeFile.CanIWriteThisFile(outputFile)) {
  2896. cmSystemTools::Error("Attempt to write file: " + outputFile +
  2897. " into a source directory.");
  2898. return false;
  2899. }
  2900. cmSystemTools::ConvertToUnixSlashes(outputFile);
  2901. // Re-generate if non-temporary outputs are missing.
  2902. // when we finalize the configuration we will remove all
  2903. // output files that now don't exist.
  2904. makeFile.AddCMakeOutputFile(outputFile);
  2905. // Create output directory
  2906. const std::string::size_type slashPos = outputFile.rfind('/');
  2907. if (slashPos != std::string::npos) {
  2908. const std::string path = outputFile.substr(0, slashPos);
  2909. cmSystemTools::MakeDirectory(path);
  2910. }
  2911. std::string newLineCharacters = "\n";
  2912. bool open_with_binary_flag = false;
  2913. if (newLineStyle.IsValid()) {
  2914. newLineCharacters = newLineStyle.GetCharacters();
  2915. open_with_binary_flag = true;
  2916. }
  2917. cmGeneratedFileStream fout;
  2918. fout.Open(outputFile, false, open_with_binary_flag);
  2919. if (!fout) {
  2920. cmSystemTools::Error("Could not open file for write in copy operation " +
  2921. outputFile);
  2922. cmSystemTools::ReportLastSystemError("");
  2923. return false;
  2924. }
  2925. fout.SetCopyIfDifferent(true);
  2926. // copy input to output and expand variables from input at the same time
  2927. std::stringstream sin(parsedArgs.Content, std::ios::in);
  2928. std::string inLine;
  2929. std::string outLine;
  2930. bool hasNewLine = false;
  2931. while (cmSystemTools::GetLineFromStream(sin, inLine, &hasNewLine)) {
  2932. outLine.clear();
  2933. makeFile.ConfigureString(inLine, outLine, parsedArgs.AtOnly,
  2934. parsedArgs.EscapeQuotes);
  2935. fout << outLine;
  2936. if (hasNewLine || newLineStyle.IsValid()) {
  2937. fout << newLineCharacters;
  2938. }
  2939. }
  2940. // close file before attempting to copy
  2941. fout.close();
  2942. return true;
  2943. }
  2944. bool HandleArchiveCreateCommand(std::vector<std::string> const& args,
  2945. cmExecutionStatus& status)
  2946. {
  2947. struct Arguments
  2948. {
  2949. std::string Output;
  2950. std::string Format;
  2951. std::string Compression;
  2952. std::string CompressionLevel;
  2953. std::string MTime;
  2954. bool Verbose = false;
  2955. std::vector<std::string> Paths;
  2956. };
  2957. static auto const parser =
  2958. cmArgumentParser<Arguments>{}
  2959. .Bind("OUTPUT"_s, &Arguments::Output)
  2960. .Bind("FORMAT"_s, &Arguments::Format)
  2961. .Bind("COMPRESSION"_s, &Arguments::Compression)
  2962. .Bind("COMPRESSION_LEVEL"_s, &Arguments::CompressionLevel)
  2963. .Bind("MTIME"_s, &Arguments::MTime)
  2964. .Bind("VERBOSE"_s, &Arguments::Verbose)
  2965. .Bind("PATHS"_s, &Arguments::Paths);
  2966. std::vector<std::string> unrecognizedArguments;
  2967. std::vector<std::string> keywordsMissingValues;
  2968. auto parsedArgs =
  2969. parser.Parse(cmMakeRange(args).advance(1), &unrecognizedArguments,
  2970. &keywordsMissingValues);
  2971. auto argIt = unrecognizedArguments.begin();
  2972. if (argIt != unrecognizedArguments.end()) {
  2973. status.SetError(cmStrCat("Unrecognized argument: \"", *argIt, "\""));
  2974. cmSystemTools::SetFatalErrorOccured();
  2975. return false;
  2976. }
  2977. const std::vector<std::string> LIST_ARGS = {
  2978. "OUTPUT", "FORMAT", "COMPRESSION", "COMPRESSION_LEVEL", "MTIME", "PATHS"
  2979. };
  2980. auto kwbegin = keywordsMissingValues.cbegin();
  2981. auto kwend = cmRemoveMatching(keywordsMissingValues, LIST_ARGS);
  2982. if (kwend != kwbegin) {
  2983. status.SetError(cmStrCat("Keywords missing values:\n ",
  2984. cmJoin(cmMakeRange(kwbegin, kwend), "\n ")));
  2985. cmSystemTools::SetFatalErrorOccured();
  2986. return false;
  2987. }
  2988. const char* knownFormats[] = {
  2989. "7zip", "gnutar", "pax", "paxr", "raw", "zip"
  2990. };
  2991. if (!parsedArgs.Format.empty() &&
  2992. !cm::contains(knownFormats, parsedArgs.Format)) {
  2993. status.SetError(
  2994. cmStrCat("archive format ", parsedArgs.Format, " not supported"));
  2995. cmSystemTools::SetFatalErrorOccured();
  2996. return false;
  2997. }
  2998. const char* zipFileFormats[] = { "7zip", "zip" };
  2999. if (!parsedArgs.Compression.empty() &&
  3000. cm::contains(zipFileFormats, parsedArgs.Format)) {
  3001. status.SetError(cmStrCat("archive format ", parsedArgs.Format,
  3002. " does not support COMPRESSION arguments"));
  3003. cmSystemTools::SetFatalErrorOccured();
  3004. return false;
  3005. }
  3006. static std::map<std::string, cmSystemTools::cmTarCompression>
  3007. compressionTypeMap = { { "None", cmSystemTools::TarCompressNone },
  3008. { "BZip2", cmSystemTools::TarCompressBZip2 },
  3009. { "GZip", cmSystemTools::TarCompressGZip },
  3010. { "XZ", cmSystemTools::TarCompressXZ },
  3011. { "Zstd", cmSystemTools::TarCompressZstd } };
  3012. cmSystemTools::cmTarCompression compress = cmSystemTools::TarCompressNone;
  3013. auto typeIt = compressionTypeMap.find(parsedArgs.Compression);
  3014. if (typeIt != compressionTypeMap.end()) {
  3015. compress = typeIt->second;
  3016. } else if (!parsedArgs.Compression.empty()) {
  3017. status.SetError(cmStrCat("compression type ", parsedArgs.Compression,
  3018. " is not supported"));
  3019. cmSystemTools::SetFatalErrorOccured();
  3020. return false;
  3021. }
  3022. int compressionLevel = 0;
  3023. if (!parsedArgs.CompressionLevel.empty()) {
  3024. if (parsedArgs.CompressionLevel.size() != 1 &&
  3025. !std::isdigit(parsedArgs.CompressionLevel[0])) {
  3026. status.SetError(cmStrCat("compression level ",
  3027. parsedArgs.CompressionLevel,
  3028. " should be in range 0 to 9"));
  3029. cmSystemTools::SetFatalErrorOccured();
  3030. return false;
  3031. }
  3032. compressionLevel = std::stoi(parsedArgs.CompressionLevel);
  3033. if (compressionLevel < 0 || compressionLevel > 9) {
  3034. status.SetError(cmStrCat("compression level ",
  3035. parsedArgs.CompressionLevel,
  3036. " should be in range 0 to 9"));
  3037. cmSystemTools::SetFatalErrorOccured();
  3038. return false;
  3039. }
  3040. if (compress == cmSystemTools::TarCompressNone) {
  3041. status.SetError(cmStrCat("compression level is not supported for "
  3042. "compression \"None\"",
  3043. parsedArgs.Compression));
  3044. cmSystemTools::SetFatalErrorOccured();
  3045. return false;
  3046. }
  3047. }
  3048. if (parsedArgs.Paths.empty()) {
  3049. status.SetError("ARCHIVE_CREATE requires a non-empty list of PATHS");
  3050. cmSystemTools::SetFatalErrorOccured();
  3051. return false;
  3052. }
  3053. if (!cmSystemTools::CreateTar(parsedArgs.Output, parsedArgs.Paths, compress,
  3054. parsedArgs.Verbose, parsedArgs.MTime,
  3055. parsedArgs.Format, compressionLevel)) {
  3056. status.SetError(cmStrCat("failed to compress: ", parsedArgs.Output));
  3057. cmSystemTools::SetFatalErrorOccured();
  3058. return false;
  3059. }
  3060. return true;
  3061. }
  3062. bool HandleArchiveExtractCommand(std::vector<std::string> const& args,
  3063. cmExecutionStatus& status)
  3064. {
  3065. struct Arguments
  3066. {
  3067. std::string Input;
  3068. bool Verbose = false;
  3069. bool ListOnly = false;
  3070. std::string Destination;
  3071. std::vector<std::string> Patterns;
  3072. };
  3073. static auto const parser = cmArgumentParser<Arguments>{}
  3074. .Bind("INPUT"_s, &Arguments::Input)
  3075. .Bind("VERBOSE"_s, &Arguments::Verbose)
  3076. .Bind("LIST_ONLY"_s, &Arguments::ListOnly)
  3077. .Bind("DESTINATION"_s, &Arguments::Destination)
  3078. .Bind("PATTERNS"_s, &Arguments::Patterns);
  3079. std::vector<std::string> unrecognizedArguments;
  3080. std::vector<std::string> keywordsMissingValues;
  3081. auto parsedArgs =
  3082. parser.Parse(cmMakeRange(args).advance(1), &unrecognizedArguments,
  3083. &keywordsMissingValues);
  3084. auto argIt = unrecognizedArguments.begin();
  3085. if (argIt != unrecognizedArguments.end()) {
  3086. status.SetError(cmStrCat("Unrecognized argument: \"", *argIt, "\""));
  3087. cmSystemTools::SetFatalErrorOccured();
  3088. return false;
  3089. }
  3090. const std::vector<std::string> LIST_ARGS = { "INPUT", "DESTINATION",
  3091. "PATTERNS" };
  3092. auto kwbegin = keywordsMissingValues.cbegin();
  3093. auto kwend = cmRemoveMatching(keywordsMissingValues, LIST_ARGS);
  3094. if (kwend != kwbegin) {
  3095. status.SetError(cmStrCat("Keywords missing values:\n ",
  3096. cmJoin(cmMakeRange(kwbegin, kwend), "\n ")));
  3097. cmSystemTools::SetFatalErrorOccured();
  3098. return false;
  3099. }
  3100. std::string inFile = parsedArgs.Input;
  3101. if (parsedArgs.ListOnly) {
  3102. if (!cmSystemTools::ListTar(inFile, parsedArgs.Patterns,
  3103. parsedArgs.Verbose)) {
  3104. status.SetError(cmStrCat("failed to list: ", inFile));
  3105. cmSystemTools::SetFatalErrorOccured();
  3106. return false;
  3107. }
  3108. } else {
  3109. std::string destDir = status.GetMakefile().GetCurrentBinaryDirectory();
  3110. if (!parsedArgs.Destination.empty()) {
  3111. if (cmSystemTools::FileIsFullPath(parsedArgs.Destination)) {
  3112. destDir = parsedArgs.Destination;
  3113. } else {
  3114. destDir = cmStrCat(destDir, "/", parsedArgs.Destination);
  3115. }
  3116. if (!cmSystemTools::MakeDirectory(destDir)) {
  3117. status.SetError(cmStrCat("failed to create directory: ", destDir));
  3118. cmSystemTools::SetFatalErrorOccured();
  3119. return false;
  3120. }
  3121. if (!cmSystemTools::FileIsFullPath(inFile)) {
  3122. inFile =
  3123. cmStrCat(cmSystemTools::GetCurrentWorkingDirectory(), "/", inFile);
  3124. }
  3125. }
  3126. cmWorkingDirectory workdir(destDir);
  3127. if (workdir.Failed()) {
  3128. status.SetError(
  3129. cmStrCat("failed to change working directory to: ", destDir));
  3130. cmSystemTools::SetFatalErrorOccured();
  3131. return false;
  3132. }
  3133. if (!cmSystemTools::ExtractTar(inFile, parsedArgs.Patterns,
  3134. parsedArgs.Verbose)) {
  3135. status.SetError(cmStrCat("failed to extract: ", inFile));
  3136. cmSystemTools::SetFatalErrorOccured();
  3137. return false;
  3138. }
  3139. }
  3140. return true;
  3141. }
  3142. bool ValidateAndConvertPermissions(const std::vector<std::string>& permissions,
  3143. mode_t& perms, cmExecutionStatus& status)
  3144. {
  3145. for (const auto& i : permissions) {
  3146. if (!cmFSPermissions::stringToModeT(i, perms)) {
  3147. status.SetError(i + " is an invalid permission specifier");
  3148. cmSystemTools::SetFatalErrorOccured();
  3149. return false;
  3150. }
  3151. }
  3152. return true;
  3153. }
  3154. bool SetPermissions(const std::string& filename, const mode_t& perms,
  3155. cmExecutionStatus& status)
  3156. {
  3157. if (!cmSystemTools::SetPermissions(filename, perms)) {
  3158. status.SetError("Failed to set permissions for " + filename);
  3159. cmSystemTools::SetFatalErrorOccured();
  3160. return false;
  3161. }
  3162. return true;
  3163. }
  3164. bool HandleChmodCommandImpl(std::vector<std::string> const& args, bool recurse,
  3165. cmExecutionStatus& status)
  3166. {
  3167. mode_t perms = 0;
  3168. mode_t fperms = 0;
  3169. mode_t dperms = 0;
  3170. cmsys::Glob globber;
  3171. globber.SetRecurse(recurse);
  3172. globber.SetRecurseListDirs(recurse);
  3173. struct Arguments
  3174. {
  3175. std::vector<std::string> Permissions;
  3176. std::vector<std::string> FilePermissions;
  3177. std::vector<std::string> DirectoryPermissions;
  3178. };
  3179. static auto const parser =
  3180. cmArgumentParser<Arguments>{}
  3181. .Bind("PERMISSIONS"_s, &Arguments::Permissions)
  3182. .Bind("FILE_PERMISSIONS"_s, &Arguments::FilePermissions)
  3183. .Bind("DIRECTORY_PERMISSIONS"_s, &Arguments::DirectoryPermissions);
  3184. std::vector<std::string> pathEntries;
  3185. std::vector<std::string> keywordsMissingValues;
  3186. Arguments parsedArgs = parser.Parse(cmMakeRange(args).advance(1),
  3187. &pathEntries, &keywordsMissingValues);
  3188. // check validity of arguments
  3189. if (parsedArgs.Permissions.empty() && parsedArgs.FilePermissions.empty() &&
  3190. parsedArgs.DirectoryPermissions.empty()) // no permissions given
  3191. {
  3192. status.SetError("No permissions given");
  3193. cmSystemTools::SetFatalErrorOccured();
  3194. return false;
  3195. }
  3196. if (!parsedArgs.Permissions.empty() && !parsedArgs.FilePermissions.empty() &&
  3197. !parsedArgs.DirectoryPermissions.empty()) // all keywords are used
  3198. {
  3199. status.SetError("Remove either PERMISSIONS or FILE_PERMISSIONS or "
  3200. "DIRECTORY_PERMISSIONS from the invocation");
  3201. cmSystemTools::SetFatalErrorOccured();
  3202. return false;
  3203. }
  3204. if (!keywordsMissingValues.empty()) {
  3205. for (const auto& i : keywordsMissingValues) {
  3206. status.SetError(i + " is not given any arguments");
  3207. cmSystemTools::SetFatalErrorOccured();
  3208. }
  3209. return false;
  3210. }
  3211. // validate permissions
  3212. bool validatePermissions =
  3213. ValidateAndConvertPermissions(parsedArgs.Permissions, perms, status) &&
  3214. ValidateAndConvertPermissions(parsedArgs.FilePermissions, fperms,
  3215. status) &&
  3216. ValidateAndConvertPermissions(parsedArgs.DirectoryPermissions, dperms,
  3217. status);
  3218. if (!validatePermissions) {
  3219. return false;
  3220. }
  3221. std::vector<std::string> allPathEntries;
  3222. if (recurse) {
  3223. std::vector<std::string> tempPathEntries;
  3224. for (const auto& i : pathEntries) {
  3225. if (cmSystemTools::FileIsDirectory(i)) {
  3226. globber.FindFiles(i + "/*");
  3227. tempPathEntries = globber.GetFiles();
  3228. allPathEntries.insert(allPathEntries.end(), tempPathEntries.begin(),
  3229. tempPathEntries.end());
  3230. allPathEntries.emplace_back(i);
  3231. } else {
  3232. allPathEntries.emplace_back(i); // We validate path entries below
  3233. }
  3234. }
  3235. } else {
  3236. allPathEntries = std::move(pathEntries);
  3237. }
  3238. // chmod
  3239. for (const auto& i : allPathEntries) {
  3240. if (!(cmSystemTools::FileExists(i) || cmSystemTools::FileIsDirectory(i))) {
  3241. status.SetError(cmStrCat("does not exist:\n ", i));
  3242. cmSystemTools::SetFatalErrorOccured();
  3243. return false;
  3244. }
  3245. if (cmSystemTools::FileExists(i, true)) {
  3246. bool success = true;
  3247. const mode_t& filePermissions =
  3248. parsedArgs.FilePermissions.empty() ? perms : fperms;
  3249. if (filePermissions) {
  3250. success = SetPermissions(i, filePermissions, status);
  3251. }
  3252. if (!success) {
  3253. return false;
  3254. }
  3255. }
  3256. else if (cmSystemTools::FileIsDirectory(i)) {
  3257. bool success = true;
  3258. const mode_t& directoryPermissions =
  3259. parsedArgs.DirectoryPermissions.empty() ? perms : dperms;
  3260. if (directoryPermissions) {
  3261. success = SetPermissions(i, directoryPermissions, status);
  3262. }
  3263. if (!success) {
  3264. return false;
  3265. }
  3266. }
  3267. }
  3268. return true;
  3269. }
  3270. bool HandleChmodCommand(std::vector<std::string> const& args,
  3271. cmExecutionStatus& status)
  3272. {
  3273. return HandleChmodCommandImpl(args, false, status);
  3274. }
  3275. bool HandleChmodRecurseCommand(std::vector<std::string> const& args,
  3276. cmExecutionStatus& status)
  3277. {
  3278. return HandleChmodCommandImpl(args, true, status);
  3279. }
  3280. } // namespace
  3281. bool cmFileCommand(std::vector<std::string> const& args,
  3282. cmExecutionStatus& status)
  3283. {
  3284. if (args.size() < 2) {
  3285. status.SetError("must be called with at least two arguments.");
  3286. return false;
  3287. }
  3288. static cmSubcommandTable const subcommand{
  3289. { "WRITE"_s, HandleWriteCommand },
  3290. { "APPEND"_s, HandleAppendCommand },
  3291. { "DOWNLOAD"_s, HandleDownloadCommand },
  3292. { "UPLOAD"_s, HandleUploadCommand },
  3293. { "READ"_s, HandleReadCommand },
  3294. { "MD5"_s, HandleHashCommand },
  3295. { "SHA1"_s, HandleHashCommand },
  3296. { "SHA224"_s, HandleHashCommand },
  3297. { "SHA256"_s, HandleHashCommand },
  3298. { "SHA384"_s, HandleHashCommand },
  3299. { "SHA512"_s, HandleHashCommand },
  3300. { "SHA3_224"_s, HandleHashCommand },
  3301. { "SHA3_256"_s, HandleHashCommand },
  3302. { "SHA3_384"_s, HandleHashCommand },
  3303. { "SHA3_512"_s, HandleHashCommand },
  3304. { "STRINGS"_s, HandleStringsCommand },
  3305. { "GLOB"_s, HandleGlobCommand },
  3306. { "GLOB_RECURSE"_s, HandleGlobRecurseCommand },
  3307. { "MAKE_DIRECTORY"_s, HandleMakeDirectoryCommand },
  3308. { "RENAME"_s, HandleRename },
  3309. { "COPY_FILE"_s, HandleCopyFile },
  3310. { "REMOVE"_s, HandleRemove },
  3311. { "REMOVE_RECURSE"_s, HandleRemoveRecurse },
  3312. { "COPY"_s, HandleCopyCommand },
  3313. { "INSTALL"_s, HandleInstallCommand },
  3314. { "DIFFERENT"_s, HandleDifferentCommand },
  3315. { "RPATH_CHANGE"_s, HandleRPathChangeCommand },
  3316. { "CHRPATH"_s, HandleRPathChangeCommand },
  3317. { "RPATH_CHECK"_s, HandleRPathCheckCommand },
  3318. { "RPATH_REMOVE"_s, HandleRPathRemoveCommand },
  3319. { "READ_ELF"_s, HandleReadElfCommand },
  3320. { "REAL_PATH"_s, HandleRealPathCommand },
  3321. { "RELATIVE_PATH"_s, HandleRelativePathCommand },
  3322. { "TO_CMAKE_PATH"_s, HandleCMakePathCommand },
  3323. { "TO_NATIVE_PATH"_s, HandleNativePathCommand },
  3324. { "TOUCH"_s, HandleTouchCommand },
  3325. { "TOUCH_NOCREATE"_s, HandleTouchNocreateCommand },
  3326. { "TIMESTAMP"_s, HandleTimestampCommand },
  3327. { "GENERATE"_s, HandleGenerateCommand },
  3328. { "LOCK"_s, HandleLockCommand },
  3329. { "SIZE"_s, HandleSizeCommand },
  3330. { "READ_SYMLINK"_s, HandleReadSymlinkCommand },
  3331. { "CREATE_LINK"_s, HandleCreateLinkCommand },
  3332. { "GET_RUNTIME_DEPENDENCIES"_s, HandleGetRuntimeDependenciesCommand },
  3333. { "CONFIGURE"_s, HandleConfigureCommand },
  3334. { "ARCHIVE_CREATE"_s, HandleArchiveCreateCommand },
  3335. { "ARCHIVE_EXTRACT"_s, HandleArchiveExtractCommand },
  3336. { "CHMOD"_s, HandleChmodCommand },
  3337. { "CHMOD_RECURSE"_s, HandleChmodRecurseCommand },
  3338. };
  3339. return subcommand(args[0], args, status);
  3340. }