cmFileCommand.cxx 116 KB

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