cmFileCommand.cxx 117 KB

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