SftpFileSystem.cpp 178 KB

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