SftpFileSystem.cpp 189 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #include "SftpFileSystem.h"
  5. #include "PuttyTools.h"
  6. #include "Common.h"
  7. #include "Exceptions.h"
  8. #include "Interface.h"
  9. #include "Terminal.h"
  10. #include "TextsCore.h"
  11. #include "HelpCore.h"
  12. #include "SecureShell.h"
  13. #include <WideStrUtils.hpp>
  14. #include <limits>
  15. #include <memory>
  16. //---------------------------------------------------------------------------
  17. #pragma package(smart_init)
  18. //---------------------------------------------------------------------------
  19. #define FILE_OPERATION_LOOP_TERMINAL FTerminal
  20. //---------------------------------------------------------------------------
  21. #define SSH_FX_OK 0
  22. #define SSH_FX_EOF 1
  23. #define SSH_FX_NO_SUCH_FILE 2
  24. #define SSH_FX_PERMISSION_DENIED 3
  25. #define SSH_FX_FAILURE 4
  26. #define SSH_FX_OP_UNSUPPORTED 8
  27. #define SSH_FXP_INIT 1
  28. #define SSH_FXP_VERSION 2
  29. #define SSH_FXP_OPEN 3
  30. #define SSH_FXP_CLOSE 4
  31. #define SSH_FXP_READ 5
  32. #define SSH_FXP_WRITE 6
  33. #define SSH_FXP_LSTAT 7
  34. #define SSH_FXP_FSTAT 8
  35. #define SSH_FXP_SETSTAT 9
  36. #define SSH_FXP_FSETSTAT 10
  37. #define SSH_FXP_OPENDIR 11
  38. #define SSH_FXP_READDIR 12
  39. #define SSH_FXP_REMOVE 13
  40. #define SSH_FXP_MKDIR 14
  41. #define SSH_FXP_RMDIR 15
  42. #define SSH_FXP_REALPATH 16
  43. #define SSH_FXP_STAT 17
  44. #define SSH_FXP_RENAME 18
  45. #define SSH_FXP_READLINK 19
  46. #define SSH_FXP_SYMLINK 20
  47. #define SSH_FXP_LINK 21
  48. #define SSH_FXP_STATUS 101
  49. #define SSH_FXP_HANDLE 102
  50. #define SSH_FXP_DATA 103
  51. #define SSH_FXP_NAME 104
  52. #define SSH_FXP_ATTRS 105
  53. #define SSH_FXP_EXTENDED 200
  54. #define SSH_FXP_EXTENDED_REPLY 201
  55. #define SSH_FXP_ATTRS 105
  56. #define SSH_FILEXFER_ATTR_SIZE 0x00000001
  57. #define SSH_FILEXFER_ATTR_UIDGID 0x00000002
  58. #define SSH_FILEXFER_ATTR_PERMISSIONS 0x00000004
  59. #define SSH_FILEXFER_ATTR_ACMODTIME 0x00000008
  60. #define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
  61. #define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
  62. #define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
  63. #define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
  64. #define SSH_FILEXFER_ATTR_ACL 0x00000040
  65. #define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
  66. #define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
  67. #define SSH_FILEXFER_ATTR_BITS 0x00000200
  68. #define SSH_FILEXFER_ATTR_ALLOCATION_SIZE 0x00000400
  69. #define SSH_FILEXFER_ATTR_TEXT_HINT 0x00000800
  70. #define SSH_FILEXFER_ATTR_MIME_TYPE 0x00001000
  71. #define SSH_FILEXFER_ATTR_LINK_COUNT 0x00002000
  72. #define SSH_FILEXFER_ATTR_UNTRANSLATED_NAME 0x00004000
  73. #define SSH_FILEXFER_ATTR_CTIME 0x00008000
  74. #define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
  75. #define SSH_FILEXFER_ATTR_COMMON \
  76. (SSH_FILEXFER_ATTR_SIZE | SSH_FILEXFER_ATTR_OWNERGROUP | \
  77. SSH_FILEXFER_ATTR_PERMISSIONS | SSH_FILEXFER_ATTR_ACCESSTIME | \
  78. SSH_FILEXFER_ATTR_MODIFYTIME)
  79. #define SSH_FILEXFER_TYPE_REGULAR 1
  80. #define SSH_FILEXFER_TYPE_DIRECTORY 2
  81. #define SSH_FILEXFER_TYPE_SYMLINK 3
  82. #define SSH_FILEXFER_TYPE_SPECIAL 4
  83. #define SSH_FILEXFER_TYPE_UNKNOWN 5
  84. #define SSH_FXF_READ 0x00000001
  85. #define SSH_FXF_WRITE 0x00000002
  86. #define SSH_FXF_APPEND 0x00000004
  87. #define SSH_FXF_CREAT 0x00000008
  88. #define SSH_FXF_TRUNC 0x00000010
  89. #define SSH_FXF_EXCL 0x00000020
  90. #define SSH_FXF_TEXT 0x00000040
  91. #define SSH_FXF_ACCESS_DISPOSITION 0x00000007
  92. #define SSH_FXF_CREATE_NEW 0x00000000
  93. #define SSH_FXF_CREATE_TRUNCATE 0x00000001
  94. #define SSH_FXF_OPEN_EXISTING 0x00000002
  95. #define SSH_FXF_OPEN_OR_CREATE 0x00000003
  96. #define SSH_FXF_TRUNCATE_EXISTING 0x00000004
  97. #define SSH_FXF_ACCESS_APPEND_DATA 0x00000008
  98. #define SSH_FXF_ACCESS_APPEND_DATA_ATOMIC 0x00000010
  99. #define SSH_FXF_ACCESS_TEXT_MODE 0x00000020
  100. #define ACE4_READ_DATA 0x00000001
  101. #define ACE4_LIST_DIRECTORY 0x00000001
  102. #define ACE4_WRITE_DATA 0x00000002
  103. #define ACE4_ADD_FILE 0x00000002
  104. #define ACE4_APPEND_DATA 0x00000004
  105. #define ACE4_ADD_SUBDIRECTORY 0x00000004
  106. #define ACE4_READ_NAMED_ATTRS 0x00000008
  107. #define ACE4_WRITE_NAMED_ATTRS 0x00000010
  108. #define ACE4_EXECUTE 0x00000020
  109. #define ACE4_DELETE_CHILD 0x00000040
  110. #define ACE4_READ_ATTRIBUTES 0x00000080
  111. #define ACE4_WRITE_ATTRIBUTES 0x00000100
  112. #define ACE4_DELETE 0x00010000
  113. #define ACE4_READ_ACL 0x00020000
  114. #define ACE4_WRITE_ACL 0x00040000
  115. #define ACE4_WRITE_OWNER 0x00080000
  116. #define ACE4_SYNCHRONIZE 0x00100000
  117. #define SSH_FILEXFER_ATTR_FLAGS_HIDDEN 0x00000004
  118. #define SSH_FXP_REALPATH_NO_CHECK 0x00000001
  119. #define SSH_FXP_REALPATH_STAT_IF 0x00000002
  120. #define SSH_FXP_REALPATH_STAT_ALWAYS 0x00000003
  121. #define SFTP_MAX_PACKET_LEN 1024000
  122. //---------------------------------------------------------------------------
  123. #define SFTP_EXT_OWNER_GROUP "owner-group-query@generic-extensions"
  124. #define SFTP_EXT_OWNER_GROUP_REPLY "owner-group-query-reply@generic-extensions"
  125. #define SFTP_EXT_NEWLINE "newline"
  126. #define SFTP_EXT_SUPPORTED "supported"
  127. #define SFTP_EXT_SUPPORTED2 "supported2"
  128. #define SFTP_EXT_FSROOTS "[email protected]"
  129. #define SFTP_EXT_VENDOR_ID "vendor-id"
  130. #define SFTP_EXT_VERSIONS "versions"
  131. #define SFTP_EXT_SPACE_AVAILABLE "space-available"
  132. #define SFTP_EXT_CHECK_FILE "check-file"
  133. #define SFTP_EXT_CHECK_FILE_NAME "check-file-name"
  134. #define SFTP_EXT_STATVFS "[email protected]"
  135. #define SFTP_EXT_STATVFS_VALUE_V2 L"2"
  136. #define SFTP_EXT_STATVFS_ST_RDONLY 0x1
  137. #define SFTP_EXT_STATVFS_ST_NOSUID 0x2
  138. #define SFTP_EXT_HARDLINK "[email protected]"
  139. #define SFTP_EXT_HARDLINK_VALUE_V1 L"1"
  140. #define SFTP_EXT_COPY_FILE "copy-file"
  141. //---------------------------------------------------------------------------
  142. #define OGQ_LIST_OWNERS 0x01
  143. #define OGQ_LIST_GROUPS 0x02
  144. //---------------------------------------------------------------------------
  145. const int SFTPMinVersion = 0;
  146. const int SFTPMaxVersion = 6;
  147. const unsigned int SFTPNoMessageNumber = static_cast<unsigned int>(-1);
  148. const int asNo = 0;
  149. const int asOK = 1 << SSH_FX_OK;
  150. const int asEOF = 1 << SSH_FX_EOF;
  151. const int asPermDenied = 1 << SSH_FX_PERMISSION_DENIED;
  152. const int asOpUnsupported = 1 << SSH_FX_OP_UNSUPPORTED;
  153. const int asNoSuchFile = 1 << SSH_FX_NO_SUCH_FILE;
  154. const int asAll = 0xFFFF;
  155. const int tfFirstLevel = 0x01;
  156. const int tfNewDirectory = 0x02;
  157. //---------------------------------------------------------------------------
  158. #define GET_32BIT(cp) \
  159. (((unsigned long)(unsigned char)(cp)[0] << 24) | \
  160. ((unsigned long)(unsigned char)(cp)[1] << 16) | \
  161. ((unsigned long)(unsigned char)(cp)[2] << 8) | \
  162. ((unsigned long)(unsigned char)(cp)[3]))
  163. #define PUT_32BIT(cp, value) { \
  164. (cp)[0] = (unsigned char)((value) >> 24); \
  165. (cp)[1] = (unsigned char)((value) >> 16); \
  166. (cp)[2] = (unsigned char)((value) >> 8); \
  167. (cp)[3] = (unsigned char)(value); }
  168. //---------------------------------------------------------------------------
  169. #define SFTP_PACKET_ALLOC_DELTA 256
  170. //---------------------------------------------------------------------------
  171. #pragma warn -inl
  172. //---------------------------------------------------------------------------
  173. struct TSFTPSupport
  174. {
  175. TSFTPSupport() :
  176. AttribExtensions(new TStringList()),
  177. Extensions(new TStringList())
  178. {
  179. Reset();
  180. }
  181. ~TSFTPSupport()
  182. {
  183. delete AttribExtensions;
  184. delete Extensions;
  185. }
  186. void Reset()
  187. {
  188. AttributeMask = 0;
  189. AttributeBits = 0;
  190. OpenFlags = 0;
  191. AccessMask = 0;
  192. MaxReadSize = 0;
  193. OpenBlockVector = 0;
  194. BlockVector = 0;
  195. AttribExtensions->Clear();
  196. Extensions->Clear();
  197. Loaded = false;
  198. }
  199. unsigned int AttributeMask;
  200. unsigned int AttributeBits;
  201. unsigned int OpenFlags;
  202. unsigned int AccessMask;
  203. unsigned int MaxReadSize;
  204. unsigned int OpenBlockVector;
  205. unsigned int BlockVector;
  206. TStrings * AttribExtensions;
  207. TStrings * Extensions;
  208. bool Loaded;
  209. };
  210. //---------------------------------------------------------------------------
  211. class TSFTPPacket
  212. {
  213. public:
  214. TSFTPPacket()
  215. {
  216. Init();
  217. }
  218. TSFTPPacket(const TSFTPPacket & Source)
  219. {
  220. Init();
  221. *this = Source;
  222. }
  223. TSFTPPacket(unsigned char AType)
  224. {
  225. Init();
  226. ChangeType(AType);
  227. }
  228. TSFTPPacket(const unsigned char * Source, unsigned int Len)
  229. {
  230. Init();
  231. FLength = Len;
  232. Capacity = FLength;
  233. memcpy(Data, Source, Len);
  234. }
  235. TSFTPPacket(const RawByteString & Source)
  236. {
  237. Init();
  238. FLength = Source.Length();
  239. Capacity = FLength;
  240. memcpy(Data, Source.c_str(), Source.Length());
  241. }
  242. ~TSFTPPacket()
  243. {
  244. if (FData != NULL)
  245. {
  246. delete[] (FData - FSendPrefixLen);
  247. }
  248. if (FReservedBy) FReservedBy->UnreserveResponse(this);
  249. }
  250. void ChangeType(unsigned char AType)
  251. {
  252. FPosition = 0;
  253. FLength = 0;
  254. Capacity = 0;
  255. FType = AType;
  256. AddByte(FType);
  257. if ((FType != 1) && (FType != SSH_FXP_INIT))
  258. {
  259. AssignNumber();
  260. AddCardinal(FMessageNumber);
  261. }
  262. }
  263. void Reuse()
  264. {
  265. AssignNumber();
  266. DebugAssert(Length >= 5);
  267. // duplicated in AddCardinal()
  268. unsigned char Buf[4];
  269. PUT_32BIT(Buf, FMessageNumber);
  270. memcpy(FData + 1, Buf, sizeof(Buf));
  271. }
  272. void AddByte(unsigned char Value)
  273. {
  274. Add(&Value, sizeof(Value));
  275. }
  276. void AddBool(bool Value)
  277. {
  278. AddByte(Value ? 1 : 0);
  279. }
  280. void AddCardinal(unsigned long Value)
  281. {
  282. // duplicated in Reuse()
  283. unsigned char Buf[4];
  284. PUT_32BIT(Buf, Value);
  285. Add(&Buf, sizeof(Buf));
  286. }
  287. void AddInt64(__int64 Value)
  288. {
  289. AddCardinal((unsigned long)(Value >> 32));
  290. AddCardinal((unsigned long)(Value & 0xFFFFFFFF));
  291. }
  292. void AddData(const void * Data, int ALength)
  293. {
  294. AddCardinal(ALength);
  295. Add(Data, ALength);
  296. }
  297. void AddString(const RawByteString & Value)
  298. {
  299. AddCardinal(Value.Length());
  300. Add(Value.c_str(), Value.Length());
  301. }
  302. inline void AddUtfString(const UTF8String & Value)
  303. {
  304. AddString(Value);
  305. }
  306. inline void AddUtfString(const UnicodeString & Value)
  307. {
  308. AddUtfString(UTF8String(Value));
  309. }
  310. inline void AddString(const UnicodeString Value, TAutoSwitch Utf)
  311. {
  312. // asAuto: Using UTF until we receive non-UTF string from the server
  313. if ((Utf == asOn) || (Utf == asAuto))
  314. {
  315. AddUtfString(Value);
  316. }
  317. else
  318. {
  319. AddString(RawByteString(AnsiString(Value)));
  320. }
  321. }
  322. // now purposeless alias to AddString
  323. inline void AddPathString(const UnicodeString & Value, TAutoSwitch Utf)
  324. {
  325. AddString(Value, Utf);
  326. }
  327. unsigned int AllocationSizeAttribute(int Version)
  328. {
  329. return (Version >= 6) ? SSH_FILEXFER_ATTR_ALLOCATION_SIZE : SSH_FILEXFER_ATTR_SIZE;
  330. }
  331. void AddProperties(unsigned short * Rights, TRemoteToken * Owner,
  332. TRemoteToken * Group, __int64 * MTime, __int64 * ATime,
  333. __int64 * Size, bool IsDirectory, int Version, TAutoSwitch Utf)
  334. {
  335. int Flags = 0;
  336. if (Size != NULL)
  337. {
  338. Flags |= AllocationSizeAttribute(Version);
  339. }
  340. // both or neither
  341. DebugAssert((Owner != NULL) == (Group != NULL));
  342. if ((Owner != NULL) && (Group != NULL))
  343. {
  344. if (Version < 4)
  345. {
  346. DebugAssert(Owner->IDValid && Group->IDValid);
  347. Flags |= SSH_FILEXFER_ATTR_UIDGID;
  348. }
  349. else
  350. {
  351. DebugAssert(Owner->NameValid && Group->NameValid);
  352. Flags |= SSH_FILEXFER_ATTR_OWNERGROUP;
  353. }
  354. }
  355. if (Rights != NULL)
  356. {
  357. Flags |= SSH_FILEXFER_ATTR_PERMISSIONS;
  358. }
  359. if ((Version < 4) && ((MTime != NULL) || (ATime != NULL)))
  360. {
  361. Flags |= SSH_FILEXFER_ATTR_ACMODTIME;
  362. }
  363. if ((Version >= 4) && (ATime != NULL))
  364. {
  365. Flags |= SSH_FILEXFER_ATTR_ACCESSTIME;
  366. }
  367. if ((Version >= 4) && (MTime != NULL))
  368. {
  369. Flags |= SSH_FILEXFER_ATTR_MODIFYTIME;
  370. }
  371. AddCardinal(Flags);
  372. if (Version >= 4)
  373. {
  374. AddByte(static_cast<unsigned char>(IsDirectory ?
  375. SSH_FILEXFER_TYPE_DIRECTORY : SSH_FILEXFER_TYPE_REGULAR));
  376. }
  377. if (Size != NULL)
  378. {
  379. // this is SSH_FILEXFER_ATTR_SIZE for version <= 5, but
  380. // SSH_FILEXFER_ATTR_ALLOCATION_SIZE for version >= 6
  381. AddInt64(*Size);
  382. }
  383. if ((Owner != NULL) && (Group != NULL))
  384. {
  385. if (Version < 4)
  386. {
  387. DebugAssert(Owner->IDValid && Group->IDValid);
  388. AddCardinal(Owner->ID);
  389. AddCardinal(Group->ID);
  390. }
  391. else
  392. {
  393. DebugAssert(Owner->NameValid && Group->NameValid);
  394. AddString(Owner->Name, Utf);
  395. AddString(Group->Name, Utf);
  396. }
  397. }
  398. if (Rights != NULL)
  399. {
  400. AddCardinal(*Rights);
  401. }
  402. if ((Version < 4) && ((MTime != NULL) || (ATime != NULL)))
  403. {
  404. // any way to reflect sbSignedTS here?
  405. // (note that casting __int64 > 2^31 < 2^32 to unsigned long is wrapped,
  406. // thus we never can set time after 2038, even if the server supports it)
  407. AddCardinal(static_cast<unsigned long>(ATime != NULL ? *ATime : *MTime));
  408. AddCardinal(static_cast<unsigned long>(MTime != NULL ? *MTime : *ATime));
  409. }
  410. if ((Version >= 4) && (ATime != NULL))
  411. {
  412. AddInt64(*ATime);
  413. }
  414. if ((Version >= 4) && (MTime != NULL))
  415. {
  416. AddInt64(*MTime);
  417. }
  418. }
  419. void AddProperties(const TRemoteProperties * Properties,
  420. unsigned short BaseRights, bool IsDirectory, int Version, TAutoSwitch Utf,
  421. TChmodSessionAction * Action)
  422. {
  423. enum TValid { valNone = 0, valRights = 0x01, valOwner = 0x02, valGroup = 0x04,
  424. valMTime = 0x08, valATime = 0x10 } Valid = valNone;
  425. unsigned short RightsNum = 0;
  426. TRemoteToken Owner;
  427. TRemoteToken Group;
  428. __int64 MTime;
  429. __int64 ATime;
  430. if (Properties != NULL)
  431. {
  432. if (Properties->Valid.Contains(vpGroup))
  433. {
  434. Valid = (TValid)(Valid | valGroup);
  435. Group = Properties->Group;
  436. }
  437. if (Properties->Valid.Contains(vpOwner))
  438. {
  439. Valid = (TValid)(Valid | valOwner);
  440. Owner = Properties->Owner;
  441. }
  442. if (Properties->Valid.Contains(vpRights))
  443. {
  444. Valid = (TValid)(Valid | valRights);
  445. TRights Rights = BaseRights;
  446. Rights |= Properties->Rights.NumberSet;
  447. Rights &= (unsigned short)~Properties->Rights.NumberUnset;
  448. if (IsDirectory && Properties->AddXToDirectories)
  449. {
  450. Rights.AddExecute();
  451. }
  452. RightsNum = Rights;
  453. if (Action != NULL)
  454. {
  455. Action->Rights(Rights);
  456. }
  457. }
  458. if (Properties->Valid.Contains(vpLastAccess))
  459. {
  460. Valid = (TValid)(Valid | valATime);
  461. ATime = Properties->LastAccess;
  462. }
  463. if (Properties->Valid.Contains(vpModification))
  464. {
  465. Valid = (TValid)(Valid | valMTime);
  466. MTime = Properties->Modification;
  467. }
  468. }
  469. AddProperties(
  470. Valid & valRights ? &RightsNum : NULL,
  471. Valid & valOwner ? &Owner : NULL,
  472. Valid & valGroup ? &Group : NULL,
  473. Valid & valMTime ? &MTime : NULL,
  474. Valid & valATime ? &ATime : NULL,
  475. NULL, IsDirectory, Version, Utf);
  476. }
  477. unsigned char GetByte()
  478. {
  479. Need(sizeof(unsigned char));
  480. unsigned char Result = FData[FPosition];
  481. DataConsumed(sizeof(unsigned char));
  482. return Result;
  483. }
  484. bool GetBool()
  485. {
  486. return (GetByte() != 0);
  487. }
  488. bool CanGetBool()
  489. {
  490. return (RemainingLength >= sizeof(unsigned char));
  491. }
  492. unsigned long GetCardinal()
  493. {
  494. unsigned long Result = PeekCardinal();
  495. DataConsumed(sizeof(Result));
  496. return Result;
  497. }
  498. bool CanGetCardinal()
  499. {
  500. return (RemainingLength >= sizeof(unsigned long));
  501. }
  502. unsigned long GetSmallCardinal()
  503. {
  504. unsigned long Result;
  505. Need(2);
  506. Result = (FData[FPosition] << 8) + FData[FPosition + 1];
  507. DataConsumed(2);
  508. return Result;
  509. }
  510. bool CanGetSmallCardinal()
  511. {
  512. return (RemainingLength >= 2);
  513. }
  514. __int64 GetInt64()
  515. {
  516. __int64 Hi = GetCardinal();
  517. __int64 Lo = GetCardinal();
  518. return (Hi << 32) + Lo;
  519. }
  520. RawByteString GetRawByteString()
  521. {
  522. RawByteString Result;
  523. unsigned long Len = GetCardinal();
  524. Need(Len);
  525. // cannot happen anyway as Need() would raise exception
  526. DebugAssert(Len < SFTP_MAX_PACKET_LEN);
  527. Result.SetLength(Len);
  528. memcpy(Result.c_str(), FData + FPosition, Len);
  529. DataConsumed(Len);
  530. return Result;
  531. }
  532. bool CanGetString(unsigned int & Size)
  533. {
  534. bool Result = CanGetCardinal();
  535. if (Result)
  536. {
  537. unsigned long Len = PeekCardinal();
  538. Size = (sizeof(Len) + Len);
  539. Result = (Size <= RemainingLength);
  540. }
  541. return Result;
  542. }
  543. // For reading strings that are character strings (not byte strings as
  544. // as file handles), and SFTP spec does not say explicitly that they
  545. // are in UTF. For most of them it actually does not matter as
  546. // the content should be pure ASCII (e.g. extension names, etc.)
  547. inline UnicodeString GetAnsiString()
  548. {
  549. return AnsiToString(GetRawByteString());
  550. }
  551. inline RawByteString GetFileHandle()
  552. {
  553. return GetRawByteString();
  554. }
  555. inline UnicodeString GetString(TAutoSwitch & Utf)
  556. {
  557. if (Utf != asOff)
  558. {
  559. return GetUtfString(Utf);
  560. }
  561. else
  562. {
  563. return GetAnsiString();
  564. }
  565. }
  566. // now purposeless alias to GetString(bool)
  567. inline UnicodeString GetPathString(TAutoSwitch & Utf)
  568. {
  569. return GetString(Utf);
  570. }
  571. void GetFile(TRemoteFile * File, int Version, TDSTMode DSTMode, TAutoSwitch & Utf, bool SignedTS, bool Complete)
  572. {
  573. DebugAssert(File);
  574. unsigned int Flags;
  575. UnicodeString ListingStr;
  576. unsigned long Permissions = 0;
  577. bool ParsingFailed = false;
  578. if (Type != SSH_FXP_ATTRS)
  579. {
  580. File->FileName = GetPathString(Utf);
  581. if (Version < 4)
  582. {
  583. ListingStr = GetString(Utf);
  584. }
  585. }
  586. Flags = GetCardinal();
  587. if (Version >= 4)
  588. {
  589. unsigned char FXType = GetByte();
  590. // -:regular, D:directory, L:symlink, S:special, U:unknown
  591. // O:socket, C:char device, B:block device, F:fifo
  592. // SSH-2.0-cryptlib returns file type 0 in response to SSH_FXP_LSTAT,
  593. // handle this undefined value as "unknown"
  594. static wchar_t * Types = L"U-DLSUOCBF";
  595. if (FXType > (unsigned char)wcslen(Types))
  596. {
  597. throw Exception(FMTLOAD(SFTP_UNKNOWN_FILE_TYPE, (int(FXType))));
  598. }
  599. File->Type = Types[FXType];
  600. }
  601. if (Flags & SSH_FILEXFER_ATTR_SIZE)
  602. {
  603. File->Size = GetInt64();
  604. }
  605. // SFTP-6 only
  606. if (Flags & SSH_FILEXFER_ATTR_ALLOCATION_SIZE)
  607. {
  608. GetInt64(); // skip
  609. }
  610. // SSH-2.0-3.2.0 F-SECURE SSH - Process Software MultiNet
  611. // sets SSH_FILEXFER_ATTR_UIDGID for v4, but does not include the UID/GUID
  612. if ((Flags & SSH_FILEXFER_ATTR_UIDGID) && (Version < 4))
  613. {
  614. File->Owner.ID = GetCardinal();
  615. File->Group.ID = GetCardinal();
  616. }
  617. if (Flags & SSH_FILEXFER_ATTR_OWNERGROUP)
  618. {
  619. DebugAssert(Version >= 4);
  620. File->Owner.Name = GetString(Utf);
  621. File->Group.Name = GetString(Utf);
  622. }
  623. if (Flags & SSH_FILEXFER_ATTR_PERMISSIONS)
  624. {
  625. Permissions = GetCardinal();
  626. }
  627. if (Version < 4)
  628. {
  629. if (Flags & SSH_FILEXFER_ATTR_ACMODTIME)
  630. {
  631. File->LastAccess = UnixToDateTime(
  632. SignedTS ?
  633. static_cast<__int64>(static_cast<signed long>(GetCardinal())) :
  634. static_cast<__int64>(GetCardinal()),
  635. DSTMode);
  636. File->Modification = UnixToDateTime(
  637. SignedTS ?
  638. static_cast<__int64>(static_cast<signed long>(GetCardinal())) :
  639. static_cast<__int64>(GetCardinal()),
  640. DSTMode);
  641. }
  642. }
  643. else
  644. {
  645. if (Flags & SSH_FILEXFER_ATTR_ACCESSTIME)
  646. {
  647. File->LastAccess = UnixToDateTime(GetInt64(), DSTMode);
  648. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  649. {
  650. GetCardinal(); // skip access time subseconds
  651. }
  652. }
  653. else
  654. {
  655. File->LastAccess = Now();
  656. }
  657. if (Flags & SSH_FILEXFER_ATTR_CREATETIME)
  658. {
  659. GetInt64(); // skip create time
  660. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  661. {
  662. GetCardinal(); // skip create time subseconds
  663. }
  664. }
  665. if (Flags & SSH_FILEXFER_ATTR_MODIFYTIME)
  666. {
  667. File->Modification = UnixToDateTime(GetInt64(), DSTMode);
  668. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  669. {
  670. GetCardinal(); // skip modification time subseconds
  671. }
  672. }
  673. else
  674. {
  675. File->Modification = Now();
  676. }
  677. // SFTP-6
  678. if (Flags & SSH_FILEXFER_ATTR_CTIME)
  679. {
  680. GetInt64(); // skip attribute modification time
  681. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  682. {
  683. GetCardinal(); // skip attribute modification time subseconds
  684. }
  685. }
  686. }
  687. if (Flags & SSH_FILEXFER_ATTR_ACL)
  688. {
  689. GetRawByteString();
  690. }
  691. if (Flags & SSH_FILEXFER_ATTR_BITS)
  692. {
  693. // while SSH_FILEXFER_ATTR_BITS is defined for SFTP5 only, vandyke 2.3.3 sets it
  694. // for SFTP4 as well
  695. unsigned long Bits = GetCardinal();
  696. if (Version >= 6)
  697. {
  698. unsigned long BitsValid = GetCardinal();
  699. Bits = Bits & BitsValid;
  700. }
  701. if (FLAGSET(Bits, SSH_FILEXFER_ATTR_FLAGS_HIDDEN))
  702. {
  703. File->IsHidden = true;
  704. }
  705. }
  706. // skip some SFTP-6 only fields
  707. if (Flags & SSH_FILEXFER_ATTR_TEXT_HINT)
  708. {
  709. GetByte();
  710. }
  711. if (Flags & SSH_FILEXFER_ATTR_MIME_TYPE)
  712. {
  713. GetAnsiString();
  714. }
  715. if (Flags & SSH_FILEXFER_ATTR_LINK_COUNT)
  716. {
  717. GetCardinal();
  718. }
  719. if (Flags & SSH_FILEXFER_ATTR_UNTRANSLATED_NAME)
  720. {
  721. GetPathString(Utf);
  722. }
  723. if ((Version < 4) && (Type != SSH_FXP_ATTRS))
  724. {
  725. try
  726. {
  727. // update permissions and user/group name
  728. // modification time and filename is ignored
  729. File->ListingStr = ListingStr;
  730. }
  731. catch(...)
  732. {
  733. // ignore any error while parsing listing line,
  734. // SFTP specification do not recommend to parse it
  735. ParsingFailed = true;
  736. }
  737. }
  738. if (Type == SSH_FXP_ATTRS || Version >= 4 || ParsingFailed)
  739. {
  740. wchar_t Type = FILETYPE_DEFAULT;
  741. if (FLAGSET(Flags, SSH_FILEXFER_ATTR_PERMISSIONS))
  742. {
  743. File->Rights->Number = (unsigned short)(Permissions & TRights::rfAllSpecials);
  744. if (FLAGSET(Permissions, TRights::rfDirectory))
  745. {
  746. Type = FILETYPE_DIRECTORY;
  747. }
  748. }
  749. if (Version < 4)
  750. {
  751. File->Type = Type;
  752. }
  753. }
  754. if (Flags & SSH_FILEXFER_ATTR_EXTENDED)
  755. {
  756. unsigned int ExtendedCount = GetCardinal();
  757. for (unsigned int Index = 0; Index < ExtendedCount; Index++)
  758. {
  759. GetRawByteString(); // skip extended_type
  760. GetRawByteString(); // skip extended_data
  761. }
  762. }
  763. if (Complete)
  764. {
  765. File->Complete();
  766. }
  767. }
  768. unsigned char * GetNextData(unsigned int Size = 0)
  769. {
  770. if (Size > 0)
  771. {
  772. Need(Size);
  773. }
  774. return FPosition < FLength ? FData + FPosition : NULL;
  775. }
  776. void DataConsumed(unsigned int Size)
  777. {
  778. FPosition += Size;
  779. }
  780. void DataUpdated(int ALength)
  781. {
  782. FPosition = 0;
  783. FLength = ALength;
  784. FType = GetByte();
  785. if (FType != SSH_FXP_VERSION)
  786. {
  787. FMessageNumber = GetCardinal();
  788. }
  789. else
  790. {
  791. FMessageNumber = SFTPNoMessageNumber;
  792. }
  793. }
  794. void LoadFromFile(const UnicodeString FileName)
  795. {
  796. TStringList * DumpLines = new TStringList();
  797. RawByteString Dump;
  798. try
  799. {
  800. DumpLines->LoadFromFile(FileName);
  801. Dump = RawByteString(AnsiString(DumpLines->Text));
  802. }
  803. __finally
  804. {
  805. delete DumpLines;
  806. }
  807. Capacity = 20480;
  808. unsigned char Byte[3];
  809. memset(Byte, '\0', sizeof(Byte));
  810. int Index = 1;
  811. unsigned int Length = 0;
  812. while (Index < Dump.Length())
  813. {
  814. char C = Dump[Index];
  815. if (IsHex(C))
  816. {
  817. if (Byte[0] == '\0')
  818. {
  819. Byte[0] = C;
  820. }
  821. else
  822. {
  823. Byte[1] = C;
  824. DebugAssert(Length < Capacity);
  825. Data[Length] = HexToByte(UnicodeString(reinterpret_cast<char *>(Byte)));
  826. Length++;
  827. memset(Byte, '\0', sizeof(Byte));
  828. }
  829. }
  830. Index++;
  831. }
  832. DataUpdated(Length);
  833. }
  834. UnicodeString __fastcall Dump() const
  835. {
  836. UnicodeString Result;
  837. for (unsigned int Index = 0; Index < Length; Index++)
  838. {
  839. Result += ByteToHex(Data[Index]) + L",";
  840. if (((Index + 1) % 25) == 0)
  841. {
  842. Result += L"\n";
  843. }
  844. }
  845. return Result;
  846. }
  847. TSFTPPacket & operator = (const TSFTPPacket & Source)
  848. {
  849. Capacity = 0;
  850. Add(Source.Data, Source.Length);
  851. DataUpdated(Source.Length);
  852. FPosition = Source.FPosition;
  853. return *this;
  854. }
  855. __property unsigned int Length = { read = FLength };
  856. __property unsigned int RemainingLength = { read = GetRemainingLength };
  857. __property unsigned char * Data = { read = FData };
  858. __property unsigned char * SendData = { read = GetSendData };
  859. __property unsigned int SendLength = { read = GetSendLength };
  860. __property unsigned int Capacity = { read = FCapacity, write = SetCapacity };
  861. __property unsigned char Type = { read = FType };
  862. __property unsigned char RequestType = { read = GetRequestType };
  863. __property unsigned int MessageNumber = { read = FMessageNumber, write = FMessageNumber };
  864. __property TSFTPFileSystem * ReservedBy = { read = FReservedBy, write = FReservedBy };
  865. __property UnicodeString TypeName = { read = GetTypeName };
  866. private:
  867. unsigned char * FData;
  868. unsigned int FLength;
  869. unsigned int FCapacity;
  870. unsigned int FPosition;
  871. unsigned char FType;
  872. unsigned int FMessageNumber;
  873. TSFTPFileSystem * FReservedBy;
  874. static int FMessageCounter;
  875. static const FSendPrefixLen = 4;
  876. void Init()
  877. {
  878. FData = NULL;
  879. FCapacity = 0;
  880. FLength = 0;
  881. FPosition = 0;
  882. FMessageNumber = SFTPNoMessageNumber;
  883. FType = -1;
  884. FReservedBy = NULL;
  885. }
  886. void AssignNumber()
  887. {
  888. // this is not strictly thread-safe, but as it is accessed from multiple
  889. // threads only for multiple connection, it is not problem if two threads get
  890. // the same number
  891. FMessageNumber = (FMessageCounter << 8) + FType;
  892. FMessageCounter++;
  893. }
  894. unsigned char GetRequestType()
  895. {
  896. if (FMessageNumber != SFTPNoMessageNumber)
  897. {
  898. return (unsigned char)(FMessageNumber & 0xFF);
  899. }
  900. else
  901. {
  902. DebugAssert(Type == SSH_FXP_VERSION);
  903. return SSH_FXP_INIT;
  904. }
  905. }
  906. inline void Add(const void * AData, int ALength)
  907. {
  908. if (Length + ALength > Capacity)
  909. {
  910. Capacity = Length + ALength + SFTP_PACKET_ALLOC_DELTA;
  911. }
  912. memcpy(FData + Length, AData, ALength);
  913. FLength += ALength;
  914. }
  915. void SetCapacity(unsigned int ACapacity)
  916. {
  917. if (ACapacity != Capacity)
  918. {
  919. FCapacity = ACapacity;
  920. if (FCapacity > 0)
  921. {
  922. unsigned char * NData = (new unsigned char[FCapacity + FSendPrefixLen]) + FSendPrefixLen;
  923. if (FData)
  924. {
  925. memcpy(NData - FSendPrefixLen, FData - FSendPrefixLen,
  926. (FLength < FCapacity ? FLength : FCapacity) + FSendPrefixLen);
  927. delete[] (FData - FSendPrefixLen);
  928. }
  929. FData = NData;
  930. }
  931. else
  932. {
  933. if (FData) delete[] (FData - FSendPrefixLen);
  934. FData = NULL;
  935. }
  936. if (FLength > FCapacity) FLength = FCapacity;
  937. }
  938. }
  939. UnicodeString GetTypeName() const
  940. {
  941. #define TYPE_CASE(TYPE) case TYPE: return TEXT(#TYPE)
  942. switch (Type) {
  943. TYPE_CASE(SSH_FXP_INIT);
  944. TYPE_CASE(SSH_FXP_VERSION);
  945. TYPE_CASE(SSH_FXP_OPEN);
  946. TYPE_CASE(SSH_FXP_CLOSE);
  947. TYPE_CASE(SSH_FXP_READ);
  948. TYPE_CASE(SSH_FXP_WRITE);
  949. TYPE_CASE(SSH_FXP_LSTAT);
  950. TYPE_CASE(SSH_FXP_FSTAT);
  951. TYPE_CASE(SSH_FXP_SETSTAT);
  952. TYPE_CASE(SSH_FXP_FSETSTAT);
  953. TYPE_CASE(SSH_FXP_OPENDIR);
  954. TYPE_CASE(SSH_FXP_READDIR);
  955. TYPE_CASE(SSH_FXP_REMOVE);
  956. TYPE_CASE(SSH_FXP_MKDIR);
  957. TYPE_CASE(SSH_FXP_RMDIR);
  958. TYPE_CASE(SSH_FXP_REALPATH);
  959. TYPE_CASE(SSH_FXP_STAT);
  960. TYPE_CASE(SSH_FXP_RENAME);
  961. TYPE_CASE(SSH_FXP_READLINK);
  962. TYPE_CASE(SSH_FXP_SYMLINK);
  963. TYPE_CASE(SSH_FXP_LINK);
  964. TYPE_CASE(SSH_FXP_STATUS);
  965. TYPE_CASE(SSH_FXP_HANDLE);
  966. TYPE_CASE(SSH_FXP_DATA);
  967. TYPE_CASE(SSH_FXP_NAME);
  968. TYPE_CASE(SSH_FXP_ATTRS);
  969. TYPE_CASE(SSH_FXP_EXTENDED);
  970. TYPE_CASE(SSH_FXP_EXTENDED_REPLY);
  971. default:
  972. return FORMAT(L"Unknown message (%d)", (int(Type)));
  973. }
  974. }
  975. unsigned char * GetSendData() const
  976. {
  977. unsigned char * Result = FData - FSendPrefixLen;
  978. // this is not strictly const-object operation
  979. PUT_32BIT(Result, Length);
  980. return Result;
  981. }
  982. unsigned int GetSendLength() const
  983. {
  984. return FSendPrefixLen + Length;
  985. }
  986. unsigned int GetRemainingLength() const
  987. {
  988. return Length - FPosition;
  989. }
  990. inline void Need(unsigned int Size)
  991. {
  992. if (Size > RemainingLength)
  993. {
  994. throw Exception(FMTLOAD(SFTP_PACKET_ERROR, (int(FPosition), int(Size), int(FLength))));
  995. }
  996. }
  997. unsigned long PeekCardinal()
  998. {
  999. unsigned long Result;
  1000. Need(sizeof(Result));
  1001. Result = GET_32BIT(FData + FPosition);
  1002. return Result;
  1003. }
  1004. inline UnicodeString GetUtfString(TAutoSwitch & Utf)
  1005. {
  1006. DebugAssert(Utf != asOff);
  1007. UnicodeString Result;
  1008. RawByteString S = GetRawByteString();
  1009. if (Utf == asAuto)
  1010. {
  1011. TEncodeType EncodeType = DetectUTF8Encoding(S);
  1012. if (EncodeType == etANSI)
  1013. {
  1014. Utf = asOff;
  1015. Result = AnsiToString(S);
  1016. }
  1017. }
  1018. if (Utf != asOff)
  1019. {
  1020. Result = UTF8ToString(S);
  1021. }
  1022. return Result;
  1023. }
  1024. };
  1025. //---------------------------------------------------------------------------
  1026. int TSFTPPacket::FMessageCounter = 0;
  1027. //---------------------------------------------------------------------------
  1028. class TSFTPQueue
  1029. {
  1030. public:
  1031. __fastcall TSFTPQueue(TSFTPFileSystem * AFileSystem)
  1032. {
  1033. FFileSystem = AFileSystem;
  1034. DebugAssert(FFileSystem);
  1035. FRequests = new TList();
  1036. FResponses = new TList();
  1037. }
  1038. virtual __fastcall ~TSFTPQueue()
  1039. {
  1040. TSFTPQueuePacket * Request;
  1041. TSFTPPacket * Response;
  1042. DebugAssert(FResponses->Count == FRequests->Count);
  1043. for (int Index = 0; Index < FRequests->Count; Index++)
  1044. {
  1045. Request = static_cast<TSFTPQueuePacket*>(FRequests->Items[Index]);
  1046. DebugAssert(Request);
  1047. delete Request;
  1048. Response = static_cast<TSFTPPacket*>(FResponses->Items[Index]);
  1049. DebugAssert(Response);
  1050. delete Response;
  1051. }
  1052. delete FRequests;
  1053. delete FResponses;
  1054. }
  1055. bool __fastcall Init()
  1056. {
  1057. return SendRequests();
  1058. }
  1059. virtual void __fastcall Dispose()
  1060. {
  1061. DebugAssert(FFileSystem->FTerminal->Active);
  1062. TSFTPQueuePacket * Request;
  1063. TSFTPPacket * Response;
  1064. while (FRequests->Count)
  1065. {
  1066. DebugAssert(FResponses->Count);
  1067. Request = static_cast<TSFTPQueuePacket*>(FRequests->Items[0]);
  1068. DebugAssert(Request);
  1069. Response = static_cast<TSFTPPacket*>(FResponses->Items[0]);
  1070. DebugAssert(Response);
  1071. try
  1072. {
  1073. ReceiveResponse(Request, Response);
  1074. }
  1075. catch(Exception & E)
  1076. {
  1077. if (FFileSystem->FTerminal->Active)
  1078. {
  1079. FFileSystem->FTerminal->LogEvent(L"Error while disposing the SFTP queue.");
  1080. FFileSystem->FTerminal->Log->AddException(&E);
  1081. }
  1082. else
  1083. {
  1084. FFileSystem->FTerminal->LogEvent(L"Fatal error while disposing the SFTP queue.");
  1085. throw;
  1086. }
  1087. }
  1088. FRequests->Delete(0);
  1089. delete Request;
  1090. FResponses->Delete(0);
  1091. delete Response;
  1092. }
  1093. }
  1094. void __fastcall DisposeSafe()
  1095. {
  1096. if (FFileSystem->FTerminal->Active)
  1097. {
  1098. Dispose();
  1099. }
  1100. }
  1101. bool __fastcall ReceivePacket(TSFTPPacket * Packet,
  1102. int ExpectedType = -1, int AllowStatus = -1, void ** Token = NULL, bool TryOnly = false)
  1103. {
  1104. DebugAssert(FRequests->Count);
  1105. bool Result;
  1106. TSFTPQueuePacket * Request = NULL;
  1107. TSFTPPacket * Response = NULL;
  1108. try
  1109. {
  1110. Request = static_cast<TSFTPQueuePacket*>(FRequests->Items[0]);
  1111. FRequests->Delete(0);
  1112. DebugAssert(Request);
  1113. if (Token != NULL)
  1114. {
  1115. *Token = Request->Token;
  1116. }
  1117. Response = static_cast<TSFTPPacket*>(FResponses->Items[0]);
  1118. FResponses->Delete(0);
  1119. DebugAssert(Response);
  1120. ReceiveResponse(Request, Response, ExpectedType, AllowStatus, TryOnly);
  1121. if ((Response->Capacity == 0) && DebugAlwaysTrue(TryOnly))
  1122. {
  1123. FRequests->Insert(0, Request);
  1124. Request = NULL;
  1125. FResponses->Insert(0, Response);
  1126. Response = NULL;
  1127. Result = true;
  1128. }
  1129. else
  1130. {
  1131. if (Packet)
  1132. {
  1133. *Packet = *Response;
  1134. }
  1135. Result = !End(Response);
  1136. if (Result)
  1137. {
  1138. SendRequests();
  1139. }
  1140. }
  1141. }
  1142. __finally
  1143. {
  1144. delete Request;
  1145. delete Response;
  1146. }
  1147. return Result;
  1148. }
  1149. bool __fastcall Next(int ExpectedType = -1, int AllowStatus = -1)
  1150. {
  1151. return ReceivePacket(NULL, ExpectedType, AllowStatus);
  1152. }
  1153. protected:
  1154. TList * FRequests;
  1155. TList * FResponses;
  1156. TSFTPFileSystem * FFileSystem;
  1157. class TSFTPQueuePacket : public TSFTPPacket
  1158. {
  1159. public:
  1160. TSFTPQueuePacket() :
  1161. TSFTPPacket()
  1162. {
  1163. Token = NULL;
  1164. }
  1165. void * Token;
  1166. };
  1167. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request) = 0;
  1168. virtual bool __fastcall End(TSFTPPacket * Response) = 0;
  1169. virtual void __fastcall SendPacket(TSFTPQueuePacket * Packet)
  1170. {
  1171. FFileSystem->SendPacket(Packet);
  1172. }
  1173. virtual void __fastcall ReceiveResponse(
  1174. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType = -1,
  1175. int AllowStatus = -1, bool TryOnly = false)
  1176. {
  1177. FFileSystem->ReceiveResponse(Packet, Response, ExpectedType, AllowStatus, TryOnly);
  1178. }
  1179. // sends as many requests as allowed by implementation
  1180. virtual bool SendRequests() = 0;
  1181. virtual bool __fastcall SendRequest()
  1182. {
  1183. TSFTPQueuePacket * Request = NULL;
  1184. try
  1185. {
  1186. Request = new TSFTPQueuePacket();
  1187. if (!InitRequest(Request))
  1188. {
  1189. delete Request;
  1190. Request = NULL;
  1191. }
  1192. }
  1193. catch(...)
  1194. {
  1195. delete Request;
  1196. throw;
  1197. }
  1198. if (Request != NULL)
  1199. {
  1200. TSFTPPacket * Response = new TSFTPPacket();
  1201. FRequests->Add(Request);
  1202. FResponses->Add(Response);
  1203. // make sure the response is reserved before actually ending the message
  1204. // as we may receive response asynchronously before SendPacket finishes
  1205. FFileSystem->ReserveResponse(Request, Response);
  1206. SendPacket(Request);
  1207. }
  1208. return (Request != NULL);
  1209. }
  1210. };
  1211. //---------------------------------------------------------------------------
  1212. class TSFTPFixedLenQueue : public TSFTPQueue
  1213. {
  1214. public:
  1215. __fastcall TSFTPFixedLenQueue(TSFTPFileSystem * AFileSystem) : TSFTPQueue(AFileSystem)
  1216. {
  1217. FMissedRequests = 0;
  1218. }
  1219. virtual __fastcall ~TSFTPFixedLenQueue(){}
  1220. bool Init(int QueueLen)
  1221. {
  1222. FMissedRequests = QueueLen - 1;
  1223. return TSFTPQueue::Init();
  1224. }
  1225. protected:
  1226. int FMissedRequests;
  1227. // sends as many requests as allowed by implementation
  1228. virtual bool SendRequests()
  1229. {
  1230. bool Result = false;
  1231. FMissedRequests++;
  1232. while ((FMissedRequests > 0) && SendRequest())
  1233. {
  1234. Result = true;
  1235. FMissedRequests--;
  1236. }
  1237. return Result;
  1238. }
  1239. };
  1240. //---------------------------------------------------------------------------
  1241. class TSFTPAsynchronousQueue : public TSFTPQueue
  1242. {
  1243. public:
  1244. __fastcall TSFTPAsynchronousQueue(TSFTPFileSystem * AFileSystem) : TSFTPQueue(AFileSystem)
  1245. {
  1246. FFileSystem->FSecureShell->RegisterReceiveHandler(ReceiveHandler);
  1247. FReceiveHandlerRegistered = true;
  1248. }
  1249. virtual __fastcall ~TSFTPAsynchronousQueue()
  1250. {
  1251. UnregisterReceiveHandler();
  1252. }
  1253. virtual void __fastcall Dispose()
  1254. {
  1255. // we do not want to receive asynchronous notifications anymore,
  1256. // while waiting synchronously for pending responses
  1257. UnregisterReceiveHandler();
  1258. TSFTPQueue::Dispose();
  1259. }
  1260. bool __fastcall Continue()
  1261. {
  1262. return SendRequest();
  1263. }
  1264. protected:
  1265. // event handler for incoming data
  1266. void __fastcall ReceiveHandler(TObject * /*Sender*/)
  1267. {
  1268. while (// optimization only as we call ReceivePacket with TryOnly anyway
  1269. FFileSystem->PeekPacket() &&
  1270. ReceivePacketAsynchronously())
  1271. {
  1272. // loop
  1273. }
  1274. }
  1275. virtual bool __fastcall ReceivePacketAsynchronously() = 0;
  1276. // sends as many requests as allowed by implementation
  1277. virtual bool SendRequests()
  1278. {
  1279. // noop
  1280. return true;
  1281. }
  1282. void __fastcall UnregisterReceiveHandler()
  1283. {
  1284. if (FReceiveHandlerRegistered)
  1285. {
  1286. FReceiveHandlerRegistered = false;
  1287. FFileSystem->FSecureShell->UnregisterReceiveHandler(ReceiveHandler);
  1288. }
  1289. }
  1290. private:
  1291. bool FReceiveHandlerRegistered;
  1292. };
  1293. //---------------------------------------------------------------------------
  1294. class TSFTPDownloadQueue : public TSFTPFixedLenQueue
  1295. {
  1296. public:
  1297. TSFTPDownloadQueue(TSFTPFileSystem * AFileSystem) :
  1298. TSFTPFixedLenQueue(AFileSystem)
  1299. {
  1300. }
  1301. virtual __fastcall ~TSFTPDownloadQueue(){}
  1302. bool __fastcall Init(int QueueLen, const RawByteString & AHandle,__int64 ATransfered,
  1303. TFileOperationProgressType * AOperationProgress)
  1304. {
  1305. FHandle = AHandle;
  1306. FTransfered = ATransfered;
  1307. OperationProgress = AOperationProgress;
  1308. return TSFTPFixedLenQueue::Init(QueueLen);
  1309. }
  1310. void __fastcall InitFillGapRequest(__int64 Offset, unsigned long Missing,
  1311. TSFTPPacket * Packet)
  1312. {
  1313. InitRequest(Packet, Offset, Missing);
  1314. }
  1315. bool __fastcall ReceivePacket(TSFTPPacket * Packet, unsigned long & BlockSize)
  1316. {
  1317. void * Token;
  1318. bool Result = TSFTPFixedLenQueue::ReceivePacket(Packet, SSH_FXP_DATA, asEOF, &Token);
  1319. BlockSize = reinterpret_cast<unsigned long>(Token);
  1320. return Result;
  1321. }
  1322. protected:
  1323. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1324. {
  1325. unsigned int BlockSize = FFileSystem->DownloadBlockSize(OperationProgress);
  1326. InitRequest(Request, FTransfered, BlockSize);
  1327. Request->Token = reinterpret_cast<void*>(BlockSize);
  1328. FTransfered += BlockSize;
  1329. return true;
  1330. }
  1331. void __fastcall InitRequest(TSFTPPacket * Request, __int64 Offset,
  1332. unsigned long Size)
  1333. {
  1334. Request->ChangeType(SSH_FXP_READ);
  1335. Request->AddString(FHandle);
  1336. Request->AddInt64(Offset);
  1337. Request->AddCardinal(Size);
  1338. }
  1339. virtual bool __fastcall End(TSFTPPacket * Response)
  1340. {
  1341. return (Response->Type != SSH_FXP_DATA);
  1342. }
  1343. private:
  1344. TFileOperationProgressType * OperationProgress;
  1345. __int64 FTransfered;
  1346. RawByteString FHandle;
  1347. };
  1348. //---------------------------------------------------------------------------
  1349. class TSFTPUploadQueue : public TSFTPAsynchronousQueue
  1350. {
  1351. public:
  1352. TSFTPUploadQueue(TSFTPFileSystem * AFileSystem) :
  1353. TSFTPAsynchronousQueue(AFileSystem)
  1354. {
  1355. FStream = NULL;
  1356. OperationProgress = NULL;
  1357. FLastBlockSize = 0;
  1358. FEnd = false;
  1359. FConvertToken = false;
  1360. }
  1361. virtual __fastcall ~TSFTPUploadQueue()
  1362. {
  1363. delete FStream;
  1364. }
  1365. bool __fastcall Init(const UnicodeString AFileName,
  1366. HANDLE AFile, TFileOperationProgressType * AOperationProgress,
  1367. const RawByteString AHandle, __int64 ATransfered,
  1368. int ConvertParams)
  1369. {
  1370. FFileName = AFileName;
  1371. FStream = new TSafeHandleStream((THandle)AFile);
  1372. OperationProgress = AOperationProgress;
  1373. FHandle = AHandle;
  1374. FTransfered = ATransfered;
  1375. FConvertParams = ConvertParams;
  1376. return TSFTPAsynchronousQueue::Init();
  1377. }
  1378. protected:
  1379. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1380. {
  1381. TTerminal * FTerminal = FFileSystem->FTerminal;
  1382. // Buffer for one block of data
  1383. TFileBuffer BlockBuf;
  1384. unsigned long BlockSize = GetBlockSize();
  1385. bool Result = (BlockSize > 0);
  1386. if (Result)
  1387. {
  1388. FILE_OPERATION_LOOP_BEGIN
  1389. {
  1390. BlockBuf.LoadStream(FStream, BlockSize, false);
  1391. }
  1392. FILE_OPERATION_LOOP_END(FMTLOAD(READ_ERROR, (FFileName)));
  1393. FEnd = (BlockBuf.Size == 0);
  1394. Result = !FEnd;
  1395. if (Result)
  1396. {
  1397. OperationProgress->AddLocallyUsed(BlockBuf.Size);
  1398. // We do ASCII transfer: convert EOL of current block
  1399. if (OperationProgress->AsciiTransfer)
  1400. {
  1401. __int64 PrevBufSize = BlockBuf.Size;
  1402. BlockBuf.Convert(FTerminal->Configuration->LocalEOLType,
  1403. FFileSystem->GetEOL(), FConvertParams, FConvertToken);
  1404. // update transfer size with difference arised from EOL conversion
  1405. OperationProgress->ChangeTransferSize(OperationProgress->TransferSize -
  1406. PrevBufSize + BlockBuf.Size);
  1407. }
  1408. if (FFileSystem->FTerminal->Configuration->ActualLogProtocol >= 1)
  1409. {
  1410. FFileSystem->FTerminal->LogEvent(FORMAT(L"Write request offset: %d, len: %d",
  1411. (int(FTransfered), int(BlockBuf.Size))));
  1412. }
  1413. Request->ChangeType(SSH_FXP_WRITE);
  1414. Request->AddString(FHandle);
  1415. Request->AddInt64(FTransfered);
  1416. Request->AddData(BlockBuf.Data, BlockBuf.Size);
  1417. FLastBlockSize = BlockBuf.Size;
  1418. FTransfered += BlockBuf.Size;
  1419. }
  1420. }
  1421. return Result;
  1422. }
  1423. virtual void __fastcall SendPacket(TSFTPQueuePacket * Packet)
  1424. {
  1425. TSFTPAsynchronousQueue::SendPacket(Packet);
  1426. OperationProgress->AddTransfered(FLastBlockSize);
  1427. }
  1428. virtual void __fastcall ReceiveResponse(
  1429. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  1430. int AllowStatus, bool TryOnly)
  1431. {
  1432. TSFTPAsynchronousQueue::ReceiveResponse(Packet, Response, ExpectedType, AllowStatus, TryOnly);
  1433. if (Response->Capacity > 0)
  1434. {
  1435. // particularly when uploading a file that completelly fits into send buffer
  1436. // over slow line, we may end up seemingly completing the transfer immediatelly
  1437. // but hanging the application for a long time waiting for responses
  1438. // (common is that the progress window would not even manage to draw itself,
  1439. // showing that upload finished, before the application "hangs")
  1440. FFileSystem->Progress(OperationProgress);
  1441. }
  1442. else
  1443. {
  1444. DebugAssert(TryOnly);
  1445. }
  1446. }
  1447. virtual bool __fastcall ReceivePacketAsynchronously()
  1448. {
  1449. // do not read response to close request
  1450. bool Result = (FRequests->Count > 0);
  1451. if (Result)
  1452. {
  1453. // Try only: We cannot read from the socket here as we are already called
  1454. // from TSecureShell::HandleNetworkEvents as it would cause a recursion
  1455. // that would potentially make PuTTY code process the SSH packets in wrong order.
  1456. ReceivePacket(NULL, SSH_FXP_STATUS, -1, NULL, true);
  1457. }
  1458. return Result;
  1459. }
  1460. inline int __fastcall GetBlockSize()
  1461. {
  1462. return FFileSystem->UploadBlockSize(FHandle, OperationProgress);
  1463. }
  1464. virtual bool __fastcall End(TSFTPPacket * /*Response*/)
  1465. {
  1466. return FEnd;
  1467. }
  1468. private:
  1469. TStream * FStream;
  1470. TFileOperationProgressType * OperationProgress;
  1471. UnicodeString FFileName;
  1472. unsigned long FLastBlockSize;
  1473. bool FEnd;
  1474. __int64 FTransfered;
  1475. RawByteString FHandle;
  1476. bool FConvertToken;
  1477. int FConvertParams;
  1478. };
  1479. //---------------------------------------------------------------------------
  1480. class TSFTPLoadFilesPropertiesQueue : public TSFTPFixedLenQueue
  1481. {
  1482. public:
  1483. TSFTPLoadFilesPropertiesQueue(TSFTPFileSystem * AFileSystem) :
  1484. TSFTPFixedLenQueue(AFileSystem)
  1485. {
  1486. FIndex = 0;
  1487. }
  1488. virtual __fastcall ~TSFTPLoadFilesPropertiesQueue(){}
  1489. bool __fastcall Init(int QueueLen, TStrings * FileList)
  1490. {
  1491. FFileList = FileList;
  1492. return TSFTPFixedLenQueue::Init(QueueLen);
  1493. }
  1494. bool __fastcall ReceivePacket(TSFTPPacket * Packet, TRemoteFile *& File)
  1495. {
  1496. void * Token;
  1497. bool Result = TSFTPFixedLenQueue::ReceivePacket(Packet, SSH_FXP_ATTRS, asAll, &Token);
  1498. File = static_cast<TRemoteFile *>(Token);
  1499. return Result;
  1500. }
  1501. protected:
  1502. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1503. {
  1504. bool Result = false;
  1505. while (!Result && (FIndex < FFileList->Count))
  1506. {
  1507. TRemoteFile * File = static_cast<TRemoteFile *>(FFileList->Objects[FIndex]);
  1508. FIndex++;
  1509. bool MissingRights =
  1510. (FFileSystem->FSupport->Loaded &&
  1511. FLAGSET(FFileSystem->FSupport->AttributeMask, SSH_FILEXFER_ATTR_PERMISSIONS) &&
  1512. File->Rights->Unknown);
  1513. bool MissingOwnerGroup =
  1514. (FFileSystem->FSecureShell->SshImplementation == sshiBitvise) ||
  1515. (FFileSystem->FSupport->Loaded &&
  1516. FLAGSET(FFileSystem->FSupport->AttributeMask, SSH_FILEXFER_ATTR_OWNERGROUP) &&
  1517. !File->Owner.IsSet || !File->Group.IsSet);
  1518. Result = (MissingRights || MissingOwnerGroup);
  1519. if (Result)
  1520. {
  1521. Request->ChangeType(SSH_FXP_LSTAT);
  1522. Request->AddPathString(FFileSystem->LocalCanonify(File->FileName),
  1523. FFileSystem->FUtfStrings);
  1524. if (FFileSystem->FVersion >= 4)
  1525. {
  1526. Request->AddCardinal(
  1527. FLAGMASK(MissingRights, SSH_FILEXFER_ATTR_PERMISSIONS) |
  1528. FLAGMASK(MissingOwnerGroup, SSH_FILEXFER_ATTR_OWNERGROUP));
  1529. }
  1530. Request->Token = File;
  1531. }
  1532. }
  1533. return Result;
  1534. }
  1535. virtual bool __fastcall SendRequest()
  1536. {
  1537. bool Result =
  1538. (FIndex < FFileList->Count) &&
  1539. TSFTPFixedLenQueue::SendRequest();
  1540. return Result;
  1541. }
  1542. virtual bool __fastcall End(TSFTPPacket * /*Response*/)
  1543. {
  1544. return (FRequests->Count == 0);
  1545. }
  1546. private:
  1547. TStrings * FFileList;
  1548. int FIndex;
  1549. };
  1550. //---------------------------------------------------------------------------
  1551. class TSFTPCalculateFilesChecksumQueue : public TSFTPFixedLenQueue
  1552. {
  1553. public:
  1554. TSFTPCalculateFilesChecksumQueue(TSFTPFileSystem * AFileSystem) :
  1555. TSFTPFixedLenQueue(AFileSystem)
  1556. {
  1557. FIndex = 0;
  1558. }
  1559. virtual __fastcall ~TSFTPCalculateFilesChecksumQueue(){}
  1560. bool __fastcall Init(int QueueLen, const UnicodeString & Alg, TStrings * FileList)
  1561. {
  1562. FAlg = Alg;
  1563. FFileList = FileList;
  1564. return TSFTPFixedLenQueue::Init(QueueLen);
  1565. }
  1566. bool __fastcall ReceivePacket(TSFTPPacket * Packet, TRemoteFile *& File)
  1567. {
  1568. void * Token;
  1569. bool Result;
  1570. try
  1571. {
  1572. Result = TSFTPFixedLenQueue::ReceivePacket(Packet, SSH_FXP_EXTENDED_REPLY, asNo, &Token);
  1573. }
  1574. __finally
  1575. {
  1576. File = static_cast<TRemoteFile *>(Token);
  1577. }
  1578. return Result;
  1579. }
  1580. protected:
  1581. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1582. {
  1583. bool Result = false;
  1584. while (!Result && (FIndex < FFileList->Count))
  1585. {
  1586. TRemoteFile * File = static_cast<TRemoteFile *>(FFileList->Objects[FIndex]);
  1587. DebugAssert(File != NULL);
  1588. FIndex++;
  1589. Result = !File->IsDirectory;
  1590. if (Result)
  1591. {
  1592. DebugAssert(!File->IsParentDirectory && !File->IsThisDirectory);
  1593. Request->ChangeType(SSH_FXP_EXTENDED);
  1594. Request->AddString(SFTP_EXT_CHECK_FILE_NAME);
  1595. Request->AddPathString(FFileSystem->LocalCanonify(File->FullFileName),
  1596. FFileSystem->FUtfStrings);
  1597. Request->AddString(FAlg);
  1598. Request->AddInt64(0); // offset
  1599. Request->AddInt64(0); // length (0 = till end)
  1600. Request->AddCardinal(0); // block size (0 = no blocks or "one block")
  1601. Request->Token = File;
  1602. }
  1603. }
  1604. return Result;
  1605. }
  1606. virtual bool __fastcall SendRequest()
  1607. {
  1608. bool Result =
  1609. (FIndex < FFileList->Count) &&
  1610. TSFTPFixedLenQueue::SendRequest();
  1611. return Result;
  1612. }
  1613. virtual bool __fastcall End(TSFTPPacket * /*Response*/)
  1614. {
  1615. return (FRequests->Count == 0);
  1616. }
  1617. private:
  1618. UnicodeString FAlg;
  1619. TStrings * FFileList;
  1620. int FIndex;
  1621. };
  1622. //---------------------------------------------------------------------------
  1623. #pragma warn .inl
  1624. //---------------------------------------------------------------------------
  1625. class TSFTPBusy
  1626. {
  1627. public:
  1628. __fastcall TSFTPBusy(TSFTPFileSystem * FileSystem)
  1629. {
  1630. FFileSystem = FileSystem;
  1631. DebugAssert(FFileSystem != NULL);
  1632. FFileSystem->BusyStart();
  1633. }
  1634. __fastcall ~TSFTPBusy()
  1635. {
  1636. FFileSystem->BusyEnd();
  1637. }
  1638. private:
  1639. TSFTPFileSystem * FFileSystem;
  1640. };
  1641. //===========================================================================
  1642. struct TOpenRemoteFileParams
  1643. {
  1644. int LocalFileAttrs;
  1645. UnicodeString FileName;
  1646. UnicodeString RemoteFileName;
  1647. TFileOperationProgressType * OperationProgress;
  1648. const TCopyParamType * CopyParam;
  1649. int Params;
  1650. bool Resume;
  1651. bool Resuming;
  1652. TSFTPOverwriteMode OverwriteMode;
  1653. __int64 DestFileSize; // output
  1654. RawByteString RemoteFileHandle; // output
  1655. TOverwriteFileParams * FileParams;
  1656. bool Confirmed;
  1657. };
  1658. //---------------------------------------------------------------------------
  1659. struct TSinkFileParams
  1660. {
  1661. UnicodeString TargetDir;
  1662. const TCopyParamType * CopyParam;
  1663. int Params;
  1664. TFileOperationProgressType * OperationProgress;
  1665. bool Skipped;
  1666. unsigned int Flags;
  1667. };
  1668. //===========================================================================
  1669. __fastcall TSFTPFileSystem::TSFTPFileSystem(TTerminal * ATerminal,
  1670. TSecureShell * SecureShell):
  1671. TCustomFileSystem(ATerminal)
  1672. {
  1673. FSecureShell = SecureShell;
  1674. FPacketReservations = new TList();
  1675. FPacketNumbers = VarArrayCreate(OPENARRAY(int, (0, 1)), varLongWord);
  1676. FPreviousLoggedPacket = 0;
  1677. FNotLoggedPackets = 0;
  1678. FBusy = 0;
  1679. FAvoidBusy = false;
  1680. FUtfStrings = asOff;
  1681. FUtfDisablingAnnounced = true;
  1682. FSignedTS = false;
  1683. FSupport = new TSFTPSupport();
  1684. FExtensions = new TStringList();
  1685. FFixedPaths = NULL;
  1686. FFileSystemInfoValid = false;
  1687. FChecksumAlgs.reset(new TStringList());
  1688. FChecksumSftpAlgs.reset(new TStringList());
  1689. // List as defined by draft-ietf-secsh-filexfer-extensions-00
  1690. // MD5 moved to the back
  1691. RegisterChecksumAlg(Sha1ChecksumAlg, L"sha1");
  1692. RegisterChecksumAlg(Sha224ChecksumAlg, L"sha224");
  1693. RegisterChecksumAlg(Sha256ChecksumAlg, L"sha256");
  1694. RegisterChecksumAlg(Sha384ChecksumAlg, L"sha384");
  1695. RegisterChecksumAlg(Sha512ChecksumAlg, L"sha512");
  1696. RegisterChecksumAlg(Md5ChecksumAlg, L"md5");
  1697. RegisterChecksumAlg(Crc32ChecksumAlg, L"crc32");
  1698. }
  1699. //---------------------------------------------------------------------------
  1700. __fastcall TSFTPFileSystem::~TSFTPFileSystem()
  1701. {
  1702. delete FSupport;
  1703. ResetConnection();
  1704. delete FPacketReservations;
  1705. delete FExtensions;
  1706. delete FFixedPaths;
  1707. delete FSecureShell;
  1708. }
  1709. //---------------------------------------------------------------------------
  1710. void __fastcall TSFTPFileSystem::Open()
  1711. {
  1712. // this is used for reconnects only
  1713. FSecureShell->Open();
  1714. }
  1715. //---------------------------------------------------------------------------
  1716. void __fastcall TSFTPFileSystem::Close()
  1717. {
  1718. FSecureShell->Close();
  1719. }
  1720. //---------------------------------------------------------------------------
  1721. bool __fastcall TSFTPFileSystem::GetActive()
  1722. {
  1723. return FSecureShell->Active;
  1724. }
  1725. //---------------------------------------------------------------------------
  1726. void __fastcall TSFTPFileSystem::CollectUsage()
  1727. {
  1728. FSecureShell->CollectUsage();
  1729. UnicodeString VersionCounter;
  1730. switch (FVersion)
  1731. {
  1732. case 0:
  1733. VersionCounter = L"OpenedSessionsSFTP0";
  1734. break;
  1735. case 1:
  1736. VersionCounter = L"OpenedSessionsSFTP1";
  1737. break;
  1738. case 2:
  1739. VersionCounter = L"OpenedSessionsSFTP2";
  1740. break;
  1741. case 3:
  1742. VersionCounter = L"OpenedSessionsSFTP3";
  1743. break;
  1744. case 4:
  1745. VersionCounter = L"OpenedSessionsSFTP4";
  1746. break;
  1747. case 5:
  1748. VersionCounter = L"OpenedSessionsSFTP5";
  1749. break;
  1750. case 6:
  1751. VersionCounter = L"OpenedSessionsSFTP6";
  1752. break;
  1753. default:
  1754. DebugFail();
  1755. }
  1756. FTerminal->Configuration->Usage->Inc(VersionCounter);
  1757. }
  1758. //---------------------------------------------------------------------------
  1759. const TSessionInfo & __fastcall TSFTPFileSystem::GetSessionInfo()
  1760. {
  1761. return FSecureShell->GetSessionInfo();
  1762. }
  1763. //---------------------------------------------------------------------------
  1764. const TFileSystemInfo & __fastcall TSFTPFileSystem::GetFileSystemInfo(bool /*Retrieve*/)
  1765. {
  1766. if (!FFileSystemInfoValid)
  1767. {
  1768. FFileSystemInfo.AdditionalInfo = L"";
  1769. if (!IsCapable(fcRename))
  1770. {
  1771. FFileSystemInfo.AdditionalInfo += LoadStr(FS_RENAME_NOT_SUPPORTED) + L"\r\n\r\n";
  1772. }
  1773. if (FExtensions->Count > 0)
  1774. {
  1775. UnicodeString Name;
  1776. UnicodeString Value;
  1777. UnicodeString Line;
  1778. FFileSystemInfo.AdditionalInfo += LoadStr(SFTP_EXTENSION_INFO) + L"\r\n";
  1779. for (int Index = 0; Index < FExtensions->Count; Index++)
  1780. {
  1781. UnicodeString Name = FExtensions->Names[Index];
  1782. UnicodeString Value = FExtensions->Values[Name];
  1783. UnicodeString Line;
  1784. if (Value.IsEmpty())
  1785. {
  1786. Line = Name;
  1787. }
  1788. else
  1789. {
  1790. Line = FORMAT(L"%s=%s", (Name, Value));
  1791. }
  1792. FFileSystemInfo.AdditionalInfo += FORMAT(L" %s\r\n", (Line));
  1793. }
  1794. }
  1795. else
  1796. {
  1797. FFileSystemInfo.AdditionalInfo += LoadStr(SFTP_NO_EXTENSION_INFO) + L"\r\n";
  1798. }
  1799. FFileSystemInfo.ProtocolBaseName = L"SFTP";
  1800. FFileSystemInfo.ProtocolName = FMTLOAD(SFTP_PROTOCOL_NAME2, (FVersion));
  1801. FTerminal->SaveCapabilities(FFileSystemInfo);
  1802. FFileSystemInfoValid = true;
  1803. }
  1804. return FFileSystemInfo;
  1805. }
  1806. //---------------------------------------------------------------------------
  1807. bool __fastcall TSFTPFileSystem::TemporaryTransferFile(const UnicodeString & FileName)
  1808. {
  1809. return AnsiSameText(UnixExtractFileExt(FileName), PARTIAL_EXT);
  1810. }
  1811. //---------------------------------------------------------------------------
  1812. bool __fastcall TSFTPFileSystem::GetStoredCredentialsTried()
  1813. {
  1814. return FSecureShell->GetStoredCredentialsTried();
  1815. }
  1816. //---------------------------------------------------------------------------
  1817. UnicodeString __fastcall TSFTPFileSystem::GetUserName()
  1818. {
  1819. return FSecureShell->UserName;
  1820. }
  1821. //---------------------------------------------------------------------------
  1822. void __fastcall TSFTPFileSystem::Idle()
  1823. {
  1824. // Keep session alive
  1825. if ((FTerminal->SessionData->PingType != ptOff) &&
  1826. (Now() - FSecureShell->LastDataSent > FTerminal->SessionData->PingIntervalDT))
  1827. {
  1828. if ((FTerminal->SessionData->PingType == ptDummyCommand) &&
  1829. FSecureShell->Ready)
  1830. {
  1831. FTerminal->LogEvent(L"Sending dummy command to keep session alive.");
  1832. TSFTPPacket Packet(SSH_FXP_REALPATH);
  1833. Packet.AddPathString(L"/", FUtfStrings);
  1834. SendPacketAndReceiveResponse(&Packet, &Packet);
  1835. }
  1836. else
  1837. {
  1838. FSecureShell->KeepAlive();
  1839. }
  1840. }
  1841. FSecureShell->Idle();
  1842. }
  1843. //---------------------------------------------------------------------------
  1844. void __fastcall TSFTPFileSystem::ResetConnection()
  1845. {
  1846. // there must be no valid packet reservation at the end
  1847. for (int i = 0; i < FPacketReservations->Count; i++)
  1848. {
  1849. DebugAssert(FPacketReservations->Items[i] == NULL);
  1850. delete (TSFTPPacket *)FPacketReservations->Items[i];
  1851. }
  1852. FPacketReservations->Clear();
  1853. FPacketNumbers.Clear();
  1854. }
  1855. //---------------------------------------------------------------------------
  1856. bool __fastcall TSFTPFileSystem::IsCapable(int Capability) const
  1857. {
  1858. DebugAssert(FTerminal);
  1859. switch (Capability) {
  1860. case fcAnyCommand:
  1861. case fcShellAnyCommand:
  1862. return false;
  1863. case fcNewerOnlyUpload:
  1864. case fcTimestampChanging:
  1865. case fcIgnorePermErrors:
  1866. case fcPreservingTimestampUpload:
  1867. case fcSecondaryShell:
  1868. case fcRemoveCtrlZUpload:
  1869. case fcRemoveBOMUpload:
  1870. case fcMoveToQueue:
  1871. case fcPreservingTimestampDirs:
  1872. case fcResumeSupport:
  1873. return true;
  1874. case fcRename:
  1875. case fcRemoteMove:
  1876. return (FVersion >= 2);
  1877. case fcSymbolicLink:
  1878. case fcResolveSymlink:
  1879. return (FVersion >= 3);
  1880. case fcModeChanging:
  1881. case fcModeChangingUpload:
  1882. return !FSupport->Loaded ||
  1883. FLAGSET(FSupport->AttributeMask, SSH_FILEXFER_ATTR_PERMISSIONS);
  1884. case fcGroupOwnerChangingByID:
  1885. return (FVersion <= 3);
  1886. case fcOwnerChanging:
  1887. case fcGroupChanging:
  1888. return
  1889. (FVersion <= 3) ||
  1890. ((FVersion >= 4) &&
  1891. (!FSupport->Loaded ||
  1892. FLAGSET(FSupport->AttributeMask, SSH_FILEXFER_ATTR_OWNERGROUP)));
  1893. case fcNativeTextMode:
  1894. return (FVersion >= 4);
  1895. case fcTextMode:
  1896. return (FVersion >= 4) ||
  1897. strcmp(GetEOL(), EOLToStr(FTerminal->Configuration->LocalEOLType)) != 0;
  1898. case fcUserGroupListing:
  1899. return SupportsExtension(SFTP_EXT_OWNER_GROUP);
  1900. case fcLoadingAdditionalProperties:
  1901. // We allow loading properties only, if "supported" extension is supported and
  1902. // the server supports "permissions" and/or "owner/group" attributes
  1903. // (no other attributes are loaded).
  1904. // This is here only because of VShell
  1905. // (it supports owner/group, but does not include them into response to
  1906. // SSH_FXP_READDIR)
  1907. // and Bitwise (the same as VShell, but it does not even bother to provide "supported" extension until 6.21)
  1908. // No other use is known.
  1909. return
  1910. (FSupport->Loaded &&
  1911. ((FSupport->AttributeMask &
  1912. (SSH_FILEXFER_ATTR_PERMISSIONS | SSH_FILEXFER_ATTR_OWNERGROUP)) != 0)) ||
  1913. (FSecureShell->SshImplementation == sshiBitvise);
  1914. case fcCheckingSpaceAvailable:
  1915. return
  1916. // extension announced in extension list of by
  1917. // SFTP_EXT_SUPPORTED/SFTP_EXT_SUPPORTED2 extension
  1918. // (SFTP version 5 and newer only)
  1919. SupportsExtension(SFTP_EXT_SPACE_AVAILABLE) ||
  1920. // extension announced by proprietary SFTP_EXT_STATVFS extension
  1921. FSupportsStatVfsV2 ||
  1922. // Bitwise (until 6.21) fails to report it's supported extensions.
  1923. (FSecureShell->SshImplementation == sshiBitvise);
  1924. case fcCalculatingChecksum:
  1925. return
  1926. // Specification says that "check-file" should be announced,
  1927. // yet Vandyke VShell (as of 4.0.3) announce "check-file-name"
  1928. // https://forums.vandyke.com/showthread.php?t=11597
  1929. SupportsExtension(SFTP_EXT_CHECK_FILE) ||
  1930. SupportsExtension(SFTP_EXT_CHECK_FILE_NAME) ||
  1931. // see above
  1932. (FSecureShell->SshImplementation == sshiBitvise);
  1933. case fcRemoteCopy:
  1934. return
  1935. SupportsExtension(SFTP_EXT_COPY_FILE) ||
  1936. // see above
  1937. (FSecureShell->SshImplementation == sshiBitvise);
  1938. case fcHardLink:
  1939. return
  1940. (FVersion >= 6) ||
  1941. FSupportsHardlink;
  1942. case fcLocking:
  1943. return false;
  1944. default:
  1945. DebugFail();
  1946. return false;
  1947. }
  1948. }
  1949. //---------------------------------------------------------------------------
  1950. bool __fastcall TSFTPFileSystem::SupportsExtension(const UnicodeString & Extension) const
  1951. {
  1952. return FSupport->Loaded && (FSupport->Extensions->IndexOf(Extension) >= 0);
  1953. }
  1954. //---------------------------------------------------------------------------
  1955. inline void __fastcall TSFTPFileSystem::BusyStart()
  1956. {
  1957. if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
  1958. {
  1959. FBusyToken = ::BusyStart();
  1960. }
  1961. FBusy++;
  1962. DebugAssert(FBusy < 10);
  1963. }
  1964. //---------------------------------------------------------------------------
  1965. inline void __fastcall TSFTPFileSystem::BusyEnd()
  1966. {
  1967. DebugAssert(FBusy > 0);
  1968. FBusy--;
  1969. if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
  1970. {
  1971. ::BusyEnd(FBusyToken);
  1972. FBusyToken = NULL;
  1973. }
  1974. }
  1975. //---------------------------------------------------------------------------
  1976. unsigned long __fastcall TSFTPFileSystem::TransferBlockSize(unsigned long Overhead,
  1977. TFileOperationProgressType * OperationProgress, unsigned long MaxPacketSize)
  1978. {
  1979. const unsigned long MinPacketSize = 32768;
  1980. // size + message number + type
  1981. const unsigned long SFTPPacketOverhead = 4 + 4 + 1;
  1982. unsigned long AMaxPacketSize = FSecureShell->MaxPacketSize();
  1983. bool MaxPacketSizeValid = (AMaxPacketSize > 0);
  1984. unsigned long Result = OperationProgress->CPS();
  1985. if ((MaxPacketSize > 0) &&
  1986. ((MaxPacketSize < AMaxPacketSize) || !MaxPacketSizeValid))
  1987. {
  1988. AMaxPacketSize = MaxPacketSize;
  1989. MaxPacketSizeValid = true;
  1990. }
  1991. if ((FMaxPacketSize > 0) &&
  1992. ((FMaxPacketSize < AMaxPacketSize) || !MaxPacketSizeValid))
  1993. {
  1994. AMaxPacketSize = FMaxPacketSize;
  1995. MaxPacketSizeValid = true;
  1996. }
  1997. if (Result == 0)
  1998. {
  1999. Result = OperationProgress->StaticBlockSize();
  2000. }
  2001. if (Result < MinPacketSize)
  2002. {
  2003. Result = MinPacketSize;
  2004. }
  2005. if (MaxPacketSizeValid)
  2006. {
  2007. Overhead += SFTPPacketOverhead;
  2008. if (AMaxPacketSize < Overhead)
  2009. {
  2010. // do not send another request
  2011. // (generally should happen only if upload buffer is full)
  2012. Result = 0;
  2013. }
  2014. else
  2015. {
  2016. AMaxPacketSize -= Overhead;
  2017. if (Result > AMaxPacketSize)
  2018. {
  2019. Result = AMaxPacketSize;
  2020. }
  2021. }
  2022. }
  2023. Result = OperationProgress->AdjustToCPSLimit(Result);
  2024. return Result;
  2025. }
  2026. //---------------------------------------------------------------------------
  2027. unsigned long __fastcall TSFTPFileSystem::UploadBlockSize(const RawByteString & Handle,
  2028. TFileOperationProgressType * OperationProgress)
  2029. {
  2030. // handle length + offset + data size
  2031. const unsigned long UploadPacketOverhead =
  2032. sizeof(unsigned long) + sizeof(__int64) + sizeof(unsigned long);
  2033. return TransferBlockSize(UploadPacketOverhead + Handle.Length(), OperationProgress);
  2034. }
  2035. //---------------------------------------------------------------------------
  2036. unsigned long __fastcall TSFTPFileSystem::DownloadBlockSize(
  2037. TFileOperationProgressType * OperationProgress)
  2038. {
  2039. unsigned long Result = TransferBlockSize(sizeof(unsigned long), OperationProgress);
  2040. if (FSupport->Loaded && (FSupport->MaxReadSize > 0) &&
  2041. (Result > FSupport->MaxReadSize))
  2042. {
  2043. Result = FSupport->MaxReadSize;
  2044. }
  2045. return Result;
  2046. }
  2047. //---------------------------------------------------------------------------
  2048. void __fastcall TSFTPFileSystem::Progress(TFileOperationProgressType * OperationProgress)
  2049. {
  2050. FTerminal->Progress(OperationProgress);
  2051. }
  2052. //---------------------------------------------------------------------------
  2053. void __fastcall TSFTPFileSystem::SendPacket(const TSFTPPacket * Packet)
  2054. {
  2055. // putting here for a lack of better place
  2056. if (!FUtfDisablingAnnounced && (FUtfStrings == asOff))
  2057. {
  2058. FTerminal->LogEvent(L"Strings received in non-UTF-8 encoding in a previous packet, will not use UTF-8 anymore");
  2059. FUtfDisablingAnnounced = true;
  2060. }
  2061. BusyStart();
  2062. try
  2063. {
  2064. if (FTerminal->Log->Logging)
  2065. {
  2066. if ((FPreviousLoggedPacket != SSH_FXP_READ &&
  2067. FPreviousLoggedPacket != SSH_FXP_WRITE) ||
  2068. (Packet->Type != FPreviousLoggedPacket) ||
  2069. (FTerminal->Configuration->ActualLogProtocol >= 1))
  2070. {
  2071. if (FNotLoggedPackets)
  2072. {
  2073. FTerminal->LogEvent(FORMAT(L"%d skipped SSH_FXP_WRITE, SSH_FXP_READ, SSH_FXP_DATA and SSH_FXP_STATUS packets.",
  2074. (FNotLoggedPackets)));
  2075. FNotLoggedPackets = 0;
  2076. }
  2077. FTerminal->Log->Add(llInput, FORMAT(L"Type: %s, Size: %d, Number: %d",
  2078. (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
  2079. if (FTerminal->Configuration->ActualLogProtocol >= 2)
  2080. {
  2081. FTerminal->Log->Add(llInput, Packet->Dump());
  2082. }
  2083. FPreviousLoggedPacket = Packet->Type;
  2084. }
  2085. else
  2086. {
  2087. FNotLoggedPackets++;
  2088. }
  2089. }
  2090. FSecureShell->Send(Packet->SendData, Packet->SendLength);
  2091. }
  2092. __finally
  2093. {
  2094. BusyEnd();
  2095. }
  2096. }
  2097. //---------------------------------------------------------------------------
  2098. unsigned long __fastcall TSFTPFileSystem::GotStatusPacket(TSFTPPacket * Packet,
  2099. int AllowStatus)
  2100. {
  2101. unsigned long Code = Packet->GetCardinal();
  2102. static int Messages[] = {
  2103. SFTP_STATUS_OK,
  2104. SFTP_STATUS_EOF,
  2105. SFTP_STATUS_NO_SUCH_FILE,
  2106. SFTP_STATUS_PERMISSION_DENIED,
  2107. SFTP_STATUS_FAILURE,
  2108. SFTP_STATUS_BAD_MESSAGE,
  2109. SFTP_STATUS_NO_CONNECTION,
  2110. SFTP_STATUS_CONNECTION_LOST,
  2111. SFTP_STATUS_OP_UNSUPPORTED,
  2112. SFTP_STATUS_INVALID_HANDLE,
  2113. SFTP_STATUS_NO_SUCH_PATH,
  2114. SFTP_STATUS_FILE_ALREADY_EXISTS,
  2115. SFTP_STATUS_WRITE_PROTECT,
  2116. SFTP_STATUS_NO_MEDIA,
  2117. SFTP_STATUS_NO_SPACE_ON_FILESYSTEM,
  2118. SFTP_STATUS_QUOTA_EXCEEDED,
  2119. SFTP_STATUS_UNKNOWN_PRINCIPAL,
  2120. SFTP_STATUS_LOCK_CONFLICT,
  2121. SFTP_STATUS_DIR_NOT_EMPTY,
  2122. SFTP_STATUS_NOT_A_DIRECTORY,
  2123. SFTP_STATUS_INVALID_FILENAME,
  2124. SFTP_STATUS_LINK_LOOP,
  2125. SFTP_STATUS_CANNOT_DELETE,
  2126. SFTP_STATUS_INVALID_PARAMETER,
  2127. SFTP_STATUS_FILE_IS_A_DIRECTORY,
  2128. SFTP_STATUS_BYTE_RANGE_LOCK_CONFLICT,
  2129. SFTP_STATUS_BYTE_RANGE_LOCK_REFUSED,
  2130. SFTP_STATUS_DELETE_PENDING,
  2131. SFTP_STATUS_FILE_CORRUPT,
  2132. SFTP_STATUS_OWNER_INVALID,
  2133. SFTP_STATUS_GROUP_INVALID,
  2134. SFTP_STATUS_NO_MATCHING_BYTE_RANGE_LOCK
  2135. };
  2136. int Message;
  2137. if ((AllowStatus & (0x01 << Code)) == 0)
  2138. {
  2139. if (Code >= LENOF(Messages))
  2140. {
  2141. Message = SFTP_STATUS_UNKNOWN;
  2142. }
  2143. else
  2144. {
  2145. Message = Messages[Code];
  2146. }
  2147. UnicodeString MessageStr = LoadStr(Message);
  2148. UnicodeString ServerMessage;
  2149. UnicodeString LanguageTag;
  2150. if ((FVersion >= 3) ||
  2151. // if version is not decided yet (i.e. this is status response
  2152. // to the init request), go on, only if there are any more data
  2153. ((FVersion < 0) && (Packet->RemainingLength > 0)))
  2154. {
  2155. // message is in UTF only since SFTP specification 01 (specification 00
  2156. // is also version 3)
  2157. // (in other words, always use UTF unless server is known to be buggy)
  2158. ServerMessage = Packet->GetString(FUtfStrings);
  2159. // SSH-2.0-Maverick_SSHD and SSH-2.0-CIGNA SFTP Server Ready! omit the language tag
  2160. // and I believe I've seen one more server doing the same.
  2161. if (Packet->RemainingLength > 0)
  2162. {
  2163. LanguageTag = Packet->GetAnsiString();
  2164. if ((FVersion >= 5) && (Message == SFTP_STATUS_UNKNOWN_PRINCIPAL))
  2165. {
  2166. UnicodeString Principals;
  2167. while (Packet->GetNextData() != NULL)
  2168. {
  2169. if (!Principals.IsEmpty())
  2170. {
  2171. Principals += L", ";
  2172. }
  2173. Principals += Packet->GetAnsiString();
  2174. }
  2175. MessageStr = FORMAT(MessageStr, (Principals));
  2176. }
  2177. }
  2178. }
  2179. else
  2180. {
  2181. ServerMessage = LoadStr(SFTP_SERVER_MESSAGE_UNSUPPORTED);
  2182. }
  2183. if (FTerminal->Log->Logging)
  2184. {
  2185. FTerminal->Log->Add(llOutput, FORMAT(L"Status code: %d, Message: %d, Server: %s, Language: %s ",
  2186. (int(Code), (int)Packet->MessageNumber, ServerMessage, LanguageTag)));
  2187. }
  2188. if (!LanguageTag.IsEmpty())
  2189. {
  2190. LanguageTag = FORMAT(L" (%s)", (LanguageTag));
  2191. }
  2192. UnicodeString HelpKeyword;
  2193. switch (Code)
  2194. {
  2195. case SSH_FX_FAILURE:
  2196. HelpKeyword = HELP_SFTP_STATUS_FAILURE;
  2197. break;
  2198. case SSH_FX_PERMISSION_DENIED:
  2199. HelpKeyword = HELP_SFTP_STATUS_PERMISSION_DENIED;
  2200. break;
  2201. }
  2202. UnicodeString Error = FMTLOAD(SFTP_ERROR_FORMAT3, (MessageStr,
  2203. int(Code), LanguageTag, ServerMessage));
  2204. if (Code == SSH_FX_FAILURE)
  2205. {
  2206. FTerminal->Configuration->Usage->Inc(L"SftpFailureErrors");
  2207. Error += L"\n\n" + LoadStr(SFTP_STATUS_4);
  2208. }
  2209. FTerminal->TerminalError(NULL, Error, HelpKeyword);
  2210. return 0;
  2211. }
  2212. else
  2213. {
  2214. if (!FNotLoggedPackets || Code)
  2215. {
  2216. FTerminal->Log->Add(llOutput, FORMAT(L"Status code: %d", ((int)Code)));
  2217. }
  2218. return Code;
  2219. }
  2220. }
  2221. //---------------------------------------------------------------------------
  2222. void __fastcall TSFTPFileSystem::RemoveReservation(int Reservation)
  2223. {
  2224. for (int Index = Reservation+1; Index < FPacketReservations->Count; Index++)
  2225. {
  2226. FPacketNumbers.PutElement(FPacketNumbers.GetElement(Index), Index-1);
  2227. }
  2228. TSFTPPacket * Packet = (TSFTPPacket *)FPacketReservations->Items[Reservation];
  2229. if (Packet)
  2230. {
  2231. DebugAssert(Packet->ReservedBy == this);
  2232. Packet->ReservedBy = NULL;
  2233. }
  2234. FPacketReservations->Delete(Reservation);
  2235. }
  2236. //---------------------------------------------------------------------------
  2237. inline int __fastcall TSFTPFileSystem::PacketLength(unsigned char * LenBuf, int ExpectedType)
  2238. {
  2239. int Length = GET_32BIT(LenBuf);
  2240. if (Length > SFTP_MAX_PACKET_LEN)
  2241. {
  2242. UnicodeString Message = FMTLOAD(SFTP_PACKET_TOO_BIG, (
  2243. int(Length), SFTP_MAX_PACKET_LEN));
  2244. if (ExpectedType == SSH_FXP_VERSION)
  2245. {
  2246. RawByteString LenString(reinterpret_cast<char *>(LenBuf), 4);
  2247. Message = FMTLOAD(SFTP_PACKET_TOO_BIG_INIT_EXPLAIN,
  2248. (Message, DisplayableStr(LenString)));
  2249. }
  2250. FTerminal->FatalError(NULL, Message, HELP_SFTP_PACKET_TOO_BIG);
  2251. }
  2252. return Length;
  2253. }
  2254. //---------------------------------------------------------------------------
  2255. bool __fastcall TSFTPFileSystem::PeekPacket()
  2256. {
  2257. bool Result;
  2258. unsigned char * Buf;
  2259. Result = FSecureShell->Peek(Buf, 4);
  2260. if (Result)
  2261. {
  2262. int Length = PacketLength(Buf, -1);
  2263. Result = FSecureShell->Peek(Buf, 4 + Length);
  2264. }
  2265. return Result;
  2266. }
  2267. //---------------------------------------------------------------------------
  2268. int __fastcall TSFTPFileSystem::ReceivePacket(TSFTPPacket * Packet,
  2269. int ExpectedType, int AllowStatus, bool TryOnly)
  2270. {
  2271. TSFTPBusy Busy(this);
  2272. int Result = SSH_FX_OK;
  2273. int Reservation = FPacketReservations->IndexOf(Packet);
  2274. if (Reservation < 0 || Packet->Capacity == 0)
  2275. {
  2276. bool IsReserved;
  2277. do
  2278. {
  2279. IsReserved = false;
  2280. DebugAssert(Packet);
  2281. if (TryOnly && !PeekPacket())
  2282. {
  2283. // Reset packet in case it was filled by previous out-of-order
  2284. // reserved packet
  2285. *Packet = TSFTPPacket();
  2286. }
  2287. else
  2288. {
  2289. unsigned char LenBuf[4];
  2290. FSecureShell->Receive(LenBuf, sizeof(LenBuf));
  2291. int Length = PacketLength(LenBuf, ExpectedType);
  2292. Packet->Capacity = Length;
  2293. FSecureShell->Receive(Packet->Data, Length);
  2294. Packet->DataUpdated(Length);
  2295. if (FTerminal->Log->Logging)
  2296. {
  2297. if ((FPreviousLoggedPacket != SSH_FXP_READ &&
  2298. FPreviousLoggedPacket != SSH_FXP_WRITE) ||
  2299. (Packet->Type != SSH_FXP_STATUS && Packet->Type != SSH_FXP_DATA) ||
  2300. (FTerminal->Configuration->ActualLogProtocol >= 1))
  2301. {
  2302. if (FNotLoggedPackets)
  2303. {
  2304. FTerminal->LogEvent(FORMAT(L"%d skipped SSH_FXP_WRITE, SSH_FXP_READ, SSH_FXP_DATA and SSH_FXP_STATUS packets.",
  2305. (FNotLoggedPackets)));
  2306. FNotLoggedPackets = 0;
  2307. }
  2308. FTerminal->Log->Add(llOutput, FORMAT(L"Type: %s, Size: %d, Number: %d",
  2309. (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
  2310. if (FTerminal->Configuration->ActualLogProtocol >= 2)
  2311. {
  2312. FTerminal->Log->Add(llOutput, Packet->Dump());
  2313. }
  2314. }
  2315. else
  2316. {
  2317. FNotLoggedPackets++;
  2318. }
  2319. }
  2320. if (Reservation < 0 ||
  2321. Packet->MessageNumber != (unsigned int)FPacketNumbers.GetElement(Reservation))
  2322. {
  2323. TSFTPPacket * ReservedPacket;
  2324. unsigned int MessageNumber;
  2325. for (int Index = 0; Index < FPacketReservations->Count; Index++)
  2326. {
  2327. MessageNumber = (unsigned int)FPacketNumbers.GetElement(Index);
  2328. if (MessageNumber == Packet->MessageNumber)
  2329. {
  2330. ReservedPacket = (TSFTPPacket *)FPacketReservations->Items[Index];
  2331. IsReserved = true;
  2332. if (ReservedPacket)
  2333. {
  2334. FTerminal->LogEvent(L"Storing reserved response");
  2335. *ReservedPacket = *Packet;
  2336. }
  2337. else
  2338. {
  2339. FTerminal->LogEvent(L"Discarding reserved response");
  2340. RemoveReservation(Index);
  2341. if ((Reservation >= 0) && (Reservation > Index))
  2342. {
  2343. Reservation--;
  2344. DebugAssert(Reservation == FPacketReservations->IndexOf(Packet));
  2345. }
  2346. }
  2347. break;
  2348. }
  2349. }
  2350. }
  2351. }
  2352. }
  2353. while (IsReserved);
  2354. }
  2355. if ((Packet->Capacity == 0) && DebugAlwaysTrue(TryOnly))
  2356. {
  2357. // noop
  2358. }
  2359. else
  2360. {
  2361. // before we removed the reservation after check for packet type,
  2362. // but if it raises exception, removal is unnecessarily
  2363. // postponed until the packet is removed
  2364. // (and it have not worked anyway until recent fix to UnreserveResponse)
  2365. if (Reservation >= 0)
  2366. {
  2367. DebugAssert(Packet->MessageNumber == (unsigned int)FPacketNumbers.GetElement(Reservation));
  2368. RemoveReservation(Reservation);
  2369. }
  2370. if (ExpectedType >= 0)
  2371. {
  2372. if (Packet->Type == SSH_FXP_STATUS)
  2373. {
  2374. if (AllowStatus < 0)
  2375. {
  2376. AllowStatus = (ExpectedType == SSH_FXP_STATUS ? asOK : asNo);
  2377. }
  2378. Result = GotStatusPacket(Packet, AllowStatus);
  2379. }
  2380. else if (ExpectedType != Packet->Type)
  2381. {
  2382. FTerminal->FatalError(NULL, FMTLOAD(SFTP_INVALID_TYPE, ((int)Packet->Type)));
  2383. }
  2384. }
  2385. }
  2386. return Result;
  2387. }
  2388. //---------------------------------------------------------------------------
  2389. void __fastcall TSFTPFileSystem::ReserveResponse(const TSFTPPacket * Packet,
  2390. TSFTPPacket * Response)
  2391. {
  2392. if (Response != NULL)
  2393. {
  2394. DebugAssert(FPacketReservations->IndexOf(Response) < 0);
  2395. // mark response as not received yet
  2396. Response->Capacity = 0;
  2397. Response->ReservedBy = this;
  2398. }
  2399. FPacketReservations->Add(Response);
  2400. if (FPacketReservations->Count >= FPacketNumbers.ArrayHighBound())
  2401. {
  2402. FPacketNumbers.ArrayRedim(FPacketReservations->Count + 10);
  2403. }
  2404. FPacketNumbers.PutElement(Packet->MessageNumber, FPacketReservations->Count - 1);
  2405. }
  2406. //---------------------------------------------------------------------------
  2407. void __fastcall TSFTPFileSystem::UnreserveResponse(TSFTPPacket * Response)
  2408. {
  2409. int Reservation = FPacketReservations->IndexOf(Response);
  2410. if (Response->Capacity != 0)
  2411. {
  2412. // added check for already received packet
  2413. // (it happens when the reserved response is received out of order,
  2414. // unexpectedly soon, and then receivepacket() on the packet
  2415. // is not actually called, due to exception)
  2416. RemoveReservation(Reservation);
  2417. }
  2418. else
  2419. {
  2420. if (Reservation >= 0)
  2421. {
  2422. // we probably do not remove the item at all, because
  2423. // we must remember that the response was expected, so we skip it
  2424. // in receivepacket()
  2425. FPacketReservations->Items[Reservation] = NULL;
  2426. }
  2427. }
  2428. }
  2429. //---------------------------------------------------------------------------
  2430. int __fastcall TSFTPFileSystem::ReceiveResponse(
  2431. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  2432. int AllowStatus, bool TryOnly)
  2433. {
  2434. int Result;
  2435. unsigned int MessageNumber = Packet->MessageNumber;
  2436. TSFTPPacket * AResponse = (Response ? Response : new TSFTPPacket());
  2437. try
  2438. {
  2439. Result = ReceivePacket(AResponse, ExpectedType, AllowStatus, TryOnly);
  2440. if (MessageNumber != AResponse->MessageNumber)
  2441. {
  2442. FTerminal->FatalError(NULL, FMTLOAD(SFTP_MESSAGE_NUMBER,
  2443. ((int)AResponse->MessageNumber, (int)MessageNumber)));
  2444. }
  2445. }
  2446. __finally
  2447. {
  2448. if (!Response)
  2449. {
  2450. delete AResponse;
  2451. }
  2452. }
  2453. return Result;
  2454. }
  2455. //---------------------------------------------------------------------------
  2456. int __fastcall TSFTPFileSystem::SendPacketAndReceiveResponse(
  2457. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  2458. int AllowStatus)
  2459. {
  2460. int Result;
  2461. TSFTPBusy Busy(this);
  2462. SendPacket(Packet);
  2463. Result = ReceiveResponse(Packet, Response, ExpectedType, AllowStatus);
  2464. return Result;
  2465. }
  2466. //---------------------------------------------------------------------------
  2467. UnicodeString __fastcall TSFTPFileSystem::RealPath(const UnicodeString Path)
  2468. {
  2469. try
  2470. {
  2471. FTerminal->LogEvent(FORMAT(L"Getting real path for '%s'",
  2472. (Path)));
  2473. TSFTPPacket Packet(SSH_FXP_REALPATH);
  2474. Packet.AddPathString(Path, FUtfStrings);
  2475. // In SFTP-6 new optional field control-byte is added that defaults to
  2476. // SSH_FXP_REALPATH_NO_CHECK=0x01, meaning it won't fail, if the path does not exist.
  2477. // That differs from SFTP-5 recommendation that
  2478. // "The server SHOULD fail the request if the path is not present on the server."
  2479. // Earlier versions had no recommendation, though canonical SFTP-3 implementation
  2480. // in OpenSSH fails.
  2481. // While we really do not care much, we anyway set the flag to ~ & 0x01 to make the request fail.
  2482. // First for consistency.
  2483. // Second to workaround a bug in ProFTPD/mod_sftp version 1.3.5rc1 through 1.3.5-stable
  2484. // that sends a completelly malformed response for non-existing paths,
  2485. // when SSH_FXP_REALPATH_NO_CHECK (even implicitly) is used.
  2486. // See http://bugs.proftpd.org/show_bug.cgi?id=4160
  2487. // Note that earlier drafts of SFTP-6 (filexfer-07 and -08) had optional compose-path field
  2488. // before control-byte field. If we ever use this against a server conforming to those drafts,
  2489. // if may cause trouble.
  2490. if (FVersion >= 6)
  2491. {
  2492. if (FSecureShell->SshImplementation != sshiProFTPD)
  2493. {
  2494. Packet.AddByte(SSH_FXP_REALPATH_STAT_ALWAYS);
  2495. }
  2496. else
  2497. {
  2498. // Cannot use SSH_FXP_REALPATH_STAT_ALWAYS as ProFTPD does wrong bitwise test
  2499. // so it incorrectly evaluates SSH_FXP_REALPATH_STAT_ALWAYS (0x03) as
  2500. // SSH_FXP_REALPATH_NO_CHECK (0x01). The only value conforming to the
  2501. // specification, yet working with ProFTPD is SSH_FXP_REALPATH_STAT_IF (0x02).
  2502. Packet.AddByte(SSH_FXP_REALPATH_STAT_IF);
  2503. }
  2504. }
  2505. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_NAME);
  2506. if (Packet.GetCardinal() != 1)
  2507. {
  2508. FTerminal->FatalError(NULL, LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
  2509. }
  2510. UnicodeString RealDir = UnixExcludeTrailingBackslash(Packet.GetPathString(FUtfStrings));
  2511. // ignore rest of SSH_FXP_NAME packet
  2512. FTerminal->LogEvent(FORMAT(L"Real path is '%s'", (RealDir)));
  2513. return RealDir;
  2514. }
  2515. catch(Exception & E)
  2516. {
  2517. if (FTerminal->Active)
  2518. {
  2519. throw ExtException(&E, FMTLOAD(SFTP_REALPATH_ERROR, (Path)));
  2520. }
  2521. else
  2522. {
  2523. throw;
  2524. }
  2525. }
  2526. }
  2527. //---------------------------------------------------------------------------
  2528. UnicodeString __fastcall TSFTPFileSystem::RealPath(const UnicodeString Path,
  2529. const UnicodeString BaseDir)
  2530. {
  2531. UnicodeString APath;
  2532. if (UnixIsAbsolutePath(Path))
  2533. {
  2534. APath = Path;
  2535. }
  2536. else
  2537. {
  2538. if (!Path.IsEmpty())
  2539. {
  2540. // this condition/block was outside (before) current block
  2541. // but it did not work when Path was empty
  2542. if (!BaseDir.IsEmpty())
  2543. {
  2544. APath = UnixIncludeTrailingBackslash(BaseDir);
  2545. }
  2546. APath = APath + Path;
  2547. }
  2548. if (APath.IsEmpty()) APath = UnixIncludeTrailingBackslash(L".");
  2549. }
  2550. return RealPath(APath);
  2551. }
  2552. //---------------------------------------------------------------------------
  2553. UnicodeString __fastcall TSFTPFileSystem::LocalCanonify(const UnicodeString & Path)
  2554. {
  2555. // TODO: improve (handle .. etc.)
  2556. if (UnixIsAbsolutePath(Path) ||
  2557. (!FCurrentDirectory.IsEmpty() && UnixSamePath(FCurrentDirectory, Path)))
  2558. {
  2559. return Path;
  2560. }
  2561. else
  2562. {
  2563. return ::AbsolutePath(FCurrentDirectory, Path);
  2564. }
  2565. }
  2566. //---------------------------------------------------------------------------
  2567. UnicodeString __fastcall TSFTPFileSystem::Canonify(UnicodeString Path)
  2568. {
  2569. // inspired by canonify() from PSFTP.C
  2570. UnicodeString Result;
  2571. FTerminal->LogEvent(FORMAT(L"Canonifying: \"%s\"", (Path)));
  2572. Path = LocalCanonify(Path);
  2573. bool TryParent = false;
  2574. try
  2575. {
  2576. Result = RealPath(Path);
  2577. }
  2578. catch(...)
  2579. {
  2580. if (FTerminal->Active)
  2581. {
  2582. TryParent = true;
  2583. }
  2584. else
  2585. {
  2586. throw;
  2587. }
  2588. }
  2589. if (TryParent)
  2590. {
  2591. UnicodeString APath = UnixExcludeTrailingBackslash(Path);
  2592. UnicodeString Name = UnixExtractFileName(APath);
  2593. if (Name == L"." || Name == L"..")
  2594. {
  2595. Result = Path;
  2596. }
  2597. else
  2598. {
  2599. UnicodeString FPath = UnixExtractFilePath(APath);
  2600. try
  2601. {
  2602. Result = RealPath(FPath);
  2603. Result = UnixIncludeTrailingBackslash(Result) + Name;
  2604. }
  2605. catch(...)
  2606. {
  2607. if (FTerminal->Active)
  2608. {
  2609. Result = Path;
  2610. }
  2611. else
  2612. {
  2613. throw;
  2614. }
  2615. }
  2616. }
  2617. }
  2618. FTerminal->LogEvent(FORMAT(L"Canonified: \"%s\"", (Result)));
  2619. return Result;
  2620. }
  2621. //---------------------------------------------------------------------------
  2622. UnicodeString __fastcall TSFTPFileSystem::AbsolutePath(UnicodeString Path, bool Local)
  2623. {
  2624. if (Local)
  2625. {
  2626. return LocalCanonify(Path);
  2627. }
  2628. else
  2629. {
  2630. return RealPath(Path, CurrentDirectory);
  2631. }
  2632. }
  2633. //---------------------------------------------------------------------------
  2634. UnicodeString __fastcall TSFTPFileSystem::GetHomeDirectory()
  2635. {
  2636. if (FHomeDirectory.IsEmpty())
  2637. {
  2638. FHomeDirectory = RealPath(L".");
  2639. }
  2640. return FHomeDirectory;
  2641. }
  2642. //---------------------------------------------------------------------------
  2643. void __fastcall TSFTPFileSystem::LoadFile(TRemoteFile * File, TSFTPPacket * Packet,
  2644. bool Complete)
  2645. {
  2646. Packet->GetFile(File, FVersion, FTerminal->SessionData->DSTMode,
  2647. FUtfStrings, FSignedTS, Complete);
  2648. }
  2649. //---------------------------------------------------------------------------
  2650. TRemoteFile * __fastcall TSFTPFileSystem::LoadFile(TSFTPPacket * Packet,
  2651. TRemoteFile * ALinkedByFile, const UnicodeString FileName,
  2652. TRemoteFileList * TempFileList, bool Complete)
  2653. {
  2654. TRemoteFile * File = new TRemoteFile(ALinkedByFile);
  2655. try
  2656. {
  2657. File->Terminal = FTerminal;
  2658. if (!FileName.IsEmpty())
  2659. {
  2660. File->FileName = FileName;
  2661. }
  2662. // to get full path for symlink completion
  2663. File->Directory = TempFileList;
  2664. LoadFile(File, Packet, Complete);
  2665. File->Directory = NULL;
  2666. }
  2667. catch(...)
  2668. {
  2669. delete File;
  2670. throw;
  2671. }
  2672. return File;
  2673. }
  2674. //---------------------------------------------------------------------------
  2675. UnicodeString __fastcall TSFTPFileSystem::GetCurrentDirectory()
  2676. {
  2677. return FCurrentDirectory;
  2678. }
  2679. //---------------------------------------------------------------------------
  2680. void __fastcall TSFTPFileSystem::DoStartup()
  2681. {
  2682. // do not know yet
  2683. FVersion = -1;
  2684. FFileSystemInfoValid = false;
  2685. TSFTPPacket Packet(SSH_FXP_INIT);
  2686. int MaxVersion = FTerminal->SessionData->SFTPMaxVersion;
  2687. if (MaxVersion > SFTPMaxVersion)
  2688. {
  2689. MaxVersion = SFTPMaxVersion;
  2690. }
  2691. Packet.AddCardinal(MaxVersion);
  2692. try
  2693. {
  2694. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_VERSION);
  2695. }
  2696. catch(Exception &E)
  2697. {
  2698. FTerminal->FatalError(&E, LoadStr(SFTP_INITIALIZE_ERROR), HELP_SFTP_INITIALIZE_ERROR);
  2699. }
  2700. FVersion = Packet.GetCardinal();
  2701. FTerminal->LogEvent(FORMAT(L"SFTP version %d negotiated.", (FVersion)));
  2702. if (FVersion < SFTPMinVersion || FVersion > SFTPMaxVersion)
  2703. {
  2704. FTerminal->FatalError(NULL, FMTLOAD(SFTP_VERSION_NOT_SUPPORTED,
  2705. (FVersion, SFTPMinVersion, SFTPMaxVersion)));
  2706. }
  2707. FExtensions->Clear();
  2708. FEOL = "\r\n";
  2709. FSupport->Loaded = false;
  2710. FSupportsStatVfsV2 = false;
  2711. FSupportsHardlink = false;
  2712. SAFE_DESTROY(FFixedPaths);
  2713. if (FVersion >= 3)
  2714. {
  2715. while (Packet.GetNextData() != NULL)
  2716. {
  2717. UnicodeString ExtensionName = Packet.GetAnsiString();
  2718. RawByteString ExtensionData = Packet.GetRawByteString();
  2719. UnicodeString ExtensionDisplayData = DisplayableStr(ExtensionData);
  2720. if (ExtensionName == SFTP_EXT_NEWLINE)
  2721. {
  2722. FEOL = AnsiString(ExtensionData);
  2723. FTerminal->LogEvent(FORMAT(L"Server requests EOL sequence %s.",
  2724. (ExtensionDisplayData)));
  2725. if (FEOL.Length() < 1 || FEOL.Length() > 2)
  2726. {
  2727. FTerminal->FatalError(NULL, FMTLOAD(SFTP_INVALID_EOL, (ExtensionDisplayData)));
  2728. }
  2729. }
  2730. // do not allow "supported" to override "supported2" if both are received
  2731. else if (((ExtensionName == SFTP_EXT_SUPPORTED) && !FSupport->Loaded) ||
  2732. (ExtensionName == SFTP_EXT_SUPPORTED2))
  2733. {
  2734. FSupport->Reset();
  2735. TSFTPPacket SupportedStruct(ExtensionData);
  2736. FSupport->Loaded = true;
  2737. FSupport->AttributeMask = SupportedStruct.GetCardinal();
  2738. FSupport->AttributeBits = SupportedStruct.GetCardinal();
  2739. FSupport->OpenFlags = SupportedStruct.GetCardinal();
  2740. FSupport->AccessMask = SupportedStruct.GetCardinal();
  2741. FSupport->MaxReadSize = SupportedStruct.GetCardinal();
  2742. if (ExtensionName == SFTP_EXT_SUPPORTED)
  2743. {
  2744. while (SupportedStruct.GetNextData() != NULL)
  2745. {
  2746. FSupport->Extensions->Add(SupportedStruct.GetAnsiString());
  2747. }
  2748. }
  2749. else
  2750. {
  2751. // note that supported-open-block-vector, supported-block-vector,
  2752. // attrib-extension-count and attrib-extension-names fields
  2753. // were added only in rev 08, while "supported2" was defined in rev 07
  2754. FSupport->OpenBlockVector = SupportedStruct.GetSmallCardinal();
  2755. FSupport->BlockVector = SupportedStruct.GetSmallCardinal();
  2756. unsigned int ExtensionCount;
  2757. ExtensionCount = SupportedStruct.GetCardinal();
  2758. for (unsigned int i = 0; i < ExtensionCount; i++)
  2759. {
  2760. FSupport->AttribExtensions->Add(SupportedStruct.GetAnsiString());
  2761. }
  2762. ExtensionCount = SupportedStruct.GetCardinal();
  2763. for (unsigned int i = 0; i < ExtensionCount; i++)
  2764. {
  2765. FSupport->Extensions->Add(SupportedStruct.GetAnsiString());
  2766. }
  2767. }
  2768. if (FTerminal->Log->Logging)
  2769. {
  2770. FTerminal->LogEvent(FORMAT(
  2771. L"Server support information (%s):\n"
  2772. " Attribute mask: %x, Attribute bits: %x, Open flags: %x\n"
  2773. " Access mask: %x, Open block vector: %x, Block vector: %x, Max read size: %d\n",
  2774. (ExtensionName,
  2775. int(FSupport->AttributeMask),
  2776. int(FSupport->AttributeBits),
  2777. int(FSupport->OpenFlags),
  2778. int(FSupport->AccessMask),
  2779. int(FSupport->OpenBlockVector),
  2780. int(FSupport->BlockVector),
  2781. int(FSupport->MaxReadSize))));
  2782. FTerminal->LogEvent(FORMAT(L" Attribute extensions (%d)\n", (FSupport->AttribExtensions->Count)));
  2783. for (int Index = 0; Index < FSupport->AttribExtensions->Count; Index++)
  2784. {
  2785. FTerminal->LogEvent(
  2786. FORMAT(L" %s", (FSupport->AttribExtensions->Strings[Index])));
  2787. }
  2788. FTerminal->LogEvent(FORMAT(L" Extensions (%d)\n", (FSupport->Extensions->Count)));
  2789. for (int Index = 0; Index < FSupport->Extensions->Count; Index++)
  2790. {
  2791. FTerminal->LogEvent(
  2792. FORMAT(L" %s", (FSupport->Extensions->Strings[Index])));
  2793. }
  2794. }
  2795. }
  2796. else if (ExtensionName == SFTP_EXT_VENDOR_ID)
  2797. {
  2798. TSFTPPacket VendorIdStruct(ExtensionData);
  2799. UnicodeString VendorName(VendorIdStruct.GetAnsiString());
  2800. UnicodeString ProductName(VendorIdStruct.GetAnsiString());
  2801. UnicodeString ProductVersion(VendorIdStruct.GetAnsiString());
  2802. __int64 ProductBuildNumber = VendorIdStruct.GetInt64();
  2803. FTerminal->LogEvent(FORMAT(L"Server software: %s %s (%d) by %s",
  2804. (ProductName, ProductVersion, int(ProductBuildNumber), VendorName)));
  2805. }
  2806. else if (ExtensionName == SFTP_EXT_FSROOTS)
  2807. {
  2808. FTerminal->LogEvent(L"File system roots:\n");
  2809. DebugAssert(FFixedPaths == NULL);
  2810. FFixedPaths = new TStringList();
  2811. try
  2812. {
  2813. TSFTPPacket RootsPacket(ExtensionData);
  2814. while (RootsPacket.GetNextData() != NULL)
  2815. {
  2816. unsigned long Dummy = RootsPacket.GetCardinal();
  2817. if (Dummy != 1)
  2818. {
  2819. break;
  2820. }
  2821. else
  2822. {
  2823. unsigned char Drive = RootsPacket.GetByte();
  2824. unsigned char MaybeType = RootsPacket.GetByte();
  2825. FTerminal->LogEvent(FORMAT(L" %s: (type %d)", (static_cast<char>(Drive), (int)MaybeType)));
  2826. FFixedPaths->Add(FORMAT(L"%s:", (static_cast<char>(Drive))));
  2827. }
  2828. }
  2829. }
  2830. catch(Exception & E)
  2831. {
  2832. FFixedPaths->Clear();
  2833. FTerminal->LogEvent(FORMAT(L"Failed to decode %s extension",
  2834. (SFTP_EXT_FSROOTS)));
  2835. FTerminal->HandleException(&E);
  2836. }
  2837. }
  2838. else if (ExtensionName == SFTP_EXT_VERSIONS)
  2839. {
  2840. // first try legacy decoding according to incorrect encoding
  2841. // (structure-like) as of VShell (bug no longer present as of 4.0.3).
  2842. TSFTPPacket VersionsPacket(ExtensionData);
  2843. unsigned int StringSize;
  2844. if (VersionsPacket.CanGetString(StringSize) &&
  2845. (StringSize == VersionsPacket.RemainingLength))
  2846. {
  2847. UnicodeString Versions = VersionsPacket.GetAnsiString();
  2848. FTerminal->LogEvent(FORMAT(L"SFTP versions supported by the server (VShell format): %s",
  2849. (Versions)));
  2850. }
  2851. else
  2852. {
  2853. // if that fails, fallback to proper decoding
  2854. FTerminal->LogEvent(FORMAT(L"SFTP versions supported by the server: %s",
  2855. (AnsiToString(ExtensionData))));
  2856. }
  2857. }
  2858. else if (ExtensionName == SFTP_EXT_STATVFS)
  2859. {
  2860. UnicodeString StatVfsVersion = AnsiToString(ExtensionData);
  2861. if (StatVfsVersion == SFTP_EXT_STATVFS_VALUE_V2)
  2862. {
  2863. FSupportsStatVfsV2 = true;
  2864. FTerminal->LogEvent(FORMAT(L"Supports %s extension version %s", (ExtensionName, ExtensionDisplayData)));
  2865. }
  2866. else
  2867. {
  2868. FTerminal->LogEvent(FORMAT(L"Unsupported %s extension version %s", (ExtensionName, ExtensionDisplayData)));
  2869. }
  2870. }
  2871. else if (ExtensionName == SFTP_EXT_HARDLINK)
  2872. {
  2873. UnicodeString HardlinkVersion = AnsiToString(ExtensionData);
  2874. if (HardlinkVersion == SFTP_EXT_HARDLINK_VALUE_V1)
  2875. {
  2876. FSupportsHardlink = true;
  2877. FTerminal->LogEvent(FORMAT(L"Supports %s extension version %s", (ExtensionName, ExtensionDisplayData)));
  2878. }
  2879. else
  2880. {
  2881. FTerminal->LogEvent(FORMAT(L"Unsupported %s extension version %s", (ExtensionName, ExtensionDisplayData)));
  2882. }
  2883. }
  2884. else
  2885. {
  2886. FTerminal->LogEvent(FORMAT(L"Unknown server extension %s=%s",
  2887. (ExtensionName, ExtensionDisplayData)));
  2888. }
  2889. FExtensions->Values[ExtensionName] = ExtensionDisplayData;
  2890. }
  2891. if (SupportsExtension(SFTP_EXT_VENDOR_ID))
  2892. {
  2893. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  2894. Packet.AddString(SFTP_EXT_VENDOR_ID);
  2895. Packet.AddString(FTerminal->Configuration->CompanyName);
  2896. Packet.AddString(FTerminal->Configuration->ProductName);
  2897. Packet.AddString(FTerminal->Configuration->ProductVersion);
  2898. Packet.AddInt64(LOWORD(FTerminal->Configuration->FixedApplicationInfo->dwFileVersionLS));
  2899. SendPacket(&Packet);
  2900. // we are not interested in the response, do not wait for it
  2901. ReceiveResponse(&Packet, &Packet);
  2902. //ReserveResponse(&Packet, NULL);
  2903. }
  2904. }
  2905. if (FVersion < 4)
  2906. {
  2907. // currently enable the bug for all servers (really known on OpenSSH)
  2908. FSignedTS = (FTerminal->SessionData->SFTPBug[sbSignedTS] == asOn) ||
  2909. (FTerminal->SessionData->SFTPBug[sbSignedTS] == asAuto);
  2910. if (FSignedTS)
  2911. {
  2912. FTerminal->LogEvent(L"We believe the server has signed timestamps bug");
  2913. }
  2914. }
  2915. else
  2916. {
  2917. FSignedTS = false;
  2918. }
  2919. switch (FTerminal->SessionData->NotUtf)
  2920. {
  2921. case asOff:
  2922. FUtfStrings = asOn;
  2923. FTerminal->LogEvent(L"We will use UTF-8 strings as configured");
  2924. break;
  2925. default:
  2926. DebugFail();
  2927. case asAuto:
  2928. // Nb, Foxit server does not exist anymore
  2929. if (GetSessionInfo().SshImplementation.Pos(L"Foxit-WAC-Server") == 1)
  2930. {
  2931. FUtfStrings = asOff;
  2932. FTerminal->LogEvent(L"We will not use UTF-8 strings as the server is known not to use them");
  2933. }
  2934. else
  2935. {
  2936. if (FVersion >= 4)
  2937. {
  2938. FTerminal->LogEvent(L"We will use UTF-8 strings as it is mandatory with SFTP version 4 and newer");
  2939. FUtfStrings = asOn;
  2940. }
  2941. else
  2942. {
  2943. FTerminal->LogEvent(L"We will use UTF-8 strings until server sends an invalid UTF-8 string as with SFTP version 3 and older UTF-8 strings are not mandatory");
  2944. FUtfStrings = asAuto;
  2945. FUtfDisablingAnnounced = false;
  2946. }
  2947. }
  2948. break;
  2949. case asOn:
  2950. FTerminal->LogEvent(L"We will not use UTF-8 strings as configured");
  2951. FUtfStrings = asOff;
  2952. break;
  2953. }
  2954. FMaxPacketSize = FTerminal->SessionData->SFTPMaxPacketSize;
  2955. if (FMaxPacketSize == 0)
  2956. {
  2957. if ((FSecureShell->SshImplementation == sshiOpenSSH) && (FVersion == 3) && !FSupport->Loaded)
  2958. {
  2959. FMaxPacketSize = 4 + (256 * 1024); // len + 256kB payload
  2960. FTerminal->LogEvent(FORMAT(L"Limiting packet size to OpenSSH sftp-server limit of %d bytes",
  2961. (int(FMaxPacketSize))));
  2962. }
  2963. // full string is "1.77 sshlib: Momentum SSH Server",
  2964. // possibly it is sshlib-related
  2965. else if (GetSessionInfo().SshImplementation.Pos(L"Momentum SSH Server") != 0)
  2966. {
  2967. FMaxPacketSize = 4 + (32 * 1024);
  2968. FTerminal->LogEvent(FORMAT(L"Limiting packet size to Momentum sftp-server limit of %d bytes",
  2969. (int(FMaxPacketSize))));
  2970. }
  2971. }
  2972. }
  2973. //---------------------------------------------------------------------------
  2974. char * __fastcall TSFTPFileSystem::GetEOL() const
  2975. {
  2976. if (FVersion >= 4)
  2977. {
  2978. DebugAssert(!FEOL.IsEmpty());
  2979. return FEOL.c_str();
  2980. }
  2981. else
  2982. {
  2983. return EOLToStr(FTerminal->SessionData->EOLType);
  2984. }
  2985. }
  2986. //---------------------------------------------------------------------------
  2987. void __fastcall TSFTPFileSystem::LookupUsersGroups()
  2988. {
  2989. DebugAssert(SupportsExtension(SFTP_EXT_OWNER_GROUP));
  2990. TSFTPPacket PacketOwners(SSH_FXP_EXTENDED);
  2991. TSFTPPacket PacketGroups(SSH_FXP_EXTENDED);
  2992. TSFTPPacket * Packets[] = { &PacketOwners, &PacketGroups };
  2993. TRemoteTokenList * Lists[] = { &FTerminal->FUsers, &FTerminal->FGroups };
  2994. wchar_t ListTypes[] = { OGQ_LIST_OWNERS, OGQ_LIST_GROUPS };
  2995. for (size_t Index = 0; Index < LENOF(Packets); Index++)
  2996. {
  2997. TSFTPPacket * Packet = Packets[Index];
  2998. Packet->AddString(SFTP_EXT_OWNER_GROUP);
  2999. Packet->AddByte(ListTypes[Index]);
  3000. SendPacket(Packet);
  3001. ReserveResponse(Packet, Packet);
  3002. }
  3003. for (size_t Index = 0; Index < LENOF(Packets); Index++)
  3004. {
  3005. TSFTPPacket * Packet = Packets[Index];
  3006. ReceiveResponse(Packet, Packet, SSH_FXP_EXTENDED_REPLY, asOpUnsupported);
  3007. if ((Packet->Type != SSH_FXP_EXTENDED_REPLY) ||
  3008. (Packet->GetAnsiString() != SFTP_EXT_OWNER_GROUP_REPLY))
  3009. {
  3010. FTerminal->LogEvent(FORMAT(L"Invalid response to %s", (SFTP_EXT_OWNER_GROUP)));
  3011. }
  3012. else
  3013. {
  3014. TRemoteTokenList & List = *Lists[Index];
  3015. unsigned long Count = Packet->GetCardinal();
  3016. List.Clear();
  3017. for (unsigned long Item = 0; Item < Count; Item++)
  3018. {
  3019. TRemoteToken Token(Packet->GetString(FUtfStrings));
  3020. List.Add(Token);
  3021. if (&List == &FTerminal->FGroups)
  3022. {
  3023. FTerminal->FMembership.Add(Token);
  3024. }
  3025. }
  3026. }
  3027. }
  3028. }
  3029. //---------------------------------------------------------------------------
  3030. void __fastcall TSFTPFileSystem::ReadCurrentDirectory()
  3031. {
  3032. if (!FDirectoryToChangeTo.IsEmpty())
  3033. {
  3034. FCurrentDirectory = FDirectoryToChangeTo;
  3035. FDirectoryToChangeTo = L"";
  3036. }
  3037. else if (FCurrentDirectory.IsEmpty())
  3038. {
  3039. // this happens only after startup when default remote directory is not specified
  3040. FCurrentDirectory = GetHomeDirectory();
  3041. }
  3042. }
  3043. //---------------------------------------------------------------------------
  3044. void __fastcall TSFTPFileSystem::HomeDirectory()
  3045. {
  3046. ChangeDirectory(GetHomeDirectory());
  3047. }
  3048. //---------------------------------------------------------------------------
  3049. void __fastcall TSFTPFileSystem::TryOpenDirectory(const UnicodeString Directory)
  3050. {
  3051. FTerminal->LogEvent(FORMAT(L"Trying to open directory \"%s\".", (Directory)));
  3052. TRemoteFile * File;
  3053. CustomReadFile(Directory, File, SSH_FXP_LSTAT, NULL, asOpUnsupported);
  3054. if (File == NULL)
  3055. {
  3056. // File can be NULL only when server does not support SSH_FXP_LSTAT.
  3057. // Fallback to legacy solution, which in turn does not allow entering
  3058. // traverse-only (chmod 110) directories.
  3059. // This is workaround for http://www.ftpshell.com/
  3060. TSFTPPacket Packet(SSH_FXP_OPENDIR);
  3061. Packet.AddPathString(UnixExcludeTrailingBackslash(Directory), FUtfStrings);
  3062. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  3063. RawByteString Handle = Packet.GetFileHandle();
  3064. Packet.ChangeType(SSH_FXP_CLOSE);
  3065. Packet.AddString(Handle);
  3066. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS, asAll);
  3067. }
  3068. else
  3069. {
  3070. delete File;
  3071. }
  3072. }
  3073. //---------------------------------------------------------------------------
  3074. void __fastcall TSFTPFileSystem::AnnounceFileListOperation()
  3075. {
  3076. }
  3077. //---------------------------------------------------------------------------
  3078. void __fastcall TSFTPFileSystem::ChangeDirectory(const UnicodeString Directory)
  3079. {
  3080. UnicodeString Path, Current;
  3081. Current = !FDirectoryToChangeTo.IsEmpty() ? FDirectoryToChangeTo : FCurrentDirectory;
  3082. Path = RealPath(Directory, Current);
  3083. // to verify existence of directory try to open it (SSH_FXP_REALPATH succeeds
  3084. // for invalid paths on some systems, like CygWin)
  3085. TryOpenDirectory(Path);
  3086. // if open dir did not fail, directory exists -> success.
  3087. FDirectoryToChangeTo = Path;
  3088. }
  3089. //---------------------------------------------------------------------------
  3090. void __fastcall TSFTPFileSystem::CachedChangeDirectory(const UnicodeString Directory)
  3091. {
  3092. FDirectoryToChangeTo = UnixExcludeTrailingBackslash(Directory);
  3093. }
  3094. //---------------------------------------------------------------------------
  3095. void __fastcall TSFTPFileSystem::ReadDirectory(TRemoteFileList * FileList)
  3096. {
  3097. DebugAssert(FileList && !FileList->Directory.IsEmpty());
  3098. UnicodeString Directory;
  3099. Directory = UnixExcludeTrailingBackslash(LocalCanonify(FileList->Directory));
  3100. FTerminal->LogEvent(FORMAT(L"Listing directory \"%s\".", (Directory)));
  3101. // moved before SSH_FXP_OPENDIR, so directory listing does not retain
  3102. // old data (e.g. parent directory) when reading fails
  3103. FileList->Reset();
  3104. TSFTPPacket Packet(SSH_FXP_OPENDIR);
  3105. RawByteString Handle;
  3106. try
  3107. {
  3108. Packet.AddPathString(Directory, FUtfStrings);
  3109. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  3110. Handle = Packet.GetFileHandle();
  3111. }
  3112. catch(...)
  3113. {
  3114. if (FTerminal->Active)
  3115. {
  3116. FileList->AddFile(new TRemoteParentDirectory(FTerminal));
  3117. }
  3118. throw;
  3119. }
  3120. TSFTPPacket Response;
  3121. try
  3122. {
  3123. bool isEOF = false;
  3124. int Total = 0;
  3125. bool HasParentDirectory = false;
  3126. TRemoteFile * File;
  3127. Packet.ChangeType(SSH_FXP_READDIR);
  3128. Packet.AddString(Handle);
  3129. SendPacket(&Packet);
  3130. do
  3131. {
  3132. ReceiveResponse(&Packet, &Response);
  3133. if (Response.Type == SSH_FXP_NAME)
  3134. {
  3135. TSFTPPacket ListingPacket = Response;
  3136. Packet.ChangeType(SSH_FXP_READDIR);
  3137. Packet.AddString(Handle);
  3138. SendPacket(&Packet);
  3139. ReserveResponse(&Packet, &Response);
  3140. unsigned int Count = ListingPacket.GetCardinal();
  3141. int ResolvedLinks = 0;
  3142. for (unsigned long Index = 0; !isEOF && (Index < Count); Index++)
  3143. {
  3144. File = LoadFile(&ListingPacket, NULL, L"", FileList);
  3145. if (FTerminal->Configuration->ActualLogProtocol >= 1)
  3146. {
  3147. FTerminal->LogEvent(FORMAT(L"Read file '%s' from listing", (File->FileName)));
  3148. }
  3149. if (File->LinkedFile != NULL)
  3150. {
  3151. ResolvedLinks++;
  3152. }
  3153. if (File->IsParentDirectory)
  3154. {
  3155. HasParentDirectory = true;
  3156. }
  3157. FileList->AddFile(File);
  3158. Total++;
  3159. if (Total % 10 == 0)
  3160. {
  3161. FTerminal->DoReadDirectoryProgress(Total, ResolvedLinks, isEOF);
  3162. if (isEOF)
  3163. {
  3164. FTerminal->DoReadDirectoryProgress(-2, 0, isEOF);
  3165. }
  3166. }
  3167. }
  3168. if ((FVersion >= 6) &&
  3169. // As of 7.0.9 the Cerberus SFTP server always sets the end-of-list to true.
  3170. (FSecureShell->SshImplementation != sshiCerberus) &&
  3171. ListingPacket.CanGetBool())
  3172. {
  3173. isEOF = ListingPacket.GetBool();
  3174. }
  3175. if (Count == 0)
  3176. {
  3177. FTerminal->LogEvent(L"Empty directory listing packet. Aborting directory reading.");
  3178. isEOF = true;
  3179. }
  3180. }
  3181. else if (Response.Type == SSH_FXP_STATUS)
  3182. {
  3183. isEOF = (GotStatusPacket(&Response, asEOF) == SSH_FX_EOF);
  3184. }
  3185. else
  3186. {
  3187. FTerminal->FatalError(NULL, FMTLOAD(SFTP_INVALID_TYPE, ((int)Response.Type)));
  3188. }
  3189. }
  3190. while (!isEOF);
  3191. if (Total == 0)
  3192. {
  3193. bool Failure = false;
  3194. // no point reading parent of root directory,
  3195. // moreover CompleteFTP terminates session upon attempt to do so
  3196. if (IsUnixRootPath(FileList->Directory))
  3197. {
  3198. File = NULL;
  3199. }
  3200. else
  3201. {
  3202. // Empty file list -> probably "permission denied", we
  3203. // at least get link to parent directory ("..")
  3204. try
  3205. {
  3206. FTerminal->ExceptionOnFail = true;
  3207. try
  3208. {
  3209. File = NULL;
  3210. FTerminal->ReadFile(
  3211. UnixIncludeTrailingBackslash(FileList->Directory) + PARENTDIRECTORY, File);
  3212. }
  3213. __finally
  3214. {
  3215. FTerminal->ExceptionOnFail = false;
  3216. }
  3217. }
  3218. catch(Exception &E)
  3219. {
  3220. if (E.InheritsFrom(__classid(EFatal)))
  3221. {
  3222. throw;
  3223. }
  3224. else
  3225. {
  3226. File = NULL;
  3227. Failure = true;
  3228. }
  3229. }
  3230. }
  3231. // on some systems even getting ".." fails, we create dummy ".." instead
  3232. if (File == NULL)
  3233. {
  3234. File = new TRemoteParentDirectory(FTerminal);
  3235. }
  3236. DebugAssert(File && File->IsParentDirectory);
  3237. FileList->AddFile(File);
  3238. if (Failure)
  3239. {
  3240. throw ExtException(
  3241. NULL, FMTLOAD(EMPTY_DIRECTORY, (FileList->Directory)),
  3242. HELP_EMPTY_DIRECTORY);
  3243. }
  3244. }
  3245. else
  3246. {
  3247. if (!HasParentDirectory)
  3248. {
  3249. FileList->AddFile(new TRemoteParentDirectory(FTerminal));
  3250. }
  3251. }
  3252. }
  3253. __finally
  3254. {
  3255. if (FTerminal->Active)
  3256. {
  3257. Packet.ChangeType(SSH_FXP_CLOSE);
  3258. Packet.AddString(Handle);
  3259. SendPacket(&Packet);
  3260. // we are not interested in the response, do not wait for it
  3261. ReserveResponse(&Packet, NULL);
  3262. }
  3263. }
  3264. }
  3265. //---------------------------------------------------------------------------
  3266. void __fastcall TSFTPFileSystem::ReadSymlink(TRemoteFile * SymlinkFile,
  3267. TRemoteFile *& File)
  3268. {
  3269. DebugAssert(SymlinkFile && SymlinkFile->IsSymLink);
  3270. DebugAssert(FVersion >= 3); // symlinks are supported with SFTP version 3 and later
  3271. // need to use full filename when resolving links within subdirectory
  3272. // (i.e. for download)
  3273. UnicodeString FileName = LocalCanonify(
  3274. SymlinkFile->Directory != NULL ? SymlinkFile->FullFileName : SymlinkFile->FileName);
  3275. TSFTPPacket ReadLinkPacket(SSH_FXP_READLINK);
  3276. ReadLinkPacket.AddPathString(FileName, FUtfStrings);
  3277. SendPacket(&ReadLinkPacket);
  3278. ReserveResponse(&ReadLinkPacket, &ReadLinkPacket);
  3279. // send second request before reading response to first one
  3280. // (performance benefit)
  3281. TSFTPPacket AttrsPacket(SSH_FXP_STAT);
  3282. AttrsPacket.AddPathString(FileName, FUtfStrings);
  3283. if (FVersion >= 4)
  3284. {
  3285. AttrsPacket.AddCardinal(SSH_FILEXFER_ATTR_COMMON);
  3286. }
  3287. SendPacket(&AttrsPacket);
  3288. ReserveResponse(&AttrsPacket, &AttrsPacket);
  3289. ReceiveResponse(&ReadLinkPacket, &ReadLinkPacket, SSH_FXP_NAME);
  3290. if (ReadLinkPacket.GetCardinal() != 1)
  3291. {
  3292. FTerminal->FatalError(NULL, LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
  3293. }
  3294. SymlinkFile->LinkTo = ReadLinkPacket.GetPathString(FUtfStrings);
  3295. FTerminal->LogEvent(FORMAT(L"Link resolved to \"%s\".", (SymlinkFile->LinkTo)));
  3296. ReceiveResponse(&AttrsPacket, &AttrsPacket, SSH_FXP_ATTRS);
  3297. // SymlinkFile->FileName was used instead SymlinkFile->LinkTo before, why?
  3298. File = LoadFile(&AttrsPacket, SymlinkFile,
  3299. UnixExtractFileName(SymlinkFile->LinkTo));
  3300. }
  3301. //---------------------------------------------------------------------------
  3302. void __fastcall TSFTPFileSystem::ReadFile(const UnicodeString FileName,
  3303. TRemoteFile *& File)
  3304. {
  3305. CustomReadFile(FileName, File, SSH_FXP_LSTAT);
  3306. }
  3307. //---------------------------------------------------------------------------
  3308. bool __fastcall TSFTPFileSystem::RemoteFileExists(const UnicodeString FullPath,
  3309. TRemoteFile ** File)
  3310. {
  3311. bool Result;
  3312. try
  3313. {
  3314. TRemoteFile * AFile;
  3315. CustomReadFile(FullPath, AFile, SSH_FXP_LSTAT, NULL, asNoSuchFile);
  3316. Result = (AFile != NULL);
  3317. if (Result)
  3318. {
  3319. if (File)
  3320. {
  3321. *File = AFile;
  3322. }
  3323. else
  3324. {
  3325. delete AFile;
  3326. }
  3327. }
  3328. }
  3329. catch(...)
  3330. {
  3331. if (!FTerminal->Active)
  3332. {
  3333. throw;
  3334. }
  3335. Result = false;
  3336. }
  3337. return Result;
  3338. }
  3339. //---------------------------------------------------------------------------
  3340. void __fastcall TSFTPFileSystem::SendCustomReadFile(TSFTPPacket * Packet,
  3341. TSFTPPacket * Response, unsigned long Flags)
  3342. {
  3343. if (FVersion >= 4)
  3344. {
  3345. Packet->AddCardinal(Flags);
  3346. }
  3347. SendPacket(Packet);
  3348. ReserveResponse(Packet, Response);
  3349. }
  3350. //---------------------------------------------------------------------------
  3351. void __fastcall TSFTPFileSystem::CustomReadFile(const UnicodeString FileName,
  3352. TRemoteFile *& File, unsigned char Type, TRemoteFile * ALinkedByFile,
  3353. int AllowStatus)
  3354. {
  3355. unsigned long Flags = SSH_FILEXFER_ATTR_SIZE | SSH_FILEXFER_ATTR_PERMISSIONS |
  3356. SSH_FILEXFER_ATTR_ACCESSTIME | SSH_FILEXFER_ATTR_MODIFYTIME |
  3357. SSH_FILEXFER_ATTR_OWNERGROUP;
  3358. TSFTPPacket Packet(Type);
  3359. Packet.AddPathString(LocalCanonify(FileName), FUtfStrings);
  3360. SendCustomReadFile(&Packet, &Packet, Flags);
  3361. ReceiveResponse(&Packet, &Packet, SSH_FXP_ATTRS, AllowStatus);
  3362. if (Packet.Type == SSH_FXP_ATTRS)
  3363. {
  3364. File = LoadFile(&Packet, ALinkedByFile, UnixExtractFileName(FileName));
  3365. }
  3366. else
  3367. {
  3368. DebugAssert(AllowStatus > 0);
  3369. File = NULL;
  3370. }
  3371. }
  3372. //---------------------------------------------------------------------------
  3373. void __fastcall TSFTPFileSystem::DoDeleteFile(const UnicodeString FileName, unsigned char Type)
  3374. {
  3375. TSFTPPacket Packet(Type);
  3376. UnicodeString RealFileName = LocalCanonify(FileName);
  3377. Packet.AddPathString(RealFileName, FUtfStrings);
  3378. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3379. }
  3380. //---------------------------------------------------------------------------
  3381. void __fastcall TSFTPFileSystem::DeleteFile(const UnicodeString FileName,
  3382. const TRemoteFile * File, int Params, TRmSessionAction & Action)
  3383. {
  3384. unsigned char Type;
  3385. if (File && File->IsDirectory && !File->IsSymLink)
  3386. {
  3387. if (FLAGCLEAR(Params, dfNoRecursive))
  3388. {
  3389. try
  3390. {
  3391. FTerminal->ProcessDirectory(FileName, FTerminal->DeleteFile, &Params);
  3392. }
  3393. catch(...)
  3394. {
  3395. Action.Cancel();
  3396. throw;
  3397. }
  3398. }
  3399. Type = SSH_FXP_RMDIR;
  3400. }
  3401. else
  3402. {
  3403. Type = SSH_FXP_REMOVE;
  3404. }
  3405. DoDeleteFile(FileName, Type);
  3406. }
  3407. //---------------------------------------------------------------------------
  3408. void __fastcall TSFTPFileSystem::RenameFile(const UnicodeString FileName,
  3409. const UnicodeString NewName)
  3410. {
  3411. TSFTPPacket Packet(SSH_FXP_RENAME);
  3412. UnicodeString RealName = LocalCanonify(FileName);
  3413. Packet.AddPathString(RealName, FUtfStrings);
  3414. UnicodeString TargetName;
  3415. if (UnixExtractFilePath(NewName).IsEmpty())
  3416. {
  3417. // rename case (TTerminal::RenameFile)
  3418. TargetName = UnixExtractFilePath(RealName) + NewName;
  3419. }
  3420. else
  3421. {
  3422. TargetName = LocalCanonify(NewName);
  3423. }
  3424. Packet.AddPathString(TargetName, FUtfStrings);
  3425. if (FVersion >= 5)
  3426. {
  3427. Packet.AddCardinal(0);
  3428. }
  3429. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3430. }
  3431. //---------------------------------------------------------------------------
  3432. void __fastcall TSFTPFileSystem::CopyFile(const UnicodeString FileName,
  3433. const UnicodeString NewName)
  3434. {
  3435. // Implemented by ProFTPD/mod_sftp and Bitvise WinSSHD (without announcing it)
  3436. DebugAssert(SupportsExtension(SFTP_EXT_COPY_FILE) || (FSecureShell->SshImplementation == sshiBitvise));
  3437. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3438. Packet.AddString(SFTP_EXT_COPY_FILE);
  3439. Packet.AddPathString(Canonify(FileName), FUtfStrings);
  3440. Packet.AddPathString(Canonify(NewName), FUtfStrings);
  3441. Packet.AddBool(false);
  3442. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3443. }
  3444. //---------------------------------------------------------------------------
  3445. void __fastcall TSFTPFileSystem::CreateDirectory(const UnicodeString DirName)
  3446. {
  3447. TSFTPPacket Packet(SSH_FXP_MKDIR);
  3448. UnicodeString CanonifiedName = Canonify(DirName);
  3449. Packet.AddPathString(CanonifiedName, FUtfStrings);
  3450. Packet.AddProperties(NULL, 0, true, FVersion, FUtfStrings, NULL);
  3451. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3452. }
  3453. //---------------------------------------------------------------------------
  3454. void __fastcall TSFTPFileSystem::CreateLink(const UnicodeString FileName,
  3455. const UnicodeString PointTo, bool Symbolic)
  3456. {
  3457. // Cerberus server does not even response to LINK or SYMLINK,
  3458. // Although its log says:
  3459. // Unrecognized SFTP client command: (20)
  3460. // Unknown SFTP packet - Sending Unsupported OP response
  3461. DebugAssert(FVersion >= 3); // links are supported with SFTP version 3 and later
  3462. bool UseLink = (FVersion >= 6);
  3463. bool UseHardlink = !Symbolic && !UseLink && FSupportsHardlink;
  3464. TSFTPPacket Packet(UseHardlink ? SSH_FXP_EXTENDED : (UseLink ? SSH_FXP_LINK : SSH_FXP_SYMLINK));
  3465. if (UseHardlink)
  3466. {
  3467. Packet.AddString(SFTP_EXT_HARDLINK);
  3468. }
  3469. bool Buggy;
  3470. // OpenSSH hardlink extension always uses the "wrong" order
  3471. // as it's defined as such to mimic OpenSSH symlink bug
  3472. if (UseHardlink)
  3473. {
  3474. Buggy = true; //sic
  3475. }
  3476. else
  3477. {
  3478. if (FTerminal->SessionData->SFTPBug[sbSymlink] == asOn)
  3479. {
  3480. Buggy = true;
  3481. FTerminal->LogEvent(L"Forcing workaround for SFTP link bug");
  3482. }
  3483. else if (FTerminal->SessionData->SFTPBug[sbSymlink] == asOff)
  3484. {
  3485. Buggy = false;
  3486. }
  3487. else
  3488. {
  3489. if (UseLink)
  3490. {
  3491. if (FSecureShell->SshImplementation == sshiProFTPD)
  3492. {
  3493. // ProFTPD/mod_sftp followed OpenSSH symlink bug even for link implementation.
  3494. // This will be fixed with the next release with
  3495. // SSH version string bumbed to "mod_sftp/1.0.0"
  3496. // http://bugs.proftpd.org/show_bug.cgi?id=4080
  3497. UnicodeString ProFTPDVerStr = GetSessionInfo().SshImplementation;
  3498. CutToChar(ProFTPDVerStr, L'/', false);
  3499. int ProFTPDMajorVer = StrToIntDef(CutToChar(ProFTPDVerStr, L'.', false), 0);
  3500. Buggy = (ProFTPDMajorVer == 0);
  3501. if (Buggy)
  3502. {
  3503. FTerminal->LogEvent(L"We believe the server has SFTP link bug");
  3504. }
  3505. }
  3506. else
  3507. {
  3508. Buggy = false;
  3509. }
  3510. }
  3511. else
  3512. {
  3513. // ProFTPD/mod_sftp deliberately follows OpenSSH bug.
  3514. // Though we should get here with ProFTPD only when user forced
  3515. // SFTP version < 6 or when connecting to an ancient version of ProFTPD.
  3516. Buggy =
  3517. (FSecureShell->SshImplementation == sshiOpenSSH) ||
  3518. (FSecureShell->SshImplementation == sshiProFTPD);
  3519. if (Buggy)
  3520. {
  3521. FTerminal->LogEvent(L"We believe the server has SFTP symlink bug");
  3522. }
  3523. }
  3524. }
  3525. }
  3526. UnicodeString FinalPointTo = PointTo;
  3527. UnicodeString FinalFileName = Canonify(FileName);
  3528. if (!Symbolic)
  3529. {
  3530. FinalPointTo = Canonify(PointTo);
  3531. }
  3532. if (!Buggy)
  3533. {
  3534. Packet.AddPathString(FinalFileName, FUtfStrings);
  3535. Packet.AddPathString(FinalPointTo, FUtfStrings);
  3536. }
  3537. else
  3538. {
  3539. Packet.AddPathString(FinalPointTo, FUtfStrings);
  3540. Packet.AddPathString(FinalFileName, FUtfStrings);
  3541. }
  3542. if (UseLink)
  3543. {
  3544. Packet.AddBool(Symbolic);
  3545. }
  3546. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3547. }
  3548. //---------------------------------------------------------------------------
  3549. void __fastcall TSFTPFileSystem::ChangeFileProperties(const UnicodeString FileName,
  3550. const TRemoteFile * /*File*/, const TRemoteProperties * AProperties,
  3551. TChmodSessionAction & Action)
  3552. {
  3553. DebugAssert(AProperties != NULL);
  3554. TRemoteFile * File;
  3555. UnicodeString RealFileName = LocalCanonify(FileName);
  3556. ReadFile(RealFileName, File);
  3557. try
  3558. {
  3559. DebugAssert(File);
  3560. if (File->IsDirectory && !File->IsSymLink && AProperties->Recursive)
  3561. {
  3562. try
  3563. {
  3564. FTerminal->ProcessDirectory(FileName, FTerminal->ChangeFileProperties,
  3565. (void*)AProperties);
  3566. }
  3567. catch(...)
  3568. {
  3569. Action.Cancel();
  3570. throw;
  3571. }
  3572. }
  3573. // SFTP can change owner and group at the same time only, not individually.
  3574. // Fortunately we know current owner/group, so if only one is present,
  3575. // we can supplement the other.
  3576. TRemoteProperties Properties(*AProperties);
  3577. if (Properties.Valid.Contains(vpGroup) &&
  3578. !Properties.Valid.Contains(vpOwner))
  3579. {
  3580. Properties.Owner = File->Owner;
  3581. Properties.Valid << vpOwner;
  3582. }
  3583. else if (Properties.Valid.Contains(vpOwner) &&
  3584. !Properties.Valid.Contains(vpGroup))
  3585. {
  3586. Properties.Group = File->Group;
  3587. Properties.Valid << vpGroup;
  3588. }
  3589. TSFTPPacket Packet(SSH_FXP_SETSTAT);
  3590. Packet.AddPathString(RealFileName, FUtfStrings);
  3591. Packet.AddProperties(&Properties, *File->Rights, File->IsDirectory, FVersion, FUtfStrings, &Action);
  3592. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3593. }
  3594. __finally
  3595. {
  3596. delete File;
  3597. }
  3598. }
  3599. //---------------------------------------------------------------------------
  3600. bool __fastcall TSFTPFileSystem::LoadFilesProperties(TStrings * FileList)
  3601. {
  3602. bool Result = false;
  3603. // without knowledge of server's capabilities, this all make no sense
  3604. if (FSupport->Loaded || (FSecureShell->SshImplementation == sshiBitvise))
  3605. {
  3606. TFileOperationProgressType Progress(&FTerminal->DoProgress, &FTerminal->DoFinished);
  3607. Progress.Start(foGetProperties, osRemote, FileList->Count);
  3608. FTerminal->FOperationProgress = &Progress;
  3609. static int LoadFilesPropertiesQueueLen = 5;
  3610. TSFTPLoadFilesPropertiesQueue Queue(this);
  3611. try
  3612. {
  3613. if (Queue.Init(LoadFilesPropertiesQueueLen, FileList))
  3614. {
  3615. TRemoteFile * File;
  3616. TSFTPPacket Packet;
  3617. bool Next;
  3618. do
  3619. {
  3620. Next = Queue.ReceivePacket(&Packet, File);
  3621. DebugAssert((Packet.Type == SSH_FXP_ATTRS) || (Packet.Type == SSH_FXP_STATUS));
  3622. if (Packet.Type == SSH_FXP_ATTRS)
  3623. {
  3624. DebugAssert(File != NULL);
  3625. Progress.SetFile(File->FileName);
  3626. LoadFile(File, &Packet);
  3627. Result = true;
  3628. TOnceDoneOperation OnceDoneOperation;
  3629. Progress.Finish(File->FileName, true, OnceDoneOperation);
  3630. }
  3631. if (Progress.Cancel != csContinue)
  3632. {
  3633. Next = false;
  3634. }
  3635. }
  3636. while (Next);
  3637. }
  3638. }
  3639. __finally
  3640. {
  3641. Queue.DisposeSafe();
  3642. FTerminal->FOperationProgress = NULL;
  3643. Progress.Stop();
  3644. }
  3645. // queue is discarded here
  3646. }
  3647. return Result;
  3648. }
  3649. //---------------------------------------------------------------------------
  3650. void __fastcall TSFTPFileSystem::DoCalculateFilesChecksum(
  3651. const UnicodeString & Alg, const UnicodeString & SftpAlg,
  3652. TStrings * FileList, TStrings * Checksums,
  3653. TCalculatedChecksumEvent OnCalculatedChecksum,
  3654. TFileOperationProgressType * OperationProgress, bool FirstLevel)
  3655. {
  3656. TOnceDoneOperation OnceDoneOperation; // not used
  3657. // recurse into subdirectories only if we have callback function
  3658. if (OnCalculatedChecksum != NULL)
  3659. {
  3660. for (int Index = 0; Index < FileList->Count; Index++)
  3661. {
  3662. TRemoteFile * File = (TRemoteFile *)FileList->Objects[Index];
  3663. DebugAssert(File != NULL);
  3664. if (File->IsDirectory && !File->IsSymLink &&
  3665. !File->IsParentDirectory && !File->IsThisDirectory)
  3666. {
  3667. OperationProgress->SetFile(File->FileName);
  3668. TRemoteFileList * SubFiles =
  3669. FTerminal->CustomReadDirectoryListing(File->FullFileName, false);
  3670. if (SubFiles != NULL)
  3671. {
  3672. TStrings * SubFileList = new TStringList();
  3673. bool Success = false;
  3674. try
  3675. {
  3676. OperationProgress->SetFile(File->FileName);
  3677. for (int Index = 0; Index < SubFiles->Count; Index++)
  3678. {
  3679. TRemoteFile * SubFile = SubFiles->Files[Index];
  3680. SubFileList->AddObject(SubFile->FullFileName, SubFile);
  3681. }
  3682. // do not collect checksums for files in subdirectories,
  3683. // only send back checksums via callback
  3684. DoCalculateFilesChecksum(Alg, SftpAlg, SubFileList, NULL,
  3685. OnCalculatedChecksum, OperationProgress, false);
  3686. Success = true;
  3687. }
  3688. __finally
  3689. {
  3690. delete SubFiles;
  3691. delete SubFileList;
  3692. if (FirstLevel)
  3693. {
  3694. OperationProgress->Finish(File->FileName, Success, OnceDoneOperation);
  3695. }
  3696. }
  3697. }
  3698. }
  3699. }
  3700. }
  3701. static int CalculateFilesChecksumQueueLen = 5;
  3702. TSFTPCalculateFilesChecksumQueue Queue(this);
  3703. try
  3704. {
  3705. if (Queue.Init(CalculateFilesChecksumQueueLen, SftpAlg, FileList))
  3706. {
  3707. TSFTPPacket Packet;
  3708. bool Next;
  3709. do
  3710. {
  3711. bool Success = false;
  3712. UnicodeString Checksum;
  3713. TRemoteFile * File = NULL;
  3714. try
  3715. {
  3716. TChecksumSessionAction Action(FTerminal->ActionLog);
  3717. try
  3718. {
  3719. Next = Queue.ReceivePacket(&Packet, File);
  3720. DebugAssert(Packet.Type == SSH_FXP_EXTENDED_REPLY);
  3721. OperationProgress->SetFile(File->FileName);
  3722. Action.FileName(FTerminal->AbsolutePath(File->FullFileName, true));
  3723. // skip alg
  3724. Packet.GetAnsiString();
  3725. Checksum = BytesToHex(reinterpret_cast<const unsigned char*>(Packet.GetNextData(Packet.RemainingLength)), Packet.RemainingLength, false);
  3726. if (OnCalculatedChecksum != NULL)
  3727. {
  3728. OnCalculatedChecksum(File->FileName, Alg, Checksum);
  3729. }
  3730. Action.Checksum(Alg, Checksum);
  3731. Success = true;
  3732. }
  3733. catch (Exception & E)
  3734. {
  3735. FTerminal->RollbackAction(Action, OperationProgress, &E);
  3736. // Error formatting expanded from inline to avoid strange exceptions
  3737. UnicodeString Error =
  3738. FMTLOAD(CHECKSUM_ERROR,
  3739. (File != NULL ? File->FullFileName : UnicodeString(L"")));
  3740. FTerminal->CommandError(&E, Error);
  3741. // TODO: retries? resume?
  3742. Next = false;
  3743. }
  3744. if (Checksums != NULL)
  3745. {
  3746. Checksums->Add(Checksum);
  3747. }
  3748. }
  3749. __finally
  3750. {
  3751. if (FirstLevel)
  3752. {
  3753. OperationProgress->Finish(File->FileName, Success, OnceDoneOperation);
  3754. }
  3755. }
  3756. if (OperationProgress->Cancel != csContinue)
  3757. {
  3758. Next = false;
  3759. }
  3760. }
  3761. while (Next);
  3762. }
  3763. }
  3764. __finally
  3765. {
  3766. Queue.DisposeSafe();
  3767. }
  3768. // queue is discarded here
  3769. }
  3770. //---------------------------------------------------------------------------
  3771. void __fastcall TSFTPFileSystem::CalculateFilesChecksum(const UnicodeString & Alg,
  3772. TStrings * FileList, TStrings * Checksums,
  3773. TCalculatedChecksumEvent OnCalculatedChecksum)
  3774. {
  3775. TFileOperationProgressType Progress(&FTerminal->DoProgress, &FTerminal->DoFinished);
  3776. Progress.Start(foCalculateChecksum, osRemote, FileList->Count);
  3777. UnicodeString NormalizedAlg = FindIdent(Alg, FChecksumAlgs.get());
  3778. UnicodeString SftpAlg;
  3779. int Index = FChecksumAlgs->IndexOf(NormalizedAlg);
  3780. if (Index >= 0)
  3781. {
  3782. SftpAlg = FChecksumSftpAlgs->Strings[Index];
  3783. }
  3784. else
  3785. {
  3786. // try user-specified alg
  3787. SftpAlg = NormalizedAlg;
  3788. }
  3789. FTerminal->FOperationProgress = &Progress;
  3790. try
  3791. {
  3792. DoCalculateFilesChecksum(NormalizedAlg, SftpAlg, FileList, Checksums, OnCalculatedChecksum,
  3793. &Progress, true);
  3794. }
  3795. __finally
  3796. {
  3797. FTerminal->FOperationProgress = NULL;
  3798. Progress.Stop();
  3799. }
  3800. }
  3801. //---------------------------------------------------------------------------
  3802. void __fastcall TSFTPFileSystem::CustomCommandOnFile(const UnicodeString /*FileName*/,
  3803. const TRemoteFile * /*File*/, UnicodeString /*Command*/, int /*Params*/,
  3804. TCaptureOutputEvent /*OutputEvent*/)
  3805. {
  3806. DebugFail();
  3807. }
  3808. //---------------------------------------------------------------------------
  3809. void __fastcall TSFTPFileSystem::AnyCommand(const UnicodeString /*Command*/,
  3810. TCaptureOutputEvent /*OutputEvent*/)
  3811. {
  3812. DebugFail();
  3813. }
  3814. //---------------------------------------------------------------------------
  3815. TStrings * __fastcall TSFTPFileSystem::GetFixedPaths()
  3816. {
  3817. return FFixedPaths;
  3818. }
  3819. //---------------------------------------------------------------------------
  3820. void __fastcall TSFTPFileSystem::SpaceAvailable(const UnicodeString Path,
  3821. TSpaceAvailable & ASpaceAvailable)
  3822. {
  3823. if (SupportsExtension(SFTP_EXT_SPACE_AVAILABLE) ||
  3824. // See comment in IsCapable
  3825. (FSecureShell->SshImplementation == sshiBitvise))
  3826. {
  3827. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3828. Packet.AddString(SFTP_EXT_SPACE_AVAILABLE);
  3829. Packet.AddPathString(LocalCanonify(Path), FUtfStrings);
  3830. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_EXTENDED_REPLY);
  3831. ASpaceAvailable.BytesOnDevice = Packet.GetInt64();
  3832. ASpaceAvailable.UnusedBytesOnDevice = Packet.GetInt64();
  3833. ASpaceAvailable.BytesAvailableToUser = Packet.GetInt64();
  3834. ASpaceAvailable.UnusedBytesAvailableToUser = Packet.GetInt64();
  3835. // bytes-per-allocation-unit was added later to the protocol
  3836. // (revision 07, while the extension was defined already in rev 06),
  3837. // be tolerant
  3838. if (Packet.CanGetCardinal())
  3839. {
  3840. ASpaceAvailable.BytesPerAllocationUnit = Packet.GetCardinal();
  3841. }
  3842. else if (Packet.CanGetSmallCardinal())
  3843. {
  3844. // See http://bugs.proftpd.org/show_bug.cgi?id=4079
  3845. FTerminal->LogEvent(L"Assuming ProFTPD/mod_sftp bug of 2-byte bytes-per-allocation-unit field");
  3846. ASpaceAvailable.BytesPerAllocationUnit = Packet.GetSmallCardinal();
  3847. }
  3848. else
  3849. {
  3850. FTerminal->LogEvent(L"Missing bytes-per-allocation-unit field");
  3851. }
  3852. }
  3853. else if (DebugAlwaysTrue(FSupportsStatVfsV2))
  3854. {
  3855. // http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=HEAD;content-type=text/plain
  3856. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3857. Packet.AddString(SFTP_EXT_STATVFS);
  3858. Packet.AddPathString(LocalCanonify(Path), FUtfStrings);
  3859. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_EXTENDED_REPLY);
  3860. __int64 BlockSize = Packet.GetInt64(); // file system block size
  3861. __int64 FundamentalBlockSize = Packet.GetInt64(); // fundamental fs block size
  3862. __int64 Blocks = Packet.GetInt64(); // number of blocks (unit f_frsize)
  3863. __int64 FreeBlocks = Packet.GetInt64(); // free blocks in file system
  3864. __int64 AvailableBlocks = Packet.GetInt64(); // free blocks for non-root
  3865. __int64 FileINodes = Packet.GetInt64(); // total file inodes
  3866. __int64 FreeFileINodes = Packet.GetInt64(); // free file inodes
  3867. __int64 AvailableFileINodes = Packet.GetInt64(); // free file inodes for to non-root
  3868. __int64 SID = Packet.GetInt64(); // file system id
  3869. __int64 Flags = Packet.GetInt64(); // bit mask of f_flag values
  3870. __int64 NameMax = Packet.GetInt64(); // maximum filename length
  3871. FTerminal->LogEvent(FORMAT(L"Block size: %s", (IntToStr(BlockSize))));
  3872. FTerminal->LogEvent(FORMAT(L"Fundamental block size: %s", (IntToStr(FundamentalBlockSize))));
  3873. FTerminal->LogEvent(FORMAT(L"Total blocks: %s", (IntToStr(Blocks))));
  3874. FTerminal->LogEvent(FORMAT(L"Free blocks: %s", (IntToStr(FreeBlocks))));
  3875. FTerminal->LogEvent(FORMAT(L"Free blocks for non-root: %s", (IntToStr(AvailableBlocks))));
  3876. FTerminal->LogEvent(FORMAT(L"Total file inodes: %s", (IntToStr(FileINodes))));
  3877. FTerminal->LogEvent(FORMAT(L"Free file inodes: %s", (IntToStr(FreeFileINodes))));
  3878. FTerminal->LogEvent(FORMAT(L"Free file inodes for non-root: %s", (IntToStr(AvailableFileINodes))));
  3879. FTerminal->LogEvent(FORMAT(L"File system ID: %s", (BytesToHex(reinterpret_cast<const unsigned char *>(&SID), sizeof(SID)))));
  3880. UnicodeString FlagStr;
  3881. if (FLAGSET(Flags, SFTP_EXT_STATVFS_ST_RDONLY))
  3882. {
  3883. AddToList(FlagStr, L"read-only", L",");
  3884. Flags -= SFTP_EXT_STATVFS_ST_RDONLY;
  3885. }
  3886. if (FLAGSET(Flags, SFTP_EXT_STATVFS_ST_NOSUID))
  3887. {
  3888. AddToList(FlagStr, L"no-setuid", L",");
  3889. Flags -= SFTP_EXT_STATVFS_ST_NOSUID;
  3890. }
  3891. if (Flags != 0)
  3892. {
  3893. AddToList(FlagStr, UnicodeString(L"0x") + IntToHex(Flags, 2), L",");
  3894. }
  3895. if (FlagStr.IsEmpty())
  3896. {
  3897. FlagStr = L"none";
  3898. }
  3899. FTerminal->LogEvent(FORMAT(L"Flags: %s", (FlagStr)));
  3900. FTerminal->LogEvent(FORMAT(L"Max name length: %s", (IntToStr(NameMax))));
  3901. ASpaceAvailable.BytesOnDevice = BlockSize * Blocks;
  3902. ASpaceAvailable.UnusedBytesOnDevice = BlockSize * FreeBlocks;
  3903. ASpaceAvailable.BytesAvailableToUser = 0;
  3904. ASpaceAvailable.UnusedBytesAvailableToUser = BlockSize * AvailableBlocks;
  3905. ASpaceAvailable.BytesPerAllocationUnit =
  3906. (BlockSize > std::numeric_limits<unsigned long>::max()) ? 0 : static_cast<unsigned long>(BlockSize);
  3907. }
  3908. }
  3909. //---------------------------------------------------------------------------
  3910. // transfer protocol
  3911. //---------------------------------------------------------------------------
  3912. void __fastcall TSFTPFileSystem::CopyToRemote(TStrings * FilesToCopy,
  3913. const UnicodeString TargetDir, const TCopyParamType * CopyParam,
  3914. int Params, TFileOperationProgressType * OperationProgress,
  3915. TOnceDoneOperation & OnceDoneOperation)
  3916. {
  3917. DebugAssert(FilesToCopy && OperationProgress);
  3918. UnicodeString FileName, FileNameOnly;
  3919. UnicodeString FullTargetDir = UnixIncludeTrailingBackslash(TargetDir);
  3920. int Index = 0;
  3921. while (Index < FilesToCopy->Count && !OperationProgress->Cancel)
  3922. {
  3923. bool Success = false;
  3924. FileName = FilesToCopy->Strings[Index];
  3925. FileNameOnly = ExtractFileName(FileName);
  3926. DebugAssert(!FAvoidBusy);
  3927. FAvoidBusy = true;
  3928. try
  3929. {
  3930. try
  3931. {
  3932. if (FTerminal->SessionData->CacheDirectories)
  3933. {
  3934. FTerminal->DirectoryModified(TargetDir, false);
  3935. if (DirectoryExists(ApiPath(FileName)))
  3936. {
  3937. FTerminal->DirectoryModified(UnixIncludeTrailingBackslash(TargetDir)+
  3938. FileNameOnly, true);
  3939. }
  3940. }
  3941. SFTPSourceRobust(FileName, FullTargetDir, CopyParam, Params, OperationProgress,
  3942. tfFirstLevel);
  3943. Success = true;
  3944. }
  3945. catch(EScpSkipFile & E)
  3946. {
  3947. TSuspendFileOperationProgress Suspend(OperationProgress);
  3948. if (!FTerminal->HandleException(&E))
  3949. {
  3950. throw;
  3951. }
  3952. }
  3953. }
  3954. __finally
  3955. {
  3956. FAvoidBusy = false;
  3957. OperationProgress->Finish(FileName, Success, OnceDoneOperation);
  3958. }
  3959. Index++;
  3960. }
  3961. }
  3962. //---------------------------------------------------------------------------
  3963. void __fastcall TSFTPFileSystem::SFTPConfirmOverwrite(
  3964. const UnicodeString & SourceFullFileName, UnicodeString & TargetFileName,
  3965. const TCopyParamType * CopyParam, int Params, TFileOperationProgressType * OperationProgress,
  3966. TSFTPOverwriteMode & OverwriteMode, const TOverwriteFileParams * FileParams)
  3967. {
  3968. bool CanAppend = (FVersion < 4) || !OperationProgress->AsciiTransfer;
  3969. unsigned int Answer;
  3970. {
  3971. TSuspendFileOperationProgress Suspend(OperationProgress);
  3972. int Answers = qaYes | qaNo | qaCancel | qaYesToAll | qaNoToAll | qaAll | qaIgnore;
  3973. // possibly we can allow alternate resume at least in some cases
  3974. if (CanAppend)
  3975. {
  3976. Answers |= qaRetry;
  3977. }
  3978. TQueryButtonAlias Aliases[5];
  3979. Aliases[0].Button = qaRetry;
  3980. Aliases[0].Alias = LoadStr(APPEND_BUTTON);
  3981. Aliases[0].GroupWith = qaNo;
  3982. Aliases[0].GrouppedShiftState = TShiftState() << ssAlt;
  3983. Aliases[1].Button = qaAll;
  3984. Aliases[1].Alias = LoadStr(YES_TO_NEWER_BUTTON);
  3985. Aliases[1].GroupWith = qaYes;
  3986. Aliases[1].GrouppedShiftState = TShiftState() << ssCtrl;
  3987. Aliases[2].Button = qaIgnore;
  3988. Aliases[2].Alias = LoadStr(RENAME_BUTTON);
  3989. Aliases[2].GroupWith = qaNo;
  3990. Aliases[2].GrouppedShiftState = TShiftState() << ssCtrl;
  3991. Aliases[3].Button = qaYesToAll;
  3992. Aliases[3].GroupWith = qaYes;
  3993. Aliases[3].GrouppedShiftState = TShiftState() << ssShift;
  3994. Aliases[4].Button = qaNoToAll;
  3995. Aliases[4].GroupWith = qaNo;
  3996. Aliases[4].GrouppedShiftState = TShiftState() << ssShift;
  3997. TQueryParams QueryParams(qpNeverAskAgainCheck);
  3998. QueryParams.NoBatchAnswers = qaIgnore | qaRetry | qaAll;
  3999. QueryParams.Aliases = Aliases;
  4000. QueryParams.AliasesCount = LENOF(Aliases);
  4001. Answer = FTerminal->ConfirmFileOverwrite(
  4002. SourceFullFileName, TargetFileName, FileParams,
  4003. Answers, &QueryParams,
  4004. OperationProgress->Side == osLocal ? osRemote : osLocal,
  4005. CopyParam, Params, OperationProgress);
  4006. }
  4007. if (CanAppend &&
  4008. ((Answer == qaRetry) || (Answer == qaSkip)))
  4009. {
  4010. // duplicated in TTerminal::ConfirmFileOverwrite
  4011. bool CanAlternateResume =
  4012. (FileParams->DestSize < FileParams->SourceSize) && !OperationProgress->AsciiTransfer;
  4013. TBatchOverwrite BatchOverwrite =
  4014. FTerminal->EffectiveBatchOverwrite(SourceFullFileName, CopyParam, Params, OperationProgress, true);
  4015. // when mode is forced by batch, never query user
  4016. if (BatchOverwrite == boAppend)
  4017. {
  4018. OverwriteMode = omAppend;
  4019. }
  4020. else if (CanAlternateResume &&
  4021. ((BatchOverwrite == boResume) || (BatchOverwrite == boAlternateResume)))
  4022. {
  4023. OverwriteMode = omResume;
  4024. }
  4025. // no other option, but append
  4026. else if (!CanAlternateResume)
  4027. {
  4028. OverwriteMode = omAppend;
  4029. }
  4030. else
  4031. {
  4032. TQueryParams Params(0, HELP_APPEND_OR_RESUME);
  4033. {
  4034. TSuspendFileOperationProgress Suspend(OperationProgress);
  4035. Answer = FTerminal->QueryUser(FORMAT(LoadStr(APPEND_OR_RESUME2), (SourceFullFileName)),
  4036. NULL, qaYes | qaNo | qaNoToAll | qaCancel, &Params);
  4037. }
  4038. switch (Answer)
  4039. {
  4040. case qaYes:
  4041. OverwriteMode = omAppend;
  4042. break;
  4043. case qaNo:
  4044. OverwriteMode = omResume;
  4045. break;
  4046. case qaNoToAll:
  4047. OverwriteMode = omResume;
  4048. OperationProgress->BatchOverwrite = boAlternateResume;
  4049. break;
  4050. default: DebugFail(); //fallthru
  4051. case qaCancel:
  4052. if (!OperationProgress->Cancel)
  4053. {
  4054. OperationProgress->Cancel = csCancel;
  4055. }
  4056. Abort();
  4057. break;
  4058. }
  4059. }
  4060. }
  4061. else if (Answer == qaIgnore)
  4062. {
  4063. if (FTerminal->PromptUser(FTerminal->SessionData, pkFileName, LoadStr(RENAME_TITLE), L"",
  4064. LoadStr(RENAME_PROMPT2), true, 0, TargetFileName))
  4065. {
  4066. OverwriteMode = omOverwrite;
  4067. }
  4068. else
  4069. {
  4070. if (!OperationProgress->Cancel)
  4071. {
  4072. OperationProgress->Cancel = csCancel;
  4073. }
  4074. Abort();
  4075. }
  4076. }
  4077. else
  4078. {
  4079. OverwriteMode = omOverwrite;
  4080. switch (Answer)
  4081. {
  4082. case qaCancel:
  4083. if (!OperationProgress->Cancel)
  4084. {
  4085. OperationProgress->Cancel = csCancel;
  4086. }
  4087. Abort();
  4088. break;
  4089. case qaNo:
  4090. THROW_SKIP_FILE_NULL;
  4091. }
  4092. }
  4093. }
  4094. //---------------------------------------------------------------------------
  4095. bool TSFTPFileSystem::SFTPConfirmResume(const UnicodeString DestFileName,
  4096. bool PartialBiggerThanSource, TFileOperationProgressType * OperationProgress)
  4097. {
  4098. bool ResumeTransfer;
  4099. DebugAssert(OperationProgress);
  4100. if (PartialBiggerThanSource)
  4101. {
  4102. unsigned int Answer;
  4103. {
  4104. TSuspendFileOperationProgress Suspend(OperationProgress);
  4105. TQueryParams Params(qpAllowContinueOnError, HELP_PARTIAL_BIGGER_THAN_SOURCE);
  4106. Answer = FTerminal->QueryUser(
  4107. FMTLOAD(PARTIAL_BIGGER_THAN_SOURCE, (DestFileName)), NULL,
  4108. qaOK | qaAbort, &Params, qtWarning);
  4109. }
  4110. if (Answer == qaAbort)
  4111. {
  4112. if (!OperationProgress->Cancel)
  4113. {
  4114. OperationProgress->Cancel = csCancel;
  4115. }
  4116. Abort();
  4117. }
  4118. ResumeTransfer = false;
  4119. }
  4120. else if (FTerminal->Configuration->ConfirmResume)
  4121. {
  4122. unsigned int Answer;
  4123. {
  4124. TSuspendFileOperationProgress Suspend(OperationProgress);
  4125. TQueryParams Params(qpAllowContinueOnError | qpNeverAskAgainCheck,
  4126. HELP_RESUME_TRANSFER);
  4127. // "abort" replaced with "cancel" to unify with "append/resume" query
  4128. Answer = FTerminal->QueryUser(
  4129. FMTLOAD(RESUME_TRANSFER2, (DestFileName)), NULL, qaYes | qaNo | qaCancel,
  4130. &Params);
  4131. }
  4132. switch (Answer) {
  4133. case qaNeverAskAgain:
  4134. FTerminal->Configuration->ConfirmResume = false;
  4135. case qaYes:
  4136. ResumeTransfer = true;
  4137. break;
  4138. case qaNo:
  4139. ResumeTransfer = false;
  4140. break;
  4141. case qaCancel:
  4142. if (!OperationProgress->Cancel)
  4143. {
  4144. OperationProgress->Cancel = csCancel;
  4145. }
  4146. Abort();
  4147. break;
  4148. }
  4149. }
  4150. else
  4151. {
  4152. ResumeTransfer = true;
  4153. }
  4154. return ResumeTransfer;
  4155. }
  4156. //---------------------------------------------------------------------------
  4157. void __fastcall TSFTPFileSystem::SFTPSourceRobust(const UnicodeString FileName,
  4158. const UnicodeString TargetDir, const TCopyParamType * CopyParam, int Params,
  4159. TFileOperationProgressType * OperationProgress, unsigned int Flags)
  4160. {
  4161. // the same in TFTPFileSystem
  4162. TUploadSessionAction Action(FTerminal->ActionLog);
  4163. TRobustOperationLoop RobustLoop(FTerminal, OperationProgress);
  4164. do
  4165. {
  4166. bool ChildError = false;
  4167. try
  4168. {
  4169. SFTPSource(FileName, TargetDir, CopyParam, Params, OperationProgress,
  4170. Flags, Action, ChildError);
  4171. }
  4172. catch(Exception & E)
  4173. {
  4174. if (!RobustLoop.TryReopen(E))
  4175. {
  4176. if (!ChildError)
  4177. {
  4178. FTerminal->RollbackAction(Action, OperationProgress, &E);
  4179. }
  4180. throw;
  4181. }
  4182. }
  4183. if (RobustLoop.ShouldRetry())
  4184. {
  4185. OperationProgress->RollbackTransfer();
  4186. Action.Restart();
  4187. // prevent overwrite and resume confirmations
  4188. // (should not be set for directories!)
  4189. Params |= cpNoConfirmation;
  4190. // enable resume even if we are uploading into new directory
  4191. Flags &= ~tfNewDirectory;
  4192. }
  4193. }
  4194. while (RobustLoop.Retry());
  4195. }
  4196. //---------------------------------------------------------------------------
  4197. void __fastcall TSFTPFileSystem::SFTPSource(const UnicodeString FileName,
  4198. const UnicodeString TargetDir, const TCopyParamType * CopyParam, int Params,
  4199. TFileOperationProgressType * OperationProgress, unsigned int Flags,
  4200. TUploadSessionAction & Action, bool & ChildError)
  4201. {
  4202. Action.FileName(ExpandUNCFileName(FileName));
  4203. OperationProgress->SetFile(FileName, false);
  4204. if (!FTerminal->AllowLocalFileTransfer(FileName, CopyParam, OperationProgress))
  4205. {
  4206. THROW_SKIP_FILE_NULL;
  4207. }
  4208. TOpenRemoteFileParams OpenParams;
  4209. OpenParams.OverwriteMode = omOverwrite;
  4210. HANDLE File;
  4211. __int64 MTime, ATime;
  4212. __int64 Size;
  4213. FTerminal->OpenLocalFile(FileName, GENERIC_READ, &OpenParams.LocalFileAttrs,
  4214. &File, NULL, &MTime, &ATime, &Size);
  4215. bool Dir = FLAGSET(OpenParams.LocalFileAttrs, faDirectory);
  4216. try
  4217. {
  4218. OperationProgress->SetFileInProgress();
  4219. if (Dir)
  4220. {
  4221. Action.Cancel();
  4222. SFTPDirectorySource(IncludeTrailingBackslash(FileName), TargetDir,
  4223. OpenParams.LocalFileAttrs, CopyParam, Params, OperationProgress, Flags);
  4224. }
  4225. else
  4226. {
  4227. // File is regular file (not directory)
  4228. DebugAssert(File);
  4229. UnicodeString DestFileName =
  4230. FTerminal->ChangeFileName(
  4231. CopyParam, ExtractFileName(FileName), osLocal,
  4232. FLAGSET(Flags, tfFirstLevel));
  4233. UnicodeString DestFullName = LocalCanonify(TargetDir + DestFileName);
  4234. UnicodeString DestPartialFullName;
  4235. bool ResumeAllowed;
  4236. bool ResumeTransfer = false;
  4237. bool DestFileExists = false;
  4238. TRights DestRights;
  4239. __int64 ResumeOffset;
  4240. FTerminal->LogEvent(FORMAT(L"Copying \"%s\" to remote directory started.", (FileName)));
  4241. OperationProgress->SetLocalSize(Size);
  4242. // Suppose same data size to transfer as to read
  4243. // (not true with ASCII transfer)
  4244. OperationProgress->SetTransferSize(OperationProgress->LocalSize);
  4245. OperationProgress->TransferingFile = false;
  4246. TDateTime Modification = UnixToDateTime(MTime, FTerminal->SessionData->DSTMode);
  4247. // Will we use ASCII of BINARY file transfer?
  4248. TFileMasks::TParams MaskParams;
  4249. MaskParams.Size = Size;
  4250. MaskParams.Modification = Modification;
  4251. UnicodeString BaseFileName = FTerminal->GetBaseFileName(FileName);
  4252. OperationProgress->SetAsciiTransfer(
  4253. CopyParam->UseAsciiTransfer(BaseFileName, osLocal, MaskParams));
  4254. FTerminal->LogEvent(
  4255. UnicodeString((OperationProgress->AsciiTransfer ? L"Ascii" : L"Binary")) +
  4256. L" transfer mode selected.");
  4257. // should we check for interrupted transfer?
  4258. ResumeAllowed = !OperationProgress->AsciiTransfer &&
  4259. CopyParam->AllowResume(OperationProgress->LocalSize) &&
  4260. IsCapable(fcRename);
  4261. TOverwriteFileParams FileParams;
  4262. FileParams.SourceSize = OperationProgress->LocalSize;
  4263. FileParams.SourceTimestamp = Modification;
  4264. if (ResumeAllowed)
  4265. {
  4266. DestPartialFullName = DestFullName + FTerminal->Configuration->PartialExt;
  4267. if (FLAGCLEAR(Flags, tfNewDirectory))
  4268. {
  4269. FTerminal->LogEvent(L"Checking existence of file.");
  4270. TRemoteFile * File = NULL;
  4271. DestFileExists = RemoteFileExists(DestFullName, &File);
  4272. OperationProgress->Progress();
  4273. if (DestFileExists)
  4274. {
  4275. OpenParams.DestFileSize = File->Size;
  4276. FileParams.DestSize = OpenParams.DestFileSize;
  4277. FileParams.DestTimestamp = File->Modification;
  4278. DestRights = *File->Rights;
  4279. // - If destination file is symlink, never do resumable transfer,
  4280. // as it would delete the symlink.
  4281. // - Also bit of heuristics to detect symlink on SFTP-3 and older
  4282. // (which does not indicate symlink in SSH_FXP_ATTRS).
  4283. // if file has all permissions and is small, then it is likely symlink.
  4284. // also it is not likely that such a small file (if it is not symlink)
  4285. // gets overwritten by large file (that would trigger resumable transfer).
  4286. // - Also never do resumable transfer for file owned by other user
  4287. // as deleting and recreating the file would change ownership.
  4288. // This won't for work for SFTP-3 (OpenSSH) as it does not provide
  4289. // owner name (only UID) and we know only logged in user name (not UID)
  4290. if (File->IsSymLink ||
  4291. ((FVersion < 4) &&
  4292. ((*File->Rights & TRights::rfAll) == TRights::rfAll) &&
  4293. (File->Size < 100)) ||
  4294. (!File->Owner.Name.IsEmpty() && !SameUserName(File->Owner.Name, FTerminal->UserName)))
  4295. {
  4296. ResumeAllowed = false;
  4297. }
  4298. delete File;
  4299. File = NULL;
  4300. }
  4301. if (ResumeAllowed)
  4302. {
  4303. FTerminal->LogEvent(L"Checking existence of partially transfered file.");
  4304. if (RemoteFileExists(DestPartialFullName, &File))
  4305. {
  4306. ResumeOffset = File->Size;
  4307. delete File;
  4308. File = NULL;
  4309. bool PartialBiggerThanSource = (ResumeOffset > OperationProgress->LocalSize);
  4310. if (FLAGCLEAR(Params, cpNoConfirmation) &&
  4311. FLAGCLEAR(Params, cpResume) &&
  4312. !CopyParam->ResumeTransfer(FileName))
  4313. {
  4314. ResumeTransfer = SFTPConfirmResume(DestFileName,
  4315. PartialBiggerThanSource, OperationProgress);
  4316. }
  4317. else
  4318. {
  4319. ResumeTransfer = !PartialBiggerThanSource;
  4320. }
  4321. if (!ResumeTransfer)
  4322. {
  4323. DoDeleteFile(DestPartialFullName, SSH_FXP_REMOVE);
  4324. OperationProgress->Progress();
  4325. }
  4326. else
  4327. {
  4328. FTerminal->LogEvent(L"Resuming file transfer.");
  4329. }
  4330. }
  4331. else
  4332. {
  4333. // partial upload file does not exists, check for full file
  4334. if (DestFileExists)
  4335. {
  4336. UnicodeString PrevDestFileName = DestFileName;
  4337. SFTPConfirmOverwrite(FileName, DestFileName,
  4338. CopyParam, Params, OperationProgress, OpenParams.OverwriteMode, &FileParams);
  4339. if (PrevDestFileName != DestFileName)
  4340. {
  4341. // update paths in case user changes the file name
  4342. DestFullName = LocalCanonify(TargetDir + DestFileName);
  4343. DestPartialFullName = DestFullName + FTerminal->Configuration->PartialExt;
  4344. FTerminal->LogEvent(L"Checking existence of new file.");
  4345. DestFileExists = RemoteFileExists(DestFullName, NULL);
  4346. }
  4347. }
  4348. }
  4349. }
  4350. }
  4351. }
  4352. // will the transfer be resumable?
  4353. bool DoResume = (ResumeAllowed && (OpenParams.OverwriteMode == omOverwrite));
  4354. UnicodeString RemoteFileName = DoResume ? DestPartialFullName : DestFullName;
  4355. OpenParams.FileName = FileName;
  4356. OpenParams.RemoteFileName = RemoteFileName;
  4357. OpenParams.Resume = DoResume;
  4358. OpenParams.Resuming = ResumeTransfer;
  4359. OpenParams.OperationProgress = OperationProgress;
  4360. OpenParams.CopyParam = CopyParam;
  4361. OpenParams.Params = Params;
  4362. OpenParams.FileParams = &FileParams;
  4363. OpenParams.Confirmed = false;
  4364. FTerminal->LogEvent(L"Opening remote file.");
  4365. FTerminal->FileOperationLoop(SFTPOpenRemote, OperationProgress, true,
  4366. FMTLOAD(SFTP_CREATE_FILE_ERROR, (OpenParams.RemoteFileName)),
  4367. &OpenParams);
  4368. OperationProgress->Progress();
  4369. if (OpenParams.RemoteFileName != RemoteFileName)
  4370. {
  4371. DebugAssert(!DoResume);
  4372. DebugAssert(UnixExtractFilePath(OpenParams.RemoteFileName) == UnixExtractFilePath(RemoteFileName));
  4373. DestFullName = OpenParams.RemoteFileName;
  4374. UnicodeString NewFileName = UnixExtractFileName(DestFullName);
  4375. DebugAssert(DestFileName != NewFileName);
  4376. DestFileName = NewFileName;
  4377. }
  4378. Action.Destination(DestFullName);
  4379. bool TransferFinished = false;
  4380. __int64 DestWriteOffset = 0;
  4381. TSFTPPacket CloseRequest;
  4382. bool SetRights = ((DoResume && DestFileExists) || CopyParam->PreserveRights);
  4383. bool SetProperties = (CopyParam->PreserveTime || SetRights);
  4384. TSFTPPacket PropertiesRequest(SSH_FXP_SETSTAT);
  4385. TSFTPPacket PropertiesResponse;
  4386. TRights Rights;
  4387. if (SetProperties)
  4388. {
  4389. PropertiesRequest.AddPathString(DestFullName, FUtfStrings);
  4390. if (CopyParam->PreserveRights)
  4391. {
  4392. Rights = CopyParam->RemoteFileRights(OpenParams.LocalFileAttrs);
  4393. }
  4394. else if (DoResume && DestFileExists)
  4395. {
  4396. Rights = DestRights;
  4397. }
  4398. else
  4399. {
  4400. DebugAssert(!SetRights);
  4401. }
  4402. unsigned short RightsNumber = Rights.NumberSet;
  4403. PropertiesRequest.AddProperties(
  4404. SetRights ? &RightsNumber : NULL, NULL, NULL,
  4405. CopyParam->PreserveTime ? &MTime : NULL,
  4406. CopyParam->PreserveTime ? &ATime : NULL,
  4407. NULL, false, FVersion, FUtfStrings);
  4408. }
  4409. try
  4410. {
  4411. if (OpenParams.OverwriteMode == omAppend)
  4412. {
  4413. FTerminal->LogEvent(L"Appending file.");
  4414. DestWriteOffset = OpenParams.DestFileSize;
  4415. }
  4416. else if (ResumeTransfer || (OpenParams.OverwriteMode == omResume))
  4417. {
  4418. if (OpenParams.OverwriteMode == omResume)
  4419. {
  4420. FTerminal->LogEvent(L"Resuming file transfer (append style).");
  4421. ResumeOffset = OpenParams.DestFileSize;
  4422. }
  4423. FileSeek((THandle)File, ResumeOffset, 0);
  4424. OperationProgress->AddResumed(ResumeOffset);
  4425. }
  4426. TSFTPUploadQueue Queue(this);
  4427. try
  4428. {
  4429. int ConvertParams =
  4430. FLAGMASK(CopyParam->RemoveCtrlZ, cpRemoveCtrlZ) |
  4431. FLAGMASK(CopyParam->RemoveBOM, cpRemoveBOM);
  4432. Queue.Init(FileName, File, OperationProgress,
  4433. OpenParams.RemoteFileHandle,
  4434. DestWriteOffset + OperationProgress->TransferedSize,
  4435. ConvertParams);
  4436. while (Queue.Continue())
  4437. {
  4438. if (OperationProgress->Cancel)
  4439. {
  4440. Abort();
  4441. }
  4442. }
  4443. // send close request before waiting for pending read responses
  4444. SFTPCloseRemote(OpenParams.RemoteFileHandle, DestFileName,
  4445. OperationProgress, false, true, &CloseRequest);
  4446. OpenParams.RemoteFileHandle = L"";
  4447. // when resuming is disabled, we can send "set properties"
  4448. // request before waiting for pending read/close responses
  4449. if (SetProperties && !DoResume)
  4450. {
  4451. SendPacket(&PropertiesRequest);
  4452. ReserveResponse(&PropertiesRequest, &PropertiesResponse);
  4453. }
  4454. }
  4455. __finally
  4456. {
  4457. Queue.DisposeSafe();
  4458. }
  4459. TransferFinished = true;
  4460. // queue is discarded here
  4461. }
  4462. __finally
  4463. {
  4464. if (FTerminal->Active)
  4465. {
  4466. // if file transfer was finished, the close request was already sent
  4467. if (!OpenParams.RemoteFileHandle.IsEmpty())
  4468. {
  4469. SFTPCloseRemote(OpenParams.RemoteFileHandle, DestFileName,
  4470. OperationProgress, TransferFinished, true, &CloseRequest);
  4471. }
  4472. // wait for the response
  4473. SFTPCloseRemote(OpenParams.RemoteFileHandle, DestFileName,
  4474. OperationProgress, TransferFinished, false, &CloseRequest);
  4475. // delete file if transfer was not completed, resuming was not allowed and
  4476. // we were not appending (incl. alternate resume),
  4477. // shortly after plain transfer completes (eq. !ResumeAllowed)
  4478. if (!TransferFinished && !DoResume && (OpenParams.OverwriteMode == omOverwrite))
  4479. {
  4480. DoDeleteFile(OpenParams.RemoteFileName, SSH_FXP_REMOVE);
  4481. }
  4482. }
  4483. }
  4484. OperationProgress->Progress();
  4485. if (DoResume)
  4486. {
  4487. if (DestFileExists)
  4488. {
  4489. FILE_OPERATION_LOOP_BEGIN
  4490. {
  4491. if (FTerminal->SessionData->OverwrittenToRecycleBin &&
  4492. !FTerminal->SessionData->RecycleBinPath.IsEmpty())
  4493. {
  4494. FTerminal->RecycleFile(DestFullName, NULL);
  4495. }
  4496. else
  4497. {
  4498. DoDeleteFile(DestFullName, SSH_FXP_REMOVE);
  4499. }
  4500. }
  4501. FILE_OPERATION_LOOP_END(
  4502. FMTLOAD(DELETE_ON_RESUME_ERROR,
  4503. (UnixExtractFileName(DestFullName), DestFullName)));
  4504. }
  4505. // originally this was before CLOSE (last __finally statement),
  4506. // on VShell it failed
  4507. FILE_OPERATION_LOOP_BEGIN
  4508. {
  4509. RenameFile(OpenParams.RemoteFileName, DestFileName);
  4510. }
  4511. FILE_OPERATION_LOOP_END_CUSTOM(
  4512. FMTLOAD(RENAME_AFTER_RESUME_ERROR,
  4513. (UnixExtractFileName(OpenParams.RemoteFileName), DestFileName)),
  4514. true, HELP_RENAME_AFTER_RESUME_ERROR);
  4515. }
  4516. if (SetProperties)
  4517. {
  4518. std::unique_ptr<TTouchSessionAction> TouchAction;
  4519. if (CopyParam->PreserveTime)
  4520. {
  4521. TDateTime MDateTime = UnixToDateTime(MTime, FTerminal->SessionData->DSTMode);
  4522. FTerminal->LogEvent(FORMAT(L"Preserving timestamp [%s]",
  4523. (StandardTimestamp(MDateTime))));
  4524. TouchAction.reset(new TTouchSessionAction(FTerminal->ActionLog, DestFullName,
  4525. MDateTime));
  4526. }
  4527. std::unique_ptr<TChmodSessionAction> ChmodAction;
  4528. // do record chmod only if it was explicitly requested,
  4529. // not when it was implicitly performed to apply timestamp
  4530. // of overwritten file to new file
  4531. if (CopyParam->PreserveRights)
  4532. {
  4533. ChmodAction.reset(new TChmodSessionAction(FTerminal->ActionLog, DestFullName, Rights));
  4534. }
  4535. try
  4536. {
  4537. // when resuming is enabled, the set properties request was not sent yet
  4538. if (DoResume)
  4539. {
  4540. SendPacket(&PropertiesRequest);
  4541. }
  4542. bool Resend = false;
  4543. FILE_OPERATION_LOOP_BEGIN
  4544. {
  4545. try
  4546. {
  4547. TSFTPPacket DummyResponse;
  4548. TSFTPPacket * Response = &PropertiesResponse;
  4549. if (Resend)
  4550. {
  4551. PropertiesRequest.Reuse();
  4552. SendPacket(&PropertiesRequest);
  4553. // ReceiveResponse currently cannot receive twice into same packet,
  4554. // so DummyResponse is temporary workaround
  4555. Response = &DummyResponse;
  4556. }
  4557. Resend = true;
  4558. ReceiveResponse(&PropertiesRequest, Response, SSH_FXP_STATUS,
  4559. asOK | FLAGMASK(CopyParam->IgnorePermErrors, asPermDenied));
  4560. }
  4561. catch (...)
  4562. {
  4563. if (FTerminal->Active &&
  4564. (!CopyParam->PreserveRights && !CopyParam->PreserveTime))
  4565. {
  4566. DebugAssert(DoResume);
  4567. FTerminal->LogEvent(L"Ignoring error preserving permissions of overwritten file");
  4568. }
  4569. else
  4570. {
  4571. throw;
  4572. }
  4573. }
  4574. }
  4575. FILE_OPERATION_LOOP_END_CUSTOM(
  4576. FMTLOAD(PRESERVE_TIME_PERM_ERROR3, (DestFileName)),
  4577. true, HELP_PRESERVE_TIME_PERM_ERROR);
  4578. }
  4579. catch(Exception & E)
  4580. {
  4581. if (TouchAction.get() != NULL)
  4582. {
  4583. TouchAction->Rollback(&E);
  4584. }
  4585. if (ChmodAction.get() != NULL)
  4586. {
  4587. ChmodAction->Rollback(&E);
  4588. }
  4589. ChildError = true;
  4590. throw;
  4591. }
  4592. }
  4593. FTerminal->LogFileDone(OperationProgress);
  4594. }
  4595. }
  4596. __finally
  4597. {
  4598. if (File != NULL)
  4599. {
  4600. CloseHandle(File);
  4601. }
  4602. }
  4603. /* TODO : Delete also read-only files. */
  4604. if (FLAGSET(Params, cpDelete))
  4605. {
  4606. if (!Dir)
  4607. {
  4608. FILE_OPERATION_LOOP_BEGIN
  4609. {
  4610. THROWOSIFFALSE(Sysutils::DeleteFile(ApiPath(FileName)));
  4611. }
  4612. FILE_OPERATION_LOOP_END(FMTLOAD(DELETE_LOCAL_FILE_ERROR, (FileName)));
  4613. }
  4614. }
  4615. else if (CopyParam->ClearArchive && FLAGSET(OpenParams.LocalFileAttrs, faArchive))
  4616. {
  4617. FILE_OPERATION_LOOP_BEGIN
  4618. {
  4619. THROWOSIFFALSE(FileSetAttr(ApiPath(FileName), OpenParams.LocalFileAttrs & ~faArchive) == 0);
  4620. }
  4621. FILE_OPERATION_LOOP_END(FMTLOAD(CANT_SET_ATTRS, (FileName)));
  4622. }
  4623. }
  4624. //---------------------------------------------------------------------------
  4625. RawByteString __fastcall TSFTPFileSystem::SFTPOpenRemoteFile(
  4626. const UnicodeString & FileName, unsigned int OpenType, __int64 Size)
  4627. {
  4628. TSFTPPacket Packet(SSH_FXP_OPEN);
  4629. Packet.AddPathString(FileName, FUtfStrings);
  4630. if (FVersion < 5)
  4631. {
  4632. Packet.AddCardinal(OpenType);
  4633. }
  4634. else
  4635. {
  4636. unsigned long Access =
  4637. FLAGMASK(FLAGSET(OpenType, SSH_FXF_READ), ACE4_READ_DATA) |
  4638. FLAGMASK(FLAGSET(OpenType, SSH_FXF_WRITE), ACE4_WRITE_DATA | ACE4_APPEND_DATA);
  4639. unsigned long Flags;
  4640. if (FLAGSET(OpenType, SSH_FXF_CREAT | SSH_FXF_EXCL))
  4641. {
  4642. Flags = SSH_FXF_CREATE_NEW;
  4643. }
  4644. else if (FLAGSET(OpenType, SSH_FXF_CREAT | SSH_FXF_TRUNC))
  4645. {
  4646. Flags = SSH_FXF_CREATE_TRUNCATE;
  4647. }
  4648. else if (FLAGSET(OpenType, SSH_FXF_CREAT))
  4649. {
  4650. Flags = SSH_FXF_OPEN_OR_CREATE;
  4651. }
  4652. else
  4653. {
  4654. Flags = SSH_FXF_OPEN_EXISTING;
  4655. }
  4656. Flags |=
  4657. FLAGMASK(FLAGSET(OpenType, SSH_FXF_APPEND), SSH_FXF_ACCESS_APPEND_DATA) |
  4658. FLAGMASK(FLAGSET(OpenType, SSH_FXF_TEXT), SSH_FXF_ACCESS_TEXT_MODE);
  4659. Packet.AddCardinal(Access);
  4660. Packet.AddCardinal(Flags);
  4661. }
  4662. bool SendSize =
  4663. (Size >= 0) &&
  4664. FLAGSET(OpenType, SSH_FXF_CREAT | SSH_FXF_TRUNC) &&
  4665. // Particuarly VanDyke VShell (4.0.3) does not support SSH_FILEXFER_ATTR_ALLOCATION_SIZE
  4666. // (it fails open request when the attribute is included).
  4667. // It's SFTP-6 attribute, so support structure should be available.
  4668. // It's actually not with VShell. But VShell supports the SSH_FILEXFER_ATTR_ALLOCATION_SIZE.
  4669. // All servers should support SSH_FILEXFER_ATTR_SIZE (SFTP < 6)
  4670. (!FSupport->Loaded || FLAGSET(FSupport->AttributeMask, Packet.AllocationSizeAttribute(FVersion)));
  4671. Packet.AddProperties(NULL, NULL, NULL, NULL, NULL,
  4672. SendSize ? &Size : NULL, false, FVersion, FUtfStrings);
  4673. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  4674. return Packet.GetFileHandle();
  4675. }
  4676. //---------------------------------------------------------------------------
  4677. int __fastcall TSFTPFileSystem::SFTPOpenRemote(void * AOpenParams, void * /*Param2*/)
  4678. {
  4679. TOpenRemoteFileParams * OpenParams = (TOpenRemoteFileParams *)AOpenParams;
  4680. DebugAssert(OpenParams);
  4681. TFileOperationProgressType * OperationProgress = OpenParams->OperationProgress;
  4682. int OpenType;
  4683. bool Success = false;
  4684. bool ConfirmOverwriting;
  4685. do
  4686. {
  4687. try
  4688. {
  4689. ConfirmOverwriting =
  4690. !OpenParams->Confirmed && !OpenParams->Resume &&
  4691. FTerminal->CheckRemoteFile(OpenParams->FileName, OpenParams->CopyParam, OpenParams->Params, OperationProgress);
  4692. OpenType = SSH_FXF_WRITE | SSH_FXF_CREAT;
  4693. // when we want to preserve overwritten files, we need to find out that
  4694. // they exist first... even if overwrite confirmation is disabled.
  4695. // but not when we already know we are not going to overwrite (but e.g. to append)
  4696. if ((ConfirmOverwriting || FTerminal->SessionData->OverwrittenToRecycleBin) &&
  4697. (OpenParams->OverwriteMode == omOverwrite))
  4698. {
  4699. OpenType |= SSH_FXF_EXCL;
  4700. }
  4701. if (!OpenParams->Resuming && (OpenParams->OverwriteMode == omOverwrite))
  4702. {
  4703. OpenType |= SSH_FXF_TRUNC;
  4704. }
  4705. if ((FVersion >= 4) && OpenParams->OperationProgress->AsciiTransfer)
  4706. {
  4707. OpenType |= SSH_FXF_TEXT;
  4708. }
  4709. OpenParams->RemoteFileHandle = SFTPOpenRemoteFile(
  4710. OpenParams->RemoteFileName, OpenType, OperationProgress->LocalSize);
  4711. Success = true;
  4712. }
  4713. catch(Exception & E)
  4714. {
  4715. if (!OpenParams->Confirmed && (OpenType & SSH_FXF_EXCL) && FTerminal->Active)
  4716. {
  4717. FTerminal->LogEvent(FORMAT(L"Cannot create new file \"%s\", checking if it exists already", (OpenParams->RemoteFileName)));
  4718. bool ThrowOriginal = false;
  4719. // When exclusive opening of file fails, try to detect if file exists.
  4720. // When file does not exist, failure was probably caused by 'permission denied'
  4721. // or similar error. In this case throw original exception.
  4722. try
  4723. {
  4724. OperationProgress->Progress();
  4725. TRemoteFile * File;
  4726. UnicodeString RealFileName = LocalCanonify(OpenParams->RemoteFileName);
  4727. ReadFile(RealFileName, File);
  4728. DebugAssert(File);
  4729. OpenParams->DestFileSize = File->Size;
  4730. if (OpenParams->FileParams != NULL)
  4731. {
  4732. OpenParams->FileParams->DestTimestamp = File->Modification;
  4733. OpenParams->FileParams->DestSize = OpenParams->DestFileSize;
  4734. }
  4735. // file exists (otherwise exception was thrown)
  4736. SAFE_DESTROY(File);
  4737. }
  4738. catch(...)
  4739. {
  4740. if (!FTerminal->Active)
  4741. {
  4742. throw;
  4743. }
  4744. else
  4745. {
  4746. ThrowOriginal = true;
  4747. }
  4748. }
  4749. if (ThrowOriginal)
  4750. {
  4751. throw;
  4752. }
  4753. // we may get here even if confirmation is disabled,
  4754. // when we have preserving of overwritten files enabled
  4755. if (ConfirmOverwriting)
  4756. {
  4757. OperationProgress->Progress();
  4758. // confirmation duplicated in SFTPSource for resumable file transfers.
  4759. UnicodeString RemoteFileNameOnly = UnixExtractFileName(OpenParams->RemoteFileName);
  4760. SFTPConfirmOverwrite(OpenParams->FileName, RemoteFileNameOnly,
  4761. OpenParams->CopyParam, OpenParams->Params, OperationProgress, OpenParams->OverwriteMode, OpenParams->FileParams);
  4762. if (RemoteFileNameOnly != UnixExtractFileName(OpenParams->RemoteFileName))
  4763. {
  4764. OpenParams->RemoteFileName =
  4765. UnixExtractFilePath(OpenParams->RemoteFileName) + RemoteFileNameOnly;
  4766. }
  4767. OpenParams->Confirmed = true;
  4768. }
  4769. else
  4770. {
  4771. DebugAssert(FTerminal->SessionData->OverwrittenToRecycleBin);
  4772. }
  4773. if ((OpenParams->OverwriteMode == omOverwrite) &&
  4774. FTerminal->SessionData->OverwrittenToRecycleBin &&
  4775. !FTerminal->SessionData->RecycleBinPath.IsEmpty())
  4776. {
  4777. OperationProgress->Progress();
  4778. FTerminal->RecycleFile(OpenParams->RemoteFileName, NULL);
  4779. }
  4780. }
  4781. else if (FTerminal->Active)
  4782. {
  4783. // if file overwriting was confirmed, it means that the file already exists,
  4784. // if not, check now
  4785. if (!OpenParams->Confirmed)
  4786. {
  4787. bool ThrowOriginal = false;
  4788. // When file does not exist, failure was probably caused by 'permission denied'
  4789. // or similar error. In this case throw original exception.
  4790. try
  4791. {
  4792. TRemoteFile * File;
  4793. UnicodeString RealFileName = LocalCanonify(OpenParams->RemoteFileName);
  4794. ReadFile(RealFileName, File);
  4795. SAFE_DESTROY(File);
  4796. }
  4797. catch(...)
  4798. {
  4799. if (!FTerminal->Active)
  4800. {
  4801. throw;
  4802. }
  4803. else
  4804. {
  4805. ThrowOriginal = true;
  4806. }
  4807. }
  4808. if (ThrowOriginal)
  4809. {
  4810. throw;
  4811. }
  4812. }
  4813. // now we know that the file exists
  4814. if (FTerminal->FileOperationLoopQuery(E, OperationProgress,
  4815. FMTLOAD(SFTP_OVERWRITE_FILE_ERROR2, (OpenParams->RemoteFileName)),
  4816. true, LoadStr(SFTP_OVERWRITE_DELETE_BUTTON)))
  4817. {
  4818. OperationProgress->Progress();
  4819. int Params = dfNoRecursive;
  4820. FTerminal->DeleteFile(OpenParams->RemoteFileName, NULL, &Params);
  4821. }
  4822. }
  4823. else
  4824. {
  4825. throw;
  4826. }
  4827. }
  4828. }
  4829. while (!Success);
  4830. return 0;
  4831. }
  4832. //---------------------------------------------------------------------------
  4833. void __fastcall TSFTPFileSystem::SFTPCloseRemote(const RawByteString Handle,
  4834. const UnicodeString FileName, TFileOperationProgressType * OperationProgress,
  4835. bool TransferFinished, bool Request, TSFTPPacket * Packet)
  4836. {
  4837. // Moving this out of SFTPSource() fixed external exception 0xC0000029 error
  4838. FILE_OPERATION_LOOP_BEGIN
  4839. {
  4840. try
  4841. {
  4842. TSFTPPacket CloseRequest;
  4843. TSFTPPacket * P = (Packet == NULL ? &CloseRequest : Packet);
  4844. if (Request)
  4845. {
  4846. P->ChangeType(SSH_FXP_CLOSE);
  4847. P->AddString(Handle);
  4848. SendPacket(P);
  4849. ReserveResponse(P, Packet);
  4850. }
  4851. else
  4852. {
  4853. DebugAssert(Packet != NULL);
  4854. ReceiveResponse(P, Packet, SSH_FXP_STATUS);
  4855. }
  4856. }
  4857. catch(...)
  4858. {
  4859. if (!FTerminal->Active || TransferFinished)
  4860. {
  4861. throw;
  4862. }
  4863. }
  4864. }
  4865. FILE_OPERATION_LOOP_END(FMTLOAD(SFTP_CLOSE_FILE_ERROR, (FileName)));
  4866. }
  4867. //---------------------------------------------------------------------------
  4868. void __fastcall TSFTPFileSystem::SFTPDirectorySource(const UnicodeString DirectoryName,
  4869. const UnicodeString TargetDir, int Attrs, const TCopyParamType * CopyParam,
  4870. int Params, TFileOperationProgressType * OperationProgress, unsigned int Flags)
  4871. {
  4872. UnicodeString DestDirectoryName =
  4873. FTerminal->ChangeFileName(
  4874. CopyParam, ExtractFileName(ExcludeTrailingBackslash(DirectoryName)),
  4875. osLocal, FLAGSET(Flags, tfFirstLevel));
  4876. UnicodeString DestFullName = UnixIncludeTrailingBackslash(TargetDir + DestDirectoryName);
  4877. OperationProgress->SetFile(DirectoryName);
  4878. bool CreateDir = false;
  4879. try
  4880. {
  4881. TryOpenDirectory(DestFullName);
  4882. }
  4883. catch(...)
  4884. {
  4885. if (FTerminal->Active)
  4886. {
  4887. // opening directory failed, it probably does not exists, try to
  4888. // create it
  4889. CreateDir = true;
  4890. }
  4891. else
  4892. {
  4893. throw;
  4894. }
  4895. }
  4896. if (CreateDir)
  4897. {
  4898. TRemoteProperties Properties;
  4899. if (CopyParam->PreserveRights)
  4900. {
  4901. Properties.Valid = TValidProperties() << vpRights;
  4902. Properties.Rights = CopyParam->RemoteFileRights(Attrs);
  4903. }
  4904. FTerminal->CreateDirectory(DestFullName, &Properties);
  4905. Flags |= tfNewDirectory;
  4906. }
  4907. int FindAttrs = faReadOnly | faHidden | faSysFile | faDirectory | faArchive;
  4908. TSearchRecChecked SearchRec;
  4909. bool FindOK;
  4910. FILE_OPERATION_LOOP_BEGIN
  4911. {
  4912. FindOK =
  4913. (FindFirstChecked(DirectoryName + L"*.*", FindAttrs, SearchRec) == 0);
  4914. }
  4915. FILE_OPERATION_LOOP_END(FMTLOAD(LIST_DIR_ERROR, (DirectoryName)));
  4916. try
  4917. {
  4918. while (FindOK && !OperationProgress->Cancel)
  4919. {
  4920. UnicodeString FileName = DirectoryName + SearchRec.Name;
  4921. try
  4922. {
  4923. if ((SearchRec.Name != L".") && (SearchRec.Name != L".."))
  4924. {
  4925. SFTPSourceRobust(FileName, DestFullName, CopyParam, Params, OperationProgress,
  4926. Flags & ~tfFirstLevel);
  4927. }
  4928. }
  4929. catch (EScpSkipFile &E)
  4930. {
  4931. // If ESkipFile occurs, just log it and continue with next file
  4932. TSuspendFileOperationProgress Suspend(OperationProgress);
  4933. // here a message to user was displayed, which was not appropriate
  4934. // when user refused to overwrite the file in subdirectory.
  4935. // hopefully it won't be missing in other situations.
  4936. if (!FTerminal->HandleException(&E))
  4937. {
  4938. throw;
  4939. }
  4940. }
  4941. FILE_OPERATION_LOOP_BEGIN
  4942. {
  4943. FindOK = (FindNextChecked(SearchRec) == 0);
  4944. }
  4945. FILE_OPERATION_LOOP_END(FMTLOAD(LIST_DIR_ERROR, (DirectoryName)));
  4946. };
  4947. }
  4948. __finally
  4949. {
  4950. FindClose(SearchRec);
  4951. }
  4952. /* TODO : Delete also read-only directories. */
  4953. /* TODO : Show error message on failure. */
  4954. if (!OperationProgress->Cancel)
  4955. {
  4956. if (CopyParam->PreserveTime && CopyParam->PreserveTimeDirs)
  4957. {
  4958. TRemoteProperties Properties;
  4959. Properties.Valid << vpModification;
  4960. FTerminal->OpenLocalFile(
  4961. ExcludeTrailingBackslash(DirectoryName), GENERIC_READ, NULL, NULL, NULL,
  4962. &Properties.Modification, &Properties.LastAccess, NULL);
  4963. FTerminal->ChangeFileProperties(DestFullName, NULL, &Properties);
  4964. }
  4965. if (FLAGSET(Params, cpDelete))
  4966. {
  4967. RemoveDir(ApiPath(DirectoryName));
  4968. }
  4969. else if (CopyParam->ClearArchive && FLAGSET(Attrs, faArchive))
  4970. {
  4971. FILE_OPERATION_LOOP_BEGIN
  4972. {
  4973. THROWOSIFFALSE(FileSetAttr(ApiPath(DirectoryName), Attrs & ~faArchive) == 0);
  4974. }
  4975. FILE_OPERATION_LOOP_END(FMTLOAD(CANT_SET_ATTRS, (DirectoryName)));
  4976. }
  4977. }
  4978. }
  4979. //---------------------------------------------------------------------------
  4980. void __fastcall TSFTPFileSystem::CopyToLocal(TStrings * FilesToCopy,
  4981. const UnicodeString TargetDir, const TCopyParamType * CopyParam,
  4982. int Params, TFileOperationProgressType * OperationProgress,
  4983. TOnceDoneOperation & OnceDoneOperation)
  4984. {
  4985. DebugAssert(FilesToCopy && OperationProgress);
  4986. UnicodeString FileName;
  4987. UnicodeString FullTargetDir = IncludeTrailingBackslash(TargetDir);
  4988. const TRemoteFile * File;
  4989. bool Success;
  4990. int Index = 0;
  4991. while (Index < FilesToCopy->Count && !OperationProgress->Cancel)
  4992. {
  4993. Success = false;
  4994. FileName = FilesToCopy->Strings[Index];
  4995. File = (TRemoteFile *)FilesToCopy->Objects[Index];
  4996. DebugAssert(!FAvoidBusy);
  4997. FAvoidBusy = true;
  4998. try
  4999. {
  5000. try
  5001. {
  5002. SFTPSinkRobust(LocalCanonify(FileName), File, FullTargetDir, CopyParam,
  5003. Params, OperationProgress, tfFirstLevel);
  5004. Success = true;
  5005. }
  5006. catch(EScpSkipFile & E)
  5007. {
  5008. TSuspendFileOperationProgress Suspend(OperationProgress);
  5009. if (!FTerminal->HandleException(&E))
  5010. {
  5011. throw;
  5012. }
  5013. }
  5014. catch(...)
  5015. {
  5016. // TODO: remove the block?
  5017. throw;
  5018. }
  5019. }
  5020. __finally
  5021. {
  5022. FAvoidBusy = false;
  5023. OperationProgress->Finish(FileName, Success, OnceDoneOperation);
  5024. }
  5025. Index++;
  5026. }
  5027. }
  5028. //---------------------------------------------------------------------------
  5029. void __fastcall TSFTPFileSystem::SFTPSinkRobust(const UnicodeString FileName,
  5030. const TRemoteFile * File, const UnicodeString TargetDir,
  5031. const TCopyParamType * CopyParam, int Params,
  5032. TFileOperationProgressType * OperationProgress, unsigned int Flags)
  5033. {
  5034. // the same in TFTPFileSystem
  5035. TDownloadSessionAction Action(FTerminal->ActionLog);
  5036. TRobustOperationLoop RobustLoop(FTerminal, OperationProgress);
  5037. do
  5038. {
  5039. bool ChildError = false;
  5040. try
  5041. {
  5042. SFTPSink(FileName, File, TargetDir, CopyParam, Params, OperationProgress,
  5043. Flags, Action, ChildError);
  5044. }
  5045. catch(Exception & E)
  5046. {
  5047. if (!RobustLoop.TryReopen(E))
  5048. {
  5049. if (!ChildError)
  5050. {
  5051. FTerminal->RollbackAction(Action, OperationProgress, &E);
  5052. }
  5053. throw;
  5054. }
  5055. }
  5056. if (RobustLoop.ShouldRetry())
  5057. {
  5058. OperationProgress->RollbackTransfer();
  5059. Action.Restart();
  5060. DebugAssert(File != NULL);
  5061. if (!File->IsDirectory)
  5062. {
  5063. // prevent overwrite and resume confirmations
  5064. Params |= cpNoConfirmation;
  5065. }
  5066. }
  5067. }
  5068. while (RobustLoop.Retry());
  5069. }
  5070. //---------------------------------------------------------------------------
  5071. void __fastcall TSFTPFileSystem::SFTPSink(const UnicodeString FileName,
  5072. const TRemoteFile * File, const UnicodeString TargetDir,
  5073. const TCopyParamType * CopyParam, int Params,
  5074. TFileOperationProgressType * OperationProgress, unsigned int Flags,
  5075. TDownloadSessionAction & Action, bool & ChildError)
  5076. {
  5077. Action.FileName(FileName);
  5078. UnicodeString OnlyFileName = UnixExtractFileName(FileName);
  5079. TFileMasks::TParams MaskParams;
  5080. DebugAssert(File);
  5081. MaskParams.Size = File->Size;
  5082. MaskParams.Modification = File->Modification;
  5083. UnicodeString BaseFileName = FTerminal->GetBaseFileName(FileName);
  5084. if (!CopyParam->AllowTransfer(BaseFileName, osRemote, File->IsDirectory, MaskParams))
  5085. {
  5086. FTerminal->LogEvent(FORMAT(L"File \"%s\" excluded from transfer", (FileName)));
  5087. THROW_SKIP_FILE_NULL;
  5088. }
  5089. if (CopyParam->SkipTransfer(FileName, File->IsDirectory))
  5090. {
  5091. OperationProgress->AddSkippedFileSize(File->Size);
  5092. THROW_SKIP_FILE_NULL;
  5093. }
  5094. FTerminal->LogFileDetails(FileName, File->Modification, File->Size);
  5095. OperationProgress->SetFile(FileName);
  5096. UnicodeString DestFileName =
  5097. FTerminal->ChangeFileName(
  5098. CopyParam, OnlyFileName, osRemote, FLAGSET(Flags, tfFirstLevel));
  5099. UnicodeString DestFullName = TargetDir + DestFileName;
  5100. if (File->IsDirectory)
  5101. {
  5102. Action.Cancel();
  5103. if (!File->IsSymLink)
  5104. {
  5105. FILE_OPERATION_LOOP_BEGIN
  5106. {
  5107. int Attrs = FileGetAttrFix(ApiPath(DestFullName));
  5108. if ((Attrs & faDirectory) == 0) EXCEPTION;
  5109. }
  5110. FILE_OPERATION_LOOP_END(FMTLOAD(NOT_DIRECTORY_ERROR, (DestFullName)));
  5111. FILE_OPERATION_LOOP_BEGIN
  5112. {
  5113. THROWOSIFFALSE(ForceDirectories(ApiPath(DestFullName)));
  5114. }
  5115. FILE_OPERATION_LOOP_END(FMTLOAD(CREATE_DIR_ERROR, (DestFullName)));
  5116. TSinkFileParams SinkFileParams;
  5117. SinkFileParams.TargetDir = IncludeTrailingBackslash(DestFullName);
  5118. SinkFileParams.CopyParam = CopyParam;
  5119. SinkFileParams.Params = Params;
  5120. SinkFileParams.OperationProgress = OperationProgress;
  5121. SinkFileParams.Skipped = false;
  5122. SinkFileParams.Flags = Flags & ~tfFirstLevel;
  5123. FTerminal->ProcessDirectory(FileName, SFTPSinkFile, &SinkFileParams);
  5124. if (CopyParam->PreserveTime && CopyParam->PreserveTimeDirs)
  5125. {
  5126. FTerminal->LogEvent(FORMAT(L"Preserving directory timestamp [%s]",
  5127. (StandardTimestamp(File->Modification))));
  5128. int SetFileTimeError = ERROR_SUCCESS;
  5129. // FILE_FLAG_BACKUP_SEMANTICS is needed to "open" directory
  5130. HANDLE LocalHandle = CreateFile(ApiPath(DestFullName).c_str(), GENERIC_WRITE,
  5131. FILE_SHARE_WRITE, NULL, OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, 0);
  5132. if (LocalHandle == INVALID_HANDLE_VALUE)
  5133. {
  5134. SetFileTimeError = GetLastError();
  5135. }
  5136. else
  5137. {
  5138. FILETIME AcTime = DateTimeToFileTime(File->LastAccess, FTerminal->SessionData->DSTMode);
  5139. FILETIME WrTime = DateTimeToFileTime(File->Modification, FTerminal->SessionData->DSTMode);
  5140. if (!SetFileTime(LocalHandle, NULL, &AcTime, &WrTime))
  5141. {
  5142. SetFileTimeError = GetLastError();
  5143. }
  5144. CloseHandle(LocalHandle);
  5145. }
  5146. if (SetFileTimeError != ERROR_SUCCESS)
  5147. {
  5148. FTerminal->LogEvent(FORMAT(L"Preserving timestamp failed, ignoring: %s",
  5149. (SysErrorMessageForError(SetFileTimeError))));
  5150. }
  5151. }
  5152. // Do not delete directory if some of its files were skip.
  5153. // Throw "skip file" for the directory to avoid attempt to deletion
  5154. // of any parent directory
  5155. if ((Params & cpDelete) && SinkFileParams.Skipped)
  5156. {
  5157. THROW_SKIP_FILE_NULL;
  5158. }
  5159. }
  5160. else
  5161. {
  5162. FTerminal->LogEvent(FORMAT(L"Skipping symlink to directory \"%s\".", (FileName)));
  5163. }
  5164. }
  5165. else
  5166. {
  5167. FTerminal->LogEvent(FORMAT(L"Copying \"%s\" to local directory started.", (FileName)));
  5168. UnicodeString DestPartialFullName;
  5169. bool ResumeAllowed;
  5170. bool ResumeTransfer = false;
  5171. __int64 ResumeOffset;
  5172. // Will we use ASCII of BINARY file transfer?
  5173. OperationProgress->SetAsciiTransfer(
  5174. CopyParam->UseAsciiTransfer(BaseFileName, osRemote, MaskParams));
  5175. FTerminal->LogEvent(UnicodeString((OperationProgress->AsciiTransfer ? L"Ascii" : L"Binary")) +
  5176. " transfer mode selected.");
  5177. // Suppose same data size to transfer as to write
  5178. // (not true with ASCII transfer)
  5179. OperationProgress->SetTransferSize(File->Size);
  5180. OperationProgress->SetLocalSize(OperationProgress->TransferSize);
  5181. // resume has no sense for temporary downloads
  5182. ResumeAllowed = ((Params & cpTemporary) == 0) &&
  5183. !OperationProgress->AsciiTransfer &&
  5184. CopyParam->AllowResume(OperationProgress->TransferSize);
  5185. int Attrs;
  5186. FILE_OPERATION_LOOP_BEGIN
  5187. {
  5188. Attrs = FileGetAttrFix(ApiPath(DestFullName));
  5189. if ((Attrs >= 0) && (Attrs & faDirectory)) EXCEPTION;
  5190. }
  5191. FILE_OPERATION_LOOP_END(FMTLOAD(NOT_FILE_ERROR, (DestFullName)));
  5192. OperationProgress->TransferingFile = false; // not set with SFTP protocol
  5193. HANDLE LocalHandle = NULL;
  5194. TStream * FileStream = NULL;
  5195. bool DeleteLocalFile = false;
  5196. RawByteString RemoteHandle;
  5197. UnicodeString LocalFileName = DestFullName;
  5198. TSFTPOverwriteMode OverwriteMode = omOverwrite;
  5199. try
  5200. {
  5201. if (ResumeAllowed)
  5202. {
  5203. DestPartialFullName = DestFullName + FTerminal->Configuration->PartialExt;
  5204. LocalFileName = DestPartialFullName;
  5205. FTerminal->LogEvent(L"Checking existence of partially transfered file.");
  5206. if (FileExists(ApiPath(DestPartialFullName)))
  5207. {
  5208. FTerminal->LogEvent(L"Partially transfered file exists.");
  5209. FTerminal->OpenLocalFile(DestPartialFullName, GENERIC_WRITE,
  5210. NULL, &LocalHandle, NULL, NULL, NULL, &ResumeOffset);
  5211. bool PartialBiggerThanSource = (ResumeOffset > OperationProgress->TransferSize);
  5212. if (FLAGCLEAR(Params, cpNoConfirmation))
  5213. {
  5214. ResumeTransfer = SFTPConfirmResume(DestFileName,
  5215. PartialBiggerThanSource, OperationProgress);
  5216. }
  5217. else
  5218. {
  5219. ResumeTransfer = !PartialBiggerThanSource;
  5220. if (!ResumeTransfer)
  5221. {
  5222. FTerminal->LogEvent(L"Partially transfered file is bigger that original file.");
  5223. }
  5224. }
  5225. if (!ResumeTransfer)
  5226. {
  5227. CloseHandle(LocalHandle);
  5228. LocalHandle = NULL;
  5229. FILE_OPERATION_LOOP_BEGIN
  5230. {
  5231. THROWOSIFFALSE(Sysutils::DeleteFile(ApiPath(DestPartialFullName)));
  5232. }
  5233. FILE_OPERATION_LOOP_END(FMTLOAD(DELETE_LOCAL_FILE_ERROR, (DestPartialFullName)));
  5234. }
  5235. else
  5236. {
  5237. FTerminal->LogEvent(L"Resuming file transfer.");
  5238. FileSeek((THandle)LocalHandle, ResumeOffset, 0);
  5239. OperationProgress->AddResumed(ResumeOffset);
  5240. }
  5241. }
  5242. OperationProgress->Progress();
  5243. }
  5244. // first open source file, not to loose the destination file,
  5245. // if we cannot open the source one in the first place
  5246. FTerminal->LogEvent(L"Opening remote file.");
  5247. FILE_OPERATION_LOOP_BEGIN
  5248. {
  5249. int OpenType = SSH_FXF_READ;
  5250. if ((FVersion >= 4) && OperationProgress->AsciiTransfer)
  5251. {
  5252. OpenType |= SSH_FXF_TEXT;
  5253. }
  5254. RemoteHandle = SFTPOpenRemoteFile(FileName, OpenType);
  5255. OperationProgress->Progress();
  5256. }
  5257. FILE_OPERATION_LOOP_END(FMTLOAD(SFTP_OPEN_FILE_ERROR, (FileName)));
  5258. TDateTime Modification;
  5259. FILETIME AcTime;
  5260. FILETIME WrTime;
  5261. TSFTPPacket RemoteFilePacket(SSH_FXP_FSTAT);
  5262. RemoteFilePacket.AddString(RemoteHandle);
  5263. SendCustomReadFile(&RemoteFilePacket, &RemoteFilePacket,
  5264. SSH_FILEXFER_ATTR_MODIFYTIME);
  5265. ReceiveResponse(&RemoteFilePacket, &RemoteFilePacket);
  5266. OperationProgress->Progress();
  5267. const TRemoteFile * AFile = File;
  5268. try
  5269. {
  5270. // ignore errors
  5271. if (RemoteFilePacket.Type == SSH_FXP_ATTRS)
  5272. {
  5273. // load file, avoid completion (resolving symlinks) as we do not need that
  5274. AFile = LoadFile(&RemoteFilePacket, NULL, UnixExtractFileName(FileName),
  5275. NULL, false);
  5276. }
  5277. Modification = AFile->Modification;
  5278. AcTime = DateTimeToFileTime(AFile->LastAccess,
  5279. FTerminal->SessionData->DSTMode);
  5280. WrTime = DateTimeToFileTime(Modification,
  5281. FTerminal->SessionData->DSTMode);
  5282. }
  5283. __finally
  5284. {
  5285. if (AFile != File)
  5286. {
  5287. delete AFile;
  5288. }
  5289. }
  5290. if ((Attrs >= 0) && !ResumeTransfer)
  5291. {
  5292. __int64 DestFileSize;
  5293. __int64 MTime;
  5294. FTerminal->OpenLocalFile(DestFullName, GENERIC_WRITE,
  5295. NULL, &LocalHandle, NULL, &MTime, NULL, &DestFileSize, false);
  5296. FTerminal->LogEvent(L"Confirming overwriting of file.");
  5297. TOverwriteFileParams FileParams;
  5298. FileParams.SourceSize = OperationProgress->TransferSize;
  5299. FileParams.SourceTimestamp = Modification;
  5300. FileParams.DestTimestamp = UnixToDateTime(MTime,
  5301. FTerminal->SessionData->DSTMode);
  5302. FileParams.DestSize = DestFileSize;
  5303. UnicodeString PrevDestFileName = DestFileName;
  5304. SFTPConfirmOverwrite(FileName, DestFileName, CopyParam, Params, OperationProgress, OverwriteMode, &FileParams);
  5305. if (PrevDestFileName != DestFileName)
  5306. {
  5307. DestFullName = TargetDir + DestFileName;
  5308. DestPartialFullName = DestFullName + FTerminal->Configuration->PartialExt;
  5309. if (ResumeAllowed)
  5310. {
  5311. if (FileExists(ApiPath(DestPartialFullName)))
  5312. {
  5313. FILE_OPERATION_LOOP_BEGIN
  5314. {
  5315. THROWOSIFFALSE(Sysutils::DeleteFile(ApiPath(DestPartialFullName)));
  5316. }
  5317. FILE_OPERATION_LOOP_END(FMTLOAD(DELETE_LOCAL_FILE_ERROR, (DestPartialFullName)));
  5318. }
  5319. LocalFileName = DestPartialFullName;
  5320. }
  5321. else
  5322. {
  5323. LocalFileName = DestFullName;
  5324. }
  5325. }
  5326. if (OverwriteMode == omOverwrite)
  5327. {
  5328. // is NULL when overwriting read-only file
  5329. if (LocalHandle)
  5330. {
  5331. CloseHandle(LocalHandle);
  5332. LocalHandle = NULL;
  5333. }
  5334. }
  5335. else
  5336. {
  5337. // is NULL when overwriting read-only file, so following will
  5338. // probably fail anyway
  5339. if (LocalHandle == NULL)
  5340. {
  5341. FTerminal->OpenLocalFile(DestFullName, GENERIC_WRITE,
  5342. NULL, &LocalHandle, NULL, NULL, NULL, NULL);
  5343. }
  5344. ResumeAllowed = false;
  5345. FileSeek((THandle)LocalHandle, DestFileSize, 0);
  5346. if (OverwriteMode == omAppend)
  5347. {
  5348. FTerminal->LogEvent(L"Appending to file.");
  5349. }
  5350. else
  5351. {
  5352. FTerminal->LogEvent(L"Resuming file transfer (append style).");
  5353. DebugAssert(OverwriteMode == omResume);
  5354. OperationProgress->AddResumed(DestFileSize);
  5355. }
  5356. }
  5357. }
  5358. Action.Destination(ExpandUNCFileName(DestFullName));
  5359. // if not already opened (resume, append...), create new empty file
  5360. if (!LocalHandle)
  5361. {
  5362. if (!FTerminal->CreateLocalFile(LocalFileName, OperationProgress,
  5363. &LocalHandle, FLAGSET(Params, cpNoConfirmation)))
  5364. {
  5365. THROW_SKIP_FILE_NULL;
  5366. }
  5367. }
  5368. DebugAssert(LocalHandle);
  5369. DeleteLocalFile = true;
  5370. FileStream = new TSafeHandleStream((THandle)LocalHandle);
  5371. // at end of this block queue is discarded
  5372. {
  5373. TSFTPDownloadQueue Queue(this);
  5374. try
  5375. {
  5376. TSFTPPacket DataPacket;
  5377. int QueueLen = int(File->Size / DownloadBlockSize(OperationProgress)) + 1;
  5378. if ((QueueLen > FTerminal->SessionData->SFTPDownloadQueue) ||
  5379. (QueueLen < 0))
  5380. {
  5381. QueueLen = FTerminal->SessionData->SFTPDownloadQueue;
  5382. }
  5383. if (QueueLen < 1)
  5384. {
  5385. QueueLen = 1;
  5386. }
  5387. Queue.Init(QueueLen, RemoteHandle, OperationProgress->TransferedSize,
  5388. OperationProgress);
  5389. bool Eof = false;
  5390. bool PrevIncomplete = false;
  5391. int GapFillCount = 0;
  5392. int GapCount = 0;
  5393. unsigned long Missing = 0;
  5394. unsigned long DataLen = 0;
  5395. unsigned long BlockSize;
  5396. bool ConvertToken = false;
  5397. while (!Eof)
  5398. {
  5399. if (Missing > 0)
  5400. {
  5401. Queue.InitFillGapRequest(OperationProgress->TransferedSize, Missing,
  5402. &DataPacket);
  5403. GapFillCount++;
  5404. SendPacketAndReceiveResponse(&DataPacket, &DataPacket,
  5405. SSH_FXP_DATA, asEOF);
  5406. }
  5407. else
  5408. {
  5409. Queue.ReceivePacket(&DataPacket, BlockSize);
  5410. }
  5411. if (DataPacket.Type == SSH_FXP_STATUS)
  5412. {
  5413. // must be SSH_FX_EOF, any other status packet would raise exception
  5414. Eof = true;
  5415. // close file right away, before waiting for pending responses
  5416. SFTPCloseRemote(RemoteHandle, DestFileName, OperationProgress,
  5417. true, true, NULL);
  5418. RemoteHandle = L""; // do not close file again in __finally block
  5419. }
  5420. if (!Eof)
  5421. {
  5422. if ((Missing == 0) && PrevIncomplete)
  5423. {
  5424. // This can happen only if last request returned less bytes
  5425. // than expected, but exactly number of bytes missing to last
  5426. // known file size, but actually EOF was not reached.
  5427. // Can happen only when filesize has changed since directory
  5428. // listing and server returns less bytes than requested and
  5429. // file has some special file size.
  5430. FTerminal->LogEvent(FORMAT(
  5431. L"Received incomplete data packet before end of file, "
  5432. "offset: %s, size: %d, requested: %d",
  5433. (IntToStr(OperationProgress->TransferedSize), int(DataLen),
  5434. int(BlockSize))));
  5435. FTerminal->TerminalError(NULL, LoadStr(SFTP_INCOMPLETE_BEFORE_EOF));
  5436. }
  5437. // Buffer for one block of data
  5438. TFileBuffer BlockBuf;
  5439. DataLen = DataPacket.GetCardinal();
  5440. PrevIncomplete = false;
  5441. if (Missing > 0)
  5442. {
  5443. DebugAssert(DataLen <= Missing);
  5444. Missing -= DataLen;
  5445. }
  5446. else if (DataLen < BlockSize)
  5447. {
  5448. if (OperationProgress->TransferedSize + DataLen !=
  5449. OperationProgress->TransferSize)
  5450. {
  5451. // with native text transfer mode (SFTP>=4), do not bother about
  5452. // getting less than requested, read offset is ignored anyway
  5453. if ((FVersion < 4) || !OperationProgress->AsciiTransfer)
  5454. {
  5455. GapCount++;
  5456. Missing = BlockSize - DataLen;
  5457. }
  5458. }
  5459. else
  5460. {
  5461. PrevIncomplete = true;
  5462. }
  5463. }
  5464. DebugAssert(DataLen <= BlockSize);
  5465. BlockBuf.Insert(0, reinterpret_cast<const char *>(DataPacket.GetNextData(DataLen)), DataLen);
  5466. DataPacket.DataConsumed(DataLen);
  5467. OperationProgress->AddTransfered(DataLen);
  5468. if ((FVersion >= 6) && DataPacket.CanGetBool() && (Missing == 0))
  5469. {
  5470. Eof = DataPacket.GetBool();
  5471. }
  5472. if (OperationProgress->AsciiTransfer)
  5473. {
  5474. DebugAssert(!ResumeTransfer && !ResumeAllowed);
  5475. unsigned int PrevBlockSize = BlockBuf.Size;
  5476. BlockBuf.Convert(GetEOL(), FTerminal->Configuration->LocalEOLType, 0, ConvertToken);
  5477. OperationProgress->SetLocalSize(
  5478. OperationProgress->LocalSize - PrevBlockSize + BlockBuf.Size);
  5479. }
  5480. FILE_OPERATION_LOOP_BEGIN
  5481. {
  5482. BlockBuf.WriteToStream(FileStream, BlockBuf.Size);
  5483. }
  5484. FILE_OPERATION_LOOP_END(FMTLOAD(WRITE_ERROR, (LocalFileName)));
  5485. OperationProgress->AddLocallyUsed(BlockBuf.Size);
  5486. }
  5487. if (OperationProgress->Cancel == csCancel)
  5488. {
  5489. Abort();
  5490. }
  5491. };
  5492. if (GapCount > 0)
  5493. {
  5494. FTerminal->LogEvent(FORMAT(
  5495. L"%d requests to fill %d data gaps were issued.",
  5496. (GapFillCount, GapCount)));
  5497. }
  5498. }
  5499. __finally
  5500. {
  5501. Queue.DisposeSafe();
  5502. }
  5503. // queue is discarded here
  5504. }
  5505. if (CopyParam->PreserveTime)
  5506. {
  5507. FTerminal->LogEvent(FORMAT(L"Preserving timestamp [%s]",
  5508. (StandardTimestamp(Modification))));
  5509. SetFileTime(LocalHandle, NULL, &AcTime, &WrTime);
  5510. }
  5511. CloseHandle(LocalHandle);
  5512. LocalHandle = NULL;
  5513. if (ResumeAllowed)
  5514. {
  5515. FILE_OPERATION_LOOP_BEGIN
  5516. {
  5517. if (FileExists(ApiPath(DestFullName)))
  5518. {
  5519. DeleteFileChecked(DestFullName);
  5520. }
  5521. THROWOSIFFALSE(Sysutils::RenameFile(DestPartialFullName, DestFullName));
  5522. }
  5523. FILE_OPERATION_LOOP_END(
  5524. FMTLOAD(RENAME_AFTER_RESUME_ERROR,
  5525. (ExtractFileName(DestPartialFullName), DestFileName)));
  5526. }
  5527. DeleteLocalFile = false;
  5528. if (Attrs == -1)
  5529. {
  5530. Attrs = faArchive;
  5531. }
  5532. int NewAttrs = CopyParam->LocalFileAttrs(*File->Rights);
  5533. if ((NewAttrs & Attrs) != NewAttrs)
  5534. {
  5535. FILE_OPERATION_LOOP_BEGIN
  5536. {
  5537. THROWOSIFFALSE(FileSetAttr(ApiPath(DestFullName), Attrs | NewAttrs) == 0);
  5538. }
  5539. FILE_OPERATION_LOOP_END(FMTLOAD(CANT_SET_ATTRS, (DestFullName)));
  5540. }
  5541. }
  5542. __finally
  5543. {
  5544. if (LocalHandle) CloseHandle(LocalHandle);
  5545. if (FileStream) delete FileStream;
  5546. if (DeleteLocalFile && (!ResumeAllowed || OperationProgress->LocallyUsed == 0) &&
  5547. (OverwriteMode == omOverwrite))
  5548. {
  5549. FILE_OPERATION_LOOP_BEGIN
  5550. {
  5551. THROWOSIFFALSE(Sysutils::DeleteFile(ApiPath(LocalFileName)));
  5552. }
  5553. FILE_OPERATION_LOOP_END(FMTLOAD(DELETE_LOCAL_FILE_ERROR, (LocalFileName)));
  5554. }
  5555. // if the transfer was finished, the file is closed already
  5556. if (FTerminal->Active && !RemoteHandle.IsEmpty())
  5557. {
  5558. // do not wait for response
  5559. SFTPCloseRemote(RemoteHandle, DestFileName, OperationProgress,
  5560. true, true, NULL);
  5561. }
  5562. }
  5563. FTerminal->LogFileDone(OperationProgress);
  5564. }
  5565. if (Params & cpDelete)
  5566. {
  5567. ChildError = true;
  5568. // If file is directory, do not delete it recursively, because it should be
  5569. // empty already. If not, it should not be deleted (some files were
  5570. // skipped or some new files were copied to it, while we were downloading)
  5571. int Params = dfNoRecursive;
  5572. FTerminal->DeleteFile(FileName, File, &Params);
  5573. ChildError = false;
  5574. }
  5575. }
  5576. //---------------------------------------------------------------------------
  5577. void __fastcall TSFTPFileSystem::SFTPSinkFile(UnicodeString FileName,
  5578. const TRemoteFile * File, void * Param)
  5579. {
  5580. TSinkFileParams * Params = (TSinkFileParams *)Param;
  5581. DebugAssert(Params->OperationProgress);
  5582. try
  5583. {
  5584. SFTPSinkRobust(FileName, File, Params->TargetDir, Params->CopyParam,
  5585. Params->Params, Params->OperationProgress, Params->Flags);
  5586. }
  5587. catch(EScpSkipFile & E)
  5588. {
  5589. TFileOperationProgressType * OperationProgress = Params->OperationProgress;
  5590. Params->Skipped = true;
  5591. {
  5592. TSuspendFileOperationProgress Suspend(OperationProgress);
  5593. if (!FTerminal->HandleException(&E))
  5594. {
  5595. throw;
  5596. }
  5597. }
  5598. if (OperationProgress->Cancel)
  5599. {
  5600. Abort();
  5601. }
  5602. }
  5603. }
  5604. //---------------------------------------------------------------------------
  5605. void __fastcall TSFTPFileSystem::RegisterChecksumAlg(const UnicodeString & Alg, const UnicodeString & SftpAlg)
  5606. {
  5607. FChecksumAlgs->Add(Alg);
  5608. FChecksumSftpAlgs->Add(SftpAlg);
  5609. }
  5610. //---------------------------------------------------------------------------
  5611. void __fastcall TSFTPFileSystem::GetSupportedChecksumAlgs(TStrings * Algs)
  5612. {
  5613. Algs->AddStrings(FChecksumAlgs.get());
  5614. }
  5615. //---------------------------------------------------------------------------
  5616. void __fastcall TSFTPFileSystem::LockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
  5617. {
  5618. DebugFail();
  5619. }
  5620. //---------------------------------------------------------------------------
  5621. void __fastcall TSFTPFileSystem::UnlockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
  5622. {
  5623. DebugFail();
  5624. }
  5625. //---------------------------------------------------------------------------
  5626. void __fastcall TSFTPFileSystem::UpdateFromMain(TCustomFileSystem * /*MainFileSystem*/)
  5627. {
  5628. // noop
  5629. }