commit b4ec9d3ab40fc0e711c12038728f4767be2381df Author: Michael Jumper Date: Fri Jun 25 00:33:08 2010 -0700 Adding files from old SVN repo, as of 0.2.6 trunk. diff --git a/guacamole/LICENSE.txt b/guacamole/LICENSE.txt new file mode 100644 index 000000000..dba13ed2d --- /dev/null +++ b/guacamole/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/guacamole/ant/build.properties b/guacamole/ant/build.properties new file mode 100644 index 000000000..493c3b1ab --- /dev/null +++ b/guacamole/ant/build.properties @@ -0,0 +1,12 @@ +servlet.api.jar=/usr/share/tomcat6/lib/servlet-api.jar + +src.dir=src +web.dir=web + +build.dir=build +dist.dir=dist +doc.dir=doc + +tar.dir=guacamole-0.2.6 +tar.src.dir=guacamole-src + diff --git a/guacamole/build.xml b/guacamole/build.xml new file mode 100644 index 000000000..585b77a61 --- /dev/null +++ b/guacamole/build.xml @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/guacamole/doc/example/guacamole-users.xml b/guacamole/doc/example/guacamole-users.xml new file mode 100644 index 000000000..50bb77a12 --- /dev/null +++ b/guacamole/doc/example/guacamole-users.xml @@ -0,0 +1,6 @@ + + + + + + diff --git a/guacamole/doc/example/guacamole.xml b/guacamole/doc/example/guacamole.xml new file mode 100644 index 000000000..cf37839aa --- /dev/null +++ b/guacamole/doc/example/guacamole.xml @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/guacamole/src/net/sourceforge/guacamole/Client.java b/guacamole/src/net/sourceforge/guacamole/Client.java new file mode 100644 index 000000000..944e21bc9 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/Client.java @@ -0,0 +1,35 @@ + +package net.sourceforge.guacamole; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import net.sourceforge.guacamole.instruction.Instruction; +import net.sourceforge.guacamole.net.GuacamoleException; +import net.sourceforge.guacamole.vnc.event.KeyEvent; +import net.sourceforge.guacamole.vnc.event.PointerEvent; + +public abstract class Client { + + public abstract void send(KeyEvent event) throws GuacamoleException; + public abstract void send(PointerEvent event) throws GuacamoleException; + public abstract void setClipboard(String clipboard) throws GuacamoleException; + public abstract void disconnect() throws GuacamoleException; + public abstract Instruction nextInstruction(boolean blocking) throws GuacamoleException; + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/ClipboardInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/ClipboardInstruction.java new file mode 100644 index 000000000..f5e62d1ab --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/ClipboardInstruction.java @@ -0,0 +1,39 @@ + +package net.sourceforge.guacamole.instruction; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class ClipboardInstruction extends Instruction { + + private String data; + + public ClipboardInstruction(String data) { + this.data = data; + } + + public String getData() { + return data; + } + + @Override + public String toString() { + return "clipboard:" + escape(getData()) + ";"; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/ErrorInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/ErrorInstruction.java new file mode 100644 index 000000000..36c337784 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/ErrorInstruction.java @@ -0,0 +1,39 @@ + +package net.sourceforge.guacamole.instruction; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class ErrorInstruction extends Instruction { + + private String error; + + public ErrorInstruction(String error) { + this.error = error; + } + + public String getError() { + return error; + } + + @Override + public String toString() { + return "error:" + escape(getError()) + ";"; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/Instruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/Instruction.java new file mode 100644 index 000000000..b7ed3553f --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/Instruction.java @@ -0,0 +1,63 @@ + +package net.sourceforge.guacamole.instruction; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public abstract class Instruction { + + + // All Instructions must provide a toString() implementation + // which returns the properly formatted instruction: + // OPCODE:parm1,parm2,...,parmN; + + @Override + public abstract String toString(); + + public String escape(String str) { + + StringBuffer sb = new StringBuffer(); + + for (int i=0; i. + */ + +public class NameInstruction extends Instruction { + + private String name; + + public NameInstruction(String name) { + this.name = name; + } + + public String getName() { + return name; + } + + @Override + public String toString() { + return "name:" + escape(getName()) + ";"; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/SizeInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/SizeInstruction.java new file mode 100644 index 000000000..4d4ece13c --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/SizeInstruction.java @@ -0,0 +1,47 @@ + +package net.sourceforge.guacamole.instruction; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class SizeInstruction extends Instruction { + + private int width; + private int height; + + public SizeInstruction(int width, int height) { + this.width = width; + this.height = height; + } + + public int getWidth() { + return width; + } + + public int getHeight() { + return height; + } + + @Override + public String toString() { + return "size:" + + getWidth() + "," + + getHeight() + ";"; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/CopyRectInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/CopyRectInstruction.java new file mode 100644 index 000000000..42cc3b930 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/CopyRectInstruction.java @@ -0,0 +1,78 @@ + +package net.sourceforge.guacamole.instruction.framebuffer; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import net.sourceforge.guacamole.instruction.Instruction; + +public class CopyRectInstruction extends Instruction { + + private final int x; + private final int y; + private final int width; + private final int height; + + private final int srcX; + private final int srcY; + + public CopyRectInstruction(int x, int y, int width, int height, int srcX, int srcY) { + this.x = x; + this.y = y; + this.width = width; + this.height = height; + this.srcX = srcX; + this.srcY = srcY; + } + + public int getX() { + return x; + } + + public int getY() { + return y; + } + + public int getWidth() { + return width; + } + + public int getHeight() { + return height; + } + + public int getSrcX() { + return srcX; + } + + public int getSrcY() { + return srcY; + } + + @Override + public String toString() { + return "copy:" + + getSrcX() + "," + + getSrcY() + "," + + getWidth() + "," + + getHeight() + "," + + getX() + "," + + getY() + ";"; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/CursorInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/CursorInstruction.java new file mode 100644 index 000000000..9122f6f6b --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/CursorInstruction.java @@ -0,0 +1,66 @@ +package net.sourceforge.guacamole.instruction.framebuffer; + +import net.sourceforge.guacamole.net.Base64; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import net.sourceforge.guacamole.instruction.Instruction; + +public class CursorInstruction extends Instruction { + + private int x; + private int y; + private PNGImage image; + + public CursorInstruction(int x, int y, PNGImage image) { + this.x = x; + this.y = y; + this.image = image; + } + + public int getX() { + return x; + } + + public int getY() { + return y; + } + + public PNGImage getImage() { + return image; + } + + public int getWidth() { + return getImage().getWidth(); + } + + public int getHeight() { + return getImage().getHeight(); + } + + @Override + public String toString() { + return "cursor:" + + getX() + "," + + getY() + "," + + Base64.toString(getImage().getData()) + ";"; + } + + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/DrawRectInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/DrawRectInstruction.java new file mode 100644 index 000000000..5da8ac271 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/DrawRectInstruction.java @@ -0,0 +1,72 @@ + +package net.sourceforge.guacamole.instruction.framebuffer; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import net.sourceforge.guacamole.instruction.Instruction; + +public class DrawRectInstruction extends Instruction { + + private final int x; + private final int y; + private final int width; + private final int height; + private final int color; + + public DrawRectInstruction(int x, int y, int width, int height, int color) { + this.x = x; + this.y = y; + this.width = width; + this.height = height; + this.color = color; + } + + public int getX() { + return x; + } + + public int getY() { + return y; + } + + public int getWidth() { + return width; + } + + public int getHeight() { + return height; + } + + public int getColor() { + return color; + } + + @Override + public String toString() { + + return "rect:" + + getX() + "," + + getY() + "," + + getWidth() + "," + + getHeight() + "," + + String.format("#%06X", getColor()) + ";"; + + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/PNGImage.java b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/PNGImage.java new file mode 100644 index 000000000..ae2a83e34 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/PNGImage.java @@ -0,0 +1,96 @@ +package net.sourceforge.guacamole.instruction.framebuffer; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.awt.image.BufferedImage; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.OutputStream; +import java.util.Iterator; +import javax.imageio.IIOImage; +import javax.imageio.ImageIO; +import javax.imageio.ImageWriter; +import javax.imageio.stream.ImageOutputStream; +import net.sourceforge.guacamole.vnc.VNCException; + + +public class PNGImage { + + private int width; + private int height; + private byte[] data; + + public PNGImage(BufferedImage image) throws VNCException { + + width = image.getWidth(); + height = image.getHeight(); + + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + + try { + writeImage(image, bos); + bos.flush(); + } + catch (IOException e) { + throw new VNCException("I/O Error while creating PNG.", e); + } + + data = bos.toByteArray(); + } + + public byte[] getData() { + return data; + } + + public int getHeight() { + return height; + } + + public int getWidth() { + return width; + } + + private static void writeImage(BufferedImage image, OutputStream outputStream) throws VNCException, IOException { + + // Obtain list of image writers + // If no such writers exist, fail with error, exit. + Iterator writers = ImageIO.getImageWritersByMIMEType("image/png"); + if (!writers.hasNext()) + throw new VNCException("No useful image writers found."); + + // Obtain JPEG writer + ImageWriter imageWriter = writers.next(); + + // Setup image parameters (including compression quality) + /*ImageWriteParam imageParameters = new JPEGImageWriteParam(Locale.ENGLISH); + imageParameters.setCompressionMode(ImageWriteParam.MODE_EXPLICIT); + imageParameters.setCompressionQuality(0.6f); // 60% quality, currently... + imageParameters.setProgressiveMode(ImageWriteParam.MODE_DEFAULT);*/ + + ImageOutputStream out = ImageIO.createImageOutputStream(outputStream); + + // Write image + imageWriter.setOutput(out); + imageWriter.write(null, new IIOImage(image, null, null), null/*imageParameters*/); + imageWriter.dispose(); + + out.flush(); + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/PNGInstruction.java b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/PNGInstruction.java new file mode 100644 index 000000000..b7f113489 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/instruction/framebuffer/PNGInstruction.java @@ -0,0 +1,65 @@ +package net.sourceforge.guacamole.instruction.framebuffer; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import net.sourceforge.guacamole.instruction.Instruction; +import net.sourceforge.guacamole.net.Base64; + +public class PNGInstruction extends Instruction { + + private int x; + private int y; + private PNGImage image; + + public PNGInstruction(int x, int y, PNGImage image) { + this.x = x; + this.y = y; + this.image = image; + } + + public int getX() { + return x; + } + + public int getY() { + return y; + } + + public PNGImage getImage() { + return image; + } + + public int getWidth() { + return getImage().getWidth(); + } + + public int getHeight() { + return getImage().getHeight(); + } + + @Override + public String toString() { + return "png:" + + getX() + "," + + getY() + "," + + Base64.toString(getImage().getData()) + ";"; + } + + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/Base64.java b/guacamole/src/net/sourceforge/guacamole/net/Base64.java new file mode 100644 index 000000000..a126bb6bd --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/Base64.java @@ -0,0 +1,66 @@ +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class Base64 { + + private static String characters = + "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; + + + public static String toString(byte[] data) { + + StringBuffer buff = new StringBuffer(); + for (int i=0; i> 2 + )); + + buff.append(characters.charAt( + ((a & 0x03) << 4) | + ((b & 0xF0) >> 4) + )); + + if (i+1 < data.length) + buff.append(characters.charAt( + ((b & 0x0F) << 2) | + ((c & 0xC0) >> 6) + )); + else + buff.append('='); + + if (i+2 < data.length) + buff.append(characters.charAt( + (c & 0x3F) + )); + else + buff.append('='); + + } + + return buff.toString(); + + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/Configuration.java b/guacamole/src/net/sourceforge/guacamole/net/Configuration.java new file mode 100644 index 000000000..3a3b188b1 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/Configuration.java @@ -0,0 +1,129 @@ + +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletContext; + +public abstract class Configuration { + + private ServletContext context; + + protected String humanReadableList(Object... values) { + + String list = ""; + for (int i=0; i= 1) + list += ", "; + + if (i == values.length -1) + list += " or "; + + list += "\"" + values[i] + "\""; + } + + return list; + + } + + protected String readParameter(String name, String defaultValue, String... allowedValues) throws GuacamoleException { + + String value = context.getInitParameter(name); + + // Use default if not specified + if (value == null) { + if (defaultValue == null) + throw new GuacamoleException("Parameter \"" + name + "\" is required."); + + return defaultValue; + } + + // If not restricted to certain values, just return whatever is given. + if (allowedValues.length == 0) + return value; + + // If restricted, only return value within given list + for (String allowedValue : allowedValues) + if (value.equals(allowedValue)) + return value; + + throw new GuacamoleException("Parameter \"" + name + "\" must be " + humanReadableList((Object) allowedValues)); + } + + protected boolean readBooleanParameter(String name, Boolean defaultValue) throws GuacamoleException { + + String value = context.getInitParameter(name); + + // Use default if not specified + if (value == null) { + if (defaultValue == null) + throw new GuacamoleException("Parameter \"" + name + "\" is required."); + + return defaultValue; + } + + value = value.trim(); + if (value.equals("true")) + return true; + + if (value.equals("false")) + return false; + + throw new GuacamoleException("Parameter \"" + name + "\" must be \"true\" or \"false\"."); + + } + + protected int readIntParameter(String name, Integer defaultValue, Integer... allowedValues) throws GuacamoleException { + + String parmString = context.getInitParameter(name); + + // Use default if not specified + if (parmString== null) { + if (defaultValue == null) + throw new GuacamoleException("Parameter \"" + name + "\" is required."); + + return defaultValue; + } + + try { + int value = Integer.parseInt(parmString); + + // If not restricted to certain values, just return whatever is given. + if (allowedValues.length == 0) + return value; + + // If restricted, only return value within given list + for (int allowedValue : allowedValues) + if (value == allowedValue) + return value; + + throw new GuacamoleException("Parameter \"" + name + "\" must be " + humanReadableList((Object) allowedValues)); + } + catch (NumberFormatException e) { + throw new GuacamoleException("Parameter \"" + name + "\" must be an integer.", e); + } + + } + + public Configuration(ServletContext context) { + this.context = context; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/GuacamoleConfiguration.java b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleConfiguration.java new file mode 100644 index 000000000..0c84247ab --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleConfiguration.java @@ -0,0 +1,64 @@ + +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletContext; + +public class GuacamoleConfiguration extends Configuration { + + private String hostname; + private int port; + private String password; + private int outputBPP; + private boolean compressStream; + + public GuacamoleConfiguration(ServletContext context) throws GuacamoleException { + + super(context); + + hostname = readParameter("host", null); + port = readIntParameter("port", null); + password = context.getInitParameter("password"); + outputBPP = readIntParameter("output-bpp", 8, 8, 24); + compressStream = readBooleanParameter("compress-stream", false); + + } + + public String getHostname() { + return hostname; + } + + public int getOutputBPP() { + return outputBPP; + } + + public String getPassword() { + return password; + } + + public int getPort() { + return port; + } + + public boolean getCompressStream() { + return compressStream; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/GuacamoleException.java b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleException.java new file mode 100644 index 000000000..a1079f4a2 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleException.java @@ -0,0 +1,36 @@ + +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class GuacamoleException extends Exception { + + public GuacamoleException(String message, Throwable cause) { + super(message, cause); + } + + public GuacamoleException(String message) { + super(message); + } + + public GuacamoleException(Throwable cause) { + super(cause); + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/GuacamoleServlet.java b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleServlet.java new file mode 100644 index 000000000..129329411 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleServlet.java @@ -0,0 +1,62 @@ + +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.io.IOException; +import javax.servlet.ServletException; +import javax.servlet.http.HttpServlet; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import net.sourceforge.guacamole.vnc.VNCException; + +public abstract class GuacamoleServlet extends HttpServlet { + + @Override + protected final void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { + try { + handleRequest(req, resp); + } + catch (GuacamoleException e) { + throw new ServletException(e); + } + } + + @Override + protected final void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { + try { + handleRequest(req, resp); + } + catch (GuacamoleException e) { + throw new ServletException(e); + } + } + + private final void handleRequest(HttpServletRequest request, HttpServletResponse response) throws GuacamoleException { + GuacamoleSession session = new GuacamoleSession(request.getSession(shouldCreateSession())); + handleRequest(session, request, response); + } + + protected abstract void handleRequest(GuacamoleSession session, HttpServletRequest request, HttpServletResponse response) throws GuacamoleException; + + protected boolean shouldCreateSession() { + return false; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/GuacamoleSession.java b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleSession.java new file mode 100644 index 000000000..b25c1e6cb --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/GuacamoleSession.java @@ -0,0 +1,123 @@ + +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletContext; +import javax.servlet.http.HttpSession; +import javax.servlet.http.HttpSessionBindingEvent; +import javax.servlet.http.HttpSessionBindingListener; +import net.sourceforge.guacamole.Client; +import net.sourceforge.guacamole.vnc.VNCClient; +import net.sourceforge.guacamole.vnc.VNCConfiguration; +import net.sourceforge.guacamole.vnc.VNCException; + +public class GuacamoleSession { + + private GuacamoleConfiguration config; + private final HttpSession session; + private Client client; + + private class SessionVNCClient extends VNCClient implements HttpSessionBindingListener { + + public SessionVNCClient(String host, int port, String password, int colorBits, int outputBPP) throws VNCException { + super(host, port, password, colorBits, outputBPP); + } + + public void valueBound(HttpSessionBindingEvent event) { + // Do nothing + } + + public void valueUnbound(HttpSessionBindingEvent event) { + try { + disconnect(); + } + catch (GuacamoleException e) { + // Ignore + } + } + + } + + public GuacamoleSession(HttpSession session) throws GuacamoleException { + + if (session == null) + throw new GuacamoleException("User has no session."); + + this.session = session; + synchronized (session) { + + // Read configuration parameters + ServletContext context = session.getServletContext(); + config = new GuacamoleConfiguration(context); + + client = (Client) session.getAttribute("CLIENT"); + } + } + + public void connect() throws GuacamoleException { + synchronized (session) { + + if (client != null) + client.disconnect(); + + // Connect to VNC server + try { + + // Read VNC-specific parameters + ServletContext context = session.getServletContext(); + VNCConfiguration vncconfig = new VNCConfiguration(context); + + client = new SessionVNCClient( + config.getHostname(), + config.getPort(), + vncconfig.getPassword(), + vncconfig.getBPP(), + config.getOutputBPP() + ); + } + catch (VNCException e) { + throw new GuacamoleException(e); + } + + session.setAttribute("CLIENT", client); + + } + } + + public GuacamoleConfiguration getConfiguration() { + return config; + } + + public Client getClient() { + synchronized (session) { + return client; + } + } + + public void invalidate() { + session.invalidate(); + } + + public void disconnect() throws GuacamoleException { + if (client != null) + client.disconnect(); + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/XMLGuacamoleServlet.java b/guacamole/src/net/sourceforge/guacamole/net/XMLGuacamoleServlet.java new file mode 100644 index 000000000..c626a5211 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/XMLGuacamoleServlet.java @@ -0,0 +1,131 @@ + +package net.sourceforge.guacamole.net; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.OutputStream; +import javax.servlet.ServletRequest; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.OutputKeys; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerConfigurationException; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.dom.DOMSource; +import javax.xml.transform.stream.StreamResult; +import net.sourceforge.guacamole.Client; +import org.w3c.dom.Document; +import org.w3c.dom.Element; + +public abstract class XMLGuacamoleServlet extends GuacamoleServlet { + + @Override + protected final void handleRequest(GuacamoleSession session, HttpServletRequest request, HttpServletResponse response) throws GuacamoleException { + + response.setContentType("text/xml"); + response.setHeader("Cache-Control", "no-store"); + response.setHeader("Pragma", "no-cache"); + response.setDateHeader("Expires", 0); + + try { + + // Create document + DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance(); + DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder(); + Document document = documentBuilder.newDocument(); + + // Root element + Element root = document.createElement("guacamole"); + document.appendChild(root); + + try { + handleRequest(session, request, root); + } + catch (Throwable t) { + addFatalError(root, t.getMessage()); + + // FATAL error ... try to disconnect + if (session != null) { + Client client = session.getClient(); + try { + if (client != null) + client.disconnect(); + } + catch (GuacamoleException e) { + addFatalError(root, e.getMessage()); + } + } + } + + // Set up transformer + TransformerFactory transformerFactory = TransformerFactory.newInstance(); + Transformer transformer = transformerFactory.newTransformer(); + transformer.setOutputProperty(OutputKeys.INDENT, "yes"); + //transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); + transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8"); + + // Write XML using transformer + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + StreamResult result = new StreamResult(bos); + DOMSource source = new DOMSource(document); + transformer.transform(source, result); + + + bos.flush(); + + byte[] xmlData = bos.toByteArray(); + response.setContentLength(xmlData.length); + OutputStream outputStream = response.getOutputStream(); + outputStream.write(xmlData); + + // Close stream + outputStream.close(); + } + catch (ParserConfigurationException e) { + throw new GuacamoleException(e); + } + catch (TransformerConfigurationException e) { + throw new GuacamoleException(e); + } + catch (TransformerException e) { + throw new GuacamoleException(e); + } + catch (IOException e) { + throw new GuacamoleException(e); + } + + + } + + private void addFatalError(Element root, String message) { + Element error = root.getOwnerDocument().createElement("error"); + error.setAttribute("type", "fatal"); + error.setTextContent(message); + root.appendChild(error); + } + + protected abstract void handleRequest(GuacamoleSession session, ServletRequest request, Element root) throws GuacamoleException; + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/control/Connect.java b/guacamole/src/net/sourceforge/guacamole/net/control/Connect.java new file mode 100644 index 000000000..c63126553 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/control/Connect.java @@ -0,0 +1,47 @@ +package net.sourceforge.guacamole.net.control; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletRequest; + +import org.w3c.dom.Element; + +import net.sourceforge.guacamole.net.XMLGuacamoleServlet; +import net.sourceforge.guacamole.net.GuacamoleException; +import net.sourceforge.guacamole.net.GuacamoleSession; + +public class Connect extends XMLGuacamoleServlet { + + protected boolean shouldCreateSession() { + return true; + } + + @Override + protected void handleRequest(GuacamoleSession session, ServletRequest request, Element root) throws GuacamoleException { + + try { + session.connect(); + } + catch (GuacamoleException e) { + throw new GuacamoleException("Error connecting to server: " + e.getMessage(), e); + } + + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/control/Disconnect.java b/guacamole/src/net/sourceforge/guacamole/net/control/Disconnect.java new file mode 100644 index 000000000..bd889f540 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/control/Disconnect.java @@ -0,0 +1,43 @@ +package net.sourceforge.guacamole.net.control; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletRequest; + +import org.w3c.dom.Element; + +import net.sourceforge.guacamole.net.XMLGuacamoleServlet; +import net.sourceforge.guacamole.net.GuacamoleException; +import net.sourceforge.guacamole.net.GuacamoleSession; + +public class Disconnect extends XMLGuacamoleServlet { + + @Override + protected void handleRequest(GuacamoleSession session, ServletRequest request, Element root) throws GuacamoleException { + + try { + session.disconnect(); // Disconnect client. + } + catch (GuacamoleException e) { + throw new GuacamoleException("Error disconnecting from VNC server: " + e.getMessage(), e); + } + + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/net/input/Clipboard.java b/guacamole/src/net/sourceforge/guacamole/net/input/Clipboard.java new file mode 100644 index 000000000..549a19c10 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/input/Clipboard.java @@ -0,0 +1,69 @@ + +package net.sourceforge.guacamole.net.input; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletRequest; +import net.sourceforge.guacamole.net.GuacamoleException; +import org.w3c.dom.Element; + +import net.sourceforge.guacamole.net.GuacamoleSession; +import net.sourceforge.guacamole.net.XMLGuacamoleServlet; +import net.sourceforge.guacamole.vnc.VNCException; + +import java.io.IOException; +import java.io.Reader; + +/** + * Servlet which sets the VNC clipboard data. + * + * This servlet takes one parameter: + * data: The data to set the clipboard to. + * + * @author Michael Jumper + */ + +public class Clipboard extends XMLGuacamoleServlet { + + @Override + protected void handleRequest(GuacamoleSession session, ServletRequest request, Element root) throws GuacamoleException { + + try { + + // Read data from request body + Reader reader = request.getReader(); + StringBuilder data = new StringBuilder(); + + int codepoint; + while ((codepoint = reader.read()) != -1) + data.appendCodePoint(codepoint); + + // Set clipboard + session.getClient().setClipboard(data.toString()); + } + catch (IOException e) { + throw new GuacamoleException("I/O error sending clipboard to server: " + e.getMessage(), e); + } + catch (GuacamoleException e) { + throw new GuacamoleException("Error sending clipboard to server: " + e.getMessage(), e); + } + + } +} + diff --git a/guacamole/src/net/sourceforge/guacamole/net/input/Key.java b/guacamole/src/net/sourceforge/guacamole/net/input/Key.java new file mode 100644 index 000000000..1099fe83e --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/input/Key.java @@ -0,0 +1,67 @@ + +package net.sourceforge.guacamole.net.input; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletRequest; +import net.sourceforge.guacamole.net.GuacamoleException; +import org.w3c.dom.Element; +import net.sourceforge.guacamole.vnc.event.KeyEvent; + +import net.sourceforge.guacamole.net.GuacamoleSession; +import net.sourceforge.guacamole.net.XMLGuacamoleServlet; +import net.sourceforge.guacamole.vnc.VNCException; + +/** + * Servlet which accepts keyboard input events, forwards these events to the + * VNC client associated with the session, and returns the result (if any) + * to the HTTP client via XML. + * + * This servlet takes three parameters: + * index: The event index. As HTTP requests may arrive out of order, + * this index provides the event queue with a means of sorting + * events, and determining if events are missing. The first + * event has index 0. + * pressed: Whether the key was pressed (1) or released (0). + * keysym: The integer representing the corresponding X11 keysym. + * + * @author Michael Jumper + */ + +public class Key extends XMLGuacamoleServlet { + + @Override + protected void handleRequest(GuacamoleSession session, ServletRequest request, Element root) throws GuacamoleException { + + // Event parameters + int index = Integer.parseInt(request.getParameter("index")); + boolean pressed = request.getParameter("pressed").equals("1"); + int keysym = Integer.parseInt(request.getParameter("keysym")); + + // Send/queue event + try { + session.getClient().send(new KeyEvent(index, keysym, pressed)); + } + catch (GuacamoleException e) { + throw new GuacamoleException("Error sending key event to server: " + e.getMessage(), e); + } + + } +} + diff --git a/guacamole/src/net/sourceforge/guacamole/net/input/Pointer.java b/guacamole/src/net/sourceforge/guacamole/net/input/Pointer.java new file mode 100644 index 000000000..4abf0ce01 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/input/Pointer.java @@ -0,0 +1,64 @@ +package net.sourceforge.guacamole.net.input; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import javax.servlet.ServletRequest; +import net.sourceforge.guacamole.net.GuacamoleException; +import org.w3c.dom.Element; +import net.sourceforge.guacamole.vnc.event.PointerEvent; + +import net.sourceforge.guacamole.net.GuacamoleSession; +import net.sourceforge.guacamole.net.XMLGuacamoleServlet; +import net.sourceforge.guacamole.vnc.VNCException; + +public class Pointer extends XMLGuacamoleServlet { + + + @Override + protected void handleRequest(GuacamoleSession session, ServletRequest request, Element root) throws GuacamoleException { + // Event parameters + String[] events = request.getParameterValues("event"); + + for (String event : events) { + + String[] parameters = event.split(","); + + int index = Integer.parseInt(parameters[0]); + + int x = Integer.parseInt(parameters[1]); + int y = Integer.parseInt(parameters[2]); + + boolean left = parameters[3].equals("1"); + boolean middle = parameters[4].equals("1"); + boolean right = parameters[5].equals("1"); + boolean up = parameters[6].equals("1"); + boolean down = parameters[7].equals("1"); + + // Store event + try { + session.getClient().send(new PointerEvent(index, left, middle, right, up, down, x, y)); + } + catch (GuacamoleException e) { + throw new GuacamoleException("Error sending pointer event to server: " + e.getMessage(), e); + } + } + } + +} + diff --git a/guacamole/src/net/sourceforge/guacamole/net/output/InstructionStream.java b/guacamole/src/net/sourceforge/guacamole/net/output/InstructionStream.java new file mode 100644 index 000000000..1bd9bc2c2 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/net/output/InstructionStream.java @@ -0,0 +1,130 @@ +package net.sourceforge.guacamole.net.output; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.io.OutputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.util.zip.DeflaterOutputStream; +import java.util.zip.GZIPOutputStream; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import net.sourceforge.guacamole.Client; +import net.sourceforge.guacamole.net.GuacamoleServlet; +import net.sourceforge.guacamole.net.GuacamoleException; +import net.sourceforge.guacamole.net.GuacamoleSession; +import net.sourceforge.guacamole.instruction.Instruction; +import net.sourceforge.guacamole.instruction.ErrorInstruction; + + +public class InstructionStream extends GuacamoleServlet { + + @Override + protected void handleRequest(GuacamoleSession session, HttpServletRequest request, HttpServletResponse response) throws GuacamoleException { + + // Instruction buffer + StringBuilder instructions = new StringBuilder(); + + try { + + // Query new update from VNC server + Client client = session.getClient(); + + int messageLimit = Integer.parseInt(request.getParameter("messageLimit")); + + // For all messages, up to given message limit. + Instruction message = client.nextInstruction(true); // Block until first message is read + while (message != null) { + + // Add message + instructions.append(message.toString()); + + // No more messages if we're exceeding our limit + if (instructions.length() >= messageLimit) break; + + message = client.nextInstruction(false); // Read remaining messages, do not block. + } + + } + catch (GuacamoleException e) { + instructions.append(new ErrorInstruction(e.getMessage()).toString()); + } + + try { + + // Get output bytes + byte[] outputBytes = instructions.toString().getBytes("UTF-8"); + + // Compress if enabled and supported by browser + if (session.getConfiguration().getCompressStream()) { + + String encodingHeader = request.getHeader("Accept-Encoding"); + if (encodingHeader != null) { + + String[] encodings = encodingHeader.split(","); + for (String encoding : encodings) { + + // Use gzip if supported + if (encoding.equals("gzip")) { + response.setHeader("Content-Encoding", "gzip"); + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + OutputStream zout = new GZIPOutputStream(bos); + zout.write(outputBytes); + zout.close(); + outputBytes = bos.toByteArray(); + break; + } + + // Use deflate if supported + if (encoding.equals("deflate")) { + response.setHeader("Content-Encoding", "deflate"); + ByteArrayOutputStream bos = new ByteArrayOutputStream(); + OutputStream zout = new DeflaterOutputStream(bos); + zout.write(outputBytes); + zout.close(); + outputBytes = bos.toByteArray(); + break; + } + + } + + } + + } + + response.setContentType("text/plain"); + response.setContentLength(outputBytes.length); + + // Use default output stream if no compression. + OutputStream out = response.getOutputStream(); + out.write(outputBytes); + out.flush(); + } + catch (UnsupportedEncodingException e) { + throw new GuacamoleException("UTF-8 not supported by Java.", e); + } + catch (IOException e) { + throw new GuacamoleException("I/O error writing to servlet output stream.", e); + } + + } + +} + diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/.VNCClient.java.swp b/guacamole/src/net/sourceforge/guacamole/vnc/.VNCClient.java.swp new file mode 100644 index 000000000..e997b5158 Binary files /dev/null and b/guacamole/src/net/sourceforge/guacamole/vnc/.VNCClient.java.swp differ diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/InputOutputStream.java b/guacamole/src/net/sourceforge/guacamole/vnc/InputOutputStream.java new file mode 100644 index 000000000..a796522e9 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/InputOutputStream.java @@ -0,0 +1,63 @@ + +package net.sourceforge.guacamole.vnc; + +import java.io.IOException; +import java.io.InputStream; +import java.util.LinkedList; + +public class InputOutputStream extends InputStream { + + private int pos = 0; + private byte[] current = null; + private LinkedList buffer = new LinkedList(); + + public void write(byte[] data) { + + if (data.length == 0) + return; + + if (current == null) + current = data; + else + buffer.addLast(data); + } + + @Override + public int read() throws IOException { + + if (pos >= current.length) { + if (buffer.size() == 0) + throw new IOException("Buffer underrun."); + + current = buffer.removeFirst(); + pos = 0; + } + + return 0xFF & current[pos++]; + + } + + @Override + public int read(byte[] data) throws IOException { + return read(data, 0, data.length); + } + + @Override + public int read(byte[] data, int off, int len) throws IOException { + + if (pos >= current.length) { + if (buffer.size() == 0) + throw new IOException("Buffer underrun."); + + current = buffer.removeFirst(); + pos = 0; + } + + int amountRead = Math.min(current.length - pos, len); + System.arraycopy(current, pos, data, off, amountRead); + pos += amountRead; + + return amountRead; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/VNCClient.java b/guacamole/src/net/sourceforge/guacamole/vnc/VNCClient.java new file mode 100644 index 000000000..52a0eeee1 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/VNCClient.java @@ -0,0 +1,1098 @@ +package net.sourceforge.guacamole.vnc; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.awt.image.WritableRaster; +import net.sourceforge.guacamole.instruction.framebuffer.PNGInstruction; +import net.sourceforge.guacamole.instruction.framebuffer.CursorInstruction; +import net.sourceforge.guacamole.instruction.framebuffer.CopyRectInstruction; +import net.sourceforge.guacamole.vnc.event.PointerEvent; +import net.sourceforge.guacamole.vnc.event.EventQueue; +import net.sourceforge.guacamole.vnc.event.KeyEvent; +import net.sourceforge.guacamole.vnc.event.EventHandler; +import java.awt.image.BufferedImage; +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.DataInputStream; +import java.io.DataOutputStream; +import java.io.IOException; +import java.io.UnsupportedEncodingException; + +import java.net.Socket; +import java.net.InetSocketAddress; +import java.net.SocketTimeoutException; +import java.net.UnknownHostException; +import java.util.LinkedList; + +import javax.crypto.Cipher; +import javax.crypto.spec.DESKeySpec; +import javax.crypto.SecretKeyFactory; +import javax.crypto.BadPaddingException; +import javax.crypto.NoSuchPaddingException; +import javax.crypto.IllegalBlockSizeException; +import java.security.InvalidKeyException; +import java.security.NoSuchAlgorithmException; +import java.security.spec.InvalidKeySpecException; +import java.util.zip.InflaterInputStream; +import java.util.zip.Inflater; +import net.sourceforge.guacamole.Client; + +import net.sourceforge.guacamole.instruction.ClipboardInstruction; +import net.sourceforge.guacamole.instruction.Instruction; +import net.sourceforge.guacamole.instruction.NameInstruction; +import net.sourceforge.guacamole.instruction.SizeInstruction; +import net.sourceforge.guacamole.instruction.framebuffer.PNGImage; +import net.sourceforge.guacamole.net.GuacamoleException; + +public class VNCClient extends Client { + + private static final int SECURITY_TYPE_INVALID = 0; + private static final int SECURITY_TYPE_NONE = 1; + private static final int SECURITY_TYPE_VNC_AUTHENTICATION = 2; + + private static final int SECURITY_RESULT_OK = 0; + private static final int SECURITY_RESULT_FAILED = 1; + + private static final int MESSAGE_SET_PIXEL_FORMAT = 0; + private static final int MESSAGE_SET_ENCODINGS = 2; + private static final int MESSAGE_FRAMEBUFFER_UPDATE_REQUEST = 3; + private static final int MESSAGE_KEY_EVENT = 4; + private static final int MESSAGE_POINTER_EVENT = 5; + private static final int MESSAGE_CLIENT_CUT_TEXT = 6; + + private static final int MESSAGE_FRAMEBUFFER_UPDATE = 0; + private static final int MESSAGE_SET_COLORMAP_ENTRIES = 1; + private static final int MESSAGE_BELL = 2; + private static final int MESSAGE_SERVER_CUT_TEXT = 3; + + private static final int HEXTILE_FLAG_RAW = 1; + private static final int HEXTILE_FLAG_BACKGROUND_SPECIFIED = 2; + private static final int HEXTILE_FLAG_FOREGROUND_SPECIFIED = 4; + private static final int HEXTILE_FLAG_ANY_SUBRECTS = 8; + private static final int HEXTILE_FLAG_SUBRECTS_COLORED = 16; + + private static final int ENCODING_RAW = 0; + private static final int ENCODING_COPYRECT = 1; + private static final int ENCODING_RRE = 2; + private static final int ENCODING_HEXTILE = 5; + private static final int ENCODING_ZRLE = 16; + private static final int ENCODING_CURSOR = -239; + + private final Socket sock; + private final DataInputStream input; + private final DataOutputStream output; + + private int frameBufferWidth; + private int frameBufferHeight; + private String name; + + private boolean needRefresh = true; + private VNCImageReader rawReader = null; + + private InputOutputStream toZlib; + private DataInputStream fromZlib; + + public int getFrameBufferHeight() { + return frameBufferHeight; + } + + public int getFrameBufferWidth() { + return frameBufferWidth; + } + + public String getName() { + return name; + } + + public byte reverse(byte b) { + + int input = b & 0xFF; + int output = 0; + + for (int i=0; i<8; i++) { + + output <<= 1; + + if ((input & 0x01) != 0) + output |= 0x01; + + input >>= 1; + + } + + return (byte) output; + } + + // Generates VNC key from string + private byte[] generateVNCAuthKey(String password) throws VNCException { + + try { + // Get password bytes + byte[] passwordBytes = password.getBytes("iso-8859-1"); + if (passwordBytes.length > 8) + throw new VNCException("Password must be 8 characters (bytes) or less."); + + // Reverse bit order of all bytes in array + for (int i=0; i 0 && height > 0) { + BufferedImage image = rawReader.readImage(input, width, height); + + // Construct FramebufferUpdate + PNGInstruction update = new PNGInstruction(dstX, dstY, new PNGImage(image)); + instructions.addLast(update); + + // If full-screen refresh, reset refresh flag. + if (dstX == 0 && dstY == 0 && width == frameBufferWidth && height == frameBufferHeight) + needRefresh = false; + } + } + else if (type == ENCODING_COPYRECT) { + + // Read CopyRect encoding + int srcX = input.readUnsignedShort(); + int srcY = input.readUnsignedShort(); + + // Construct FramebufferUpdate + + if (width > 0 && height > 0) { + CopyRectInstruction update = new CopyRectInstruction(dstX, dstY, width, height, srcX, srcY); + instructions.addLast(update); + } + } + else if (type == ENCODING_RRE) { + + int numSubRects = input.readInt(); + int background = rawReader.readPixel(input); + + BufferedImage image = null; + + if (width > 0 && height > 0) { + image = rawReader.generateBlankImage(width, height); + } + + //instructions.addLast(new DrawRectInstruction(dstX, dstY, width, height, background)); + if (image != null) { + fillRect(image, 0, 0, width, height, background); + } + + for (int j=0; j 0 && height > 0) { + BufferedImage image = rawReader.generateBlankImage(width, height); + WritableRaster raster = image.getWritableTile(0, 0); + + int backgroundColor = 0; + int foregroundColor = 0; + + // For all 16x16 tiles in left-to-right, top-to-bottom order + for (int tileOffsetY = 0; tileOffsetY < height; tileOffsetY += 16) { + + int tileHeight = Math.min(16, height - tileOffsetY); + + for (int tileOffsetX = 0; tileOffsetX < width; tileOffsetX += 16) { + + int tileWidth = Math.min(16, width - tileOffsetX); + + int flags = input.read(); + + // If RAW flag is set, other flags are irrelevant. + if ((flags & HEXTILE_FLAG_RAW) != 0) { + + // Read and draw raw tile + BufferedImage tile = rawReader.readImage(input, tileWidth, tileHeight); + raster.setRect(tileOffsetX, tileOffsetY, tile.getData()); + + } + + // RAW = 0 + else { + + // If background specified, read pixel value + if ((flags & HEXTILE_FLAG_BACKGROUND_SPECIFIED) != 0) + backgroundColor = rawReader.readPixel(input); + + // Draw background + fillRect(image, tileOffsetX, tileOffsetY, tileWidth, tileHeight, backgroundColor); + + // If foreground specified, read pixel value + if ((flags & HEXTILE_FLAG_FOREGROUND_SPECIFIED) != 0) + foregroundColor = rawReader.readPixel(input); + + // If subrects present, read subrects + if ((flags & HEXTILE_FLAG_ANY_SUBRECTS) != 0) { + + // Read number of subrects, determine whether they are colored + int numSubRects = input.read(); + boolean colored = (flags & HEXTILE_FLAG_SUBRECTS_COLORED) != 0; + + int color = foregroundColor; + for (int j=0; j> 4; + int y = position & 0x0F; + + // Read dimensions + int dimensions = input.read(); + int w = (dimensions >> 4) + 1; + int h = (dimensions & 0x0F) + 1; + + fillRect(image, tileOffsetX+x, tileOffsetY+y, w, h, color); + } + + } + + } // end if not raw + + } + } + + // Send as png instruction (rects are too inefficient) + PNGInstruction update = new PNGInstruction(dstX, dstY, new PNGImage(image)); + instructions.addLast(update); + + // If full-screen refresh, reset refresh flag. + if (dstX == 0 && dstY == 0 && width == frameBufferWidth && height == frameBufferHeight) + needRefresh = false; + } + + } + else if (type == ENCODING_ZRLE) { + + // Read ZLIB data + int length = input.readInt(); + byte[] zlibData = new byte[length]; + input.readFully(zlibData); + + // Write data to ZLIB stream + toZlib.write(zlibData); + + + if (width > 0 && height > 0) { + BufferedImage image = rawReader.generateBlankImage(width, height); + WritableRaster raster = image.getWritableTile(0, 0); + + // For all 64x64 tiles in left-to-right, top-to-bottom order + for (int tileOffsetY = 0; tileOffsetY < height; tileOffsetY += 64) { + + int tileHeight = Math.min(64, height - tileOffsetY); + + for (int tileOffsetX = 0; tileOffsetX < width; tileOffsetX += 64) { + + int tileWidth = Math.min(64, width - tileOffsetX); + + // Get subencoding type (RLE flag + palette size) + int subencodingType = fromZlib.read(); + + // If RAW, just read raw image + if (subencodingType == 0) { + + // Read and draw raw tile + if (image != null) { + BufferedImage tile = rawReader.readCImage(fromZlib, tileWidth, tileHeight); + raster.setRect(tileOffsetX, tileOffsetY, tile.getData()); + } + + } + + // If single color... + else if (subencodingType == 1) { + + // Read color + int color = rawReader.readCPixel(fromZlib); + + // Draw solid rectangle + if (image != null) { + fillRect(image, tileOffsetX, tileOffsetY, tileWidth, tileHeight, color); + } + + } + + // Packed palette + else if (subencodingType >= 2 && subencodingType <= 16) { + + int paletteSize = subencodingType; + int[] palette = new int[paletteSize]; + + // Read palette + for (int j=0; j> (8 - indexBits); + buffer <<= indexBits; + bitsAvailable -= indexBits; + + // Write pixel to image + image.setRGB(tileOffsetX+x, tileOffsetY+y, 0xFF000000 | palette[index]); + + } + } + + } + + // Plain RLE + else if (subencodingType == 128) { + + int color = -1; + int runRemaining= 0; + + for (int y=0; y= 130 && subencodingType <= 255) { + + int paletteSize = subencodingType - 128; + int[] palette = new int[paletteSize]; + + // Read palette + for (int j=0; j 0 && height > 0) { + BufferedImage image = rawReader.readImage(input, width, height); + + // Read cursor mask + for (int y=0; y> 8; + int green = input.readUnsignedShort() >> 8; + int blue = input.readUnsignedShort() >> 8; + + reds[i] = (byte) red; + greens[i] = (byte) green; + blues[i] = (byte) blue; + alphas[i] = (byte) 0xFF; + } + + // Set reader + rawReader = new VNCIndexedImageReader(reds, greens, blues); + } + + private void handleBell() { + // Do nothing, currently + // This message has no data, so no need to dummy-read. + log("BELL!"); + } + + private void handleServerCutText() throws IOException { + + byte[] padding = new byte[3]; + input.readFully(padding); + + int length = input.readInt(); + byte[] textBytes = new byte[length]; + input.readFully(textBytes); + + String clipboard = new String(textBytes, "UTF-8"); + instructions.addLast(new ClipboardInstruction(clipboard)); + } + + private void setPixelFormat(int bitsPerPixel, int depth, + boolean bigEndian, boolean trueColor, + int redMax, int greenMax, int blueMax, + int redShift, int greenShift, int blueShift) + throws IOException { + + synchronized (output) { + output.writeByte(MESSAGE_SET_PIXEL_FORMAT); + output.writeBytes(" "); // Padding + output.writeByte(bitsPerPixel); + output.writeByte(depth); + output.writeBoolean(bigEndian); + output.writeBoolean(trueColor); + output.writeShort(redMax); + output.writeShort(greenMax); + output.writeShort(blueMax); + output.writeByte(redShift); + output.writeByte(greenShift); + output.writeByte(blueShift); + output.writeBytes(" "); // Padding + output.flush(); + } + + } + + // Last is most recent message. + private final Object instructionLock = new Object(); + private LinkedList instructions = new LinkedList(); + + @Override + public void setClipboard(String clipboard) throws GuacamoleException { + try { + sendClipboard(clipboard); + } + catch (IOException e) { + throw new GuacamoleException("Could not send clipboard data to VNC server (network error).", e); + } + } + + @Override + public void send(KeyEvent event) throws GuacamoleException { + try { + // Add to queue + keyEvents.add(event); + } + catch (IOException e) { + throw new GuacamoleException("Could not send keyboard event to VNC server (network error).", e); + } + } + + @Override + public void send(PointerEvent event) throws GuacamoleException { + try { + // Add to queue + pointerEvents.add(event); + } + catch (IOException e) { + throw new GuacamoleException("Could not send pointer event to VNC server (network error).", e); + } + } + + private static final int EVENT_DEADLINE = 500; + + private EventQueue keyEvents = new EventQueue(new EventHandler() { + + public void handle(KeyEvent e) throws IOException { + sendKeyEvent(e.getPressed(), e.getKeySym()); + } + + }, EVENT_DEADLINE); + + private EventQueue pointerEvents = new EventQueue(new EventHandler() { + + public void handle(PointerEvent e) throws IOException { + sendPointerEvent( + e.isLeftButtonPressed(), + e.isMiddleButtonPressed(), + e.isRightButtonPressed(), + e.isUpButtonPressed(), + e.isDownButtonPressed(), + e.getX(), + e.getY() + ); + } + + }, EVENT_DEADLINE); + + private void sendClipboard(String clipboard) throws IOException { + + synchronized (output) { + output.writeByte(MESSAGE_CLIENT_CUT_TEXT); + output.writeBytes(" "); // Padding + + byte[] encodedString = clipboard.getBytes("UTF-8"); + + output.writeInt(encodedString.length); + output.write(encodedString); + output.flush(); + } + + } + + private void sendKeyEvent(boolean pressed, int keysym) throws IOException { + + synchronized (output) { + output.writeByte(MESSAGE_KEY_EVENT); + output.writeBoolean(pressed); + output.writeBytes(" "); // Padding + output.writeInt(keysym); + output.flush(); + } + + //log("Sent key event."); + } + + private void sendPointerEvent(boolean left, boolean middle, boolean right, boolean up, boolean down, int x, int y) throws IOException { + + int buttonMask = 0; + if (left) buttonMask |= 1; + if (middle) buttonMask |= 2; + if (right) buttonMask |= 4; + if (up) buttonMask |= 8; + if (down) buttonMask |= 16; + + synchronized (output) { + output.writeByte(MESSAGE_POINTER_EVENT); + output.writeByte(buttonMask); + output.writeShort(x); + output.writeShort(y); + output.flush(); + } + + //log("Sent pointer event."); + } + + private void sendEncodings(int... encodings) throws IOException { + + synchronized (output) { + output.writeByte(MESSAGE_SET_ENCODINGS); + output.writeBytes(" "); // padding + output.writeShort(encodings.length); + + for (int encoding : encodings) + output.writeInt(encoding); + } + + } + + @Override + public Instruction nextInstruction(boolean blocking) + throws GuacamoleException { + + synchronized (instructionLock) { + if (instructions.size() == 0) { + + try { + // Send framebuffer update request + synchronized (output) { + output.writeByte(MESSAGE_FRAMEBUFFER_UPDATE_REQUEST); + output.writeBoolean(!needRefresh); // Incremental + output.writeShort(0); // x + output.writeShort(0); // y + output.writeShort(frameBufferWidth); // width + output.writeShort(frameBufferHeight); // height + output.flush(); + } + } + catch (IOException e) { + throw new GuacamoleException("Could not send framebuffer update request to VNC server (network error).", e); + } + + // Handle incoming messages, blocking until one message exists + try { + handleMessages(blocking); + } + catch (IOException e) { + throw new GuacamoleException("Could not read messages from VNC server (network error).", e); + } + catch (VNCException e) { + throw new GuacamoleException(e); + } + + } + + // If no messages, return null. + if (instructions.size() == 0) + return null; + + // Send messages, oldest first + return instructions.removeFirst(); + } + + } + + private void log(String str) { + System.err.println(str); + } + + @Override + public void disconnect() throws GuacamoleException { + try { + + // Close event queues + keyEvents.close(); + pointerEvents.close(); + + // Close socket + sock.close(); + } + catch (IOException e) { + throw new GuacamoleException("Network error while closing socket.", e); + } + } +} + diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/VNCConfiguration.java b/guacamole/src/net/sourceforge/guacamole/vnc/VNCConfiguration.java new file mode 100644 index 000000000..bdab8d826 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/VNCConfiguration.java @@ -0,0 +1,47 @@ + +package net.sourceforge.guacamole.vnc; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import net.sourceforge.guacamole.net.*; +import javax.servlet.ServletContext; + +public class VNCConfiguration extends Configuration { + + private String password; + private int bpp; + + public VNCConfiguration(ServletContext context) throws GuacamoleException { + + super(context); + + password = context.getInitParameter("password"); + bpp = readIntParameter("bpp", 24, 8, 16, 24); + + } + + public int getBPP() { + return bpp; + } + + public String getPassword() { + return password; + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/VNCException.java b/guacamole/src/net/sourceforge/guacamole/vnc/VNCException.java new file mode 100644 index 000000000..ae14c65bd --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/VNCException.java @@ -0,0 +1,32 @@ + +package net.sourceforge.guacamole.vnc; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class VNCException extends Exception { + + public VNCException(String message, Throwable cause) { + super(message, cause); + } + + public VNCException(String message) { + super(message); + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/VNCFullColorImageReader.java b/guacamole/src/net/sourceforge/guacamole/vnc/VNCFullColorImageReader.java new file mode 100644 index 000000000..108af77d0 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/VNCFullColorImageReader.java @@ -0,0 +1,211 @@ +package net.sourceforge.guacamole.vnc; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.awt.image.BufferedImage; +import java.awt.image.IndexColorModel; +import java.io.DataInputStream; +import java.io.IOException; + + +public class VNCFullColorImageReader extends VNCImageReader { + + private int bpp; + private int depth; + + private int redBits; + private int greenBits; + private int blueBits; + + private int redMax; + private int greenMax; + private int blueMax; + + private int redShift; + private int greenShift; + private int blueShift; + + private boolean readAsIndexed; + + public boolean isBigEndian() { + return true; + } + + public int getBitsPerPixel() { + return bpp; + } + + public int getDepth() { + return depth; + } + + public int getRedMax() { + return redMax; + } + + public int getGreenMax() { + return greenMax; + } + + public int getBlueMax() { + return blueMax; + } + + public int getRedShift() { + return redShift; + } + + public int getGreenShift() { + return greenShift; + } + + public int getBlueShift() { + return blueShift; + } + + // Set up BGR reader + public VNCFullColorImageReader(int redBits, int greenBits, int blueBits, int outputBPP) throws VNCException { + + depth = redBits + greenBits + blueBits; + + if (depth > 0 && depth <= 8) + bpp = 8; + else if (depth <= 16) + bpp = 16; + else if (depth <= 32) + bpp = 32; + else + throw new VNCException("Illegal bit depth for VNC images: " + bpp); + + this.redBits = redBits; + this.greenBits = greenBits; + this.blueBits = blueBits; + + redMax = (1 << redBits) - 1; + greenMax = (1 << greenBits) - 1; + blueMax = (1 << blueBits) - 1; + + redShift = greenBits + blueBits; + greenShift = blueBits; + blueShift = 0; + + if (outputBPP == 8) + this.readAsIndexed = true; + else if (outputBPP == 24) + this.readAsIndexed = false; + else + throw new VNCException("Only 8-bit or 24-bit output is supported."); + + } + + @Override + public int readCPixel(DataInputStream input) throws IOException { + + if (redBits != 8 || greenBits != 8 || blueBits != 8) + return readPixel(input); + + int red = input.read(); + int green = input.read(); + int blue = input.read(); + + int color = (red << 16) | (green << 8) | blue; + return color; + } + + @Override + public int readPixel(DataInputStream input) throws IOException { + int value; + switch (bpp) { + case 8: + value = input.read(); + break; + case 16: + value = input.readShort(); + break; + case 32: + value = input.readInt(); + break; + default: + throw new IOException("Invalid BPP."); + } + + int red = (value >> redShift) & redMax; + int green = (value >> greenShift) & greenMax; + int blue = (value >> blueShift) & blueMax; + + red <<= 8 - redBits; + green <<= 8 - greenBits; + blue <<= 8 - blueBits; + + int color = (red << 16) | (green << 8) | blue; + return color; + } + + @Override + public BufferedImage generateBlankImage(int width, int height) { + if (readAsIndexed) + return new BufferedImage(width, height, BufferedImage.TYPE_BYTE_INDEXED, COLOR_MODEL); + return new BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB); + } + + // Load color model + public static final IndexColorModel COLOR_MODEL; + static { + // Construct color model + byte[] colorShade = {0, (byte) 51, (byte) 104, (byte) 153, (byte) 204, (byte) 255}; + byte[] greyShade = new byte[39]; + for (int i=1; i<40; i++) + greyShade[i-1] = (byte) (6*i); + + byte[] red = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + byte[] green = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + byte[] blue = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + byte[] alpha = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + + int color = 0; + for (int r=0; r. + */ + +import java.awt.image.BufferedImage; +import java.io.DataInputStream; +import java.io.IOException; + +public abstract class VNCImageReader { + + public BufferedImage readCImage(DataInputStream input, int width, int height) throws IOException { + + BufferedImage image = generateBlankImage(width, height); + // Read image + + for (int pixelY=0; pixelY. + */ + +import java.awt.image.BufferedImage; +import java.awt.image.IndexColorModel; +import java.io.DataInputStream; +import java.io.IOException; + + +public class VNCIndexedImageReader extends VNCImageReader { + + private IndexColorModel palette; + private byte[] red; + private byte[] green; + private byte[] blue; + + // Set up BGR reader + public VNCIndexedImageReader(byte[] red, byte[] green, byte[] blue) throws VNCException { + + this.red = red; + this.green = green; + this.blue = blue; + + palette = new IndexColorModel(8, 256, red, green, blue); + if (palette.getMapSize() != 256) + throw new VNCException("Currently, only 256-color maps are supported."); + + } + + @Override + public int readPixel(DataInputStream input) throws IOException { + int value = input.read(); + int color = (red[value] << 16) | (green[value] << 8) | blue[value]; + return color; + } + + @Override + public BufferedImage generateBlankImage(int width, int height) { + BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_BYTE_INDEXED, palette); + return image; + } + + // Load color model + public static final IndexColorModel COLOR_MODEL; + static { + // Construct color model + byte[] colorShade = {0, (byte) 51, (byte) 104, (byte) 153, (byte) 204, (byte) 255}; + byte[] greyShade = new byte[39]; + for (int i=1; i<40; i++) + greyShade[i-1] = (byte) (6*i); + + byte[] red = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + byte[] green = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + byte[] blue = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + byte[] alpha = new byte[colorShade.length*colorShade.length*colorShade.length+greyShade.length+1]; + + int color = 0; + for (int r=0; r. + */ + +public abstract class Event implements Comparable { + + private long time; + private int index; + + public Event(int index) { + this.time = System.currentTimeMillis(); + this.index = index; + } + + public int getIndex() { + return index; + } + + public long getTime() { + return time; + } + + public int hashCode() { + return index; + } + + @Override + public boolean equals(Object o) { + if (o == null) return false; + if (getClass() != o.getClass()) return false; + return getIndex() == ((Event) o).getIndex(); + } + + public int compareTo(Event e) { + return getIndex() - e.getIndex(); + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/event/EventHandler.java b/guacamole/src/net/sourceforge/guacamole/vnc/event/EventHandler.java new file mode 100644 index 000000000..637b991e1 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/event/EventHandler.java @@ -0,0 +1,28 @@ + +package net.sourceforge.guacamole.vnc.event; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.io.IOException; + +public interface EventHandler { + + public void handle(E e) throws IOException; + +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/event/EventQueue.java b/guacamole/src/net/sourceforge/guacamole/vnc/event/EventQueue.java new file mode 100644 index 000000000..d77276b36 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/event/EventQueue.java @@ -0,0 +1,191 @@ + +package net.sourceforge.guacamole.vnc.event; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +import java.io.IOException; +import java.util.PriorityQueue; + +public class EventQueue { + + private int nextIndex = 0; + private final PriorityQueue queue = new PriorityQueue(); + private EventHandler handler; + + private final int deadline; + + private AutoflushThread autoflush = new AutoflushThread(); + + private class AutoflushThread extends Thread { + + private IOException error; + private long deadline; + private static final long ONE_YEAR = 31536000; + + private boolean killed = false; + + public AutoflushThread() { + this.deadline = ONE_YEAR; + start(); + } + + public void run() { + while (!killed) { + try { + if (deadline > 0) sleep(deadline); + dropPendingEvents(); + flush(); + } + catch (InterruptedException e) { + // Interrupt indicates event handled, or thread killed + if (killed) return; + } + catch (IOException e) { + error = e; + break; + } + } + } + + public void setDeadline(long deadline) { + this.deadline = deadline; + interrupt(); + } + + public void checkError() throws IOException { + if (error != null) throw error; + } + + public void kill() { + killed = true; + interrupt(); + } + + } + + public void close() { + autoflush.kill(); + } + + // Starts autoflush wait thread for any waiting events on the queue + private void startDeadlineAutoflush() { + synchronized (queue) { + + // No need to autoflush if nothing waiting + if (queue.size() == 0) return; + + // Get waiting event + E waiting = queue.peek(); + + if (waiting != null) { + long untilDeadline = deadline + waiting.getTime() - System.currentTimeMillis(); + + // Start autoflush thread which waits for time remaining until next + // event's deadline. + autoflush.setDeadline(untilDeadline); + } + else + autoflush.setDeadline(AutoflushThread.ONE_YEAR); + + } + } + + public EventQueue(EventHandler handler, int deadline) { + this.handler = handler; + this.deadline = deadline; + } + + public void add(E event) throws IOException { + synchronized (queue) { + + autoflush.checkError(); + + if (event.getIndex() < nextIndex) { + //System.err.println("Past event dropped."); + return; + } + + if (event == null) + throw new Error("Cannot add null event."); + + queue.add(event); + } + + flush(); + } + + private E next() { + synchronized (queue) { + // If no events, return nothing. + if (queue.size() == 0) return null; + + // If still waiting for true next event, return nothing. + E event = queue.peek(); + if (event.getIndex() != nextIndex) + return null; + + // If event found, expect next event, remove and return current. + queue.remove(); + nextIndex++; + return event; + } + } + + // Return number of waiting events + public int getWaiting() { + synchronized (queue) { + // If no events, then none waiting. + if (queue.size() == 0) return 0; + + // If we have the next event, then none waiting. + E event = queue.peek(); + if (event.getIndex() == nextIndex) + return 0; + + // Otherwise, all events are waiting. + return queue.size(); + } + } + + // Stop waiting for any unreceived events + private void dropPendingEvents() { + synchronized (queue) { + // If no events, nothing needs to be changed; + if (queue.size() == 0) return; + + // Otherwise, update nextIndex to index of next event + E event = queue.peek(); + nextIndex = event.getIndex(); + } + } + + // Attempts to flush queue + // If any events remain, an autoflush thread is started. + private void flush() throws IOException { + synchronized (queue) { + E nextEvent; + while ((nextEvent = next()) != null) + handler.handle(nextEvent); + } + + // Start autoflush thread for any remaining events. + startDeadlineAutoflush(); + } + +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/event/KeyEvent.java b/guacamole/src/net/sourceforge/guacamole/vnc/event/KeyEvent.java new file mode 100644 index 000000000..b5ac54e50 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/event/KeyEvent.java @@ -0,0 +1,39 @@ +package net.sourceforge.guacamole.vnc.event; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class KeyEvent extends Event { + + private int keysym; + private boolean pressed; + + public KeyEvent(int index, int keysym, boolean pressed) { + super(index); + this.keysym = keysym; + this.pressed = pressed; + } + + public int getKeySym() { + return keysym; + } + + public boolean getPressed() { + return pressed; + } +} diff --git a/guacamole/src/net/sourceforge/guacamole/vnc/event/PointerEvent.java b/guacamole/src/net/sourceforge/guacamole/vnc/event/PointerEvent.java new file mode 100644 index 000000000..17e568a71 --- /dev/null +++ b/guacamole/src/net/sourceforge/guacamole/vnc/event/PointerEvent.java @@ -0,0 +1,69 @@ +package net.sourceforge.guacamole.vnc.event; + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +public class PointerEvent extends Event { + + private boolean leftButtonPressed; + private boolean middleButtonPressed; + private boolean rightButtonPressed; + private boolean upButtonPressed; + private boolean downButtonPressed; + private int x; + private int y; + + public PointerEvent(int index, boolean leftButtonPressed, boolean middleButtonPressed, boolean rightButtonPressed, boolean upButtonPressed, boolean downButtonPressed, int x, int y) { + super(index); + this.leftButtonPressed = leftButtonPressed; + this.middleButtonPressed = middleButtonPressed; + this.rightButtonPressed = rightButtonPressed; + this.upButtonPressed = upButtonPressed; + this.downButtonPressed = downButtonPressed; + this.x = x; + this.y = y; + } + + public boolean isLeftButtonPressed() { + return leftButtonPressed; + } + + public boolean isMiddleButtonPressed() { + return middleButtonPressed; + } + + public boolean isRightButtonPressed() { + return rightButtonPressed; + } + + public boolean isUpButtonPressed() { + return upButtonPressed; + } + + public boolean isDownButtonPressed() { + return downButtonPressed; + } + + public int getX() { + return x; + } + + public int getY() { + return y; + } +} diff --git a/guacamole/web/WEB-INF/web.xml b/guacamole/web/WEB-INF/web.xml new file mode 100644 index 000000000..6e54cf951 --- /dev/null +++ b/guacamole/web/WEB-INF/web.xml @@ -0,0 +1,102 @@ + + + + + + index.html + + + + 30 + + + + + Connect + net.sourceforge.guacamole.net.control.Connect + + + Connect + /connect + + + Disconnect + net.sourceforge.guacamole.net.control.Disconnect + + + Disconnect + /disconnect + + + Instruction stream servlet. + InstructionStream + net.sourceforge.guacamole.net.output.InstructionStream + + + InstructionStream + /instructions + + + Clipboard input servlet. + Clipboard + net.sourceforge.guacamole.net.input.Clipboard + + + Clipboard + /clipboard + + + Key input servlet. + Key + net.sourceforge.guacamole.net.input.Key + + + Key + /key + + + Pointer input servlet. + Pointer + net.sourceforge.guacamole.net.input.Pointer + + + Pointer + /pointer + + + Guacamole Access Restrictions + + Guacamole + All servlets/pages within Guacamole. + /* + + + Only allow Guacamole users access. + guacamole + + + + BASIC + Guacamole + + + Guacamole + guacamole + + diff --git a/guacamole/web/agpl-3.0-standalone.html b/guacamole/web/agpl-3.0-standalone.html new file mode 100644 index 000000000..bf47c6c0a --- /dev/null +++ b/guacamole/web/agpl-3.0-standalone.html @@ -0,0 +1,688 @@ + + + + + GNU Affero General Public License - GNU Project - Free Software Foundation (FSF) + + + +

GNU AFFERO GENERAL PUBLIC LICENSE

+

Version 3, 19 November 2007

+ +

Copyright © 2007 Free Software Foundation, +Inc. <http://fsf.org/> +
+ Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed.

+ +

Preamble

+ +

The GNU Affero General Public License is a free, copyleft license +for software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software.

+ +

The licenses for most software and other practical works are +designed to take away your freedom to share and change the works. By +contrast, our General Public Licenses are 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.

+ +

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.

+ +

Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software.

+ +

A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public.

+ +

The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version.

+ +

An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license.

+ +

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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.

+ +

Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph.

+ +

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 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 work with which it is +combined will remain governed by version 3 of the GNU General Public +License.

+ +

14. Revised Versions of this License.

+ +

The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero +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 Affero 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 Affero 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.

+ +
    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+ +

Also add information on how to contact you by electronic and paper mail.

+ +

If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements.

+ +

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 AGPL, see +<http://www.gnu.org/licenses/>.

+ + diff --git a/guacamole/web/guacamole.css b/guacamole/web/guacamole.css new file mode 100644 index 000000000..2ce139d6c --- /dev/null +++ b/guacamole/web/guacamole.css @@ -0,0 +1,184 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +body { + background: black; + font-family: sans-serif; +} + +div.errorDialogOuter { + display: table; + height: 100%; + width: 100%; + position: fixed; + left: 0; + top: 0; + + visibility: hidden; +} + +div.errorDialogMiddle { + width: 100%; + text-align: center; + display: table-cell; + vertical-align: middle; +} + +div.errorDialog { + + background: #D44; + border: 1px solid black; + padding: 1em; + + -khtml-border-radius: 0.5em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + + -moz-box-shadow: 0 0.25em 0.75em black, inset 0.1em 0.1em 0.5em #F99, inset -0.1em -0.1em 0.75em #800; + -webkit-box-shadow: 0 0.25em 0.75em black, inset 0.1em 0.1em 0.5em #F99, inset -0.1em -0.1em 0.75em #800; + -khtml-box-shadow: 0 0.25em 0.75em black, inset 0.1em 0.1em 0.5em #F99, inset -0.1em -0.1em 0.75em #800; + box-shadow: 0 0.25em 0.75em black, inset 0.1em 0.1em 0.5em #F99, inset -0.1em -0.1em 0.75em #800; + + max-width: 75%; + text-align: left; + + display: inline-block; +} + +div.errorDialog h1 { + margin: 0; + margin-bottom: 0.25em; + text-align: center; + text-shadow: 0 0 0.25em white; +} + +div.errorDialog div.buttons { + margin: 0; + margin-top: 0.5em; + text-align: center; +} + +div.errorDialog p { + margin: 0; +} + + +#menu { + margin-left: auto; + margin-right: auto; + margin-bottom: 1em; + font-size: 0.8em; + background: #FEA; + border: 1px solid black; + position: fixed; + left: 0; + top: 0; + width: 100%; + z-index: 1; +} + +#menu.connected { + opacity: 0.5; +} + +#menu.connected:hover { + opacity: 1; +} + +#menu.error { + background: #D44; +} + +.error #state { + font-weight: bold; +} + +img { + border: none; +} + +img#license { + border: none; + float: right; + margin: 2px; +} + +div#display { + position: relative; + width: 640px; + height: 480px; + margin-left: auto; + margin-right: auto; +} + +div#display.loading { + border: 1px dotted gray; + background-image: url('images/spinner92.gif'); + background-position: center; + background-repeat: no-repeat; +} + +div#display.error { + border: 1px dotted red; + background-image: url('images/noimage92.png'); + background-position: center; + background-repeat: no-repeat; +} + +#menu img { + vertical-align: middle; +} + +#menu button { + vertical-align: middle; +} + +#menu span { + vertical-align: middle; +} + +div#clipboardDiv { + display: none; + position: absolute; + background: #FA5; + padding: 1em; + + border: 1px solid black; + -khtml-border-radius: 0.5em; + -webkit-border-radius: 0.5em; + -moz-border-radius: 0.5em; + border-radius: 0.5em; + + width: 50em; +} + +div#clipboardDiv h2 { + margin: 0; + font-size: 1em; +} + +div#clipboardDiv textarea { + width: 100%; +} + +.hideCursor { + cursor: url('images/mouse/dot.gif'),url('images/mouse/blank.cur'),default; +} + diff --git a/guacamole/web/images/agpl-logo.png b/guacamole/web/images/agpl-logo.png new file mode 100644 index 000000000..37f01585a Binary files /dev/null and b/guacamole/web/images/agpl-logo.png differ diff --git a/guacamole/web/images/checker.png b/guacamole/web/images/checker.png new file mode 100644 index 000000000..06f89032d Binary files /dev/null and b/guacamole/web/images/checker.png differ diff --git a/guacamole/web/images/guacamole-64-icon.png b/guacamole/web/images/guacamole-64-icon.png new file mode 100644 index 000000000..02897db2e Binary files /dev/null and b/guacamole/web/images/guacamole-64-icon.png differ diff --git a/guacamole/web/images/guacamole-icon-64.png b/guacamole/web/images/guacamole-icon-64.png new file mode 100644 index 000000000..02897db2e Binary files /dev/null and b/guacamole/web/images/guacamole-icon-64.png differ diff --git a/guacamole/web/images/guacamole-logo.png b/guacamole/web/images/guacamole-logo.png new file mode 100644 index 000000000..3652598c5 Binary files /dev/null and b/guacamole/web/images/guacamole-logo.png differ diff --git a/guacamole/web/images/mouse/blank.cur b/guacamole/web/images/mouse/blank.cur new file mode 100644 index 000000000..dfcdea8d0 Binary files /dev/null and b/guacamole/web/images/mouse/blank.cur differ diff --git a/guacamole/web/images/mouse/blank.gif b/guacamole/web/images/mouse/blank.gif new file mode 100644 index 000000000..ec5c17c0a Binary files /dev/null and b/guacamole/web/images/mouse/blank.gif differ diff --git a/guacamole/web/images/mouse/dot.gif b/guacamole/web/images/mouse/dot.gif new file mode 100644 index 000000000..9ac8a00b9 Binary files /dev/null and b/guacamole/web/images/mouse/dot.gif differ diff --git a/guacamole/web/images/noguacamole-logo.png b/guacamole/web/images/noguacamole-logo.png new file mode 100644 index 000000000..2245bfdf1 Binary files /dev/null and b/guacamole/web/images/noguacamole-logo.png differ diff --git a/guacamole/web/images/noimage92.png b/guacamole/web/images/noimage92.png new file mode 100644 index 000000000..657d85e2f Binary files /dev/null and b/guacamole/web/images/noimage92.png differ diff --git a/guacamole/web/images/spinner92.gif b/guacamole/web/images/spinner92.gif new file mode 100644 index 000000000..0dfe0695c Binary files /dev/null and b/guacamole/web/images/spinner92.gif differ diff --git a/guacamole/web/index.html b/guacamole/web/index.html new file mode 100644 index 000000000..224460f86 --- /dev/null +++ b/guacamole/web/index.html @@ -0,0 +1,253 @@ + + + + + + + + + + + Guacamole + + + + + + + + + +
+ +
+
+ + + +
+
+
+

Error

+

+
+
+
+
+ + + + + + + + + + + + + + + + + diff --git a/guacamole/web/javascript/guacamole.js b/guacamole/web/javascript/guacamole.js new file mode 100644 index 000000000..0ef8b03a6 --- /dev/null +++ b/guacamole/web/javascript/guacamole.js @@ -0,0 +1,637 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +function VNCClient(display) { + + var STATE_IDLE = 0; + var STATE_CONNECTING = 1; + var STATE_WAITING = 2; + var STATE_CONNECTED = 3; + var STATE_DISCONNECTING = 4; + var STATE_DISCONNECTED = 5; + + var currentState = STATE_IDLE; + var stateChangeHandler = null; + + function setState(state) { + if (state != currentState) { + currentState = state; + if (stateChangeHandler) + stateChangeHandler(currentState); + } + } + + this.setOnStateChangeHandler = function(handler) { + stateChangeHandler = handler; + } + + function isConnected() { + return currentState == STATE_CONNECTED + || currentState == STATE_WAITING; + } + + var keyIndex = 0; + var xmlIndex = 0; + + // Layers + var background = null; + var cursor = null; + + var cursorImage = null; + var cursorHotspotX = 0; + var cursorHotspotY = 0; + + + // FIXME: Make object. Clean up. + var cursorRectX = 0; + var cursorRectY = 0; + var cursorRectW = 0; + var cursorRectH = 0; + + var cursorHidden = 0; + + function redrawCursor() { + + // Hide hardware cursor + if (cursorHidden == 0) { + display.className += " hideCursor"; + cursorHidden = 1; + } + + // Erase old cursor + cursor.clearRect(cursorRectX, cursorRectY, cursorRectW, cursorRectH); + + // Update rect + cursorRectX = mouse.getX() - cursorHotspotX; + cursorRectY = mouse.getY() - cursorHotspotY; + cursorRectW = cursorImage.width; + cursorRectH = cursorImage.height; + + // Draw new cursor + cursor.drawImage(cursorRectX, cursorRectY, cursorImage); + } + + + + + /*****************************************/ + /*** Keyboard ***/ + /*****************************************/ + + var keyboard = new GuacamoleKeyboard(document); + + this.disableKeyboard = function() { + keyboard.setKeyPressedHandler(null); + keyboard.setKeyReleasedHandler(null); + }; + + this.enableKeyboard = function() { + keyboard.setKeyPressedHandler( + function (keysym) { + sendKeyEvent(1, keysym); + } + ); + + keyboard.setKeyReleasedHandler( + function (keysym) { + sendKeyEvent(0, keysym); + } + ); + }; + + // Enable keyboard by default + this.enableKeyboard(); + + function sendKeyEvent(pressed, keysym) { + + // Do not send requests if not connected + if (!isConnected()) + return; + + var key_xmlhttprequest = new XMLHttpRequest(); + key_xmlhttprequest.open("GET", + "key?index=" + (keyIndex++) + + "&pressed=" + pressed + + "&keysym=" + keysym); + key_xmlhttprequest.send(null); + } + + this.pressKey = function(keysym) { + sendKeyEvent(1, keysym); + }; + + this.releaseKey = function(keysym) { + sendKeyEvent(0, keysym); + }; + + + /*****************************************/ + /*** Mouse ***/ + /*****************************************/ + + var mouse = new GuacamoleMouse(display); + mouse.setButtonPressedHandler( + function(mouseState) { + sendMouseState(mouseState); + } + ); + + mouse.setButtonReleasedHandler( + function(mouseState) { + sendMouseState(mouseState); + } + ); + + mouse.setMovementHandler( + function(mouseState) { + + // Draw client-side cursor + if (cursorImage != null) { + redrawCursor(); + } + + sendMouseState(mouseState); + } + ); + + + var sendingMouseEvents = 0; + var mouseEventBuffer = ""; + + function sendMouseState(mouseState) { + + // Do not send requests if not connected + if (!isConnected()) + return; + + // Add event to queue, restart send loop if finished. + if (mouseEventBuffer.length > 0) mouseEventBuffer += "&"; + mouseEventBuffer += "event=" + mouseState.toString(); + if (sendingMouseEvents == 0) + sendPendingMouseEvents(); + + } + + function sendPendingMouseEvents() { + + // Do not send requests if not connected + if (!isConnected()) + return; + + if (mouseEventBuffer.length > 0) { + + sendingMouseEvents = 1; + + var mouse_xmlhttprequest = new XMLHttpRequest(); + mouse_xmlhttprequest.open("GET", "pointer?" + mouseEventBuffer); + mouseEventBuffer = ""; // Clear buffer + + var eventSendStart = new Date().getTime(); + + // Once response received, send next queued event. + mouse_xmlhttprequest.onreadystatechange = function() { + + // Update round-trip-time figures + if (mouse_xmlhttprequest.readyState == 2) { + var eventSendEnd = new Date().getTime(); + totalRoundTrip += eventSendEnd - eventSendStart; + roundTripSamples++; + } + + if (mouse_xmlhttprequest.readyState == 4) { + sendPendingMouseEvents(); + } + }; + + mouse_xmlhttprequest.send(null); + } + else + sendingMouseEvents = 0; + + } + + + /*****************************************/ + /*** Clipboard ***/ + /*****************************************/ + + this.setClipboard = function(data) { + + // Do not send requests if not connected + if (!isConnected()) + return; + + var clipboard_xmlhttprequest = new XMLHttpRequest(); + clipboard_xmlhttprequest.open("POST", "clipboard"); + + var sendStart = new Date().getTime(); + + // Update round trip metrics + clipboard_xmlhttprequest.onreadystatechange = function() { + + // Update round-trip-time figures + if (clipboard_xmlhttprequest.readyState == 2) { + var sendEnd = new Date().getTime(); + totalRoundTrip += sendEnd - sendStart; + roundTripSamples++; + } + + }; + + clipboard_xmlhttprequest.send(data); + + } + + + function desaturateFilter(data, width, height) { + + for (var i=0; i= 2) + nextRequest = makeRequest(); + + function parseResponse() { + + // Make request the moment we receive headers + // If the event handler isn't set by the time headers are available, we will + // already have made this request. + if (xmlhttprequest.readyState == 2) { + if (nextRequest == null) + nextRequest = makeRequest(); + + start = new Date().getTime(); + startOffset = 0; + } + + // Parse stream when data is received and when complete. + if (xmlhttprequest.readyState == 3 || + xmlhttprequest.readyState == 4) { + + // Halt on error during request + if (xmlhttprequest.status == 0) { + showError("Request canceled by browser."); + return; + } + else if (xmlhttprequest.status != 200) { + showError("Error during request (HTTP " + xmlhttprequest.status + "): " + xmlhttprequest.statusText); + return; + } + + var current = xmlhttprequest.responseText; + var instructionEnd; + + if (start == null) { + start = new Date().getTime(); + startOffset = current.length; + } + + while ((instructionEnd = current.indexOf(";", startIndex)) != -1) { + + // Start next search at next instruction + startIndex = instructionEnd+1; + + var instruction = current.substr(instructionStart, + instructionEnd - instructionStart); + + instructionStart = startIndex; + + var opcodeEnd = instruction.indexOf(":"); + + var opcode = instruction.substr(0, opcodeEnd); + var parameters = instruction.substr(opcodeEnd+1).split(","); + + // Call instruction handler. + doInstruction(opcode, parameters); + } + + // Start search at end of string. + startIndex = current.length; + + delete instruction; + delete parameters; + + // If we're done parsing, handle the next response. + if (xmlhttprequest.readyState == 4 && isConnected()) { + + // If we got the start time, do statistics. + if (start) { + var end = new Date().getTime(); + var duration = end - start; + var length = current.length; + + totalTime += duration; + totalTransferred += length; + } + + delete xmlhttprequest; + handleResponse(nextRequest); + } + + } + + }; + + xmlhttprequest.onreadystatechange = parseResponse; + + // Handle what we have so far. + parseResponse(); + } + + function makeRequest() { + + // Calculate message limit as number of bytes likely to be transferred + // in one round trip. + var messageLimit; + if (totalTime == 0 || roundTripSamples == 0) + messageLimit = 10240; // Default to a reasonable 10k + else + messageLimit = Math.round(totalRoundTrip * totalTransferred / totalTime / roundTripSamples); + + // Download self + var xmlhttprequest = new XMLHttpRequest(); + xmlhttprequest.open("GET", "instructions?messageLimit=" + messageLimit); + xmlhttprequest.send(null); + + return xmlhttprequest; + + } + + function unescapeGuacamoleString(str) { + + var unescapedString = ""; + + for (var i=0; i. + */ + +function GuacamoleKeyboard(element) { + + /*****************************************/ + /*** Keyboard Handler ***/ + /*****************************************/ + + // Single key state/modifier buffer + var modShift = 0; + var modCtrl = 0; + var modAlt = 0; + + var keydownChar = new Array(); + + + // ID of routine repeating keystrokes. -1 = not repeating. + var repeatKeyTimeoutId = -1; + var repeatKeyIntervalId = -1; + + // Starts repeating keystrokes + function startRepeat(keySym) { + repeatKeyIntervalId = setInterval(function() { + sendKeyReleased(keySym); + sendKeyPressed(keySym); + }, 50); + } + + // Stops repeating keystrokes + function stopRepeat() { + if (repeatKeyTimeoutId != -1) clearInterval(repeatKeyTimeoutId); + if (repeatKeyIntervalId != -1) clearInterval(repeatKeyIntervalId); + } + + + function getKeySymFromKeyIdentifier(shifted, keyIdentifier) { + + var unicodePrefixLocation = keyIdentifier.indexOf("U+"); + if (unicodePrefixLocation >= 0) { + + var hex = keyIdentifier.substring(unicodePrefixLocation+2); + var codepoint = parseInt(hex, 16); + var typedCharacter; + + // Convert case if shifted + if (shifted == 0) + typedCharacter = String.fromCharCode(codepoint).toLowerCase(); + else + typedCharacter = String.fromCharCode(codepoint).toUpperCase(); + + // Get codepoint + codepoint = typedCharacter.charCodeAt(0); + + return getKeySymFromCharCode(codepoint); + + } + + return null; + + } + + function getKeySymFromCharCode(keyCode) { + + if (keyCode >= 0x0000 && keyCode <= 0x00FF) + return keyCode; + + if (keyCode >= 0x0100 && keyCode <= 0x10FFFF) + return 0x01000000 | keyCode; + + return null; + + } + + function getKeySymFromKeyCode(keyCode) { + + var keysym = null; + if (modShift == 0) keysym = unshiftedKeySym[keyCode]; + else { + keysym = shiftedKeySym[keyCode]; + if (keysym == null) keysym = unshiftedKeySym[keyCode]; + } + + return keysym; + + } + + + // Sends a single keystroke over the network + function sendKeyPressed(keysym) { + if (keysym != null && keyPressedHandler) + keyPressedHandler(keysym); + } + + // Sends a single keystroke over the network + function sendKeyReleased(keysym) { + if (keysym != null) + keyReleasedHandler(keysym); + } + + + var KEYDOWN = 1; + var KEYPRESS = 2; + + var keySymSource = null; + + // When key pressed + var keydownCode = null; + element.onkeydown = function(e) { + + // Only intercept if handler set + if (!keyPressedHandler) return true; + + var keynum; + if (window.event) keynum = window.event.keyCode; + else if (e.which) keynum = e.which; + + // Ctrl/Alt/Shift + if (keynum == 16) + modShift = 1; + else if (keynum == 17) + modCtrl = 1; + else if (keynum == 18) + modAlt = 1; + + var keysym = getKeySymFromKeyCode(keynum); + if (keysym) { + // Get keysyms and events from KEYDOWN + keySymSource = KEYDOWN; + } + + // If modifier keys are held down, and we have keyIdentifier + else if ((modCtrl == 1 || modAlt == 1) && e.keyIdentifier) { + + // Get keysym from keyIdentifier + keysym = getKeySymFromKeyIdentifier(modShift, e.keyIdentifier); + + // Get keysyms and events from KEYDOWN + keySymSource = KEYDOWN; + + } + + else + // Get keysyms and events from KEYPRESS + keySymSource = KEYPRESS; + + keydownCode = keynum; + + // Ignore key if we don't need to use KEYPRESS. + // Send key event here + if (keySymSource == KEYDOWN) { + + if (keydownChar[keynum] != keysym) { + + // Send event + keydownChar[keynum] = keysym; + sendKeyPressed(keysym); + + // Clear old key repeat, if any. + stopRepeat(); + + // Start repeating (if not a modifier key) after a short delay + if (keynum != 16 && keynum != 17 && keynum != 18) + repeatKeyTimeoutId = setTimeout(function() { startRepeat(keysym); }, 500); + } + + return false; + } + + }; + + // When key pressed + element.onkeypress = function(e) { + + // Only intercept if handler set + if (!keyPressedHandler) return true; + + if (keySymSource != KEYPRESS) return false; + + var keynum; + if (window.event) keynum = window.event.keyCode; + else if (e.which) keynum = e.which; + + var keysym = getKeySymFromCharCode(keynum); + if (keysym && keydownChar[keynum] != keysym) { + + // If this button already pressed, release first + var lastKeyDownChar = keydownChar[keydownCode]; + if (lastKeyDownChar) + sendKeyReleased(lastKeyDownChar); + + keydownChar[keydownCode] = keysym; + + // Clear old key repeat, if any. + stopRepeat(); + + // Send key event + sendKeyPressed(keysym); + + // Start repeating (if not a modifier key) after a short delay + repeatKeyTimeoutId = setTimeout(function() { startRepeat(keysym); }, 500); + } + + return false; + }; + + // When key released + element.onkeyup = function(e) { + + // Only intercept if handler set + if (!keyReleasedHandler) return true; + + var keynum; + if (window.event) keynum = window.event.keyCode; + else if (e.which) keynum = e.which; + + // Ctrl/Alt/Shift + if (keynum == 16) + modShift = 0; + else if (keynum == 17) + modCtrl = 0; + else if (keynum == 18) + modAlt = 0; + else + stopRepeat(); + + // Get corresponding character + var lastKeyDownChar = keydownChar[keynum]; + + // Clear character record + keydownChar[keynum] = null; + + // Send release event + sendKeyReleased(lastKeyDownChar); + + return false; + }; + + // When focus is lost, clear modifiers. + var docOnblur = element.onblur; + element.onblur = function() { + modAlt = 0; + modCtrl = 0; + modShift = 0; + if (docOnblur != null) docOnblur(); + }; + + var keyPressedHandler = null; + var keyReleasedHandler = null; + + this.setKeyPressedHandler = function(kh) { keyPressedHandler = kh; }; + this.setKeyReleasedHandler = function(kh) { keyReleasedHandler = kh; }; + +} diff --git a/guacamole/web/javascript/keymap.js b/guacamole/web/javascript/keymap.js new file mode 100644 index 000000000..22f49992e --- /dev/null +++ b/guacamole/web/javascript/keymap.js @@ -0,0 +1,72 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + + +// Keymap + +var unshiftedKeySym = new Array(); +unshiftedKeySym[8] = 0xFF08; // backspace +unshiftedKeySym[9] = 0xFF09; // tab +unshiftedKeySym[13] = 0xFF0D; // enter +unshiftedKeySym[16] = 0xFFE1; // shift +unshiftedKeySym[17] = 0xFFE3; // ctrl +unshiftedKeySym[18] = 0xFFE9; // alt +unshiftedKeySym[19] = 0xFF13; // pause/break +unshiftedKeySym[20] = 0xFFE5; // caps lock +unshiftedKeySym[27] = 0xFF1B; // escape +unshiftedKeySym[33] = 0xFF55; // page up +unshiftedKeySym[34] = 0xFF56; // page down +unshiftedKeySym[35] = 0xFF57; // end +unshiftedKeySym[36] = 0xFF50; // home +unshiftedKeySym[37] = 0xFF51; // left arrow +unshiftedKeySym[38] = 0xFF52; // up arrow +unshiftedKeySym[39] = 0xFF53; // right arrow +unshiftedKeySym[40] = 0xFF54; // down arrow +unshiftedKeySym[45] = 0xFF63; // insert +unshiftedKeySym[46] = 0xFFFF; // delete +unshiftedKeySym[91] = 0xFFEB; // left window key (super_l) +unshiftedKeySym[92] = 0xFF67; // right window key (menu key?) +unshiftedKeySym[93] = null; // select key +unshiftedKeySym[112] = 0xFFBE; // f1 +unshiftedKeySym[113] = 0xFFBF; // f2 +unshiftedKeySym[114] = 0xFFC0; // f3 +unshiftedKeySym[115] = 0xFFC1; // f4 +unshiftedKeySym[116] = 0xFFC2; // f5 +unshiftedKeySym[117] = 0xFFC3; // f6 +unshiftedKeySym[118] = 0xFFC4; // f7 +unshiftedKeySym[119] = 0xFFC5; // f8 +unshiftedKeySym[120] = 0xFFC6; // f9 +unshiftedKeySym[121] = 0xFFC7; // f10 +unshiftedKeySym[122] = 0xFFC8; // f11 +unshiftedKeySym[123] = 0xFFC9; // f12 +unshiftedKeySym[144] = 0xFF7F; // num lock +unshiftedKeySym[145] = 0xFF14; // scroll lock + +// Shifted versions, IF DIFFERENT FROM UNSHIFTED! +// If any of these are null, the unshifted one will be used. +var shiftedKeySym = new Array(); +shiftedKeySym[18] = 0xFFE7; // alt + +// Constants for keysyms for special keys +var KEYSYM_CTRL = 65507; +var KEYSYM_ALT = 65513; +var KEYSYM_DELETE = 65535; +var KEYSYM_SHIFT = 65505; + + diff --git a/guacamole/web/javascript/layer.js b/guacamole/web/javascript/layer.js new file mode 100644 index 000000000..2074010e7 --- /dev/null +++ b/guacamole/web/javascript/layer.js @@ -0,0 +1,128 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +function Layer(width, height) { + + // Off-screen buffer + var display = document.createElement("canvas"); + + display.style.position = "absolute"; + display.style.left = "0px"; + display.style.right = "0px"; + + display.width = width; + display.height = height; + + var displayContext = display.getContext("2d"); + + var nextUpdateToDraw = 0; + var currentUpdate = 0; + var updates = new Array(); + + // Given an update ID, either call the provided update callback, or + // schedule the update for later. + function setUpdate(updateId, update) { + + // If this update is the next to draw... + if (updateId == nextUpdateToDraw) { + + // Call provided update handler. + update(); + + // Draw all pending updates. + var updateCallback; + while (updateCallback = updates[++nextUpdateToDraw]) { + updateCallback(); + delete updates[nextUpdateToDraw]; + } + + } + + // If not next to draw, set callback and wait. + else + updates[updateId] = update; + + } + + display.drawImage = function(x, y, image) { + var updateId = currentUpdate++; + + setUpdate(updateId, function() { + displayContext.drawImage(image, x, y); + }); + + } + + + display.draw = function(x, y, url) { + var updateId = currentUpdate++; + + var image = new Image(); + image.onload = function() { + setUpdate(updateId, function() { + displayContext.drawImage(image, x, y); + }); + }; + image.src = url; + }; + + + display.copyRect = function(srcx, srcy, w, h, x, y) { + var updateId = currentUpdate++; + + setUpdate(updateId, function() { + displayContext.drawImage(display, srcx, srcy, w, h, x, y, w, h); + }); + + }; + + display.drawRect = function(x, y, w, h, color) { + var updateId = currentUpdate++; + + setUpdate(updateId, function() { + displayContext.fillStyle = color; + displayContext.fillRect(x, y, w, h); + }); + + }; + + display.clearRect = function(x, y, w, h) { + var updateId = currentUpdate++; + + setUpdate(updateId, function() { + displayContext.clearRect(x, y, w, h); + }); + + }; + + display.filter = function(filter) { + var updateId = currentUpdate++; + + setUpdate(updateId, function() { + var imageData = displayContext.getImageData(0, 0, width, height); + filter(imageData.data, width, height); + displayContext.putImageData(imageData, 0, 0); + }); + + }; + + return display; + +} + diff --git a/guacamole/web/javascript/message.js b/guacamole/web/javascript/message.js new file mode 100644 index 000000000..c573109c8 --- /dev/null +++ b/guacamole/web/javascript/message.js @@ -0,0 +1,175 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +function GuacamoleMessage(xml) { + + var server = null; + var framebuffer = null; + var errors = new Array(); + var updates = new Array(); + + + this.getServer = function() { return server; }; + this.getFramebuffer = function() { return framebuffer; }; + this.getErrors = function() { return errors; }; + this.hasErrors = function() { return errors.length > 0; }; + this.getUpdates = function() { return updates; }; + + if (xml) { + + // Parse document + var root = xml.documentElement; + if (root) { + + // Parse errors + var errorElements = root.getElementsByTagName("error"); + if (errorElements.length >= 1) { + for (var errorIndex=0; errorIndex. + */ + + +function GuacamoleMouse(element) { + + /*****************************************/ + /*** Mouse Handler ***/ + /*****************************************/ + + + var mouseIndex = 0; + + var mouseLeftButton = 0; + var mouseMiddleButton = 0; + var mouseRightButton = 0; + + var mouseX = 0; + var mouseY = 0; + + var absoluteMouseX = 0; + var absoluteMouseY = 0; + + + function getMouseState(up, down) { + var mouseState = new MouseEvent(mouseX, mouseY, + mouseLeftButton, mouseMiddleButton, mouseRightButton, up, down); + + return mouseState; + } + + + // Block context menu so right-click gets sent properly + element.oncontextmenu = function(e) {return false;}; + + element.onmousemove = function(e) { + + e.stopPropagation(); + + absoluteMouseX = e.pageX; + absoluteMouseY = e.pageY; + + mouseX = absoluteMouseX - element.offsetLeft; + mouseY = absoluteMouseY - element.offsetTop; + + // This is all JUST so we can get the mouse position within the element + var parent = element.offsetParent; + while (parent) { + if (parent.offsetLeft && parent.offsetTop) { + mouseX -= parent.offsetLeft; + mouseY -= parent.offsetTop; + } + parent = parent.offsetParent; + } + + movementHandler(getMouseState(0, 0)); + }; + + + element.onmousedown = function(e) { + + e.stopPropagation(); + + switch (e.button) { + case 0: + mouseLeftButton = 1; + break; + case 1: + mouseMiddleButton = 1; + break; + case 2: + mouseRightButton = 1; + break; + } + + buttonPressedHandler(getMouseState(0, 0)); + }; + + + element.onmouseup = function(e) { + + e.stopPropagation(); + + switch (e.button) { + case 0: + mouseLeftButton = 0; + break; + case 1: + mouseMiddleButton = 0; + break; + case 2: + mouseRightButton = 0; + break; + } + + buttonReleasedHandler(getMouseState(0, 0)); + }; + + // Override selection on mouse event element. + element.onselectstart = function() { + return false; + }; + + // Scroll wheel support + function handleScroll(e) { + + var delta = 0; + if (e.detail) + delta = e.detail; + else if (e.wheelDelta) + delta = -event.wheelDelta; + + // Up + if (delta < 0) { + buttonPressedHandler(getMouseState(1, 0)); + buttonReleasedHandler(getMouseState(0, 0)); + } + + // Down + if (delta > 0) { + buttonPressedHandler(getMouseState(0, 1)); + buttonReleasedHandler(getMouseState(0, 0)); + } + + if (e.preventDefault) + e.preventDefault(); + + e.returnValue = false; + } + + element.addEventListener('DOMMouseScroll', handleScroll, false); + + element.onmousewheel = function(e) { + handleScroll(e); + } + + function MouseEvent(x, y, left, middle, right, up, down) { + + this.getX = function() { + return x; + }; + + this.getY = function() { + return y; + }; + + this.getLeft = function() { + return left; + }; + + this.getMiddle = function() { + return middle; + }; + + this.getRight = function() { + return right; + }; + + this.getUp = function() { + return up; + }; + + this.getDown = function() { + return down; + }; + + this.toString = function() { + return (mouseIndex++) + "," + x + "," + y + "," + left + "," + middle + "," + right + "," + up + "," + down; + }; + + } + + + var buttonPressedHandler = null; + var buttonReleasedHandler = null; + var movementHandler = null; + + this.setButtonPressedHandler = function(mh) {buttonPressedHandler = mh;}; + this.setButtonReleasedHandler = function(mh) {buttonReleasedHandler = mh;}; + this.setMovementHandler = function(mh) {movementHandler = mh;}; + + + this.getX = function() {return mouseX;}; + this.getY = function() {return mouseY;}; + this.getLeftButton = function() {return mouseLeftButton;}; + this.getMiddleButton = function() {return mouseMiddleButton;}; + this.getRightButton = function() {return mouseRightButton;}; + +} diff --git a/guacamole/web/javascript/oskeyboard.js b/guacamole/web/javascript/oskeyboard.js new file mode 100644 index 000000000..21f1df13e --- /dev/null +++ b/guacamole/web/javascript/oskeyboard.js @@ -0,0 +1,487 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + + +function GuacamoleOnScreenKeyboard(url) { + + var tabIndex = 1; + var allKeys = new Array(); + var modifierState = new function() {}; + + function getKeySize(size) { + return (5*size) + "ex"; + } + + function getCapSize(size) { + return (5*size - 0.5) + "ex"; + } + + function clearModifiers() { + + // Send key release events for all pressed modifiers + for (var k=0; k 0) + return true; + + return false; + } + + function toggleModifierPressed(modifier) { + if (isModifierActive(modifier)) + setModifierReleased(modifier); + else + setModifierPressed(modifier); + } + + function refreshAllKeysState() { + for (var k=0; k= 0x0000 && charCode <= 0x00FF) + keysym = charCode; + + else if (charCode >= 0x0100 && charCode <= 0x10FFFF) + keysym = 0x01000000 | charCode; + } + + // Required modifiers for this keycap + var reqMod = null; + if (cap.attributes["if"]) + reqMod = cap.attributes["if"].value.split(","); + + + // Modifier represented by this keycap + var modifier = null; + if (cap.attributes["modifier"]) + modifier = cap.attributes["modifier"].value; + + + // Whether this key is sticky (toggles) + // Currently only valid for modifiers. + var sticky = false; + if (cap.attributes["sticky"] && cap.attributes["sticky"].value == "true") + sticky = true; + + this.getDisplayText = function() { + return cap.textContent; + }; + + this.getKeySym = function() { + return keysym; + }; + + this.getRequiredModifiers = function() { + return reqMod; + }; + + this.getModifier = function() { + return modifier; + }; + + this.isSticky = function() { + return sticky; + }; + + } + + var size = null; + if (key.attributes["size"]) + size = parseFloat(key.attributes["size"].value); + + var caps = key.getElementsByTagName("cap"); + var keycaps = new Array(); + for (var i=0; i can contain or + if (child.tagName == "key") { + var key = new Key(child); + keyboardRow.appendChild(key); + allKeys.push(key); + } + else if (child.tagName == "gap") { + var gap = new Gap(child); + keyboardRow.appendChild(gap); + } + else if (child.tagName == "column") { + var col = new Column(child); + keyboardRow.appendChild(col); + } + + } + + return keyboardRow; + + } + + function Column(col) { + + var keyboardCol = document.createElement("div"); + keyboardCol.className = "col"; + + var align = null; + if (col.attributes["align"]) + align = col.attributes["align"].value; + + var children = col.childNodes; + for (var j=0; j can only contain + if (child.tagName == "row") { + var row = new Row(child); + keyboardCol.appendChild(row); + } + + } + + if (align) + keyboardCol.style.textAlign = align; + + return keyboardCol; + + } + + + + // Create keyboard + var keyboard = document.createElement("div"); + keyboard.className = "keyboard"; + + + // Retrieve keyboard XML + var xmlhttprequest = new XMLHttpRequest(); + xmlhttprequest.open("GET", url, false); + xmlhttprequest.send(null); + + var xml = xmlhttprequest.responseXML; + + if (xml) { + + // Parse document + var root = xml.documentElement; + if (root) { + + var children = root.childNodes; + for (var i=0; i can contain or + if (child.tagName == "row") { + keyboard.appendChild(new Row(child)); + } + else if (child.tagName == "column") { + keyboard.appendChild(new Column(child)); + } + + } + + } + + } + + var keyPressedHandler = null; + var keyReleasedHandler = null; + + keyboard.setKeyPressedHandler = function(kh) { keyPressedHandler = kh; }; + keyboard.setKeyReleasedHandler = function(kh) { keyReleasedHandler = kh; }; + + // Do not allow selection or mouse movement to propagate/register. + keyboard.onselectstart = + keyboard.onmousemove = + keyboard.onmouseup = + keyboard.onmousedown = + function(e) { + e.stopPropagation(); + return false; + }; + + return keyboard; +} + diff --git a/guacamole/web/keyboard.css b/guacamole/web/keyboard.css new file mode 100644 index 000000000..a4131d197 --- /dev/null +++ b/guacamole/web/keyboard.css @@ -0,0 +1,123 @@ + +/* + * Guacamole - Pure JavaScript/HTML VNC Client + * Copyright (C) 2010 Michael Jumper + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero 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 Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + */ + +div#keyboardContainer { + position: fixed; + left: 0px; + bottom: 0px; + text-align: center; + width: 100%; + display: none; + z-index: 1; +} + +div.keyboard { + + font-size: 10pt; + white-space: pre; + + border: 1px solid black; + -moz-border-radius: 0.5em; + -webkit-border-radius: 0.5em; + -khtml-border-radius: 0.5em; + border-radius: 0.5em; + background: #222; + + cursor: default; + + opacity: 0.85; + + padding: 0.25em; + margin: 0.25em; + + display: inline-block; + text-align: left; +} + +div.key { + + margin: 0; + padding: 0; + + width: 5ex; + height: 5ex; + + display: inline-block; + text-align: center; +} + +div.cap { + + border: 1px solid #888; + -moz-border-radius: 0.25em; + -webkit-border-radius: 0.25em; + -khtml-border-radius: 0.25em; + border-radius: 0.25em; + background: #444; + + margin: 0; + padding: 0; + + color: white; + text-shadow: 0 0.1em 0.1em black; + + width: 4.5ex; + height: 4.5ex; + line-height: 4.5ex; + white-space: pre; + + display: inline-block; + text-align: center; +} + +div.key:hover div.cap { + background: #666; + border-color: #666; + cursor: pointer; +} + +div.key.pressed div.cap { + background: #822; + border-color: #D44; +} + +div.key.sticky.active div.cap { + background: #882; + border-color: #DD4; +} + +div.gap { + margin: 0; + padding: 0; + + width: 5ex; + height: 5ex; + + display: inline-block; +} + +div.row { + vertical-align: top; +} + +div.col { + display: inline-block; + vertical-align: top; +} + diff --git a/guacamole/web/layouts/en-us-qwerty.xml b/guacamole/web/layouts/en-us-qwerty.xml new file mode 100644 index 000000000..7f3cbced1 --- /dev/null +++ b/guacamole/web/layouts/en-us-qwerty.xml @@ -0,0 +1,409 @@ + + + + + + + + Esc + + + + F1 + + + F2 + + + F3 + + + F4 + + + + F5 + + + F6 + + + F7 + + + F8 + + + + F9 + + + F10 + + + F11 + + + F12 + + + + + + + + + ` + ~ + + + 1 + ! + + + 2 + @ + + + 3 + # + + + 4 + $ + + + 5 + % + + + 6 + ^ + + + 7 + & + + + 8 + * + + + 9 + ( + + + 0 + ) + + + - + _ + + + = + + + + + Back + + + + + + Tab + + + q + Q + Q + q + + + w + W + W + w + + + e + E + E + e + + + r + R + R + r + + + t + T + T + t + + + y + Y + Y + y + + + u + U + U + u + + + i + I + I + i + + + o + O + O + o + + + p + P + P + p + + + [ + { + + + ] + } + + + \ + | + + + + + Caps + + + a + A + A + a + + + s + S + S + s + + + d + D + D + d + + + f + F + F + f + + + g + G + G + g + + + h + H + H + h + + + j + J + J + j + + + k + K + K + k + + + l + L + L + l + + + ; + : + + + ' + " + + + Enter + + + + + Shift + + + z + Z + Z + z + + + x + X + X + x + + + c + C + C + c + + + v + V + V + v + + + b + B + B + b + + + n + N + N + n + + + m + M + M + m + + + , + < + + + . + > + + + / + ? + + + Shift + + + + + Ctrl + + + Super + + + Alt + + + + + + Alt + + + Menu + + + Ctrl + + + + + + + + + + + + Ins + + + Home + + + PgUp + + + + + Del + + + End + + + PgDn + + + + + + + + ↑ + + + + + ← + + + ↓ + + + → + + + +