| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251 | /******************************************************************************* copyright: Copyright (c) 2007-2008 Tango. All rights reserved license: BSD style: $(LICENSE) version: August 2008: Initial version author: Lester L. Martin II *******************************************************************************/ module tango.io.vfs.FtpFolder; private { import tango.net.ftp.FtpClient; import tango.io.vfs.model.Vfs; import tango.io.vfs.FileFolder; import tango.io.device.Conduit; import tango.text.Util; import tango.time.Time; } private char[] fixName(char[] toFix) { if (containsPattern(toFix, "/")) toFix = toFix[(locatePrior(toFix, '/') + 1) .. length]; return toFix; } private char[] checkFirst(char[] toFix) { for(; toFix.length>0 && toFix[$-1] == '/';) toFix = toFix[0 .. ($-1)]; return toFix; } private char[] checkLast(char[] toFix) { for(;toFix.length>1 && toFix[0] == '/' && toFix[1] == '/' ;) toFix = toFix[1 .. $]; if(toFix.length && toFix[0] != '/') toFix = '/' ~ toFix; return toFix; } private char[] checkCat(char[] first, char[] last) { return checkFirst(first) ~ checkLast(last); } private FtpFileInfo[] getEntries(FTPConnection ftp, char[] path = "") { FtpFileInfo[] orig = ftp.ls(path); FtpFileInfo[] temp2; FtpFileInfo[] use; FtpFileInfo[] temp; foreach(FtpFileInfo inf; orig) { if(inf.type == FtpFileType.dir) { temp ~= inf; } } foreach(FtpFileInfo inf; temp) { temp2 ~= getEntries((ftp.cd(inf.name) , ftp)); //wasn't here at the beginning foreach(inf2; temp2) { inf2.name = checkCat(inf.name, inf2.name); use ~= inf2; } orig ~= use; //end wasn't here at the beginning ftp.cdup(); } return orig; } private FtpFileInfo[] getFiles(FTPConnection ftp, char[] path = "") { FtpFileInfo[] infos = getEntries(ftp, path); FtpFileInfo[] return_; foreach(FtpFileInfo info; infos) { if(info.type == FtpFileType.file || info.type == FtpFileType.other || info.type == FtpFileType.unknown) return_ ~= info; } return return_; } private FtpFileInfo[] getFolders(FTPConnection ftp, char[] path = "") { FtpFileInfo[] infos = getEntries(ftp, path); FtpFileInfo[] return_; foreach(FtpFileInfo info; infos) { if(info.type == FtpFileType.dir || info.type == FtpFileType.cdir || info.type == FtpFileType.pdir) return_ ~= info; } return return_; } /****************************************************************************** Defines a folder over FTP that has yet to be opened, may not exist, and may be created. ******************************************************************************/ class FtpFolderEntry: VfsFolderEntry { char[] toString_, name_, username_, password_; uint port_; public this(char[] server, char[] path, char[] username = "", char[] password = "", uint port = 21) in { assert(server.length > 0); } body { toString_ = checkFirst(server); name_ = checkLast(path); username_ = username; password_ = password; port_ = port; } /*********************************************************************** Open a folder. ***********************************************************************/ final VfsFolder open() { return new FtpFolder(toString_, name_, username_, password_, port_); } /*********************************************************************** Create a new folder. ***********************************************************************/ final VfsFolder create() { FTPConnection conn; scope(failure) { if(conn !is null) conn.close(); } scope(exit) { if(conn !is null) conn.close(); } conn = new FTPConnection(toString_, username_, password_, port_); conn.mkdir(name_); return new FtpFolder(toString_, name_, username_, password_, port_); } /*********************************************************************** Test to see if a folder exists. ***********************************************************************/ final bool exists() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } bool return_; if(name_ == "") { try { conn = new FTPConnection(toString_, username_, password_, port_); return_ = true; } catch(Exception e) { return false; } } else { try { conn = new FTPConnection(toString_, username_, password_, port_); try { conn.cd(name_); return_ = true; } catch(Exception e) { if(conn.exist(name_) == 2) return_ = true; else return_ = false; } } catch(Exception e) { return_ = false; } } return return_; } } /****************************************************************************** Represents a FTP Folder in full, allowing one to address specific folders of an FTP File system. ******************************************************************************/ class FtpFolder: VfsFolder { char[] toString_, name_, username_, password_; uint port_; public this(char[] server, char[] path, char[] username = "", char[] password = "", uint port = 21) in { assert(server.length > 0); } body { toString_ = checkFirst(server); name_ = checkLast(path); username_ = username; password_ = password; port_ = port; } /*********************************************************************** Return a short name. ***********************************************************************/ final char[] name() { return fixName(name_); } /*********************************************************************** Return a long name. ***********************************************************************/ final char[] toString() { return checkCat(toString_, name_); } /*********************************************************************** Return a contained file representation. ***********************************************************************/ final VfsFile file(char[] path) { return new FtpFile(toString_, checkLast(checkCat(name_, path)), username_, password_, port_); } /*********************************************************************** Return a contained folder representation. ***********************************************************************/ final VfsFolderEntry folder(char[] path) { return new FtpFolderEntry(toString_, checkLast(checkCat(name_, path)), username_, password_, port_); } /*********************************************************************** Returns a folder set containing only this one. Statistics are inclusive of entries within this folder only. ***********************************************************************/ final VfsFolders self() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); return new FtpFolders(toString_, name_, username_, password_, port_, getFiles(conn), true); } /*********************************************************************** Returns a subtree of folders. Statistics are inclusive of files within this folder and all others within the tree. ***********************************************************************/ final VfsFolders tree() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); return new FtpFolders(toString_, name_, username_, password_, port_, getEntries(conn), false); } /*********************************************************************** Iterate over the set of immediate child folders. This is useful for reflecting the hierarchy. ***********************************************************************/ final int opApply(int delegate(ref VfsFolder) dg) { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); FtpFileInfo[] info = getFolders(conn); int result; foreach(FtpFileInfo fi; info) { VfsFolder x = new FtpFolder(toString_, checkLast(checkCat(name_, fi.name)), username_, password_, port_); if((result = dg(x)) != 0) break; } return result; } /*********************************************************************** Clear all content from this folder and subordinates. ***********************************************************************/ final VfsFolder clear() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); conn = new FTPConnection(connect, username_, password_, port_); conn.cd(name_); FtpFileInfo[] reverse(FtpFileInfo[] infos) { FtpFileInfo[] reversed; for(int i = infos.length - 1; i >= 0; i--) { reversed ~= infos[i]; } return reversed; } foreach(VfsFolder f; tree.subset(null)) conn.rm(f.name); foreach(FtpFileInfo entries; getEntries(conn)) conn.del(entries.name); //foreach(VfsFolder f; tree.subset(null)) // conn.rm(f.name); return this; } /*********************************************************************** Is folder writable? ***********************************************************************/ final bool writable() { try { FTPConnection conn; scope(failure) { if(conn !is null) conn.close(); } scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); conn.mkdir("ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"); conn.rm("ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"); return true; } catch(Exception e) { return false; } } /*********************************************************************** Close and/or synchronize changes made to this folder. Each driver should take advantage of this as appropriate, perhaps combining multiple files together, or possibly copying to a remote location. ***********************************************************************/ VfsFolder close(bool commit = true) { return this; } /*********************************************************************** A folder is being added or removed from the hierarchy. Use this to test for validity (or whatever) and throw exceptions as necessary. ***********************************************************************/ void verify(VfsFolder folder, bool mounting) { return; } } /****************************************************************************** A set of folders within an FTP file system as was selected by the Adapter or as was selected at initialization. ******************************************************************************/ class FtpFolders: VfsFolders { char[] toString_, name_, username_, password_; uint port_; bool flat_; FtpFileInfo[] infos_; package this(char[] server, char[] path, char[] username = "", char[] password = "", uint port = 21, FtpFileInfo[] infos = null, bool flat = false) in { assert(server.length > 0); } body { toString_ = checkFirst(server); name_ = checkLast(path); username_ = username; password_ = password; port_ = port; infos_ = infos; flat_ = flat; } public this(char[] server, char[] path, char[] username = "", char[] password = "", uint port = 21, bool flat = false) in { assert(server.length > 0); } body { toString_ = checkFirst(server); name_ = checkLast(path); username_ = username; password_ = password; port_ = port; flat_ = flat; FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); if(!flat_) infos_ = getEntries(conn); else infos_ = getFiles(conn); } /*********************************************************************** Iterate over the set of contained VfsFolder instances. ***********************************************************************/ final int opApply(int delegate(ref VfsFolder) dg) { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); FtpFileInfo[] info = getFolders(conn); int result; foreach(FtpFileInfo fi; info) { VfsFolder x = new FtpFolder(toString_, checkLast(checkCat(name_, fi.name)), username_, password_, port_); // was // VfsFolder x = new FtpFolder(toString_ ~ "/" ~ name_, fi.name, // username_, password_, port_); if((result = dg(x)) != 0) break; } return result; } /*********************************************************************** Return the number of files. ***********************************************************************/ final uint files() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); return getFiles(conn).length; } /*********************************************************************** Return the number of folders. ***********************************************************************/ final uint folders() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); return getFolders(conn).length; } /*********************************************************************** Return the total number of entries (files + folders.) ***********************************************************************/ final uint entries() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); return getEntries(conn).length; } /*********************************************************************** Return the total size of contained files. ***********************************************************************/ final ulong bytes() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); ulong return_; foreach(FtpFileInfo inf; getEntries(conn)) { return_ += inf.size; } return return_; } /*********************************************************************** Return a subset of folders matching the given pattern. ***********************************************************************/ final VfsFolders subset(char[] pattern) { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); FtpFileInfo[] return__; if(pattern !is null) foreach(FtpFileInfo inf; getFolders(conn)) { if(containsPattern(inf.name, pattern)) return__ ~= inf; } else return__ = getFolders(conn); return new FtpFolders(toString_, name_, username_, password_, port_, return__); } /*********************************************************************** Return a set of files matching the given pattern. ***********************************************************************/ final VfsFiles catalog(char[] pattern) { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); FtpFileInfo[] return__; if(pattern !is null) { foreach(FtpFileInfo inf; getFiles(conn)) { if(containsPattern(inf.name, pattern)) { return__ ~= inf; } } } else { return__ = getFiles(conn); } return new FtpFiles(toString_, name_, username_, password_, port_, return__); } /*********************************************************************** Return a set of files matching the given filter. ***********************************************************************/ final VfsFiles catalog(VfsFilter filter = null) { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); FtpFileInfo[] return__; if(filter !is null) foreach(FtpFileInfo inf; getFiles(conn)) { VfsFilterInfo vinf; vinf.bytes = inf.size; vinf.name = inf.name; vinf.folder = false; vinf.path = checkCat(checkFirst(toString_), checkCat(name_ ,inf.name)); if(filter(&vinf)) return__ ~= inf; } else return__ = getFiles(conn); return new FtpFiles(toString_, name_, username_, password_, port_, return__); } } /******************************************************************************* Represents a file over a FTP file system. *******************************************************************************/ class FtpFile: VfsFile { char[] toString_, name_, username_, password_; uint port_; bool conOpen; FTPConnection conn; public this(char[] server, char[] path, char[] username = "", char[] password = "", uint port = 21) in { assert(server.length > 0); } body { toString_ = checkFirst(server); name_ = checkLast(path); username_ = username; password_ = password; port_ = port; } /*********************************************************************** Return a short name. ***********************************************************************/ final char[] name() { return fixName(name_); } /*********************************************************************** Return a long name. ***********************************************************************/ final char[] toString() { return checkCat(toString_, name_); } /*********************************************************************** Does this file exist? ***********************************************************************/ final bool exists() { scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } scope(exit) { if(!conOpen) if(conn !is null) conn.close(); } bool return_; char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } if(conn.exist(name_) == 1) { return_ = true; } else { return_ = false; } return return_; } /*********************************************************************** Return the file size. ***********************************************************************/ final ulong size() { scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } scope(exit) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } return conn.size(name_); } /*********************************************************************** Create and copy the given source. ***********************************************************************/ final VfsFile copy(VfsFile source) { output.copy(source.input); return this; } /*********************************************************************** Create and copy the given source, and remove the source. ***********************************************************************/ final VfsFile move(VfsFile source) { copy(source); source.remove; return this; } /*********************************************************************** Create a new file instance. ***********************************************************************/ final VfsFile create() { char[1] a = "0"; output.write(a); return this; } /*********************************************************************** Create a new file instance and populate with stream. ***********************************************************************/ final VfsFile create(InputStream stream) { output.copy(stream); return this; } /*********************************************************************** Remove this file. ***********************************************************************/ final VfsFile remove() { conn.close(); conOpen = false; scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } scope(exit) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } conn.del(name_); return this; } /*********************************************************************** Return the input stream. Don't forget to close it. ***********************************************************************/ final InputStream input() { scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } conOpen = true; return conn.input(name_); } /*********************************************************************** Return the output stream. Don't forget to close it. ***********************************************************************/ final OutputStream output() { scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } conOpen = true; return conn.output(name_); } /*********************************************************************** Duplicate this entry. ***********************************************************************/ final VfsFile dup() { return new FtpFile(toString_, name_, username_, password_, port_); } /*********************************************************************** Time modified. ***********************************************************************/ final Time mtime() { conn.close(); conOpen = false; scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } scope(exit) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } return conn.getFileInfo(name_).modify; } /*********************************************************************** Time created. ***********************************************************************/ final Time ctime() { conn.close(); conOpen = false; scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } scope(exit) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } return conn.getFileInfo(name_).create; } final Time atime() { conn.close(); conOpen = false; scope(failure) { if(!conOpen) if(conn !is null) conn.close(); } scope(exit) { if(!conOpen) if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } if(!conOpen) { conn = new FTPConnection(connect, username_, password_, port_); } return conn.getFileInfo(name_).modify; } /*********************************************************************** Modified time of the file. ***********************************************************************/ final Time modified () { return mtime (); } } /****************************************************************************** Represents a selection of Files. ******************************************************************************/ class FtpFiles: VfsFiles { char[] toString_, name_, username_, password_; uint port_; FtpFileInfo[] infos_; public this(char[] server, char[] path, char[] username = "", char[] password = "", uint port = 21, FtpFileInfo[] infos = null) in { assert(server.length > 0); } body { toString_ = checkFirst(server); name_ = checkLast(path); username_ = username; password_ = password; port_ = port; if(infos !is null) infos_ = infos; else fillInfos(); } final void fillInfos() { FTPConnection conn; scope(exit) { if(conn !is null) conn.close(); } char[] connect = toString_; if(connect[$ - 1] == '/') { connect = connect[0 .. ($ - 1)]; } conn = new FTPConnection(connect, username_, password_, port_); if(name_ != "") conn.cd(name_); infos_ = getFiles(conn); } /*********************************************************************** Iterate over the set of contained VfsFile instances. ***********************************************************************/ final int opApply(int delegate(ref VfsFile) dg) { int result = 0; foreach(FtpFileInfo inf; infos_) { VfsFile x = new FtpFile(toString_, checkLast(checkCat(name_, inf.name)), username_, password_, port_); if((result = dg(x)) != 0) break; } return result; } /*********************************************************************** Return the total number of entries. ***********************************************************************/ final uint files() { return infos_.length; } /*********************************************************************** Return the total size of all files. ***********************************************************************/ final ulong bytes() { ulong return_; foreach(FtpFileInfo inf; infos_) { return_ += inf.size; } return return_; } } |