| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392 |
- //---------------------------------------------------------------------------
- #include <vcl.h>
- #pragma hdrstop
- #include "SftpFileSystem.h"
- #include <sftp.h>
- #include "PuttyIntf.h"
- #include "Common.h"
- #include "Interface.h"
- #include "Terminal.h"
- #include "TextsCore.h"
- #include <memory>
- //---------------------------------------------------------------------------
- #pragma package(smart_init)
- //---------------------------------------------------------------------------
- // additional constants for SFTP protocol not defined in Putty's sftp.h
- #define SSH_FXP_READLINK 19
- #define SSH_FXP_SYMLINK 20
- #define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
- #define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
- #define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
- #define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
- #define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
- #define SSH_FILEXFER_TYPE_REGULAR 1
- #define SSH_FILEXFER_TYPE_DIRECTORY 2
- #define SSH_FILEXFER_TYPE_SYMLINK 3
- #define SSH_FILEXFER_TYPE_SPECIAL 4
- #define SSH_FILEXFER_TYPE_UNKNOWN 5
- #define SSH_FXF_TEXT 0x00000040
- //---------------------------------------------------------------------------
- const int SFTPMinVersion = 2;
- const int SFTPMaxVersion = 4;
- const int SFTPNoMessageNumber = -1;
- const int asOK = 1 << SSH_FX_OK;
- const int asEOF = 1 << SSH_FX_EOF;
- const int asOpUnsupported = 1 << SSH_FX_OP_UNSUPPORTED;
- //---------------------------------------------------------------------------
- #define GET_32BIT(cp) \
- (((unsigned long)(unsigned char)(cp)[0] << 24) | \
- ((unsigned long)(unsigned char)(cp)[1] << 16) | \
- ((unsigned long)(unsigned char)(cp)[2] << 8) | \
- ((unsigned long)(unsigned char)(cp)[3]))
- #define PUT_32BIT(cp, value) { \
- (cp)[0] = (unsigned char)((value) >> 24); \
- (cp)[1] = (unsigned char)((value) >> 16); \
- (cp)[2] = (unsigned char)((value) >> 8); \
- (cp)[3] = (unsigned char)(value); }
- #define THROW_SKIP_FILE_NULL THROW_SKIP_FILE(NULL, "")
- //---------------------------------------------------------------------------
- #define SFTP_PACKET_ALLOC_DELTA 256
- //---------------------------------------------------------------------------
- class TSFTPPacket
- {
- public:
- TSFTPPacket()
- {
- Init();
- }
- TSFTPPacket(const TSFTPPacket & Source)
- {
- Init();
- *this = Source;
- }
- TSFTPPacket(unsigned char AType)
- {
- Init();
- ChangeType(AType);
- }
- ~TSFTPPacket()
- {
- delete FData;
- if (FReservedBy) FReservedBy->UnreserveResponse(this);
- }
- void ChangeType(unsigned char AType)
- {
- FPosition = 0;
- FLength = 0;
- Capacity = 0;
- FType = AType;
- AddByte(FType);
- if (FType != SSH_FXP_INIT)
- {
- FMessageNumber = (FMessageCounter << 8) + FType;
- FMessageCounter++;
- AddCardinal(FMessageNumber);
- }
- }
- void AddByte(unsigned char Value)
- {
- Add(&Value, sizeof(Value));
- }
- void AddCardinal(unsigned long Value)
- {
- unsigned char Buf[4];
- PUT_32BIT(Buf, Value);
- Add(&Buf, sizeof(Buf));
- }
- void AddInt64(__int64 Value)
- {
- AddCardinal((unsigned long)(Value >> 32));
- AddCardinal((unsigned long)(Value & 0xFFFFFFFF));
- }
- void AddData(const void * Data, int ALength)
- {
- AddCardinal(ALength);
- Add(Data, ALength);
- }
- void AddString(const AnsiString Value)
- {
- AddCardinal(Value.Length());
- Add(Value.c_str(), Value.Length());
- }
- void AddProperties(const TRemoteProperties * Properties,
- unsigned short BaseRights, bool IsDirectory, int Version)
- {
- int Flags = 0;
- if (Properties)
- {
- if (Properties->Valid.Contains(vpOwner) || Properties->Valid.Contains(vpGroup))
- {
- Flags |= SSH_FILEXFER_ATTR_OWNERGROUP;
- }
- if (Properties->Valid.Contains(vpRights))
- {
- Flags |= SSH_FILEXFER_ATTR_PERMISSIONS;
- }
- }
- AddCardinal(Flags);
- if (Version >= 4)
- {
- AddByte((unsigned char)(IsDirectory ? SSH_FILEXFER_TYPE_DIRECTORY : SSH_FILEXFER_TYPE_REGULAR));
- }
- if (Properties)
- {
- if (Flags & SSH_FILEXFER_ATTR_OWNERGROUP)
- {
- assert(Version >= 4);
- AddString(Properties->Valid.Contains(vpOwner) ?
- Properties->Owner : AnsiString());
- AddString(Properties->Valid.Contains(vpGroup) ?
- Properties->Group : AnsiString());
- }
- if (Flags & SSH_FILEXFER_ATTR_PERMISSIONS)
- {
- TRights Rights = BaseRights;
- Rights |= Properties->Rights.NumberSet;
- Rights &= (unsigned short)~Properties->Rights.NumberUnset;
- if (IsDirectory && Properties->AddXToDirectories)
- {
- Rights.AddExecute();
- }
- AddCardinal(Rights);
- }
- }
- }
- char GetByte()
- {
- assert(FPosition <= FLength - sizeof(char));
- char Result = FData[FPosition];
- FPosition++;
- return Result;
- }
- unsigned long GetCardinal()
- {
- unsigned long Result;
- assert(FPosition <= FLength - sizeof(Result));
- Result = GET_32BIT(FData + FPosition);
- FPosition += sizeof(Result);
- return Result;
- }
- __int64 GetInt64()
- {
- __int64 Hi = GetCardinal();
- __int64 Lo = GetCardinal();
- return (Hi << 32) + Lo;
- }
- AnsiString GetString()
- {
- AnsiString Result;
- unsigned long Len = GetCardinal();
- Result.SetLength(Len);
- assert(FLength >= Len && FPosition <= FLength - Len);
- memcpy(Result.c_str(), FData + FPosition, Len);
- FPosition += Len;
- return Result;
- }
- void GetFile(TRemoteFile * File, int Version)
- {
- assert(File);
- unsigned int Flags;
- AnsiString ListingStr;
- unsigned long Permissions;
- bool ParsingFailed = false;
- if (Type != SSH_FXP_ATTRS)
- {
- File->FileName = GetString();
- if (Version < 4)
- {
- ListingStr = GetString();
- }
- }
- Flags = GetCardinal();
- if (Version >= 4)
- {
- char FXType = GetByte();
- char Types[] = "-DLSU";
- if (FXType < 1 || FXType > (char)strlen(Types))
- {
- throw Exception(FMTLOAD(SFTP_UNKNOWN_FILE_TYPE, (int(FXType))));
- }
- File->Type = Types[FXType-1];
- }
- if (Flags & SSH_FILEXFER_ATTR_SIZE)
- {
- File->Size = GetInt64();
- }
- if (Flags & SSH_FILEXFER_ATTR_UIDGID)
- {
- assert(Version < 4);
- GetCardinal(); // skip UID
- GetCardinal(); // skip GUID
- }
- if (Flags & SSH_FILEXFER_ATTR_OWNERGROUP)
- {
- assert(Version >= 4);
- File->Owner = GetString();
- File->Group = GetString();
- }
- if (Flags & SSH_FILEXFER_ATTR_PERMISSIONS)
- {
- Permissions = GetCardinal();
- }
- if (Version < 4)
- {
- if (Flags & SSH_FILEXFER_ATTR_ACMODTIME)
- {
- File->LastAccess = UnixToDateTime(GetCardinal());
- File->Modification = UnixToDateTime(GetCardinal());
- }
- }
- else
- {
- if (Flags & SSH_FILEXFER_ATTR_ACCESSTIME)
- {
- File->LastAccess = UnixToDateTime((unsigned long)GetInt64());
- }
- if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
- {
- GetCardinal(); // skip access time subseconds
- }
- if (Flags & SSH_FILEXFER_ATTR_CREATETIME)
- {
- GetInt64(); // skip create time
- }
- if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
- {
- GetCardinal(); // skip create time subseconds
- }
- if (Flags & SSH_FILEXFER_ATTR_MODIFYTIME)
- {
- File->Modification = UnixToDateTime((unsigned long)GetInt64());
- }
- if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
- {
- GetCardinal(); // skip modification time subseconds
- }
- }
- if ((Version < 4) && (Type != SSH_FXP_ATTRS))
- {
- try
- {
- // update permissions and user/group name
- // modification time and filename is ignored
- File->ListingStr = ListingStr;
- }
- catch(...)
- {
- // ignore any error while parsing listing line,
- // SFTP specification do not recommend to parse it
- ParsingFailed = true;
- }
- }
- if (Type == SSH_FXP_ATTRS || Version >= 4 || ParsingFailed)
- {
- File->Rights->Number = (unsigned short)(Permissions & 0777);
- if (Version < 4)
- {
- File->Type = (Permissions & 0040000 ? FILETYPE_DIRECTORY : '-');
- }
- }
- // TODO: read extended attributes (Flags & SSH_FILEXFER_ATTR_EXTENDED)
- // Format: Count=Cardinal, Count*(Name=String, Value=String)
- }
- void DataUpdated(int ALength)
- {
- FPosition = 0;
- FLength = ALength;
- FType = GetByte();
- if (FType != SSH_FXP_VERSION)
- {
- FMessageNumber = GetCardinal();
- }
- else
- {
- FMessageNumber = SFTPNoMessageNumber;
- }
- }
- TSFTPPacket & operator = (const TSFTPPacket & Source)
- {
- Capacity = 0;
- Add(Source.Data, Source.Length);
- DataUpdated(Source.Length);
- FPosition = Source.FPosition;
- return *this;
- }
- __property unsigned int Length = { read = FLength };
- __property char * Data = { read = FData };
- __property char * NextData = { read = GetNextData };
- __property char * Content = { read = GetContent };
- __property unsigned int ContentLength = { read = GetContentLength };
- __property unsigned int Capacity = { read = FCapacity, write = SetCapacity };
- __property unsigned char Type = { read = FType };
- __property unsigned char RequestType = { read = GetRequestType };
- __property unsigned int MessageNumber = { read = FMessageNumber, write = FMessageNumber };
- __property TSFTPFileSystem * ReservedBy = { read = FReservedBy, write = FReservedBy };
- __property AnsiString TypeName = { read = GetTypeName };
- private:
- char * FData;
- unsigned int FLength;
- unsigned int FCapacity;
- unsigned int FPosition;
- unsigned char FType;
- unsigned int FMessageNumber;
- TSFTPFileSystem * FReservedBy;
- static int FMessageCounter;
- void Init()
- {
- FData = NULL;
- FCapacity = 0;
- FLength = 0;
- FPosition = 0;
- FMessageNumber = SFTPNoMessageNumber;
- FType = -1;
- FReservedBy = NULL;
- }
- unsigned char GetRequestType()
- {
- if (FMessageNumber != SFTPNoMessageNumber)
- {
- return (unsigned char)(FMessageNumber & 0xFF);
- }
- else
- {
- assert(Type == SSH_FXP_VERSION);
- return SSH_FXP_INIT;
- }
- }
- void Add(const void * AData, int ALength)
- {
- if (Length + ALength > Capacity)
- {
- Capacity = Length + ALength + SFTP_PACKET_ALLOC_DELTA;
- }
- memcpy(FData + Length, AData, ALength);
- FLength += ALength;
- }
- void SetCapacity(unsigned int ACapacity)
- {
- if (ACapacity != Capacity)
- {
- FCapacity = ACapacity;
- if (FCapacity > 0)
- {
- char * NData = new char[FCapacity];
- if (FData)
- {
- memcpy(NData, FData, (FLength < FCapacity ? FLength : FCapacity));
- delete FData;
- }
- FData = NData;
- }
- else
- {
- if (FData) delete FData;
- FData = NULL;
- }
- if (FLength > FCapacity) FLength = FCapacity;
- }
- }
- AnsiString GetTypeName() const
- {
- #define TYPE_CASE(TYPE) case TYPE: return #TYPE
- switch (Type) {
- TYPE_CASE(SSH_FXP_INIT);
- TYPE_CASE(SSH_FXP_VERSION);
- TYPE_CASE(SSH_FXP_OPEN);
- TYPE_CASE(SSH_FXP_CLOSE);
- TYPE_CASE(SSH_FXP_READ);
- TYPE_CASE(SSH_FXP_WRITE);
- TYPE_CASE(SSH_FXP_LSTAT);
- TYPE_CASE(SSH_FXP_FSTAT);
- TYPE_CASE(SSH_FXP_SETSTAT);
- TYPE_CASE(SSH_FXP_FSETSTAT);
- TYPE_CASE(SSH_FXP_OPENDIR);
- TYPE_CASE(SSH_FXP_READDIR);
- TYPE_CASE(SSH_FXP_REMOVE);
- TYPE_CASE(SSH_FXP_MKDIR);
- TYPE_CASE(SSH_FXP_RMDIR);
- TYPE_CASE(SSH_FXP_REALPATH);
- TYPE_CASE(SSH_FXP_STAT);
- TYPE_CASE(SSH_FXP_RENAME);
- TYPE_CASE(SSH_FXP_READLINK);
- TYPE_CASE(SSH_FXP_SYMLINK);
- TYPE_CASE(SSH_FXP_STATUS);
- TYPE_CASE(SSH_FXP_HANDLE);
- TYPE_CASE(SSH_FXP_DATA);
- TYPE_CASE(SSH_FXP_NAME);
- TYPE_CASE(SSH_FXP_ATTRS);
- TYPE_CASE(SSH_FXP_EXTENDED);
- TYPE_CASE(SSH_FXP_EXTENDED_REPLY);
- default:
- return FORMAT("Unknown message (%d)", (int(Type)));
- }
- }
- char * GetContent()
- {
- return Data + sizeof(Byte) + (FType != SSH_FXP_VERSION ? sizeof(Cardinal) : 0);
- }
- unsigned int GetContentLength()
- {
- return Length - sizeof(Byte) - (FType != SSH_FXP_VERSION ? sizeof(Cardinal) : 0);
- }
- char * GetNextData()
- {
- return FPosition < FLength ? FData + FPosition : NULL;
- }
- };
- //---------------------------------------------------------------------------
- int TSFTPPacket::FMessageCounter = 0;
- //===========================================================================
- struct TOpenRemoteFileParams
- {
- int LocalFileAttrs;
- AnsiString RemoteFileName;
- TFileOperationProgressType * OperationProgress;
- const TCopyParamType * CopyParam;
- int Params;
- bool Resume;
- AnsiString RemoteFileHandle; // output
- };
- struct TSinkFileParams
- {
- AnsiString TargetDir;
- const TCopyParamType * CopyParam;
- int Params;
- TFileOperationProgressType * OperationProgress;
- bool Skipped;
- };
- //===========================================================================
- __fastcall TSFTPFileSystem::TSFTPFileSystem(TTerminal * ATerminal):
- TCustomFileSystem(ATerminal)
- {
- FPacketReservations = new TList();
- FPacketNumbers = VarArrayCreate(OPENARRAY(int, (0, 1)), varInteger);
- FPreviousLoggedPacket = 0;
- FNotLoggedPackets = 0;
- FBusy = 0;
- FAvoidBusy = false;
- }
- //---------------------------------------------------------------------------
- __fastcall TSFTPFileSystem::~TSFTPFileSystem()
- {
- delete FPacketReservations;
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall TSFTPFileSystem::GetProtocolName() const
- {
- return FMTLOAD(SFTP_PROTOCOL_NAME, (FVersion));
- }
- //---------------------------------------------------------------------------
- bool __fastcall TSFTPFileSystem::IsCapable(int Capability) const
- {
- assert(FTerminal);
- switch (Capability) {
- case fcUserGroupListing:
- case fcAnyCommand:
- case fcHardLink:
- return false;
- case fcOwnerChanging:
- case fcGroupChanging:
- return (FVersion >= 4);
- case fcSymbolicLink:
- case fcResolveSymlink:
- return (FVersion >= 3);
- case fcModeChanging:
- return true;
- case fcTextMode:
- return (FVersion >= 4) ||
- strcmp(GetEOL(), EOLToStr(FTerminal->Configuration->LocalEOLType)) != 0;
- default:
- assert(false);
- return false;
- }
- }
- //---------------------------------------------------------------------------
- struct TUnicodeEmitParams
- {
- WideString Buffer;
- int Pos;
- int Len;
- };
- //---------------------------------------------------------------------------
- extern "C" void UnicodeEmit(void * AParams, long int Output)
- {
- if (Output == 0xFFFFL) // see Putty's charset\internal.h
- {
- throw Exception(LoadStr(DECODE_UTF_ERROR));
- }
- TUnicodeEmitParams * Params = (TUnicodeEmitParams *)AParams;
- if (Params->Pos >= Params->Len)
- {
- Params->Len += 50;
- Params->Buffer.SetLength(Params->Len);
- }
- Params->Buffer[Params->Pos + 1] = (wchar_t)Output;
- Params->Pos++;
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall TSFTPFileSystem::DecodeUTF(const AnsiString UTF)
- {
- charset_state State;
- char * Str;
- TUnicodeEmitParams Params;
- AnsiString Result;
- State.s0 = 0;
- Str = UTF.c_str();
- Params.Pos = 0;
- Params.Len = UTF.Length();
- Params.Buffer.SetLength(Params.Len);
- while (*Str)
- {
- read_utf8(NULL, (unsigned char)*Str, &State, UnicodeEmit, &Params);
- Str++;
- }
- Params.Buffer.SetLength(Params.Pos);
- return Params.Buffer;
- }
- //---------------------------------------------------------------------------
- inline void __fastcall TSFTPFileSystem::BusyStart()
- {
- if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
- {
- Busy(true);
- }
- FBusy++;
- assert(FBusy < 10);
- }
- //---------------------------------------------------------------------------
- inline void __fastcall TSFTPFileSystem::BusyEnd()
- {
- assert(FBusy > 0);
- FBusy--;
- if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
- {
- Busy(false);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SendPacket(const TSFTPPacket * Packet)
- {
- BusyStart();
- try
- {
- if (FTerminal->IsLogging())
- {
- if ((FPreviousLoggedPacket != SSH_FXP_READ &&
- FPreviousLoggedPacket != SSH_FXP_WRITE) ||
- (Packet->Type != FPreviousLoggedPacket))
- {
- if (FNotLoggedPackets)
- {
- FTerminal->LogEvent(FORMAT("%d skipped SSH_FXP_WRITE, SSH_FXP_READ, SSH_FXP_DATA and SSH_FXP_STATUS packets.",
- (FNotLoggedPackets)));
- FNotLoggedPackets = 0;
- }
- FTerminal->Log->Add(llInput, FORMAT("Type: %s, Size: %d, Number: %d",
- (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
- FPreviousLoggedPacket = Packet->Type;
- }
- else
- {
- FNotLoggedPackets++;
- }
- }
- char LenBuf[4];
- PUT_32BIT(LenBuf, Packet->Length);
- FTerminal->Send(LenBuf, sizeof(LenBuf));
- FTerminal->Send(Packet->Data, Packet->Length);
- }
- __finally
- {
- BusyEnd();
- }
- }
- //---------------------------------------------------------------------------
- unsigned long __fastcall TSFTPFileSystem::GotStatusPacket(TSFTPPacket * Packet,
- int AllowStatus)
- {
- unsigned long Code = Packet->GetCardinal();
- static int Messages[] = {
- SFTP_STATUS_OK,
- SFTP_STATUS_EOF,
- SFTP_STATUS_NO_SUCH_FILE,
- SFTP_STATUS_PERMISSION_DENIED,
- SFTP_STATUS_FAILURE,
- SFTP_STATUS_BAD_MESSAGE,
- SFTP_STATUS_NO_CONNECTION,
- SFTP_STATUS_CONNECTION_LOST,
- SFTP_STATUS_OP_UNSUPPORTED,
- SFTP_STATUS_INVALID_HANDLE,
- SFTP_STATUS_NO_SUCH_PATH,
- SFTP_STATUS_FILE_ALREADY_EXISTS,
- SFTP_STATUS_WRITE_PROTECT,
- SFTP_STATUS_NO_MEDIA,
- };
- int Message;
- if ((AllowStatus & (0x01 << Code)) == 0)
- {
- if (Code >= sizeof(Messages) / sizeof(*Messages))
- {
- Message = SFTP_STATUS_UNKNOWN;
- }
- else
- {
- Message = Messages[Code];
- }
- AnsiString ServerMessage;
- AnsiString LanguageTag;
- if (FVersion >= 3)
- {
- ServerMessage = DecodeUTF(Packet->GetString());
- LanguageTag = Packet->GetString();
- }
- else
- {
- ServerMessage = LoadStr(SFTP_SERVER_MESSAGE_UNSUPPORTED);
- }
- if (LanguageTag.IsEmpty())
- {
- LanguageTag = "?";
- }
- if (FTerminal->IsLogging())
- {
- FTerminal->Log->Add(llOutput, FORMAT("Status/error code: %d, Message: %d, Server: %s, Language: %s ",
- (int(Code), (int)Packet->MessageNumber, ServerMessage, LanguageTag)));
- }
- FTerminal->TerminalError(NULL, FMTLOAD(SFTP_ERROR_FORMAT,
- (LoadStr(Message), int(Code), ServerMessage, LanguageTag, int(Packet->RequestType))));
- return 0;
- }
- else
- {
- if (!FNotLoggedPackets || Code)
- {
- FTerminal->Log->Add(llOutput, FORMAT("Status/error code: %d", ((int)Code)));
- }
- return Code;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::RemoveReservation(int Reservation)
- {
- for (int Index = Reservation+1; Index < FPacketReservations->Count; Index++)
- {
- FPacketNumbers.PutElement(FPacketNumbers.GetElement(Index), Index-1);
- }
- TSFTPPacket * Packet = (TSFTPPacket *)FPacketReservations->Items[Reservation];
- if (Packet)
- {
- assert(Packet->ReservedBy == this);
- Packet->ReservedBy = NULL;
- }
- FPacketReservations->Delete(Reservation);
- }
- //---------------------------------------------------------------------------
- int __fastcall TSFTPFileSystem::ReceivePacket(TSFTPPacket * Packet,
- int ExpectedType, int AllowStatus)
- {
- int Result = SSH_FX_OK;
- BusyStart();
- try
- {
- int Reservation = FPacketReservations->IndexOf(Packet);
- if (Reservation < 0 || Packet->Capacity == 0)
- {
- bool IsReserved;
- do
- {
- IsReserved = false;
- assert(Packet);
- char LenBuf[4];
- FTerminal->Receive(LenBuf, sizeof(LenBuf));
- int Length = GET_32BIT(LenBuf);
- Packet->Capacity = Length;
- FTerminal->Receive(Packet->Data, Length);
- Packet->DataUpdated(Length);
- if (FTerminal->IsLogging())
- {
- if ((FPreviousLoggedPacket != SSH_FXP_READ &&
- FPreviousLoggedPacket != SSH_FXP_WRITE) ||
- (Packet->Type != SSH_FXP_STATUS && Packet->Type != SSH_FXP_DATA))
- {
- if (FNotLoggedPackets)
- {
- FTerminal->LogEvent(FORMAT("%d skipped SSH_FXP_WRITE, SSH_FXP_READ, SSH_FXP_DATA and SSH_FXP_STATUS packets.",
- (FNotLoggedPackets)));
- FNotLoggedPackets = 0;
- }
- FTerminal->Log->Add(llOutput, FORMAT("Type: %s, Size: %d, Number: %d",
- (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
- }
- else
- {
- FNotLoggedPackets++;
- }
- }
- if (Reservation < 0 ||
- Packet->MessageNumber != (unsigned long)FPacketNumbers.GetElement(Reservation))
- {
- TSFTPPacket * ReservedPacket;
- unsigned long MessageNumber;
- for (int Index = 0; Index < FPacketReservations->Count; Index++)
- {
- MessageNumber = FPacketNumbers.GetElement(Index);
- if (MessageNumber == Packet->MessageNumber)
- {
- ReservedPacket = (TSFTPPacket *)FPacketReservations->Items[Index];
- IsReserved = true;
- if (ReservedPacket)
- {
- *ReservedPacket = *Packet;
- }
- else
- {
- RemoveReservation(Index);
- }
- break;
- }
- }
- }
- }
- while (IsReserved);
- }
- if (ExpectedType >= 0)
- {
- if (Packet->Type == SSH_FXP_STATUS)
- {
- Result = GotStatusPacket(Packet, (AllowStatus >= 0 ? AllowStatus : asOK));
- }
- else if (ExpectedType != Packet->Type)
- {
- FTerminal->FatalError(FMTLOAD(SFTP_INVALID_TYPE, ((int)Packet->Type)));
- }
- }
- if (Reservation >= 0)
- {
- // order might have changed, when reserved, but not longer needed packet
- // was receive in above loop
- Reservation = FPacketReservations->IndexOf(Packet);
- assert(Reservation >= 0);
- assert(Packet->MessageNumber == (unsigned long)FPacketNumbers.GetElement(Reservation));
- RemoveReservation(Reservation);
- }
- }
- __finally
- {
- BusyEnd();
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ReserveResponse(const TSFTPPacket * Packet,
- TSFTPPacket * Response)
- {
- assert(FPacketReservations->IndexOf(Response) < 0);
- // mark response as not received yet
- Response->Capacity = 0;
- Response->ReservedBy = this;
- FPacketReservations->Add(Response);
- if (FPacketReservations->Count >= FPacketNumbers.ArrayHighBound())
- {
- FPacketNumbers.ArrayRedim(FPacketReservations->Count + 10);
- }
- FPacketNumbers.PutElement(Packet->MessageNumber, FPacketReservations->Count - 1);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::UnreserveResponse(TSFTPPacket * Response)
- {
- int Reservation = FPacketReservations->IndexOf(Response);
- if (Reservation >= 0)
- {
- FPacketReservations->Items[Reservation] = NULL;
- }
- }
- //---------------------------------------------------------------------------
- int __fastcall TSFTPFileSystem::ReceiveResponse(
- const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
- int AllowStatus)
- {
- int Result;
- unsigned int MessageNumber = Packet->MessageNumber;
- TSFTPPacket * AResponse = (Response ? Response : new TSFTPPacket());
- try
- {
- Result = ReceivePacket(AResponse, ExpectedType, AllowStatus);
- if (MessageNumber != AResponse->MessageNumber)
- {
- FTerminal->FatalError(FMTLOAD(SFTP_MESSAGE_NUMBER,
- ((int)AResponse->MessageNumber, (int)MessageNumber)));
- }
- }
- __finally
- {
- if (!Response) delete AResponse;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- int __fastcall TSFTPFileSystem::SendPacketAndReceiveResponse(
- const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
- int AllowStatus)
- {
- int Result;
- BusyStart();
- try
- {
- SendPacket(Packet);
- Result = ReceiveResponse(Packet, Response, ExpectedType, AllowStatus);
- }
- __finally
- {
- BusyEnd();
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- bool __fastcall inline TSFTPFileSystem::IsAbsolutePath(const AnsiString Path)
- {
- return !Path.IsEmpty() && Path[1] == '/';
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall TSFTPFileSystem::RealPath(const AnsiString Path)
- {
- try
- {
- TSFTPPacket Packet(SSH_FXP_REALPATH);
- Packet.AddString(Path);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_NAME);
- if (Packet.GetCardinal() != 1)
- {
- FTerminal->FatalError(LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
- }
- AnsiString RealDir = Packet.GetString();
- // ignore rest of SSH_FXP_NAME packet
- return RealDir;
- }
- catch(Exception & E)
- {
- if (FTerminal->Active)
- {
- throw ExtException(&E, FMTLOAD(SFTP_REALPATH_ERROR, (Path)));
- }
- else
- {
- throw;
- }
- }
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall TSFTPFileSystem::RealPath(const AnsiString Path,
- const AnsiString BaseDir)
- {
- AnsiString APath;
- if (IsAbsolutePath(Path))
- {
- APath = Path;
- }
- else
- {
- if (!BaseDir.IsEmpty())
- {
- APath = UnixIncludeTrailingBackslash(BaseDir);
- }
- if (!Path.IsEmpty())
- {
- APath = APath + Path;
- }
- if (APath.IsEmpty()) APath = UnixIncludeTrailingBackslash(".");
- }
- return RealPath(APath);
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall inline TSFTPFileSystem::LocalCanonify(const AnsiString Path)
- {
- // TODO: improve (handle .. etc.)
- if (IsAbsolutePath(Path)) return Path;
- else
- {
- return UnixIncludeTrailingBackslash(FCurrentDirectory) + Path;
- }
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall inline TSFTPFileSystem::Canonify(AnsiString Path)
- {
- // inspired by canonify() from PSFTP.C
- AnsiString Result;
- Path = LocalCanonify(Path);
- try
- {
- Result = RealPath(Path);
- }
- catch(...)
- {
- if (FTerminal->Active)
- {
- AnsiString APath = UnixExcludeTrailingBackslash(Path);
- AnsiString Name = UnixExtractFileName(APath);
- if (Name == "." || Name == "..")
- {
- Result = Path;
- }
- else
- {
- AnsiString FPath = UnixExcludeTrailingBackslash(UnixExtractFilePath(Path));
- try
- {
- Result = RealPath(FPath);
- Result = UnixIncludeTrailingBackslash(Result) + Name;
- }
- catch(...)
- {
- if (FTerminal->Active)
- {
- Result = Path;
- }
- else
- {
- throw;
- }
- }
- }
- }
- else
- {
- throw;
- }
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall TSFTPFileSystem::GetHomeDirectory()
- {
- if (FHomeDirectory.IsEmpty())
- {
- FHomeDirectory = RealPath(".");
- }
- return FHomeDirectory;
- }
- //---------------------------------------------------------------------------
- TRemoteFile * __fastcall TSFTPFileSystem::LoadFile(TSFTPPacket * Packet,
- TRemoteFile * ALinkedByFile)
- {
- TRemoteFile * File = new TRemoteFile(ALinkedByFile);
- try
- {
- File->Terminal = FTerminal;
- Packet->GetFile(File, FVersion);
- }
- catch(...)
- {
- delete File;
- throw;
- }
- return File;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SetCurrentDirectory(AnsiString value)
- {
- assert(false);
- }
- //---------------------------------------------------------------------------
- AnsiString __fastcall TSFTPFileSystem::GetCurrentDirectory()
- {
- return FCurrentDirectory;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::DoStartup()
- {
- TSFTPPacket Packet(SSH_FXP_INIT);
- Packet.AddCardinal(SFTPMaxVersion);
- try
- {
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_VERSION);
- }
- catch(Exception &E)
- {
- FTerminal->FatalError(&E, LoadStr(SFTP_INITIALIZE_ERROR));
- }
- FVersion = Packet.GetCardinal();
- FTerminal->LogEvent(FORMAT("SFTP version %d negotiated.", (FVersion)));
- if (FVersion < SFTPMinVersion || FVersion > SFTPMaxVersion)
- {
- FTerminal->FatalError(FMTLOAD(SFTP_VERSION_NOT_SUPPORTED,
- (FVersion, SFTPMinVersion, SFTPMaxVersion)));
- }
- if (FVersion >= 3)
- {
- FEOL = "\r\n";
- AnsiString ExtensionName;
- AnsiString ExtensionData;
- while (Packet.NextData)
- {
- ExtensionName = Packet.GetString();
- ExtensionData = Packet.GetString();
- if (ExtensionName == "newline")
- {
- FEOL = ExtensionData;
- AnsiString EOLHex;
- for (int i = 0; i < FEOL.Length(); i++)
- {
- EOLHex += IntToHex(FEOL[i+1], 2);
- }
- FTerminal->LogEvent(FORMAT("Server requests EOL sequence %s.", (EOLHex)));
- if (FEOL.Length() < 1 || FEOL.Length() > 2)
- {
- FTerminal->FatalError(FMTLOAD(SFTP_INVALID_EOL, (EOLHex)));
- }
- }
- else
- {
- FTerminal->LogEvent(FORMAT("Unknown server extension %s=%s",
- (ExtensionName, ExtensionData)));
- }
- }
- Packet.ChangeType(SSH_FXP_EXTENDED);
- Packet.AddString("[email protected]");
- int Status = SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS,
- asOK | asOpUnsupported);
- if (Status == SSH_FX_OK)
- {
- FTerminal->LogEvent("Server recognises WinSCP.");
- }
- else
- {
- FTerminal->LogEvent("Server does not recognise WinSCP.");
- }
- }
- }
- //---------------------------------------------------------------------------
- char * __fastcall TSFTPFileSystem::GetEOL() const
- {
- if (FVersion >= 4)
- {
- assert(!FEOL.IsEmpty());
- return FEOL.c_str();
- }
- else
- {
- return EOLToStr(FTerminal->SessionData->EOLType);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::LookupUserGroups()
- {
- assert(false);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ReadCurrentDirectory()
- {
- if (!FDirectoryToChangeTo.IsEmpty())
- {
- FCurrentDirectory = FDirectoryToChangeTo;
- FDirectoryToChangeTo = "";
- }
- else if (FCurrentDirectory.IsEmpty())
- {
- // this happens only after startup when default remote directory is not specified
- FCurrentDirectory = GetHomeDirectory();
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::HomeDirectory()
- {
- ChangeDirectory(GetHomeDirectory());
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::TryOpenDirectory(const AnsiString Directory)
- {
- TSFTPPacket Packet(SSH_FXP_OPENDIR);
- Packet.AddString(Directory);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
- AnsiString Handle = Packet.GetString();
- Packet.ChangeType(SSH_FXP_CLOSE);
- Packet.AddString(Handle);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ChangeDirectory(const AnsiString Directory)
- {
- AnsiString Path, Current;
- Current = !FDirectoryToChangeTo.IsEmpty() ? FDirectoryToChangeTo : FCurrentDirectory;
- Path = RealPath(Directory, Current);
- // to verify existence of directory try to open it (SSH_FXP_REALPATH succeeds
- // for invalid paths on some systems, like CygWin)
- TryOpenDirectory(Path);
- // if open dir did not fail, directory exists -> success.
- FDirectoryToChangeTo = Path;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ReadDirectory(TRemoteFileList * FileList)
- {
- assert(FileList && !FileList->Directory.IsEmpty());
- AnsiString Directory = LocalCanonify(FileList->Directory);
- FTerminal->LogEvent(FORMAT("Listing directory \"%s\".", (Directory)));
- TSFTPPacket Packet(SSH_FXP_OPENDIR);
- Packet.AddString(Directory);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
- AnsiString Handle = Packet.GetString();
- FileList->Clear();
- TSFTPPacket Response;
- try
- {
- bool isEOF = false;
- int Total = 0;
- TRemoteFile * File;
- Packet.ChangeType(SSH_FXP_READDIR);
- Packet.AddString(Handle);
- SendPacket(&Packet);
- do
- {
- ReceiveResponse(&Packet, &Response);
- if (Response.Type == SSH_FXP_NAME)
- {
- TSFTPPacket ListingPacket = Response;
- Packet.ChangeType(SSH_FXP_READDIR);
- Packet.AddString(Handle);
- SendPacket(&Packet);
- ReserveResponse(&Packet, &Response);
- unsigned int Count = ListingPacket.GetCardinal();
- for (unsigned long Index = 0; Index < Count; Index++)
- {
- File = LoadFile(&ListingPacket, NULL);
- FileList->AddFile(File);
- Total++;
- }
- }
- else if (Response.Type == SSH_FXP_STATUS)
- {
- isEOF = (GotStatusPacket(&Response, asEOF) == SSH_FX_EOF);
- }
- else
- {
- FTerminal->FatalError(FMTLOAD(SFTP_INVALID_TYPE, ((int)Response.Type)));
- }
- }
- while (!isEOF);
- if (Total == 0)
- {
- // Empty file list -> probably "permision denied", we
- // at least get link to parent directory ("..")
- try
- {
- FTerminal->ExceptionOnFail = true;
- try
- {
- File = NULL;
- FTerminal->ReadFile(
- UnixIncludeTrailingBackslash(FileList->Directory) + PARENTDIRECTORY, File);
- }
- __finally
- {
- FTerminal->ExceptionOnFail = false;
- }
- }
- catch(Exception &E)
- {
- if (E.InheritsFrom(__classid(EFatal))) throw;
- else File = NULL;
- }
- // on some systems even getting ".." fails, we create dummy ".." instead
- bool Failure = (File == NULL);
- if (Failure)
- {
- File = new TRemoteFile();
- File->FileName = PARENTDIRECTORY;
- File->Modification = Now();
- File->Type = FILETYPE_DIRECTORY;
- }
- assert(File && File->IsParentDirectory);
- FileList->AddFile(File);
- if (Failure)
- {
- throw Exception(FMTLOAD(EMPTY_DIRECTORY, (FileList->Directory)));
- }
- }
- }
- __finally
- {
- if (FTerminal->Active)
- {
- Packet.ChangeType(SSH_FXP_CLOSE);
- Packet.AddString(Handle);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ReadSymlink(TRemoteFile * SymlinkFile,
- TRemoteFile *& File)
- {
- assert(SymlinkFile && SymlinkFile->IsSymLink);
- assert(FVersion >= 3); // symlinks are supported with SFTP version 3 and later
- AnsiString FileName = LocalCanonify(SymlinkFile->FileName);
- TSFTPPacket ReadLinkPacket(SSH_FXP_READLINK);
- ReadLinkPacket.AddString(FileName);
- SendPacket(&ReadLinkPacket);
- ReserveResponse(&ReadLinkPacket, &ReadLinkPacket);
- // send second request before reading response to first one
- // (performance benefit)
- TSFTPPacket AttrsPacket(SSH_FXP_STAT);
- AttrsPacket.AddString(FileName);
- SendPacket(&AttrsPacket);
- ReserveResponse(&AttrsPacket, &AttrsPacket);
- ReceiveResponse(&ReadLinkPacket, &ReadLinkPacket, SSH_FXP_NAME);
- if (ReadLinkPacket.GetCardinal() != 1)
- {
- FTerminal->FatalError(LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
- }
- SymlinkFile->LinkTo = ReadLinkPacket.GetString();
- ReceiveResponse(&AttrsPacket, &AttrsPacket, SSH_FXP_ATTRS);
- File = LoadFile(&AttrsPacket, SymlinkFile);
- File->FileName = UnixExtractFileName(SymlinkFile->FileName);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ReadFile(const AnsiString FileName,
- TRemoteFile *& File)
- {
- CustomReadFile(FileName, File, SSH_FXP_LSTAT);
- }
- //---------------------------------------------------------------------------
- bool __fastcall inline TSFTPFileSystem::RemoteFileExists(const AnsiString FullPath,
- TRemoteFile ** File)
- {
- bool Result;
- try
- {
- TRemoteFile * AFile;
- ReadFile(FullPath, AFile);
- Result = true;
- if (File)
- {
- *File = AFile;
- }
- else
- {
- delete AFile;
- }
- }
- catch(...)
- {
- if (!FTerminal->Active)
- {
- throw;
- }
- Result = false;
- }
- return Result;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::CustomReadFile(const AnsiString FileName,
- TRemoteFile *& File, char Type, TRemoteFile * ALinkedByFile)
- {
- TSFTPPacket Packet(Type);
- Packet.AddString(LocalCanonify(FileName));
- if (FVersion >= 4)
- {
- Packet.AddCardinal(SSH_FILEXFER_ATTR_SIZE | SSH_FILEXFER_ATTR_PERMISSIONS |
- SSH_FILEXFER_ATTR_ACCESSTIME | SSH_FILEXFER_ATTR_MODIFYTIME |
- SSH_FILEXFER_ATTR_OWNERGROUP);
- }
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_ATTRS);
- File = LoadFile(&Packet, ALinkedByFile);
- File->FileName = UnixExtractFileName(FileName);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::DeleteFile(const AnsiString FileName,
- const TRemoteFile * File, bool Recursive)
- {
- char Type;
- AnsiString RealFileName = LocalCanonify(FileName);
- if (File && File->IsDirectory && !File->IsSymLink)
- {
- if (Recursive)
- {
- FTerminal->ProcessDirectory(FileName, FTerminal->DeleteFile, &Recursive);
- }
- Type = SSH_FXP_RMDIR;
- }
- else
- {
- Type = SSH_FXP_REMOVE;
- }
- TSFTPPacket Packet(Type);
- Packet.AddString(RealFileName);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::RenameFile(const AnsiString FileName,
- const AnsiString NewName)
- {
- TSFTPPacket Packet(SSH_FXP_RENAME);
- AnsiString RealName = LocalCanonify(FileName);
- Packet.AddString(RealName);
- Packet.AddString(UnixExtractFilePath(RealName) + NewName);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::CreateDirectory(const AnsiString DirName,
- const TRemoteProperties * Properties)
- {
- TSFTPPacket Packet(SSH_FXP_MKDIR);
- Packet.AddString(Canonify(DirName));
- Packet.AddProperties(Properties, 0, true, FVersion);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::CreateLink(const AnsiString FileName,
- const AnsiString PointTo, bool Symbolic)
- {
- assert(Symbolic); // only symlinks are supported by SFTP
- assert(FVersion >= 3); // symlinks are supported with SFTP version 3 and later
- TSFTPPacket Packet(SSH_FXP_SYMLINK);
- Packet.AddString(PointTo);
- Packet.AddString(Canonify(FileName));
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::ChangeFileProperties(const AnsiString FileName,
- const TRemoteFile * /*File*/, const TRemoteProperties * Properties)
- {
- assert(Properties);
- TRemoteFile * File;
- AnsiString RealFileName = LocalCanonify(FileName);
- ReadFile(RealFileName, File);
- try
- {
- assert(File);
- if (File->IsDirectory && Properties->Recursive)
- {
- FTerminal->ProcessDirectory(FileName, FTerminal->ChangeFileProperties,
- (void*)Properties);
- }
- TSFTPPacket Packet(SSH_FXP_SETSTAT);
- Packet.AddString(RealFileName);
- Packet.AddProperties(Properties, *File->Rights, File->IsDirectory, FVersion);
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
- }
- __finally
- {
- delete File;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::CustomCommandOnFile(const AnsiString /*FileName*/,
- const TRemoteFile * /*File*/, AnsiString /*Command*/)
- {
- assert(false);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::AnyCommand(const AnsiString /*Command*/)
- {
- assert(false);
- }
- //---------------------------------------------------------------------------
- // transfer protocol
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::CopyToRemote(TStrings * FilesToCopy,
- const AnsiString TargetDir, const TCopyParamType * CopyParam,
- int Params, TFileOperationProgressType * OperationProgress,
- bool & DisconnectWhenComplete)
- {
- assert(FilesToCopy && OperationProgress);
- AnsiString FileName, FileNameOnly;
- AnsiString FullTargetDir = UnixIncludeTrailingBackslash(TargetDir);
- int Index = 0;
- while (Index < FilesToCopy->Count && !OperationProgress->Cancel)
- {
- bool Success = false;
- FileName = FilesToCopy->Strings[Index];
- FileNameOnly = ExtractFileName(FileName);
- assert(!FAvoidBusy);
- FAvoidBusy = true;
- try
- {
- try
- {
- if (FTerminal->SessionData->CacheDirectories)
- {
- FTerminal->DirectoryModified(TargetDir, false);
- if (DirectoryExists(FileName))
- {
- FTerminal->DirectoryModified(UnixIncludeTrailingBackslash(TargetDir)+
- FileNameOnly, true);
- }
- }
- SFTPSource(FileName, FullTargetDir, CopyParam, Params, OperationProgress);
- Success = true;
- }
- catch(EScpSkipFile & E)
- {
- SUSPEND_OPERATION (
- if (!FTerminal->HandleException(&E)) throw;
- );
- }
- catch(...)
- {
- throw;
- }
- }
- __finally
- {
- FAvoidBusy = false;
- OperationProgress->Finish(FileNameOnly, Success, DisconnectWhenComplete);
- }
- Index++;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SFTPConfirmOverwrite(const AnsiString FileName,
- TFileOperationProgressType * OperationProgress)
- {
- if (OperationProgress->NoToAll)
- {
- THROW_SKIP_FILE_NULL;
- }
- else
- {
- AnsiString QuestionFmt = LoadStr(FILE_OVERWRITE);
- int Answer;
- SUSPEND_OPERATION
- (
- Answer = FTerminal->DoQueryUser(
- FORMAT(QuestionFmt, (FileName)),
- qaYes | qaNo | qaAbort | qaYesToAll | qaNoToAll, qpNeverAskAgainCheck);
- );
- switch (Answer) {
- case qaNeverAskAgain:
- FTerminal->Configuration->ConfirmOverwriting = false;
- case qaYesToAll:
- OperationProgress->YesToAll = true;
- case qaYes:
- // file overwriting was confirmed, try to open file
- // second time, now without exclusive flag (SSH_FXF_EXCL)
- break;
- case qaAbort:
- if (!OperationProgress->Cancel)
- {
- OperationProgress->Cancel = csCancel;
- }
- Abort();
- break;
- case qaNoToAll:
- OperationProgress->NoToAll = true;
- case qaNo:
- THROW_SKIP_FILE_NULL;
- }
- }
- }
- //---------------------------------------------------------------------------
- bool TSFTPFileSystem::SFTPConfirmResume(const AnsiString DestFileName,
- bool PartialBiggerThanSource, TFileOperationProgressType * OperationProgress)
- {
- bool ResumeTransfer;
- assert(OperationProgress);
- if (PartialBiggerThanSource)
- {
- int Answer;
- SUSPEND_OPERATION
- (
- Answer = FTerminal->DoQueryUser(
- FMTLOAD(PARTIAL_BIGGER_THAN_SOURCE, (DestFileName)), NULL,
- qaOK | qaAbort, qpAllowContinueOnError, qtWarning);
- )
- if (Answer == qaAbort)
- {
- if (!OperationProgress->Cancel)
- {
- OperationProgress->Cancel = csCancel;
- }
- Abort();
- }
- ResumeTransfer = false;
- }
- else
- {
- int Answer;
- SUSPEND_OPERATION
- (
- Answer = FTerminal->DoQueryUser(
- FMTLOAD(RESUME_TRANSFER, (DestFileName)), qaYes | qaNo | qaAbort,
- qpAllowContinueOnError);
- );
- switch (Answer) {
- case qaYes:
- ResumeTransfer = true;
- break;
- case qaNo:
- ResumeTransfer = false;
- break;
- case qaAbort:
- if (!OperationProgress->Cancel)
- {
- OperationProgress->Cancel = csCancel;
- }
- Abort();
- break;
- }
- }
- return ResumeTransfer;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SFTPSource(const AnsiString FileName,
- const AnsiString TargetDir, const TCopyParamType * CopyParam, int Params,
- TFileOperationProgressType * OperationProgress)
- {
- FTerminal->LogEvent(FORMAT("File: \"%s\"", (FileName)));
- OperationProgress->SetFile(FileName);
- TOpenRemoteFileParams OpenParams;
- HANDLE File;
- unsigned long MTime, ATime;
- __int64 Size;
- FTerminal->OpenLocalFile(FileName, GENERIC_READ, &OpenParams.LocalFileAttrs,
- &File, NULL, &MTime, &ATime, &Size);
- if (OpenParams.LocalFileAttrs & faDirectory)
- {
- SFTPDirectorySource(IncludeTrailingBackslash(FileName), TargetDir,
- OpenParams.LocalFileAttrs, CopyParam, Params, OperationProgress);
- }
- else
- try
- {
- // File is regular file (not directory)
- assert(File);
- AnsiString DestFileName = CopyParam->ChangeFileName(ExtractFileName(FileName), osLocal);
- AnsiString DestFullName = LocalCanonify(TargetDir + DestFileName);
- AnsiString DestPartinalFullName;
- bool ResumeAllowed;
- bool ResumeTransfer = false;
- bool DestFileExists = false;
- __int64 ResumeOffset;
- FTerminal->LogEvent(FORMAT("Copying \"%s\" to remote directory started.", (FileName)));
- OperationProgress->SetLocalSize(Size);
- // Suppose same data size to transfer as to read
- // (not true with ASCII transfer)
- OperationProgress->SetTransferSize(OperationProgress->LocalSize);
- OperationProgress->TransferingFile = false;
- // Will we use ASCII of BINARY file tranfer?
- OperationProgress->SetAsciiTransfer(CopyParam->UseAsciiTransfer(FileName));
- FTerminal->LogEvent(
- AnsiString((OperationProgress->AsciiTransfer ? "Ascii" : "Binary")) +
- " transfer mode selected.");
- ResumeAllowed = !OperationProgress->AsciiTransfer &&
- CopyParam->AllowResume(OperationProgress->LocalSize);
- OperationProgress->SetResumeStatus(ResumeAllowed ? rsEnabled : rsDisabled);
- if (ResumeAllowed)
- {
- DestPartinalFullName = DestFullName + FTerminal->Configuration->PartialExt;
- FTerminal->LogEvent("Checking existence of file.");
- DestFileExists = RemoteFileExists(DestFullName);
- TRemoteFile * File;
- FTerminal->LogEvent("Checking existence of partially transfered file.");
- if (RemoteFileExists(DestPartinalFullName, &File))
- {
- ResumeOffset = File->Size;
- delete File;
- ResumeTransfer = SFTPConfirmResume(DestFileName,
- ResumeOffset > OperationProgress->LocalSize, OperationProgress);
-
- if (!ResumeTransfer)
- {
- DeleteFile(DestPartinalFullName);
- }
- else
- {
- FTerminal->LogEvent("Resuming file transfer.");
- }
- }
- else
- {
- // partial upload file does not exists, check for full file
- if (DestFileExists && FTerminal->Configuration->ConfirmOverwriting &&
- !OperationProgress->YesToAll && !(Params & cpNoConfirmation))
- {
- SFTPConfirmOverwrite(DestFileName, OperationProgress);
- }
- }
- }
- OpenParams.RemoteFileName = ResumeAllowed ? DestPartinalFullName : DestFullName;
- OpenParams.Resume = ResumeAllowed;
- OpenParams.OperationProgress = OperationProgress;
- OpenParams.CopyParam = CopyParam;
- OpenParams.Params = Params;
- FTerminal->LogEvent("Opening remote file.");
- FTerminal->FileOperationLoop(SFTPOpenRemote, OperationProgress, true,
- FMTLOAD(SFTP_CREATE_FILE_ERROR, (OpenParams.RemoteFileName)),
- &OpenParams);
- bool DeleteFileAfter = true;
- try
- {
- if (ResumeTransfer)
- {
- FileSeek((THandle)File, ResumeOffset, 0);
- OperationProgress->AddResumed(ResumeOffset);
- }
- TSFTPPacket DataPacket;
- bool Eof;
- do
- {
- // Buffer for one block of data
- TFileBuffer BlockBuf;
- FILE_OPERATION_LOOP(FileName,
- FMTLOAD(READ_ERROR, (FileName)),
- BlockBuf.LoadFile(File, OperationProgress->StaticBlockSize(), false);
- );
- Eof = (BlockBuf.Size == 0);
- if (!Eof)
- {
- OperationProgress->AddLocalyUsed(BlockBuf.Size);
- // We do ASCII transfer: convert EOL of current block
- if (OperationProgress->AsciiTransfer)
- {
- assert(!ResumeTransfer && !ResumeAllowed);
- __int64 PrevBufSize = BlockBuf.Size;
- BlockBuf.ConvertEOL(FTerminal->Configuration->LocalEOLType,
- GetEOL());
- // update transfer size with difference arised from EOL conversion
- OperationProgress->SetTransferSize(OperationProgress->TransferSize -
- PrevBufSize + BlockBuf.Size);
- }
- FILE_OPERATION_LOOP(OpenParams.RemoteFileName,
- FMTLOAD(WRITE_ERROR, (OpenParams.RemoteFileName)),
- DataPacket.ChangeType(SSH_FXP_WRITE);
- DataPacket.AddString(OpenParams.RemoteFileHandle);
- DataPacket.AddInt64(OperationProgress->TransferedSize);
- DataPacket.AddData(BlockBuf.Data, BlockBuf.Size);
- SendPacketAndReceiveResponse(&DataPacket, &DataPacket, SSH_FXP_STATUS);
- );
- OperationProgress->AddTransfered(BlockBuf.Size);
- if (OperationProgress->Cancel == csCancel)
- {
- Abort();
- }
- }
- }
- while (!Eof);
- DeleteFileAfter = false;
- }
- __finally
- {
- if (FTerminal->Active)
- {
- FILE_OPERATION_LOOP(DestFileName,
- FMTLOAD(SFTP_CLOSE_FILE_ERROR, (DestFileName)),
- TSFTPPacket CloseRequest(SSH_FXP_CLOSE);
- CloseRequest.AddString(OpenParams.RemoteFileHandle);
- SendPacketAndReceiveResponse(&CloseRequest, NULL, SSH_FXP_STATUS);
- );
- // delete file if transfer was not completed and resuming is not allowed
- if (DeleteFileAfter && !ResumeAllowed)
- {
- DeleteFile(OpenParams.RemoteFileName);
- }
- }
- }
- // originally this was before CLOSE (last __finally statement),
- // on VShell it failed
- if (ResumeAllowed)
- {
- FILE_OPERATION_LOOP(DestFileName,
- FMTLOAD(RENAME_AFTER_RESUME_ERROR,
- (UnixExtractFileName(OpenParams.RemoteFileName), DestFileName)),
- if (DestFileExists)
- {
- DeleteFile(DestFullName);
- DestFileExists = false;
- }
- RenameFile(OpenParams.RemoteFileName, DestFileName);
- );
- }
- if (CopyParam->PreserveTime)
- {
- FILE_OPERATION_LOOP(DestFileName,
- FMTLOAD(CHANGE_PROPERTIES_ERROR, (DestFileName)),
- TSFTPPacket Packet(SSH_FXP_SETSTAT);
- Packet.AddString(DestFullName);
- if (FVersion >= 4)
- {
- Packet.AddCardinal(SSH_FILEXFER_ATTR_ACCESSTIME |
- SSH_FILEXFER_ATTR_MODIFYTIME);
- Packet.AddByte(SSH_FILEXFER_TYPE_REGULAR);
- Packet.AddInt64(ATime);
- Packet.AddInt64(MTime);
- }
- else
- {
- Packet.AddCardinal(SSH_FILEXFER_ATTR_ACMODTIME);
- Packet.AddCardinal(ATime);
- Packet.AddCardinal(MTime);
- }
- SendPacketAndReceiveResponse(&Packet, NULL, SSH_FXP_STATUS);
- );
- }
- }
- __finally
- {
- CloseHandle(File);
- }
- /* TODO : Delete also read-only files. */
- /* TODO : Show error message on failure. */
- if (Params & cpDelete) Sysutils::DeleteFile(FileName);
- }
- //---------------------------------------------------------------------------
- int __fastcall TSFTPFileSystem::SFTPOpenRemote(void * AOpenParams, void * /*Param2*/)
- {
- TOpenRemoteFileParams * OpenParams = (TOpenRemoteFileParams *)AOpenParams;
- assert(OpenParams);
- TFileOperationProgressType * OperationProgress = OpenParams->OperationProgress;
- TSFTPPacket OpenRequest;
- int OpenType;
- bool Confirmed = false;
- bool Success = false;
- do
- {
- try
- {
- OpenType = 0;
- OpenRequest.ChangeType(SSH_FXP_OPEN);
- if (FTerminal->Configuration->ConfirmOverwriting &&
- !Confirmed && !OperationProgress->YesToAll && !OpenParams->Resume &&
- !(OpenParams->Params & cpNoConfirmation))
- {
- OpenType |= SSH_FXF_EXCL;
- }
- if (!OpenParams->Resume)
- {
- OpenType |= SSH_FXF_TRUNC;
- }
- if ((FVersion >= 4) && OpenParams->OperationProgress->AsciiTransfer)
- {
- OpenType |= SSH_FXF_TEXT;
- }
- OpenRequest.AddString(OpenParams->RemoteFileName);
- OpenRequest.AddCardinal(SSH_FXF_WRITE | SSH_FXF_CREAT | OpenType );
- OpenRequest.AddCardinal(
- OpenParams->CopyParam->PreserveRights ? SSH_FILEXFER_ATTR_PERMISSIONS : 0);
- if (FVersion >= 4)
- {
- OpenRequest.AddByte(SSH_FILEXFER_TYPE_REGULAR);
- }
- if (OpenParams->CopyParam->PreserveRights)
- {
- OpenRequest.AddCardinal(
- OpenParams->CopyParam->RemoteFileRights(OpenParams->LocalFileAttrs));
- }
- SendPacketAndReceiveResponse(&OpenRequest, &OpenRequest, SSH_FXP_HANDLE);
- OpenParams->RemoteFileHandle = OpenRequest.GetString();
- Success = true;
- }
- catch(Exception & E)
- {
- if (!Confirmed && (OpenType & SSH_FXF_EXCL) && FTerminal->Active)
- {
- // When exclusive opening of file fails, try to detect if file exists.
- // When file does not exist, failure was probably caused by 'permission denied'
- // or similar error. In this case throw original exception.
- try
- {
- TRemoteFile * File;
- AnsiString RealFileName = LocalCanonify(OpenParams->RemoteFileName);
- ReadFile(RealFileName, File);
- // file exists (otherwise exception was thrown)
- assert(File);
- SAFE_DESTROY(File);
- }
- catch(...)
- {
- if (!FTerminal->Active)
- {
- throw;
- }
- else
- {
- throw E;
- }
- }
- // confirmation duplicated in SFTPSource for resumable file transfers.
- SFTPConfirmOverwrite(UnixExtractFileName(OpenParams->RemoteFileName),
- OperationProgress);
- Confirmed = true;
- }
- else
- {
- throw;
- }
- }
- }
- while (!Success);
- return 0;
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SFTPDirectorySource(const AnsiString DirectoryName,
- const AnsiString TargetDir, int Attrs, const TCopyParamType * CopyParam,
- int Params, TFileOperationProgressType * OperationProgress)
- {
- AnsiString DestDirectoryName = CopyParam->ChangeFileName(
- ExtractFileName(ExcludeTrailingBackslash(DirectoryName)), osLocal);
- AnsiString DestFullName = UnixIncludeTrailingBackslash(TargetDir + DestDirectoryName);
- OperationProgress->SetFile(DirectoryName);
- try
- {
- TryOpenDirectory(DestFullName);
- }
- catch(...)
- {
- if (FTerminal->Active)
- {
- // opening directory failed, it probably does not exists, try to
- // create it
- TRemoteProperties Properties;
- if (CopyParam->PreserveRights)
- {
- Properties.Valid = TValidProperties() << vpRights;
- Properties.Rights = CopyParam->RemoteFileRights(Attrs);
- }
- FTerminal->CreateDirectory(DestFullName, &Properties);
- }
- else
- {
- throw;
- }
- }
- int FindAttrs = faReadOnly | faHidden | faSysFile | faDirectory | faArchive;
- TSearchRec SearchRec;
- bool FindOK;
- FILE_OPERATION_LOOP (DirectoryName, FMTLOAD(LIST_DIR_ERROR, (DirectoryName)),
- FindOK = (bool)(FindFirst(DirectoryName + "*.*",
- FindAttrs, SearchRec) == 0);
- );
- while (FindOK && !OperationProgress->Cancel)
- {
- AnsiString FileName = DirectoryName + SearchRec.Name;
- try
- {
- if ((SearchRec.Name != ".") && (SearchRec.Name != ".."))
- {
- SFTPSource(FileName, DestFullName, CopyParam, Params, OperationProgress);
- }
- }
- catch (EScpSkipFile &E)
- {
- // If ESkipFile occurs, just log it and continue with next file
- SUSPEND_OPERATION (
- if (FTerminal->DoQueryUser(FMTLOAD(COPY_ERROR, (FileName)), E.Message,
- qaOK | qaAbort, qpAllowContinueOnError) == qaAbort)
- {
- OperationProgress->Cancel = csCancel;
- }
- if (!FTerminal->HandleException(&E)) throw;
- );
- }
- FILE_OPERATION_LOOP (DirectoryName, FMTLOAD(LIST_DIR_ERROR, (DirectoryName)),
- FindOK = (FindNext(SearchRec) == 0);
- );
- };
- FindClose(SearchRec);
- /* TODO : Delete also read-only directories. */
- /* TODO : Show error message on failure. */
- if ((Params & cpDelete) && !OperationProgress->Cancel) RemoveDir(DirectoryName);
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::CopyToLocal(TStrings * FilesToCopy,
- const AnsiString TargetDir, const TCopyParamType * CopyParam,
- int Params, TFileOperationProgressType * OperationProgress,
- bool & DisconnectWhenComplete)
- {
- assert(FilesToCopy && OperationProgress);
- AnsiString FileName, FileNameOnly;
- AnsiString FullTargetDir = IncludeTrailingBackslash(TargetDir);
- const TRemoteFile * File;
- bool Success;
- int Index = 0;
- while (Index < FilesToCopy->Count && !OperationProgress->Cancel)
- {
- Success = false;
- FileName = FilesToCopy->Strings[Index];
- FileNameOnly = UnixExtractFileName(FileName);
- File = (TRemoteFile *)FilesToCopy->Objects[Index];
- assert(!FAvoidBusy);
- FAvoidBusy = true;
- try
- {
- try
- {
- SFTPSink(LocalCanonify(FileName), File, FullTargetDir, CopyParam,
- Params, OperationProgress);
- Success = true;
- }
- catch(EScpSkipFile & E)
- {
- SUSPEND_OPERATION (
- if (!FTerminal->HandleException(&E)) throw;
- );
- }
- /*catch(...)
- {
- throw;
- } */
- }
- __finally
- {
- FAvoidBusy = false;
- OperationProgress->Finish(FileNameOnly, Success, DisconnectWhenComplete);
- }
- Index++;
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SFTPSink(const AnsiString FileName,
- const TRemoteFile * File, const AnsiString TargetDir,
- const TCopyParamType * CopyParam, int Params,
- TFileOperationProgressType * OperationProgress)
- {
- assert(File);
- FTerminal->LogEvent(FORMAT("File: \"%s\"", (FileName)));
- AnsiString OnlyFileName = UnixExtractFileName(FileName);
- OperationProgress->SetFile(OnlyFileName);
- AnsiString DestFileName = CopyParam->ChangeFileName(OnlyFileName, osRemote);
- AnsiString DestFullName = TargetDir + DestFileName;
- if (File->IsDirectory)
- {
- FILE_OPERATION_LOOP (DestFullName, FMTLOAD(NOT_DIRECTORY_ERROR, (DestFullName)),
- int Attrs = FileGetAttr(DestFullName);
- if ((Attrs & faDirectory) == 0) EXCEPTION;
- );
- FILE_OPERATION_LOOP (DestFullName, FMTLOAD(CREATE_DIR_ERROR, (DestFullName)),
- if (!ForceDirectories(DestFullName)) EXCEPTION;
- );
- TSinkFileParams SinkFileParams;
- SinkFileParams.TargetDir = IncludeTrailingBackslash(DestFullName);
- SinkFileParams.CopyParam = CopyParam;
- SinkFileParams.Params = Params;
- SinkFileParams.OperationProgress = OperationProgress;
- SinkFileParams.Skipped = false;
- FTerminal->ProcessDirectory(FileName, SFTPSinkFile, &SinkFileParams);
- // Do not delete directory if some of its files were skip.
- // Throw "skip file" for the directory to avoid attempt to deletion
- // of any parent directory
- if ((Params & cpDelete) && SinkFileParams.Skipped)
- {
- THROW_SKIP_FILE_NULL;
- }
- }
- else
- {
- FTerminal->LogEvent(FORMAT("Copying \"%s\" to local directory started.", (FileName)));
- AnsiString DestPartinalFullName;
- bool ResumeAllowed;
- bool ResumeTransfer = false;
- //bool DestFileExists = false;
- __int64 ResumeOffset;
- // Will we use ASCII of BINARY file tranfer?
- OperationProgress->SetAsciiTransfer(CopyParam->UseAsciiTransfer(DestFileName));
- FTerminal->LogEvent(AnsiString((OperationProgress->AsciiTransfer ? "Ascii" : "Binary")) +
- " transfer mode selected.");
- // Suppose same data size to transfer as to write
- // (not true with ASCII transfer)
- OperationProgress->SetTransferSize(File->Size);
- OperationProgress->SetLocalSize(OperationProgress->TransferSize);
- // resume has no sense for drag&drop downloads, because files are downloaded
- // to temp directory, but anyway TTerminal does know this, so the condition
- // placement is currently wrong.
- ResumeAllowed = ((Params & cpDragDrop) == 0) &&
- !OperationProgress->AsciiTransfer &&
- CopyParam->AllowResume(OperationProgress->TransferSize);
- OperationProgress->SetResumeStatus(ResumeAllowed ? rsEnabled : rsDisabled);
- int Attrs;
- FILE_OPERATION_LOOP (DestFullName, FMTLOAD(NOT_FILE_ERROR, (DestFullName)),
- Attrs = FileGetAttr(DestFullName);
- if ((Attrs >= 0) && (Attrs & faDirectory)) EXCEPTION;
- );
- OperationProgress->TransferingFile = false; // not set with SFTP protocol
- HANDLE LocalHandle = NULL;
- TStream * FileStream = NULL;
- bool DeleteLocalFile = false;
- AnsiString RemoteHandle;
- AnsiString LocalFileName = DestFullName;
- try
- {
- if (ResumeAllowed)
- {
- DestPartinalFullName = DestFullName + FTerminal->Configuration->PartialExt;
- LocalFileName = DestPartinalFullName;
- FTerminal->LogEvent("Checking existence of partially transfered file.");
- if (FileExists(DestPartinalFullName))
- {
- FTerminal->OpenLocalFile(DestPartinalFullName, GENERIC_WRITE,
- NULL, &LocalHandle, NULL, NULL, NULL, &ResumeOffset);
- ResumeTransfer = SFTPConfirmResume(DestFileName,
- ResumeOffset > OperationProgress->TransferSize, OperationProgress);
- if (!ResumeTransfer)
- {
- CloseHandle(LocalHandle);
- LocalHandle = NULL;
- Sysutils::DeleteFile(DestPartinalFullName);
- }
- else
- {
- FTerminal->LogEvent("Resuming file transfer.");
- FileSeek((THandle)LocalHandle, ResumeOffset, 0);
- OperationProgress->AddResumed(ResumeOffset);
- }
- }
- }
- if (Attrs >= 0 && FTerminal->Configuration->ConfirmOverwriting &&
- !OperationProgress->YesToAll && !ResumeTransfer &&
- !(Params & cpNoConfirmation))
- {
- FTerminal->LogEvent("Checking existence of file.");
- SFTPConfirmOverwrite(DestFileName, OperationProgress);
- }
- // if not resuming, create new empty file
- if (!ResumeTransfer)
- {
- // Create file
- FILE_OPERATION_LOOP (DestFullName, FMTLOAD(CREATE_FILE_ERROR, (DestFullName)),
- LocalHandle = CreateFile(LocalFileName.c_str(), GENERIC_WRITE, 0, NULL,
- CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, 0);
- if (LocalHandle == INVALID_HANDLE_VALUE) EXCEPTION;
- );
- }
- assert(LocalHandle);
- DeleteLocalFile = true;
- FTerminal->LogEvent("Opening remote file.");
- FILE_OPERATION_LOOP (FileName, FMTLOAD(SFTP_OPEN_FILE_ERROR, (FileName)),
- TSFTPPacket Packet;
- Packet.ChangeType(SSH_FXP_OPEN);
- Packet.AddString(FileName);
- int OpenType = SSH_FXF_READ;
- if ((FVersion >= 4) && OperationProgress->AsciiTransfer)
- {
- OpenType |= SSH_FXF_TEXT;
- }
- Packet.AddCardinal(OpenType);
- Packet.AddCardinal(0); // no attrs
- if (FVersion >= 4)
- {
- Packet.AddCardinal(SSH_FILEXFER_TYPE_REGULAR);
- }
- SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
- RemoteHandle = Packet.GetString();
- );
- FileStream = new THandleStream((THandle)LocalHandle);
- TSFTPPacket DataPacket;
- bool Eof = false;
- while (!Eof)
- {
- // Buffer for one block of data
- TFileBuffer BlockBuf;
- unsigned long BlockSize = OperationProgress->StaticBlockSize();
- FILE_OPERATION_LOOP(FileName,
- FMTLOAD(READ_ERROR, (FileName)),
- DataPacket.ChangeType(SSH_FXP_READ);
- DataPacket.AddString(RemoteHandle);
- DataPacket.AddInt64(OperationProgress->TransferedSize);
- DataPacket.AddCardinal(BlockSize);
- SendPacketAndReceiveResponse(&DataPacket, &DataPacket,
- SSH_FXP_DATA, asEOF);
- if (DataPacket.Type == SSH_FXP_STATUS)
- {
- // must be SSH_FX_EOF, any other status packet would raise exception
- Eof = true;
- }
- );
- if (!Eof)
- {
- unsigned long DataLen = DataPacket.GetCardinal();
- assert(DataLen <= BlockSize);
- BlockBuf.Insert(0, DataPacket.NextData, DataLen);
- OperationProgress->AddTransfered(DataLen);
- if (OperationProgress->AsciiTransfer)
- {
- assert(!ResumeTransfer && !ResumeAllowed);
- unsigned int PrevBlockSize = BlockBuf.Size;
- BlockBuf.ConvertEOL(GetEOL(),
- FTerminal->Configuration->LocalEOLType);
- OperationProgress->SetLocalSize(
- OperationProgress->LocalSize - PrevBlockSize + BlockBuf.Size);
- }
- FILE_OPERATION_LOOP (
- DestFullName, FMTLOAD(WRITE_ERROR, (LocalFileName)),
- BlockBuf.WriteToStream(FileStream, BlockBuf.Size);
- );
- OperationProgress->AddLocalyUsed(BlockBuf.Size);
- if (OperationProgress->Cancel == csCancel)
- {
- Abort();
- }
- }
- };
- if (CopyParam->PreserveTime)
- {
- FILETIME AcTime = DateTimeToFileTime(File->LastAccess);
- FILETIME WrTime = DateTimeToFileTime(File->Modification);
- SetFileTime(LocalHandle, NULL, &AcTime, &WrTime);
- }
- CloseHandle(LocalHandle);
- LocalHandle = NULL;
- if (ResumeAllowed)
- {
- FILE_OPERATION_LOOP(DestFileName,
- FMTLOAD(RENAME_AFTER_RESUME_ERROR,
- (ExtractFileName(DestPartinalFullName), DestFileName)),
- if (FileExists(DestFullName))
- {
- if (!Sysutils::DeleteFile(DestFullName)) EXCEPTION;
- }
- if (!Sysutils::RenameFile(DestPartinalFullName, DestFullName))
- {
- EXCEPTION;
- }
- );
- }
- DeleteLocalFile = false;
- }
- __finally
- {
- if (LocalHandle) CloseHandle(LocalHandle);
- if (FileStream) delete FileStream;
- if (DeleteLocalFile && (!ResumeAllowed || OperationProgress->LocalyUsed == 0))
- {
- Sysutils::DeleteFile(LocalFileName);
- }
- if (FTerminal->Active && !RemoteHandle.IsEmpty())
- {
- FILE_OPERATION_LOOP(FileName,
- FMTLOAD(SFTP_CLOSE_FILE_ERROR, (DestFileName)),
- TSFTPPacket CloseRequest(SSH_FXP_CLOSE);
- CloseRequest.AddString(RemoteHandle);
- SendPacketAndReceiveResponse(&CloseRequest, NULL, SSH_FXP_STATUS);
- );
- }
- }
- }
- if (Params & cpDelete)
- {
- // If file is directory, do not delete it recursively, because it should be
- // empty already. If not, it should not be deleted (some files were
- // skipped or some new files were copied to it, while we were downloading)
- bool Recursive = false;
- FTerminal->DeleteFile(FileName, File, &Recursive);
- }
- }
- //---------------------------------------------------------------------------
- void __fastcall TSFTPFileSystem::SFTPSinkFile(AnsiString FileName,
- const TRemoteFile * File, void * Param)
- {
- TSinkFileParams * Params = (TSinkFileParams *)Param;
- assert(Params->OperationProgress);
- try
- {
- SFTPSink(FileName, File, Params->TargetDir, Params->CopyParam,
- Params->Params, Params->OperationProgress);
- }
- catch(EScpSkipFile & E)
- {
- TFileOperationProgressType * OperationProgress = Params->OperationProgress;
- Params->Skipped = true;
- SUSPEND_OPERATION (
- if (!FTerminal->HandleException(&E)) throw;
- );
- if (OperationProgress->Cancel)
- {
- Abort();
- }
- }
- }
|