diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/Reference/winfsp-msil.dll b/Reference/winfsp-msil.dll index 7f50281..73a771d 100644 Binary files a/Reference/winfsp-msil.dll and b/Reference/winfsp-msil.dll differ diff --git a/Reference/winfsp-msil.xml b/Reference/winfsp-msil.xml index 5929512..d5291db 100644 --- a/Reference/winfsp-msil.xml +++ b/Reference/winfsp-msil.xml @@ -946,6 +946,11 @@ Gets or sets a value that determines whether the file system supports named streams. + + + Gets or sets a value that determines whether the file system supports extended attributes. + + Gets or sets the prefix for a network file system. @@ -1099,6 +1104,11 @@ Not currently implemented. Set to 0. + + + The extended attribute size of the file. + + Provides the base class for a process that can be run as a service, diff --git a/WebDAVClient/Client.cs b/WebDAVClient/Client.cs index 5c0fb0f..05f7faa 100644 --- a/WebDAVClient/Client.cs +++ b/WebDAVClient/Client.cs @@ -1,4 +1,4 @@ -using NLog; +using NLog; using System; using System.Collections.Generic; using System.IO; @@ -6,19 +6,34 @@ using System.Net; using System.Net.Http; using System.Net.Http.Headers; +using System.Net.Security; using System.Security.Cryptography.X509Certificates; using System.Text; using System.Threading.Tasks; using System.Web; using WebDAVClient.Helpers; +using WebDAVClient.HttpClient; using WebDAVClient.Model; namespace WebDAVClient { + class PartialRange : ContentRangeHeaderValue + { + public PartialRange(Int64 from) : base(from, from) + { + } + + public override string ToString() + { + return $"bytes {From}-/*"; + } + } + public class Client : IClient { private static readonly HttpMethod PropFind = new HttpMethod("PROPFIND"); private static readonly HttpMethod MoveMethod = new HttpMethod("MOVE"); + private static readonly HttpMethod CopyMethod = new HttpMethod("COPY"); private static readonly HttpMethod MkCol = new HttpMethod(WebRequestMethods.Http.MkCol); @@ -43,8 +58,7 @@ public class Client : IClient private static readonly string AssemblyVersion = typeof(IClient).Assembly.GetName().Version.ToString(); - private readonly HttpClient _client; - private readonly HttpClient _uploadClient; + private readonly IHttpClientWrapper _httpClientWrapper; private string _server; private string _basePath = "/"; @@ -98,8 +112,16 @@ public string BasePath /// public string UserAgentVersion { get; set; } - #endregion + /// + /// Specify additional headers to be sent with every request + /// + public ICollection> CustomHeaders { get; set; } + /// + /// Specify the certificates validation logic + /// + public RemoteCertificateValidationCallback ServerCertificateValidationCallback { get; set; } + #endregion public Client(NetworkCredential credential = null, TimeSpan? uploadTimeout = null, IWebProxy proxy = null, X509Certificate clientCert = null) { @@ -113,6 +135,10 @@ public Client(NetworkCredential credential = null, TimeSpan? uploadTimeout = nul handler.Credentials = credential; handler.PreAuthenticate = true; } + else + { + handler.UseDefaultCredentials = true; + } if (clientCert != null) { @@ -120,15 +146,23 @@ public Client(NetworkCredential credential = null, TimeSpan? uploadTimeout = nul handler.ClientCertificates.Add(clientCert); } - _client = new HttpClient(handler); - _client.DefaultRequestHeaders.ExpectContinue = false; + var client = new System.Net.Http.HttpClient(handler); + client.DefaultRequestHeaders.ExpectContinue = false; + System.Net.Http.HttpClient uploadClient = null; if (uploadTimeout != null) { - _uploadClient = new HttpClient(handler); - _uploadClient.DefaultRequestHeaders.ExpectContinue = false; - _uploadClient.Timeout = uploadTimeout.Value; + uploadClient = new System.Net.Http.HttpClient(handler); + uploadClient.DefaultRequestHeaders.ExpectContinue = false; + uploadClient.Timeout = uploadTimeout.Value; } + + _httpClientWrapper = new HttpClientWrapper(client, uploadClient ?? client); + } + + public Client(IHttpClientWrapper httpClientWrapper) + { + _httpClientWrapper = httpClientWrapper; } #region WebDAV operations @@ -152,6 +186,14 @@ public async Task> List(string path = "/", int? depth = 1) headers.Add("Depth", depth.ToString()); } + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + HttpResponseMessage response = null; try @@ -215,7 +257,7 @@ public async Task> List(string path = "/", int? depth = 1) public async Task GetFolder(string path = "/") { var listUri = /*await*/ GetServerUrl(path, true)/*.ConfigureAwait(false)*/; - return await Get(listUri.Uri, path).ConfigureAwait(false); + return await Get(listUri.Uri).ConfigureAwait(false); } /// @@ -225,7 +267,7 @@ public async Task GetFolder(string path = "/") public async Task GetFile(string path = "/") { var listUri = /*await*/ GetServerUrl(path, false)/*.ConfigureAwait(false)*/; - return await Get(listUri.Uri, path).ConfigureAwait(false); + return await Get(listUri.Uri).ConfigureAwait(false); } @@ -233,7 +275,7 @@ public async Task GetFile(string path = "/") /// List all files present on the server. /// /// A list of files (entries without a trailing slash) and directories (entries with a trailing slash) - private async Task Get(Uri listUri, string path) + private async Task Get(Uri listUri) { //logger.Trace($"WEBDAVCLIENT Get {listUri}"); @@ -241,6 +283,14 @@ private async Task Get(Uri listUri, string path) IDictionary headers = new Dictionary(); headers.Add("Depth", "0"); + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + HttpResponseMessage response = null; try @@ -280,50 +330,104 @@ private async Task Get(Uri listUri, string path) /// Download a file from the server /// /// Source path and filename of the file on the server - public async Task Download(string remoteFilePath) + public Task Download(string remoteFilePath) { - //logger.Trace($"WEBDAVCLIENT Download {remoteFilePath}"); - - // Should not have a trailing slash. - var downloadUri = /*await*/ GetServerUrl(remoteFilePath, false)/*.ConfigureAwait(false)*/; + var headers = new Dictionary { { "translate", "f" } }; + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair.Key, keyValuePair.Value); + } + } + return DownloadFile(remoteFilePath, headers); + } - var dictionary = new Dictionary { { "translate", "f" } }; - HttpResponseMessage response = null; - try + /// + /// Download a part of file from the server + /// + /// Source path and filename of the file on the server + /// Start bytes of content + /// End bytes of content + public Task DownloadPartial(string remoteFilePath, long startBytes, long endBytes) + { + var headers = new Dictionary { { "translate", "f" }, { "Range", "bytes=" + startBytes + "-" + endBytes } }; + if (CustomHeaders != null) { - response = await HttpRequest(downloadUri.Uri, HttpMethod.Get, dictionary).ConfigureAwait(false); - if (response.StatusCode != HttpStatusCode.OK) throw new WebDAVException((int)response.StatusCode, "Failed retrieving file."); - Stream s = await response.Content.ReadAsStreamAsync().ConfigureAwait(false); - using (MemoryStream MS = new MemoryStream()) + foreach (var keyValuePair in CustomHeaders) { - await s.CopyToAsync(MS); - return MS.ToArray(); + headers.Add(keyValuePair.Key, keyValuePair.Value); } } - catch (Exception ex) + return DownloadFile(remoteFilePath, headers); + } + + + /// + /// Upload a file to the server + /// + /// Source path and filename of the file on the server + /// + /// + public async Task Upload(string remoteFilePath, Stream content, string name) + { + // Should not have a trailing slash. + var uploadUri = /*await*/ GetServerUrl(remoteFilePath.TrimEnd('/') + "/" + name.TrimStart('/'), false)/*.ConfigureAwait(false)*/; + + IDictionary headers = new Dictionary(); + if (CustomHeaders != null) { - throw ex; + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } } - finally + + HttpResponseMessage response = await HttpUploadRequest(uploadUri.Uri, HttpMethod.Put, content, headers).ConfigureAwait(false); + + if (response.StatusCode == HttpStatusCode.Conflict) + throw new WebDAVConflictException((int)response.StatusCode, "Failed uploading file."); + + if (response.StatusCode != HttpStatusCode.OK && + response.StatusCode != HttpStatusCode.NoContent && + response.StatusCode != HttpStatusCode.Created) { - if (response != null) - response.Dispose(); + throw new WebDAVException((int)response.StatusCode, "Failed uploading file."); } + + return response.IsSuccessStatusCode; } + /// - /// Download a file from the server + /// Partial upload a part of file to the server /// /// Source path and filename of the file on the server - /// - /// - public async Task Upload(string remoteFilePath, Stream content, string name) + /// Partial content to update + /// Name of the file to update + /// Start byte position of the target content + /// End bytes of the target content. Must match the length of plus + public async Task UploadPartial(string remoteFilePath, Stream content, string name, long startBytes, long? endBytes) { + if (endBytes.HasValue && startBytes + content.Length != endBytes) + { + throw new InvalidOperationException("The length of the given content plus the startBytes must match the endBytes."); + } + // Should not have a trailing slash. var uploadUri = /*await*/ GetServerUrl(remoteFilePath.TrimEnd('/') + "/" + name.TrimStart('/'), false)/*.ConfigureAwait(false)*/; - HttpResponseMessage response = await HttpUploadRequest(uploadUri.Uri, HttpMethod.Put, content).ConfigureAwait(false); + IDictionary headers = new Dictionary(); + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + + HttpResponseMessage response = await HttpUploadRequest(uploadUri.Uri, HttpMethod.Put, content, headers, startBytes, endBytes).ConfigureAwait(false); if (response.StatusCode == HttpStatusCode.Conflict) throw new WebDAVConflictException((int)response.StatusCode, "Failed uploading file."); @@ -351,7 +455,16 @@ public async Task CreateDir(string remotePath, string name) // Should not have a trailing slash. var dirUri = /*await*/ GetServerUrl(remotePath.TrimEnd('/') + "/" + name.TrimStart('/'), false)/*.ConfigureAwait(false)*/; - HttpResponseMessage response = await HttpRequest(dirUri.Uri, MkCol).ConfigureAwait(false); + IDictionary headers = new Dictionary(); + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + + HttpResponseMessage response = await HttpRequest(dirUri.Uri, MkCol, headers).ConfigureAwait(false); if (response.StatusCode == HttpStatusCode.Conflict) throw new WebDAVConflictException((int)response.StatusCode, "Failed creating folder."); @@ -383,9 +496,18 @@ private async Task Delete(Uri listUri) { //logger.Trace($"WEBDAVCLIENT Delete {listUri}"); + IDictionary headers = new Dictionary(); + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + try { - var response = await HttpRequest(listUri, HttpMethod.Delete).ConfigureAwait(false); + var response = await HttpRequest(listUri, HttpMethod.Delete, headers).ConfigureAwait(false); if (response.StatusCode != HttpStatusCode.OK && response.StatusCode != HttpStatusCode.NoContent) @@ -417,6 +539,24 @@ public async Task MoveFile(string srcFilePath, string dstFilePath) return await Move(srcUri.Uri, dstUri.Uri).ConfigureAwait(false); } + public async Task CopyFile(string srcFilePath, string dstFilePath) + { + // Should not have a trailing slash. + var srcUri = /*await*/ GetServerUrl(srcFilePath, false)/*.ConfigureAwait(false)*/; + var dstUri = /*await*/ GetServerUrl(dstFilePath, false)/*.ConfigureAwait(false)*/; + + return await Copy(srcUri.Uri, dstUri.Uri).ConfigureAwait(false); + } + + public async Task CopyFolder(string srcFolderPath, string dstFolderPath) + { + // Should have a trailing slash. + var srcUri = /*await*/ GetServerUrl(srcFolderPath, true)/*.ConfigureAwait(false)*/; + var dstUri = /*await*/ GetServerUrl(dstFolderPath, false)/*.ConfigureAwait(false)*/; + + return await Copy(srcUri.Uri, dstUri.Uri).ConfigureAwait(false); + } + private async Task Move(Uri srcUri, Uri dstUri) { @@ -427,6 +567,14 @@ private async Task Move(Uri srcUri, Uri dstUri) IDictionary headers = new Dictionary(); headers.Add("Destination", HttpUtility.UrlPathEncode(dstUri.ToString())); + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + var response = await HttpRequest(srcUri, MoveMethod, headers, Encoding.UTF8.GetBytes(requestContent)).ConfigureAwait(false); if (response.StatusCode != HttpStatusCode.OK && @@ -440,6 +588,57 @@ private async Task Move(Uri srcUri, Uri dstUri) } + private async Task Copy(Uri srcUri, Uri dstUri) + { + //logger.Trace($"WEBDAVCLIENT Copy {srcUri}"); + + const string requestContent = "COPY"; + + IDictionary headers = new Dictionary(); + headers.Add("Destination", HttpUtility.UrlPathEncode(dstUri.ToString())); + + if (CustomHeaders != null) + { + foreach (var keyValuePair in CustomHeaders) + { + headers.Add(keyValuePair); + } + } + + var response = await HttpRequest(srcUri, CopyMethod, headers, Encoding.UTF8.GetBytes(requestContent)).ConfigureAwait(false); + + if (response.StatusCode != HttpStatusCode.OK && + response.StatusCode != HttpStatusCode.Created && + response.StatusCode != HttpStatusCode.NoContent) + { + throw new WebDAVException((int)response.StatusCode, "Failed copying file."); + } + + return response.IsSuccessStatusCode; + } + + private async Task DownloadFile(String remoteFilePath, Dictionary header) + { + //logger.Trace($"WEBDAVCLIENT Download {remoteFilePath}"); + + // Should not have a trailing slash. + var downloadUri = /*await*/ GetServerUrl(remoteFilePath, false)/*.ConfigureAwait(false)*/; + + try + { + var response = await HttpRequest(downloadUri.Uri, HttpMethod.Get, header).ConfigureAwait(false); + if (response.StatusCode == HttpStatusCode.OK || response.StatusCode == HttpStatusCode.PartialContent) + { + return await response.Content.ReadAsStreamAsync().ConfigureAwait(false); + } + throw new WebDAVException((int)response.StatusCode, "Failed retrieving file."); + } + catch (Exception ex) + { + throw ex; + } + } + #endregion #region Server communication @@ -478,7 +677,7 @@ private async Task HttpRequest(Uri uri, HttpMethod method, request.Content.Headers.ContentType = new MediaTypeHeaderValue("text/xml"); } - return await _client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead).ConfigureAwait(false); + return await _httpClientWrapper.SendAsync(request, HttpCompletionOption.ResponseHeadersRead).ConfigureAwait(false); } } @@ -489,7 +688,7 @@ private async Task HttpRequest(Uri uri, HttpMethod method, /// /// /// - private async Task HttpUploadRequest(Uri uri, HttpMethod method, Stream content, IDictionary headers = null) + private async Task HttpUploadRequest(Uri uri, HttpMethod method, Stream content, IDictionary headers = null, long? startbytes = null, long? endbytes = null) { using (var request = new HttpRequestMessage(method, uri)) { @@ -506,15 +705,27 @@ private async Task HttpUploadRequest(Uri uri, HttpMethod me request.Headers.Add(key, headers[key]); } } + request.Headers.TransferEncodingChunked = true; // Need to send along content? if (content != null) { request.Content = new StreamContent(content); + if (startbytes.HasValue) + { + if (endbytes.HasValue) + { + request.Content.Headers.ContentRange = ContentRangeHeaderValue.Parse($"bytes {startbytes}-{endbytes}/*"); + request.Content.Headers.ContentLength = endbytes - startbytes; + } + else + { + request.Content.Headers.ContentRange = new PartialRange(startbytes.Value); + } + } } - var client = _uploadClient ?? _client; - return await client.SendAsync(request).ConfigureAwait(false); + return await _httpClientWrapper.SendUploadAsync(request).ConfigureAwait(false); } } @@ -539,7 +750,7 @@ private static bool TryCreateAbsolute(string uriString, out Uri uriResult) if (path == "/") URL = _server + _basePath; else if (path.StartsWith(_server)) URL = path; - else if (path.StartsWith(_basePath)) URL = _server + _basePath + path.Replace(_basePath, ""); + else if (path.StartsWith(_basePath)) URL = _server + path; else URL = _server + _basePath + (path.StartsWith("/") ? path.Substring(1) : path); if (appendTrailingSlash && !URL.EndsWith("/")) URL += "/"; @@ -554,8 +765,8 @@ private static bool TryCreateAbsolute(string uriString, out Uri uriResult) // Resolve the base path on the server if (_encodedBasePath == null) { - var baseUri = new UriBuilder(_server) { Path = _basePath }; - var root = await Get(baseUri.Uri, null).ConfigureAwait(false); + var baseUri = new UriBuilder(_server) {Path = _basePath, Port = (int)Port}; + var root = await Get(baseUri.Uri).ConfigureAwait(false); _encodedBasePath = root.Href; } @@ -572,7 +783,7 @@ private static bool TryCreateAbsolute(string uriString, out Uri uriResult) } // Otherwise, use the resolved base path relatively to the server - var baseUri = new UriBuilder(_server) { Path = _encodedBasePath }; + var baseUri = new UriBuilder(_server) {Path = _encodedBasePath, Port = (int)Port}; //logger.Trace($"WEBDAVCLIENT GetServerUrl out {baseUri}"); return baseUri; } @@ -600,7 +811,7 @@ private static bool TryCreateAbsolute(string uriString, out Uri uriResult) } else { - baseUri = new UriBuilder(_server); + baseUri = new UriBuilder(_server) { Port = (int)Port }; // Ensure we don't add the base path twice var finalPath = path; @@ -621,5 +832,18 @@ private static bool TryCreateAbsolute(string uriString, out Uri uriResult) } #endregion + + #region WebDAV Connection Helpers + + public bool ServerCertificateValidation(object sender, System.Security.Cryptography.X509Certificates.X509Certificate certification, System.Security.Cryptography.X509Certificates.X509Chain chain, System.Net.Security.SslPolicyErrors sslPolicyErrors) + { + if (ServerCertificateValidationCallback != null) + { + return ServerCertificateValidationCallback(sender, certification, chain, sslPolicyErrors); + } + return false; + } + + #endregion } } diff --git a/WebDAVClient/Helpers/ResponseParser.cs b/WebDAVClient/Helpers/ResponseParser.cs index 0da1c1f..4fe9dc1 100644 --- a/WebDAVClient/Helpers/ResponseParser.cs +++ b/WebDAVClient/Helpers/ResponseParser.cs @@ -137,11 +137,6 @@ public static IEnumerable ParseItems(Stream stream) case "version-controlled-configuration": reader.Skip(); break; - default: - { - //int a = 0; - break; - } } } else if (reader.NodeType == XmlNodeType.EndElement && reader.LocalName.ToLower() == "response") diff --git a/WebDAVClient/HttpClient/HttpClientWrapper.cs b/WebDAVClient/HttpClient/HttpClientWrapper.cs new file mode 100644 index 0000000..db36b6f --- /dev/null +++ b/WebDAVClient/HttpClient/HttpClientWrapper.cs @@ -0,0 +1,27 @@ +using System.Net.Http; +using System.Threading.Tasks; + +namespace WebDAVClient.HttpClient +{ + public class HttpClientWrapper : IHttpClientWrapper + { + private readonly System.Net.Http.HttpClient _httpClient; + private readonly System.Net.Http.HttpClient _uploadHttpClient; + + public HttpClientWrapper(System.Net.Http.HttpClient httpClient, System.Net.Http.HttpClient uploadHttpClient) + { + _httpClient = httpClient; + _uploadHttpClient = uploadHttpClient; + } + + public Task SendAsync(HttpRequestMessage request, HttpCompletionOption responseHeadersRead) + { + return _httpClient.SendAsync(request, responseHeadersRead); + } + + public Task SendUploadAsync(HttpRequestMessage request) + { + return _uploadHttpClient.SendAsync(request); + } + } +} \ No newline at end of file diff --git a/WebDAVClient/HttpClient/IHttpClientWrapper.cs b/WebDAVClient/HttpClient/IHttpClientWrapper.cs new file mode 100644 index 0000000..31ea89f --- /dev/null +++ b/WebDAVClient/HttpClient/IHttpClientWrapper.cs @@ -0,0 +1,11 @@ +using System.Net.Http; +using System.Threading.Tasks; + +namespace WebDAVClient.HttpClient +{ + public interface IHttpClientWrapper + { + Task SendAsync(HttpRequestMessage request, HttpCompletionOption responseHeadersRead); + Task SendUploadAsync(HttpRequestMessage request); + } +} \ No newline at end of file diff --git a/WebDAVClient/IClient.cs b/WebDAVClient/IClient.cs index ca80f66..f966d12 100644 --- a/WebDAVClient/IClient.cs +++ b/WebDAVClient/IClient.cs @@ -31,6 +31,10 @@ public interface IClient /// string UserAgentVersion { get; set; } + /// + /// Specify additional headers to be sent with every request + /// + ICollection> CustomHeaders { get; set; } /// /// List all files present on the server. @@ -56,16 +60,34 @@ public interface IClient /// Download a file from the server /// /// Source path and filename of the file on the server - Task Download(string remoteFilePath); + Task Download(string remoteFilePath); /// - /// Download a file from the server + /// Download a part of file from the server + /// + /// Source path and filename of the file on the server + /// Start bytes of content + /// End bytes of content + Task DownloadPartial(string remoteFilePath, long startBytes, long endBytes); + + /// + /// Upload a file to the server /// /// Source path and filename of the file on the server /// /// Task Upload(string remoteFilePath, Stream content, string name); + /// + /// Upload a part of a file to the server. + /// + /// Target path excluding the servername and base path + /// The content to upload. Must match the length of minus + /// The target filename. The file must exist on the server + /// StartByte on the target file + /// EndByte on the target file + Task UploadPartial(string remoteFilePath, Stream content, string name, long startBytes, long? endBytes); + /// /// Create a directory on the server /// @@ -98,5 +120,19 @@ public interface IClient /// Source path and filename of the file on the server /// Destination path and filename of the file on the server Task MoveFile(string srcFilePath, string dstFilePath); + + /// + /// Copies a file on the server + /// + /// Source path and filename of the file on the server + /// Destination path and filename of the file on the server + Task CopyFile(string srcFilePath, string dstFilePath); + + /// + /// Copies a folder on the server + /// + /// Source path of the folder on the server + /// Destination path of the folder on the server + Task CopyFolder(string srcFolderPath, string dstFolderPath); } } \ No newline at end of file diff --git a/WebDAVClient/Properties/AssemblyInfo.cs b/WebDAVClient/Properties/AssemblyInfo.cs index 04d9616..6039b80 100644 --- a/WebDAVClient/Properties/AssemblyInfo.cs +++ b/WebDAVClient/Properties/AssemblyInfo.cs @@ -31,5 +31,5 @@ // You can specify all the values or you can default the Build and Revision Numbers // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.1.2.0")] -[assembly: AssemblyFileVersion("1.1.2.0")] +[assembly: AssemblyVersion("1.1.4.0")] +[assembly: AssemblyFileVersion("1.1.4.0")] diff --git a/WebDAVClient/WebDAVClient.csproj b/WebDAVClient/WebDAVClient.csproj index a986114..266f4ca 100644 --- a/WebDAVClient/WebDAVClient.csproj +++ b/WebDAVClient/WebDAVClient.csproj @@ -65,7 +65,9 @@ + + diff --git a/src/About/About.xaml b/src/About/About.xaml index 1c40a50..f76b374 100644 --- a/src/About/About.xaml +++ b/src/About/About.xaml @@ -19,7 +19,7 @@ - Install the 2018.2 B2 release of WinFSP or superior + Install the 2019.3 B1 release of WinFSP or superior diff --git a/src/FS/FileNode.cs b/src/FS/FileNode.cs index 7b2e582..46d239e 100644 --- a/src/FS/FileNode.cs +++ b/src/FS/FileNode.cs @@ -1,7 +1,10 @@ using Fsp.Interop; using Newtonsoft.Json; using System; +using System.IO.Pipes; using System.Security.AccessControl; +using System.Threading; +using System.Threading.Tasks; using System.Web; namespace KS2Drive.FS @@ -37,6 +40,10 @@ public class FileNode private static String _DocumentLibraryPath; private static WebDAVMode _WebDAVMode; + private AnonymousPipeServerStream UploadStream = null; + private UInt64 UploadOffset; + private Task UploadTask = null; + private static bool _IsInited = false; public static void Init(String DocumentLibraryPath, WebDAVMode webDavMode) @@ -66,6 +73,7 @@ public FileNode(WebDAVClient.Model.Item WebDavObject) { this.RepositoryPath = WebDavObject.Href; } + this.RepositoryPath = this.RepositoryPath.Replace("//", "/"); this.LocalPath = HttpUtility.UrlDecode(ConvertRepositoryPathToLocalPath(this.RepositoryPath)); @@ -105,11 +113,78 @@ public FileNode(WebDAVClient.Model.Item WebDavObject) this.FileSecurity = GetDefaultSecurity(); } + public FileNode(String Path) + { + if (!FileNode._IsInited) throw new InvalidOperationException("Please Call Init First"); + + lock (_handlelock) + { + this.ObjectId = (++ObjetIdSequence).ToString(); + } + + this.LastRefresh = DateTime.Now; + + this.LocalPath = Path; + this.RepositoryPath = ConvertLocalPathToRepositoryPath(Path); + this.Name = GetRepositoryDocumentName(this.RepositoryPath); + + this.FileInfo.FileAttributes = (UInt32)System.IO.FileAttributes.Normal; + + this.FileSecurity = GetDefaultSecurity(); + } + + public bool PendingUpload(UInt64 Offset) + { + return (UploadStream != null && UploadOffset < Offset); + } + + public bool FlushUpload() + { + if (UploadStream != null) + { + UploadStream.Close(); + bool result = UploadTask.GetAwaiter().GetResult(); + UploadStream = null; + UploadTask = null; + return result; + } + return false; + } + + public void Upload(byte[] Data, UInt64 Offset, UInt32 Length) + { + if (UploadStream != null && UploadOffset != Offset) + { + FlushUpload(); + } + if (UploadStream == null) + { + UploadStream = new AnonymousPipeServerStream(); + UploadOffset = Offset; + var Proxy = new WebDavClient2(Timeout.InfiniteTimeSpan); + var PipeStream = new AnonymousPipeClientStream(PipeDirection.In, UploadStream.ClientSafePipeHandle); + if (UploadOffset == 0) + { + UploadTask = Proxy.Upload(GetRepositoryParentPath(RepositoryPath), PipeStream, Name); + } + else + { + UploadTask = Proxy.UploadPartial(GetRepositoryParentPath(RepositoryPath), PipeStream, Name, (long)UploadOffset); + } + } + if (Data != null) + { + UploadStream.Write(Data, 0, (int)Length); + UploadOffset += Length; + } + } + public static String ConvertRepositoryPathToLocalPath(String CMISPath) { if (CMISPath.EndsWith("/")) CMISPath = CMISPath.Substring(0, CMISPath.Length - 1); - String ReworkdPath = CMISPath.Replace(_DocumentLibraryPath, "").Replace('/', System.IO.Path.DirectorySeparatorChar); + if (!_DocumentLibraryPath.Equals("")) CMISPath = CMISPath.Replace(_DocumentLibraryPath, ""); + String ReworkdPath = CMISPath.Replace('/', System.IO.Path.DirectorySeparatorChar); if (!ReworkdPath.StartsWith(System.IO.Path.DirectorySeparatorChar.ToString())) ReworkdPath = System.IO.Path.DirectorySeparatorChar + ReworkdPath; return ReworkdPath; } @@ -183,7 +258,7 @@ internal static String GetRepositoryParentPath(String DocumentPath) { if (DocumentPath.EndsWith("/")) DocumentPath = DocumentPath.Substring(0, DocumentPath.Length - 1); - if (DocumentPath.Equals(_DocumentLibraryPath)) return null; + if (DocumentPath.Equals(_DocumentLibraryPath)) return ""; if (DocumentPath.Length < _DocumentLibraryPath.Length) return null; return DocumentPath.Substring(0, DocumentPath.LastIndexOf('/')); } diff --git a/src/FS/WebDavClient2.cs b/src/FS/WebDavClient2.cs index f4b46f6..222f4e0 100644 --- a/src/FS/WebDavClient2.cs +++ b/src/FS/WebDavClient2.cs @@ -61,10 +61,26 @@ private String ParameterConvert(String input) return base.DeleteFolder(remotePath); } - public new Task Download(string remotePath) + public new async Task Download(string remotePath) { remotePath = ParameterConvert(remotePath); - return base.Download(remotePath); + Stream s = await base.Download(remotePath); + using (MemoryStream MS = new MemoryStream()) + { + await s.CopyToAsync(MS); + return MS.ToArray(); + } + } + + public new async Task DownloadPartial(string remotePath, long startBytes, long endBytes) + { + remotePath = ParameterConvert(remotePath); + Stream s = await base.DownloadPartial(remotePath, startBytes, endBytes); + using (MemoryStream MS = new MemoryStream()) + { + await s.CopyToAsync(MS); + return MS.ToArray(); + } } public new Task GetFile(string remotePath = "/") @@ -105,6 +121,12 @@ private String ParameterConvert(String input) return base.Upload(remoteFilePath, content, name); } + public new Task UploadPartial(string remoteFilePath, Stream content, string name, long startBytes, long? endBytes = null) + { + remoteFilePath = ParameterConvert(remoteFilePath); + return base.UploadPartial(remoteFilePath, content, name, startBytes, endBytes); + } + /// /// Retrieve a file or folder from the remote repository /// Return either a RepositoryElement or a FileSystem Error Message diff --git a/src/FS/davFS.cs b/src/FS/davFS.cs index e438f22..6200c89 100644 --- a/src/FS/davFS.cs +++ b/src/FS/davFS.cs @@ -6,7 +6,6 @@ using System; using System.Collections.Generic; using System.IO; -using System.Linq; using System.Net.Http; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; @@ -496,18 +495,9 @@ public override Int32 Create( { try { - if (Proxy.Upload(RepositoryNewDocumentParentPath, new MemoryStream(new byte[0]), NewDocumentName).GetAwaiter().GetResult()) - { - CFN = new FileNode(Proxy.GetRepositoryElement(FileName)); - CFN.HasUnflushedData = true; - } - else - { - L = new LogListItem() { Date = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"), Object = "None", Method = "Create", File = FileName, Result = "STATUS_CANNOT_MAKE" }; - RepositoryActionPerformed?.Invoke(this, L); - DebugEnd(OperationId, null, "STATUS_CANNOT_MAKE"); - return STATUS_CANNOT_MAKE; - } + CFN = new FileNode(FileName); + CFN.Upload(null, 0, 0); + CFN.HasUnflushedData = true; } catch (WebDAVConflictException) { @@ -775,6 +765,8 @@ public override void Close( } } + CFN.FlushUpload(); + Int32 HandleCount = Interlocked.Decrement(ref CFN.OpenCount); if (HandleCount == 0) CFN.FileData = null; //No more handle on the file, we free its content DebugEnd(OperationId, CFN, $"STATUS_SUCCESS - Handle {HandleCount}"); @@ -882,6 +874,8 @@ public override void Cleanup( } } + CFN.FlushUpload(); + /* FileNode FileNode = (FileNode)FileNode0; @@ -946,12 +940,18 @@ public override Int32 Read( String OperationId = Guid.NewGuid().ToString(); DebugStart(OperationId, CFN); + if (CFN.PendingUpload(Offset)) { + DebugEnd(OperationId, CFN, "STATUS_END_OF_FILE"); + return STATUS_END_OF_FILE; + } + + byte[] FileData = null; if (CFN.FileData == null) { var Proxy = new WebDavClient2(); try { - CFN.FileData = Proxy.Download(CFN.RepositoryPath).GetAwaiter().GetResult(); + FileData = Proxy.DownloadPartial(CFN.RepositoryPath, (long)Offset, (long)Offset + Length - 1).GetAwaiter().GetResult(); } catch (WebDAVException ex) when (ex.GetHttpCode() == 401) { @@ -959,40 +959,54 @@ public override Int32 Read( Cache.Clear(); return STATUS_NETWORK_UNREACHABLE; } + catch (WebDAVException ex) when (ex.GetHttpCode() == 416) + { + DebugEnd(OperationId, CFN, $"STATUS_END_OF_FILE - {ex.Message}"); + return STATUS_END_OF_FILE; + } catch (HttpRequestException ex) { - CFN.FileData = null; DebugEnd(OperationId, CFN, $"STATUS_NETWORK_UNREACHABLE - {ex.Message}"); return STATUS_NETWORK_UNREACHABLE; } catch (Exception ex) { - CFN.FileData = null; DebugEnd(OperationId, CFN, $"STATUS_NETWORK_UNREACHABLE - {ex.Message}"); return STATUS_NETWORK_UNREACHABLE; } - } - if (CFN.FileData == null) - { - DebugEnd(OperationId, CFN, "STATUS_OBJECT_NAME_NOT_FOUND"); - return STATUS_OBJECT_NAME_NOT_FOUND; + if (Offset == 0 && (ulong)FileData.LongLength == CFN.FileInfo.FileSize) + { + CFN.FileData = FileData; + } + Offset = 0; + BytesTransferred = (uint)FileData.Length; } + else + { + FileData = CFN.FileData; + UInt64 FileSize = (UInt64)FileData.LongLength; + + if (Offset >= FileSize) + { + BytesTransferred = default(UInt32); + DebugEnd(OperationId, CFN, "STATUS_END_OF_FILE"); + return STATUS_END_OF_FILE; + } - UInt64 FileSize = (UInt64)CFN.FileData.LongLength; + UInt64 EndOffset = Offset + Length; + if (EndOffset > FileSize) EndOffset = FileSize; - if (Offset >= FileSize) - { - BytesTransferred = default(UInt32); - DebugEnd(OperationId, CFN, "STATUS_END_OF_FILE"); - return STATUS_END_OF_FILE; + BytesTransferred = (UInt32)(EndOffset - Offset); } - UInt64 EndOffset = Offset + Length; - if (EndOffset > FileSize) EndOffset = FileSize; + if (FileData == null) + { + DebugEnd(OperationId, CFN, "STATUS_OBJECT_NAME_NOT_FOUND"); + return STATUS_OBJECT_NAME_NOT_FOUND; + } - BytesTransferred = (UInt32)(EndOffset - Offset); - Marshal.Copy(CFN.FileData, (int)Offset, Buffer, (int)BytesTransferred); + Marshal.Copy(FileData, (int)Offset, Buffer, (int)BytesTransferred); /* FileNode FileNode = (FileNode)FileNode0; @@ -1101,9 +1115,18 @@ public override Int32 Write( } BytesTransferred = (UInt32)(EndOffset - Offset); + var FileData = CFN.FileData; + var FileDataOffset = Offset; + if (this.FlushMode == FlushMode.FlushAtWrite) + { + FileData = new byte[BytesTransferred]; + CFN.FileData = (Offset == 0 && BytesTransferred == CFN.FileInfo.FileSize) ? FileData : null; + FileDataOffset = 0; + } + try { - Marshal.Copy(Buffer, CFN.FileData, (int)Offset, (int)BytesTransferred); + Marshal.Copy(Buffer, FileData, (int)FileDataOffset, (int)BytesTransferred); } catch (Exception ex) { @@ -1116,13 +1139,9 @@ public override Int32 Write( if (this.FlushMode == FlushMode.FlushAtWrite) { - var Proxy = new WebDavClient2(); try { - if (!Proxy.Upload(FileNode.GetRepositoryParentPath(CFN.RepositoryPath), new MemoryStream(CFN.FileData.Take((int)CFN.FileInfo.FileSize).ToArray()), CFN.Name).GetAwaiter().GetResult()) - { - throw new Exception(); - } + CFN.Upload(FileData, Offset, BytesTransferred); } catch (WebDAVConflictException) { @@ -1500,10 +1519,8 @@ private Int32 SetFileSizeInternal( { if (FileNode.FileInfo.AllocationSize != NewSize) { - if (NewSize > MaxFileSize) return STATUS_DISK_FULL; - byte[] FileData = null; - if (NewSize != 0) + if (this.FlushMode == FlushMode.FlushAtCleanup && NewSize != 0) { try { @@ -1534,7 +1551,7 @@ private Int32 SetFileSizeInternal( if (Result < 0) return Result; } - if (NewSize > FileNode.FileInfo.FileSize) + if (this.FlushMode == FlushMode.FlushAtCleanup && NewSize > FileNode.FileInfo.FileSize) { int CopyLength = (int)(NewSize - FileNode.FileInfo.FileSize); if (CopyLength != 0) Array.Clear(FileNode.FileData, (int)FileNode.FileInfo.FileSize, CopyLength); diff --git a/src/WinFSP/WinFSPUI.xaml b/src/WinFSP/WinFSPUI.xaml index f05f3ab..27b17e2 100644 --- a/src/WinFSP/WinFSPUI.xaml +++ b/src/WinFSP/WinFSPUI.xaml @@ -14,10 +14,10 @@ - + - +