From 771ea0b5f58f0e66078c245c16288c5330ca776d Mon Sep 17 00:00:00 2001 From: Craig Williams Date: Tue, 3 Feb 2026 13:01:07 +0000 Subject: [PATCH] UserFrosting API, Database, widgets and server code all added --- .Rbuildignore | 2 + DESCRIPTION | 22 +- LICENSE.md | 595 +++++++++++++++++++++++++++++++++++++++ NAMESPACE | 9 + R/UFApi-Initialize.R | 11 + R/UFApi-LogActivity.R | 29 ++ R/UFApi-SendEmail.R | 27 ++ R/UFApi-ShinySession.R | 46 +++ R/UFApi-UFRequest.R | 152 ++++++++++ R/UFApi-UFSession.R | 27 ++ R/UFApi-UFUser.R | 44 +++ R/UFApi.R | 42 +++ R/UFDatabase.R | 78 +++++ R/aaa.R | 7 + R/ufWrapApplication.R | 131 +++++++++ R/widgets.R | 107 +++++++ README.Rmd | 29 ++ README.md | 20 ++ man/UFApi.Rd | 8 + man/UFDatabase.Rd | 123 ++++++++ man/ufServer.Rd | 24 ++ man/ufUiSidebar.Rd | 11 + man/ufUiTopbar.Rd | 11 + man/ufWrapApplication.Rd | 29 ++ 24 files changed, 1579 insertions(+), 5 deletions(-) create mode 100644 .Rbuildignore create mode 100644 LICENSE.md create mode 100644 R/UFApi-Initialize.R create mode 100644 R/UFApi-LogActivity.R create mode 100644 R/UFApi-SendEmail.R create mode 100644 R/UFApi-ShinySession.R create mode 100644 R/UFApi-UFRequest.R create mode 100644 R/UFApi-UFSession.R create mode 100644 R/UFApi-UFUser.R create mode 100644 R/UFApi.R create mode 100644 R/UFDatabase.R create mode 100644 R/aaa.R create mode 100644 R/ufWrapApplication.R create mode 100644 R/widgets.R create mode 100644 README.Rmd create mode 100644 README.md create mode 100644 man/UFApi.Rd create mode 100644 man/UFDatabase.Rd create mode 100644 man/ufServer.Rd create mode 100644 man/ufUiSidebar.Rd create mode 100644 man/ufUiTopbar.Rd create mode 100644 man/ufWrapApplication.Rd diff --git a/.Rbuildignore b/.Rbuildignore new file mode 100644 index 0000000..2a2cb83 --- /dev/null +++ b/.Rbuildignore @@ -0,0 +1,2 @@ +^LICENSE\.md$ +^README\.Rmd$ diff --git a/DESCRIPTION b/DESCRIPTION index 979859d..ae677d8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,11 +1,23 @@ Package: AVSDevR.UserFrosting -Title: What the Package Does (One Line, Title Case) Version: 0.0.0.9000 +Title: AVSDev UserFrosting Integration For R Authors@R: - person("First", "Last", , "first.last@example.com", role = c("aut", "cre")) -Description: What the package does (one paragraph). -License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a - license + person("Craig", "Williams", , "craig@avsdev.uk", role = c("aut", "cre")) +Description: AVSDevR.UserFrosting provides integration with UserFrosting v4 + for R Shiny projects. Included methods allow for calling API's provided + by UF, fetching user details and wrapping a shiny app in a UF style + dashboard. +License: GPL (>= 3) Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.3 +Imports: + dplyr, + httr, + R6, + rlang, + shiny +Suggests: + AVSDevR.DBClient, + AVSDevR.ShinyDisconnectHandler, + shinyjs diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..175443c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,595 @@ +GNU General Public License +========================== + +_Version 3, 29 June 2007_ +_Copyright © 2007 Free Software Foundation, Inc. <>_ + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for software and other +kinds of works. + +The licenses for most software and other practical works are designed to take away +your freedom to share and change the works. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change all versions of a +program--to make sure it remains free software for all its users. We, the Free +Software Foundation, use the GNU General Public License for most of our software; it +applies also to any other work released this way by its authors. You can apply it to +your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General +Public Licenses are designed to make sure that you have the freedom to distribute +copies of free software (and charge for them if you wish), that you receive source +code or can get it if you want it, that you can change the software or use pieces of +it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or +asking you to surrender the rights. Therefore, you have certain responsibilities if +you distribute copies of the software, or if you modify it: responsibilities to +respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, +you must pass on to the recipients the same freedoms that you received. You must make +sure that they, too, receive or can get the source code. And you must show them these +terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: **(1)** assert +copyright on the software, and **(2)** offer you this License giving you legal permission +to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is +no warranty for this free software. For both users' and authors' sake, the GPL +requires that modified versions be marked as changed, so that their problems will not +be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of +the software inside them, although the manufacturer can do so. This is fundamentally +incompatible with the aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we have designed +this version of the GPL to prohibit the practice for those products. If such problems +arise substantially in other domains, we stand ready to extend this provision to +those domains in future versions of the GPL, as needed to protect the freedom of +users. + +Finally, every program is threatened constantly by software patents. States should +not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that patents +applied to a free program could make it effectively proprietary. To prevent this, the +GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact copy. The +resulting work is called a “modified version” of the earlier work or a +work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on +the Program. + +To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for infringement under +applicable copyright law, except executing it on a computer or modifying a private +copy. Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the +extent that it includes a convenient and prominently visible feature that **(1)** +displays an appropriate copyright notice, and **(2)** tells the user that there is no +warranty for the work (except to the extent that warranties are provided), that +licensees may convey the work under this License, and how to view a copy of this +License. If the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The “source code” for a work means the preferred form of the work for +making modifications to it. “Object code” means any non-source form of a +work. + +A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of interfaces +specified for a particular programming language, one that is widely used among +developers working in that language. + +The “System Libraries” of an executable work include anything, other than +the work as a whole, that **(a)** is included in the normal form of packaging a Major +Component, but which is not part of that Major Component, and **(b)** serves only to +enable use of the work with that Major Component, or to implement a Standard +Interface for which an implementation is available to the public in source code form. +A “Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system (if any) on which +the executable work runs, or a compiler used to produce the work, or an object code +interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the +source code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. However, +it does not include the work's System Libraries, or general-purpose tools or +generally available free programs which are used unmodified in performing those +activities but which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for the work, and +the source code for shared libraries and dynamically linked subprograms that the work +is specifically designed to require, such as by intimate data communication or +control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of copyright on the +Program, and are irrevocable provided the stated conditions are met. This License +explicitly affirms your unlimited permission to run the unmodified Program. The +output from running a covered work is covered by this License only if the output, +given its content, constitutes a covered work. This License acknowledges your rights +of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey covered +works to others for the sole purpose of having them make modifications exclusively +for you, or provide you with facilities for running those works, provided that you +comply with the terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for you must do so +exclusively on your behalf, under your direction and control, on terms that prohibit +them from making any copies of your copyrighted material outside their relationship +with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological measure under any +applicable law fulfilling obligations under article 11 of the WIPO copyright treaty +adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention +of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of +technological measures to the extent such circumvention is effected by exercising +rights under this License with respect to the covered work, and you disclaim any +intention to limit operation or modification of the work as a means of enforcing, +against the work's users, your or third parties' legal rights to forbid circumvention +of technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you receive it, in any +medium, provided that you conspicuously and appropriately publish on each copy an +appropriate copyright notice; keep intact all notices stating that this License and +any non-permissive terms added in accord with section 7 apply to the code; keep +intact all notices of the absence of any warranty; and give all recipients a copy of +this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer +support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to produce it from +the Program, in the form of source code under the terms of section 4, provided that +you also meet all of these conditions: + +* **a)** The work must carry prominent notices stating that you modified it, and giving a +relevant date. +* **b)** The work must carry prominent notices stating that it is released under this +License and any conditions added under section 7. This requirement modifies the +requirement in section 4 to “keep intact all notices”. +* **c)** You must license the entire work, as a whole, under this License to anyone who +comes into possession of a copy. This License will therefore apply, along with any +applicable section 7 additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no permission to license the +work in any other way, but it does not invalidate such permission if you have +separately received it. +* **d)** If the work has interactive user interfaces, each must display Appropriate Legal +Notices; however, if the Program has interactive interfaces that do not display +Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are +not by their nature extensions of the covered work, and which are not combined with +it such as to form a larger program, in or on a volume of a storage or distribution +medium, is called an “aggregate” if the compilation and its resulting +copyright are not used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work in an aggregate +does not cause this License to apply to the other parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms of sections 4 and +5, provided that you also convey the machine-readable Corresponding Source under the +terms of this License, in one of these ways: + +* **a)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by the Corresponding Source fixed on a +durable physical medium customarily used for software interchange. +* **b)** Convey the object code in, or embodied in, a physical product (including a +physical distribution medium), accompanied by a written offer, valid for at least +three years and valid for as long as you offer spare parts or customer support for +that product model, to give anyone who possesses the object code either **(1)** a copy of +the Corresponding Source for all the software in the product that is covered by this +License, on a durable physical medium customarily used for software interchange, for +a price no more than your reasonable cost of physically performing this conveying of +source, or **(2)** access to copy the Corresponding Source from a network server at no +charge. +* **c)** Convey individual copies of the object code with a copy of the written offer to +provide the Corresponding Source. This alternative is allowed only occasionally and +noncommercially, and only if you received the object code with such an offer, in +accord with subsection 6b. +* **d)** Convey the object code by offering access from a designated place (gratis or for +a charge), and offer equivalent access to the Corresponding Source in the same way +through the same place at no further charge. You need not require recipients to copy +the Corresponding Source along with the object code. If the place to copy the object +code is a network server, the Corresponding Source may be on a different server +(operated by you or a third party) that supports equivalent copying facilities, +provided you maintain clear directions next to the object code saying where to find +the Corresponding Source. Regardless of what server hosts the Corresponding Source, +you remain obligated to ensure that it is available for as long as needed to satisfy +these requirements. +* **e)** Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are being +offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the +Corresponding Source as a System Library, need not be included in conveying the +object code work. + +A “User Product” is either **(1)** a “consumer product”, which +means any tangible personal property which is normally used for personal, family, or +household purposes, or **(2)** anything designed or sold for incorporation into a +dwelling. In determining whether a product is a consumer product, doubtful cases +shall be resolved in favor of coverage. For a particular product received by a +particular user, “normally used” refers to a typical or common use of +that class of product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected to use, the +product. A product is a consumer product regardless of whether the product has +substantial commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install and execute +modified versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the continued +functioning of the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for +use in, a User Product, and the conveying occurs as part of a transaction in which +the right of possession and use of the User Product is transferred to the recipient +in perpetuity or for a fixed term (regardless of how the transaction is +characterized), the Corresponding Source conveyed under this section must be +accompanied by the Installation Information. But this requirement does not apply if +neither you nor any third party retains the ability to install modified object code +on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to +continue to provide support service, warranty, or updates for a work that has been +modified or installed by the recipient, or for the User Product in which it has been +modified or installed. Access to a network may be denied when the modification itself +materially and adversely affects the operation of the network or violates the rules +and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with +this section must be in a format that is publicly documented (and with an +implementation available to the public in source code form), and must require no +special password or key for unpacking, reading or copying. + +### 7. Additional Terms + +“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. Additional +permissions that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part may be +used separately under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when you +modify the work.) You may place additional permissions on material, added by you to a +covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a +covered work, you may (if authorized by the copyright holders of that material) +supplement the terms of this License with terms: + +* **a)** Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or +* **b)** Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed by works +containing it; or +* **c)** Prohibiting misrepresentation of the origin of that material, or requiring that +modified versions of such material be marked in reasonable ways as different from the +original version; or +* **d)** Limiting the use for publicity purposes of names of licensors or authors of the +material; or +* **e)** Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or +* **f)** Requiring indemnification of licensors and authors of that material by anyone +who conveys the material (or modified versions of it) with contractual assumptions of +liability to the recipient, for any liability that these contractual assumptions +directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you received +it, or any part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. If a +license document contains a further restriction but permits relicensing or conveying +under this License, you may add to a covered work material governed by the terms of +that license document, provided that the further restriction does not survive such +relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in +the relevant source files, a statement of the additional terms that apply to those +files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a +separately written license, or stated as exceptions; the above requirements apply +either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly provided under +this License. Any attempt otherwise to propagate or modify it is void, and will +automatically terminate your rights under this License (including any patent licenses +granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a +particular copyright holder is reinstated **(a)** provisionally, unless and until the +copyright holder explicitly and finally terminates your license, and **(b)** permanently, +if the copyright holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, this +is the first time you have received notice of violation of this License (for any +work) from that copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of +parties who have received copies or rights from you under this License. If your +rights have been terminated and not permanently reinstated, you do not qualify to +receive new licenses for the same material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or run a copy of the +Program. Ancillary propagation of a covered work occurring solely as a consequence of +using peer-to-peer transmission to receive a copy likewise does not require +acceptance. However, nothing other than this License grants you permission to +propagate or modify any covered work. These actions infringe copyright if you do not +accept this License. Therefore, by modifying or propagating a covered work, you +indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically receives a license +from the original licensors, to run, modify and propagate that work, subject to this +License. You are not responsible for enforcing compliance by third parties with this +License. + +An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an organization, or +merging organizations. If propagation of a covered work results from an entity +transaction, each party to that transaction who receives a copy of the work also +receives whatever licenses to the work the party's predecessor in interest had or +could give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if the predecessor +has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or +affirmed under this License. For example, you may not impose a license fee, royalty, +or other charge for exercise of rights granted under this License, and you may not +initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging +that any patent claim is infringed by making, using, selling, offering for sale, or +importing the Program or any portion of it. + +### 11. Patents + +A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The work thus +licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or +controlled by the contributor, whether already acquired or hereafter acquired, that +would be infringed by some manner, permitted by this License, of making, using, or +selling its contributor version, but do not include claims that would be infringed +only as a consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant patent +sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license +under the contributor's essential patent claims, to make, use, sell, offer for sale, +import and otherwise run, modify and propagate the contents of its contributor +version. + +In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent (such as an +express permission to practice a patent or covenant not to sue for patent +infringement). To “grant” such a patent license to a party means to make +such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free of charge +and under the terms of this License, through a publicly available network server or +other readily accessible means, then you must either **(1)** cause the Corresponding +Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the +patent license for this particular work, or **(3)** arrange, in a manner consistent with +the requirements of this License, to extend the patent license to downstream +recipients. “Knowingly relying” means you have actual knowledge that, but +for the patent license, your conveying the covered work in a country, or your +recipient's use of the covered work in a country, would infringe one or more +identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you +convey, or propagate by procuring conveyance of, a covered work, and grant a patent +license to some of the parties receiving the covered work authorizing them to use, +propagate, modify or convey a specific copy of the covered work, then the patent +license you grant is automatically extended to all recipients of the covered work and +works based on it. + +A patent license is “discriminatory” if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on the +non-exercise of one or more of the rights that are specifically granted under this +License. You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which you make +payment to the third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties who would receive +the covered work from you, a discriminatory patent license **(a)** in connection with +copies of the covered work conveyed by you (or copies made from those copies), or **(b)** +primarily for and in connection with specific products or compilations that contain +the covered work, unless you entered into that arrangement, or that patent license +was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available to you +under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from the +conditions of this License. If you cannot convey a covered work so as to satisfy +simultaneously your obligations under this License and any other pertinent +obligations, then as a consequence you may not convey it at all. For example, if you +agree to terms that obligate you to collect a royalty for further conveying from +those to whom you convey the Program, the only way you could satisfy both those terms +and this License would be to refrain entirely from conveying the Program. + +### 13. Use with the GNU Affero General Public License + +Notwithstanding any other provision of this License, you have permission to link or +combine any covered work with a work licensed under version 3 of the GNU Affero +General Public License into a single combined work, and to convey the resulting work. +The terms of this License will continue to apply to the part which is the covered +work, but the special requirements of the GNU Affero General Public License, section +13, concerning interaction through a network will apply to the combination as such. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions of the GNU +General Public License from time to time. Such new versions will be similar in spirit +to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that +a certain numbered version of the GNU General Public License “or any later +version” applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published by the +Free Software Foundation. If the Program does not specify a version number of the GNU +General Public License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU +General Public License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no +additional obligations are imposed on any author or copyright holder as a result of +your choosing to follow a later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE +QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY +COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS +PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE +OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE +WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided above cannot be +given local legal effect according to their terms, reviewing courts shall apply local +law that most closely approximates an absolute waiver of all civil liability in +connection with the Program, unless a warranty or assumption of liability accompanies +a copy of the Program in return for a fee. + +_END OF TERMS AND CONDITIONS_ + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to +the public, the best way to achieve this is to make it free software which everyone +can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them +to the start of each source file to most effectively state the exclusion of warranty; +and each file should have at least the “copyright” line and a pointer to +where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like this +when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + +The hypothetical commands `show w` and `show c` should show the appropriate parts of +the General Public License. Of course, your program's commands might be different; +for a GUI interface, you would use an “about box”. + +You should also get your employer (if you work as a programmer) or school, if any, to +sign a “copyright disclaimer” for the program, if necessary. For more +information on this, and how to apply and follow the GNU GPL, see +<>. + +The GNU General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may consider it +more useful to permit linking proprietary applications with the library. If this is +what you want to do, use the GNU Lesser General Public License instead of this +License. But first, please read +<>. diff --git a/NAMESPACE b/NAMESPACE index 6ae9268..3696993 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,2 +1,11 @@ # Generated by roxygen2: do not edit by hand +export(UFApi) +export(UFDatabase) +export(ufServer) +export(ufUiSidebar) +export(ufUiTopbar) +export(ufWrapApplication) +import(R6) +importFrom(R6,R6Class) +importFrom(rlang,.data) diff --git a/R/UFApi-Initialize.R b/R/UFApi-Initialize.R new file mode 100644 index 0000000..6238deb --- /dev/null +++ b/R/UFApi-Initialize.R @@ -0,0 +1,11 @@ +uf_uri <- NULL +uf_app_name <- NULL + +initialize <- function(uri, app_name = NULL) { + private$uf_uri <- uri + private$uf_app_name <- app_name +} + +getURI <- function() { + private$uf_uri +} diff --git a/R/UFApi-LogActivity.R b/R/UFApi-LogActivity.R new file mode 100644 index 0000000..fb105af --- /dev/null +++ b/R/UFApi-LogActivity.R @@ -0,0 +1,29 @@ + +logActivity <- function(type, message, ...) { + params <- list(...) + paramNames <- names(params) + if (length(params) > 0 + && (length(paramNames) == 0 || sum(nchar(paramNames) == 0) > 0) + ) { + stop("All substitution parameters must be named") + } + + if (getOption("uf.virtual", FALSE)) { + cat("***** UF *****\n") + cat("Log activity:\n") + dplyr::glimpse(list(type = type, message = message, params = params)) + cat("***** /UF *****\n") + return() + } + + for (idx in seq_along(paramNames)) { + paramName <- paramNames[[idx]] + message <- gsub( + paste0("\\{\\{", paramName, "\\}\\}"), + paste0(params[[paramName]], collapse = ","), + message + ) + } + + private$ufApiPOST("/activity", body = list(type = type, message = message)) +} diff --git a/R/UFApi-SendEmail.R b/R/UFApi-SendEmail.R new file mode 100644 index 0000000..5998e22 --- /dev/null +++ b/R/UFApi-SendEmail.R @@ -0,0 +1,27 @@ + +sendEmail <- function(type, ...) { + params <- list(...) + paramNames <- names(params) + if (length(params) > 0 + && (length(paramNames) == 0 || sum(nchar(paramNames) == 0) > 0) + ) { + stop("All substitution parameters must be named") + } + + if (getOption("uf.virtual", FALSE)) { + cat("***** UF *****\n") + cat("Send email:\n") + dplyr::glimpse(list(type = type, params = params)) + cat("***** /UF *****\n") + return() + } + + type <- gsub("^/*", "", type) + if (length(params) > 0) { + response <- private$ufApiPOST(paste0("/email/", type), body = params) + } else { + response <- private$ufApiPOST(paste0("/email/", type)) + } + + response +} diff --git a/R/UFApi-ShinySession.R b/R/UFApi-ShinySession.R new file mode 100644 index 0000000..4ee08de --- /dev/null +++ b/R/UFApi-ShinySession.R @@ -0,0 +1,46 @@ +shiny_session <- NULL +client_ip <- NULL + +setShinySession <- function(session) { + private$shiny_session <- session + + if ("HTTP_X_REAL_IP" %in% names(session$request)) { + cat("Using client IP from HTTP_X_REAL_IP\n") + private$client_ip <- session$request$HTTP_X_REAL_IP + } else if ("HTTP_X_FORWARDED_FOR" %in% names(session$request)) { + cat("Using client IP from HTTP_X_FORWARDED_FOR\n") + private$client_ip <- strsplit( + session$request$HTTP_X_FORWARDED_FOR, "," + )[[1]][[1]] + } else if ("REMOTE_ADDR" %in% names(session$request)) { + cat("Using client IP from REMOTE_ADDR\n") + private$client_ip <- session$request$REMOTE_ADDR + } else { + cat("Warning: No client IP found\n") + private$client_ip <- "x.x.x.x" + } + cat("Client IP:") + utils::str(private$client_ip) +} + +onSessionStart <- function() { + if (getOption("uf.virtual", FALSE)) { + return() + } + private$ufApiGET("/open") +} + +onSessionEnd <- function() { + if (getOption("uf.virtual", FALSE)) { + return() + } + private$ufApiGET("/close", redirect_on_session_timeout = FALSE) +} + +getShinySession <- function() { + private$shiny_session +} + +getClientIp <- function() { + private$client_ip +} diff --git a/R/UFApi-UFRequest.R b/R/UFApi-UFRequest.R new file mode 100644 index 0000000..0f797d5 --- /dev/null +++ b/R/UFApi-UFRequest.R @@ -0,0 +1,152 @@ + +.apiURI <- function(uri, ...) { + params <- list(...) + paramNames <- names(params) + if (length(params) > 0 + && (length(paramNames) == 0 || sum(nchar(paramNames) == 0) > 0) + ) { + stop("All substitution parameters must be named") + } + uri <- paste0(private$uf_uri, "/api/", private$uf_app_name, uri) + for (idx in seq_along(paramNames)) { + paramName <- paramNames[[idx]] + uri <- gsub( + paste0("\\{\\{", paramName, "\\}\\}"), + paste0(params[[paramName]], collapse = ","), + uri + ) + } + uri +} + +.ufApiGET <- function(uri, redirect_on_session_timeout = TRUE, ...) { + response <- NULL + + full_uri <- private$apiURI(uri, ...) + + tryCatch( + { + cat("URI:", full_uri, "\n") + if (is.null(private$uf_session_id)) { + http_response <- httr::GET( + full_uri, + httr::add_headers( + `Accept` = "application/json", + `X-Forwarded-For` = private$client_ip, + `X-Real-Ip` = private$client_ip + ) + ) + } else { + http_response <- httr::GET( + full_uri, + httr::add_headers( + `Accept` = "application/json", + `X-Forwarded-For` = private$client_ip, + `X-Real-Ip` = private$client_ip + ), + httr::set_cookies(`uf4` = private$uf_session_id) + ) + } + + if (http_response$status_code == 401) { + stop("User session expired") + } + + if (http_response$status_code != 200) { + if (getOption("uf.debug_response", FALSE)) { + utils::str(http_response) + } + stop("Response was not OK") + } + + if (http_response$headers$`content-type` != "application/json") { + if (getOption("uf.debug_response", FALSE)) { + utils::str(http_response) + } + stop("Invalid response type") + } + + response <- httr::content(http_response) + + if (getOption("uf.debug_response", FALSE)) { + cat("RESULT:") + dplyr::glimpse(response) + } + }, + error = function(ex) { + cat("UF API EXCEPTION: ") + utils::str(ex$message) + } + ) + + response +} + +.ufApiPOST <- function(uri, body = list(), encoding = "json", ...) { + response <- NULL + + csrf <- private$ufApiGET("/csrf") + + full_uri <- private$apiURI(uri, ...) + + tryCatch( + { + cat("URI:", full_uri, "\n") + if (is.null(private$uf_session_id)) { + http_response <- httr::POST( + full_uri, + body = c(csrf, body), + encode = encoding, + httr::add_headers( + `Accept` = "application/json", + `X-Forwarded-For` = private$client_ip, + `X-Real-Ip` = private$client_ip + ) + ) + } else { + http_response <- httr::POST( + full_uri, + body = c(csrf, body), + encode = encoding, + httr::add_headers( + `Accept` = "application/json", + `X-Forwarded-For` = private$client_ip, + `X-Real-Ip` = private$client_ip + ), + httr::set_cookies(`uf4` = private$uf_session_id) + ) + } + + if (http_response$status_code == 401) { + stop("User session expired") + } + + if (http_response$status_code != 200) { + if (getOption("uf.debug_response", FALSE)) { + utils::str(http_response) + } + stop("Response was not OK") + } + + if (http_response$headers$`content-type` != "application/json") { + if (getOption("uf.debug_response", FALSE)) { + utils::str(http_response) + } + stop("Invalid response type") + } + + response <- httr::content(http_response) + + if (getOption("uf.debug_response", FALSE)) { + cat("RESULT:") + dplyr::glimpse(response) + } + }, + error = function(ex) { + cat("UF API EXCEPTION: ") + utils::str(ex$message) + } + ) + + response +} diff --git a/R/UFApi-UFSession.R b/R/UFApi-UFSession.R new file mode 100644 index 0000000..dc0c734 --- /dev/null +++ b/R/UFApi-UFSession.R @@ -0,0 +1,27 @@ +uf_session_id <- NULL + +verifyUFSession <- function(query) { + if (getOption("uf.virtual", FALSE)) { + private$uf_session_id <- "supercalifragilisticexpialidocious" + return(TRUE) + } + + if (!("key" %in% names(query))) { + return(FALSE) + } + + result <- private$ufApiGET("/check-session?key={{key}}", key = query$key) + if (length(result) == 0 && is.null(result)) { + return(FALSE) + } + + result <- private$ufApiGET("/session?key={{key}}", key = query$key) + private$uf_session_id <- result$session$id + httr::handle_reset(private$uf_uri) + + TRUE +} + +getSessionId <- function() { + private$uf_session_id +} diff --git a/R/UFApi-UFUser.R b/R/UFApi-UFUser.R new file mode 100644 index 0000000..75cbae2 --- /dev/null +++ b/R/UFApi-UFUser.R @@ -0,0 +1,44 @@ +uf_user <- NULL + +fetchUser <- function() { + if (getOption("uf.virtual", FALSE)) { + private$uf_user <- list( + id = getOption("uf.user_id", 1), + user_name = "AVSDEV_DEBUG", + email = "debug@avsdev.uk", + first_name = "DEBUG", + last_name = "@AVSDEV", + flag_verified = TRUE, + flag_enabled = TRUE, + phone_number = "01202883234", + avatar = "https://www.gravatar.com/avatar/default?d=mm", + group = list( + icon = NULL, + name = NULL, + description = NULL + ), + roles = data.frame( + slug = c("user", "site-admin", "activities-admin"), + name = c("User", "Site Administrator", "Activities Administrator"), + description = c("", "", ""), + stringsAsFactors = FALSE + ), + organisations = data.frame( + slug = c("AVSDev"), + name = c("AVSDev"), + description = c("AVS Developments Ltd"), + flag_approved = c(TRUE), + flag_admin = c(TRUE), + stringsAsFactors = FALSE + ) + ) + return(private$uf_user) + } + + result <- private$ufApiGET("/session-user") + private$uf_user <- result +} + +getUser <- function() { + private$uf_user +} diff --git a/R/UFApi.R b/R/UFApi.R new file mode 100644 index 0000000..a1a9e63 --- /dev/null +++ b/R/UFApi.R @@ -0,0 +1,42 @@ + +class_env <- new.env(parent = baseenv()) + +res <- lapply( + list.files("R", pattern = "UFApi-.*\\.R"), + function(fn) { + eval(parse(paste0("R/", fn)), envir = class_env, enclos = emptyenv()) + } +) + +fn_names <- names(which(vapply(class_env, is.function, logical(1)))) +fn_list <- lapply(fn_names, function(fn_name) { + class_env[[fn_name]] +}) +names(fn_list) <- fn_names + +priv_fn_names <- ls(class_env, pattern = "^\\..*", all.names = TRUE) +priv_fn_list <- lapply(priv_fn_names, function(fn_name) { + class_env[[fn_name]] +}) +names(priv_fn_list) <- gsub("^\\.", "", priv_fn_names) + +member_names <- names(which(!vapply(class_env, is.function, logical(1)))) +member_list <- lapply(member_names, function(member_name) { + class_env[[member_name]] +}) +names(member_list) <- member_names + + +#' @name UFApi +#' @title UFApi +#' @description UserFrosting API class +NULL + +#' @export +UFApi <- R6::R6Class( + "UFApi", + public = fn_list, + private = c(member_list, priv_fn_list), + lock_class = TRUE, + parent_env = class_env +) diff --git a/R/UFDatabase.R b/R/UFDatabase.R new file mode 100644 index 0000000..34c01e0 --- /dev/null +++ b/R/UFDatabase.R @@ -0,0 +1,78 @@ +#' @name UFDatabase +#' @title UFDatabase +#' @description UserFrosting Database class +#' @export +UFDatabase <- R6::R6Class( + "UFDatabase", + public = list( + #' @description Initialises the UFDatabase class + #' @param db_client An instance of AVSDevR.DBClient::DBClient + initialize = function(db_client) { + if (is.null(db_client) || !inherits(db_client, "DBClient")) { + stop("DBClient instance required!") + } + private$db_client <- db_client + }, + + #' @description Retreives the details of a user from the UserFrosting + #' database tables + #' @param user_id The ID of the user to retrieve (usually the current + #' session user) + #' @param collect When TRUE, calls dplyr::collect() on the query, when + #' FALSE returns the query object unfetched + #' @returns The query object or data table of the user + getUser = function(user_id, collect = TRUE) { + tbl <- private$db_client$table("users") + filt_tbl <- dplyr::filter(tbl, .data$id == !!user_id) + filt_tbl <- dplyr::mutate( + filt_tbl, + full_name = paste(.data$first_name, .data$last_name) + ) + private$db_client$collectOrReturn(filt_tbl) + }, + + #' @description Retrieves the user name (first_name last_name) of a user + #' from the UserFrosting database tables + #' @param user_id The ID of the user to retrieve (usually the current + #' session user) + #' @returns The name related to user_id + getUserName = function(user_id) { + tbl <- private$db_client$table("users") + filt_tbl <- dplyr::filter( + tbl, + .data$id == !!user_id, + .data$flag_verified == TRUE, + .data$flag_enabled == TRUE + ) + filt_tbl <- dplyr::mutate( + filt_tbl, + full_name = paste(.data$first_name, .data$last_name) + ) + dplyr::pull(filt_tbl, .data$full_name) + }, + + #' @description Retrieves the user's roles from the UserFrosting database + #' tables + #' @param user_id The ID of the user to retrieve (usually the current + #' session user) + #' @param collect When TRUE, calls dplyr::collect() on the query, when + #' FALSE returns the query object unfetched + #' @returns The query object or the user roles + getUserRoles = function(user_id, collect = TRUE) { + tbl_role_user <- dplyr::select( + private$db_client$table("role_users"), .data$user_id, .data$role_id + ) + + tbl <- dplyr::left_join( + private$db_client$table("roles"), tbl_role_user, by = c(id = "role_id") + ) + filt_tbl <- dplyr::filter(tbl, .data$user_id == !!user_id) + private$db_client$collectOrReturn(filt_tbl) + } + ), + private = list( + db_client = NULL + ), + lock_class = TRUE, + parent_env = baseenv() +) diff --git a/R/aaa.R b/R/aaa.R new file mode 100644 index 0000000..27f8750 --- /dev/null +++ b/R/aaa.R @@ -0,0 +1,7 @@ +if(getRversion() >= "2.15.1") utils::globalVariables(c("self")) +if(getRversion() >= "2.15.1") utils::globalVariables(c("private")) + +#' @importFrom rlang .data +#' @importFrom R6 R6Class +#' @import R6 +NULL diff --git a/R/ufWrapApplication.R b/R/ufWrapApplication.R new file mode 100644 index 0000000..8301dcb --- /dev/null +++ b/R/ufWrapApplication.R @@ -0,0 +1,131 @@ +#' Wraps an application with UserFrosting user & session authentication +#' @param app The application to wrap +#' @param ufURI The UserFrosting API instance +#' @param with_users Wether to enable user authentication +#' @param user_optional Inidicates wether authenticated users are optional. If +#' FALSE then any un-authenticated user can still access the application +#' @param app_name The name of the application (used in the UFApi calls) +#' @export +ufWrapApplication <- function( + app, ufURI, with_users = TRUE, user_optional = FALSE, app_name = NULL +) { + inner_server <- app$serverFuncSource() + + wrapped_server <- function(input, output, session, ...) { + ##### User Frosting integration + ufApi <- UFApi$new(ufURI, app_name) + ufApi$setShinySession(session) + + printMarkerBegin <- function() { + # nolint start: line_length_linter + cat("#####UF-SVR-BEGIN###############################################################\n") + # nolint end + } + printMarkerEnd <- function() { + # nolint start: line_length_linter + cat("#####UF-SVR-END#################################################################\n\n") + # nolint end + } + + + isSessionRequired <- function() { + return(!(length(with_users) > 0 && !with_users)) + } + + isSessionValid <- function() { + return(ufApi$verifyUFSession(shiny::getQueryString(session))) + } + + isSessionOptional <- function() { + return(length(user_optional) > 0 && user_optional) + } + + + handleNoSessionRequired <- function() { + printMarkerBegin() + cat("Starting server - No UF session required\n") + cat("Session started for non-UF user:", ufApi$getClientIp(), "\n") + printMarkerEnd() + + inner_server( + input, output, session, ufApi = ufApi, ufUser = NULL, ... + ) + } + + handleSessionVerified <- function() { + printMarkerBegin() + cat("Starting server - UF user verified\n") + session$onSessionEnded(ufApi$onSessionEnd) + + ufUser <- ufApi$fetchUser() + session$userData$user_id <- ufUser$id + cat("Session started for user:", ufUser$id, "\n") + printMarkerEnd() + + inner_server( + input, output, session, ufApi = ufApi, ufUser = ufUser, ... + ) + } + + handleSessionOptional <- function() { + printMarkerBegin() + cat("Starting server - UF user optional\n") + session$onSessionEnded(ufApi$onSessionEnd) + + cat("Session started for non-UF user:", ufApi$getClientIp(), "\n") + printMarkerEnd() + + inner_server( + input, output, session, ufApi = ufApi, ufUser = NULL, ... + ) + } + + handleSessionInvalid <- function() { + printMarkerBegin() + cat("Not starting server - UF user invalid\n") + windowTarget <- paste0( + session$clientData$url_protocol, "//", session$clientData$url_hostname + ) + if (nchar(session$clientData$url_port) > 0 + && !(session$clientData$url_port %in% c("80", "443")) + ) { + windowTarget <- paste0(windowTarget, ":", session$clientData$url_port) + } + + if (requireNamespace("shinyjs")) { + if (requireNamespace("AVSDevR.ShinyDisconnectHandler")) { + shinyjs::runjs(paste0("bannerDisconnectHandler.disableOverlay();")) + } + shinyjs::runjs(paste0( + "window.parent.postMessage('reload', '", windowTarget, "');" + )) + } + + cat("Stopping server with 401...\n") + printMarkerEnd() + + stop(401) + } + + ##### UF <--> R User + runOnce <- shiny::observe({ + if (!isSessionRequired()) { + handleNoSessionRequired() + } else if (isSessionValid()) { + handleSessionVerified() + } else if (isSessionOptional()) { + handleSessionOptional() + } else { + handleSessionInvalid() + } + + runOnce$destroy() + }) + } + + app$serverFuncSource <- function() { + wrapped_server + } + + return(app) +} diff --git a/R/widgets.R b/R/widgets.R new file mode 100644 index 0000000..67498a3 --- /dev/null +++ b/R/widgets.R @@ -0,0 +1,107 @@ + +#' UI placeholder for the UserFrosting styled top navigation bar +#' @export +ufUiTopbar <- function() { + shiny::uiOutput( + "UF-uiUserDropdown", + container = shiny::tags$li, class = "dropdown user user-menu" + ) +} + + +#' UI placeholder for the UserFrosting styled side navigation bar +#' @export +ufUiSidebar <- function() { + shiny::uiOutput( + "UF-uiUserPanel", + container = shiny::tags$div, class = "user-panel" + ) +} + + +#' Populates the UserFrosting UI elements with the authenticated UF user for +#' this session +#' @param input Shiny inputs +#' @param output Shiny outputs +#' @param session Shiny session +#' @param ufApi UserFrosting API instance +#' @param ... Masks any additional parameters not used by this server instance +#' @export +ufServer <- function(input, output, session, ufApi, ...) { + user <- ufApi$getUser() + + output$uiUserDropdown <- shiny::renderUI({ + userLinks <- shiny::tagList( + shiny::tags$a( + href = paste0(ufApi$getURI(), "/dashboard"), + class = "btn btn-default btn-flat btn-block", + target = "_top", + "Dashboard" + ), + shiny::tags$a( + href = paste0(ufApi$getURI(), "/account/settings"), + class = "btn btn-default btn-flat btn-block", + target = "_top", + "My Account" + ), + shiny::tags$a( + href = paste0(ufApi$getURI(), "/account/logout"), + class = "btn btn-default btn-flat btn-block", + target = "_top", + "Logout" + ) + ) + + shiny::tagList( + shiny::tags$a( + href = "javascript:void(0);", + class = "dropdown-toggle", + `data-toggle` = "dropdown", + shiny::tags$img( + src = user$avatar, + class = "user-image", + alt = "User Image" + ), + shiny::span( + paste(user$first_name, user$last_name), class = "hidden-xs" + ), + shiny::icon("chevron-down") + ), + shiny::tags$ul( + class = "dropdown-menu", + shiny::tags$li( + class = "user-header", + shiny::tags$img( + src = user$avatar, + class = "img-circle", + alt = "User Image" + ), + shiny::tags$p( + paste(user$first_name, user$last_name), + shiny::tags$small(paste0("(", user$user_name, ")")) + ) + ), + userLinks + ) + ) + }) + + output$uiUserPanel <- shiny::renderUI({ + shiny::tagList( + shiny::tags$div( + class = "pull-left image", + shiny::tags$img( + src = user$avatar, + class = "img-circle", + alt = "User Image" + ) + ), + shiny::tags$div( + class = "pull-left info", + shiny::tags$p(paste(user$first_name, user$last_name)), + shiny::tags$i(class = user$group$icon), + user$group$name + ) + ) + }) +} diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..37ed61a --- /dev/null +++ b/README.Rmd @@ -0,0 +1,29 @@ +--- +output: github_document +--- + + + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "man/figures/README-", + out.width = "100%" +) +``` + +# AVSDevR.UserFrosting + + + + +The goal of AVSDevR.UserFrosting is to provide integration with UserFrosting v4 for R Shiny projects. Included methods allow for calling API's provided by UF, fetching user details and wrapping a shiny app in a UF style dashboard. + +## Installation + +You can install the development version of AVSDevR.UserFrosting like so: + +``` r +remotes::install_git("https://git.avsdev.uk/R/AVSDevR.UserFrosting") +``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1817eb --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ + + + +# AVSDevR.UserFrosting + + + + +The goal of AVSDevR.UserFrosting is to provide integration with +UserFrosting v4 for R Shiny projects. Included methods allow for calling +API’s provided by UF, fetching user details and wrapping a shiny app in +a UF style dashboard. + +## Installation + +You can install the development version of AVSDevR.UserFrosting like so: + +``` r +remotes::install_git("https://git.avsdev.uk/R/AVSDevR.UserFrosting") +``` diff --git a/man/UFApi.Rd b/man/UFApi.Rd new file mode 100644 index 0000000..2ac08ed --- /dev/null +++ b/man/UFApi.Rd @@ -0,0 +1,8 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/UFApi.R +\name{UFApi} +\alias{UFApi} +\title{UFApi} +\description{ +UserFrosting API class +} diff --git a/man/UFDatabase.Rd b/man/UFDatabase.Rd new file mode 100644 index 0000000..b6dcbf4 --- /dev/null +++ b/man/UFDatabase.Rd @@ -0,0 +1,123 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/UFDatabase.R +\name{UFDatabase} +\alias{UFDatabase} +\title{UFDatabase} +\value{ +\if{html}{\out{}} The query object or data table of the user + +\if{html}{\out{}} The name related to user_id + +\if{html}{\out{}} The query object or the user roles +} +\description{ +UserFrosting Database class +} +\section{Methods}{ +\subsection{Public methods}{ +\itemize{ +\item \href{#method-UFDatabase-new}{\code{UFDatabase$new()}} +\item \href{#method-UFDatabase-getUser}{\code{UFDatabase$getUser()}} +\item \href{#method-UFDatabase-getUserName}{\code{UFDatabase$getUserName()}} +\item \href{#method-UFDatabase-getUserRoles}{\code{UFDatabase$getUserRoles()}} +\item \href{#method-UFDatabase-clone}{\code{UFDatabase$clone()}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-UFDatabase-new}{}}} +\subsection{Method \code{new()}}{ +Initialises the UFDatabase class +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{UFDatabase$new(db_client)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{db_client}}{An instance of AVSDevR.DBClient::DBClient} +} +\if{html}{\out{
}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-UFDatabase-getUser}{}}} +\subsection{Method \code{getUser()}}{ +Retreives the details of a user from the UserFrosting +database tables +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{UFDatabase$getUser(user_id, collect = TRUE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{user_id}}{The ID of the user to retrieve (usually the current +session user)} + +\item{\code{collect}}{When TRUE, calls dplyr::collect() on the query, when +FALSE returns the query object unfetched} +} +\if{html}{\out{
}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-UFDatabase-getUserName}{}}} +\subsection{Method \code{getUserName()}}{ +Retrieves the user name (first_name last_name) of a user +from the UserFrosting database tables +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{UFDatabase$getUserName(user_id)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{user_id}}{The ID of the user to retrieve (usually the current +session user)} +} +\if{html}{\out{
}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-UFDatabase-getUserRoles}{}}} +\subsection{Method \code{getUserRoles()}}{ +Retrieves the user's roles from the UserFrosting database +tables +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{UFDatabase$getUserRoles(user_id, collect = TRUE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{user_id}}{The ID of the user to retrieve (usually the current +session user)} + +\item{\code{collect}}{When TRUE, calls dplyr::collect() on the query, when +FALSE returns the query object unfetched} +} +\if{html}{\out{
}} +} +} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-UFDatabase-clone}{}}} +\subsection{Method \code{clone()}}{ +The objects of this class are cloneable with this method. +\subsection{Usage}{ +\if{html}{\out{
}}\preformatted{UFDatabase$clone(deep = FALSE)}\if{html}{\out{
}} +} + +\subsection{Arguments}{ +\if{html}{\out{
}} +\describe{ +\item{\code{deep}}{Whether to make a deep clone.} +} +\if{html}{\out{
}} +} +} +} diff --git a/man/ufServer.Rd b/man/ufServer.Rd new file mode 100644 index 0000000..c7d164c --- /dev/null +++ b/man/ufServer.Rd @@ -0,0 +1,24 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/widgets.R +\name{ufServer} +\alias{ufServer} +\title{Populates the UserFrosting UI elements with the authenticated UF user for +this session} +\usage{ +ufServer(input, output, session, ufApi, ...) +} +\arguments{ +\item{input}{Shiny inputs} + +\item{output}{Shiny outputs} + +\item{session}{Shiny session} + +\item{ufApi}{UserFrosting API instance} + +\item{...}{Masks any additional parameters not used by this server instance} +} +\description{ +Populates the UserFrosting UI elements with the authenticated UF user for +this session +} diff --git a/man/ufUiSidebar.Rd b/man/ufUiSidebar.Rd new file mode 100644 index 0000000..aa766b6 --- /dev/null +++ b/man/ufUiSidebar.Rd @@ -0,0 +1,11 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/widgets.R +\name{ufUiSidebar} +\alias{ufUiSidebar} +\title{UI placeholder for the UserFrosting styled side navigation bar} +\usage{ +ufUiSidebar() +} +\description{ +UI placeholder for the UserFrosting styled side navigation bar +} diff --git a/man/ufUiTopbar.Rd b/man/ufUiTopbar.Rd new file mode 100644 index 0000000..2ca6bfc --- /dev/null +++ b/man/ufUiTopbar.Rd @@ -0,0 +1,11 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/widgets.R +\name{ufUiTopbar} +\alias{ufUiTopbar} +\title{UI placeholder for the UserFrosting styled top navigation bar} +\usage{ +ufUiTopbar() +} +\description{ +UI placeholder for the UserFrosting styled top navigation bar +} diff --git a/man/ufWrapApplication.Rd b/man/ufWrapApplication.Rd new file mode 100644 index 0000000..1aec656 --- /dev/null +++ b/man/ufWrapApplication.Rd @@ -0,0 +1,29 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/ufWrapApplication.R +\name{ufWrapApplication} +\alias{ufWrapApplication} +\title{Wraps an application with UserFrosting user & session authentication} +\usage{ +ufWrapApplication( + app, + ufURI, + with_users = TRUE, + user_optional = FALSE, + app_name = NULL +) +} +\arguments{ +\item{app}{The application to wrap} + +\item{ufURI}{The UserFrosting API instance} + +\item{with_users}{Wether to enable user authentication} + +\item{user_optional}{Inidicates wether authenticated users are optional. If +FALSE then any un-authenticated user can still access the application} + +\item{app_name}{The name of the application (used in the UFApi calls)} +} +\description{ +Wraps an application with UserFrosting user & session authentication +}