From dfa3dd8cb803146ca0dfed9f5387b8bd5aa14bb4 Mon Sep 17 00:00:00 2001 From: Richard Eckart de Castilho Date: Thu, 29 Dec 2022 19:47:31 +0100 Subject: [PATCH] #3668 - Disable tutorial for now - Moved tutorial code to separate module that is not included in the final JAR - If for some reason the JAR is in the classpath though, the tutorial will be enabled --- inception/inception-app-webapp/pom.xml | 6 + inception/inception-tutorial/LICENSE.txt | 202 ++++++++++++++++++ .../inception-tutorial/marker-wicket-module | 1 + inception/inception-tutorial/pom.xml | 114 ++++++++++ .../tutorial}/EnjoyHintJsReference.java | 2 +- .../tutorial}/TutorialFooterItem.java | 2 +- .../tutorial}/TutorialFooterPanel.html | 0 .../tutorial}/TutorialFooterPanel.java | 4 +- .../TutorialJavascriptReference.java | 2 +- .../ukp/inception/tutorial}/enjoyhint.js | 0 .../ukp/inception/tutorial}/tutorial.js | 0 inception/inception-ui-core/pom.xml | 85 -------- .../projectlist/ProjectsOverviewPage.java | 12 ++ inception/installEclipseSettings.sh | 1 + inception/pom.xml | 6 + 15 files changed, 346 insertions(+), 91 deletions(-) create mode 100644 inception/inception-tutorial/LICENSE.txt create mode 100644 inception/inception-tutorial/marker-wicket-module create mode 100644 inception/inception-tutorial/pom.xml rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/EnjoyHintJsReference.java (95%) rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/TutorialFooterItem.java (95%) rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/TutorialFooterPanel.html (100%) rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/TutorialFooterPanel.java (94%) rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/TutorialJavascriptReference.java (95%) rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/enjoyhint.js (100%) rename inception/{inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources => inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial}/tutorial.js (100%) diff --git a/inception/inception-app-webapp/pom.xml b/inception/inception-app-webapp/pom.xml index d54654a9227..a869cf311cd 100644 --- a/inception/inception-app-webapp/pom.xml +++ b/inception/inception-app-webapp/pom.xml @@ -100,6 +100,12 @@ de.tudarmstadt.ukp.inception.app inception-ui-tagsets + diff --git a/inception/inception-tutorial/LICENSE.txt b/inception/inception-tutorial/LICENSE.txt new file mode 100644 index 00000000000..d6456956733 --- /dev/null +++ b/inception/inception-tutorial/LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/inception/inception-tutorial/marker-wicket-module b/inception/inception-tutorial/marker-wicket-module new file mode 100644 index 00000000000..44dcaf8bea4 --- /dev/null +++ b/inception/inception-tutorial/marker-wicket-module @@ -0,0 +1 @@ +Marker file which activates the profile "wicket-module" from the parent POM. diff --git a/inception/inception-tutorial/pom.xml b/inception/inception-tutorial/pom.xml new file mode 100644 index 00000000000..609fb346b59 --- /dev/null +++ b/inception/inception-tutorial/pom.xml @@ -0,0 +1,114 @@ + + + 4.0.0 + + de.tudarmstadt.ukp.inception.app + inception-app + 27.0-SNAPSHOT + + inception-tutorial + INCEpTION - UI - Tutorial + + + + de.tudarmstadt.ukp.inception.app + inception-ui-core + + + + org.springframework + spring-core + + + org.springframework + spring-context + + + + javax.servlet + javax.servlet-api + provided + + + + + + org.apache.wicket + wicket-core + + + org.apache.wicket + wicket-spring + + + de.agilecoders.wicket.webjars + wicket-webjars + + + + org.webjars.bower + hover + + + org.webjars.bowergithub.xbsoftware + enjoyhint + + + org.webjars.bowergithub.flesler + jquery.scrollto + + + org.webjars.bowergithub.jquery + jquery-dist + + + + + org.webjars.npm + kinetic + + + org.webjars.bower + jquery.scrollTo + + + + + + + + org.apache.maven.plugins + maven-dependency-plugin + + + + org.webjars.bower:hover + org.webjars.bowergithub.xbsoftware:enjoyhint + org.webjars.npm:kinetic + org.webjars.bower:jquery.scrollTo + + + + + + + \ No newline at end of file diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/EnjoyHintJsReference.java b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/EnjoyHintJsReference.java similarity index 95% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/EnjoyHintJsReference.java rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/EnjoyHintJsReference.java index 937c78367d1..1977542d017 100644 --- a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/EnjoyHintJsReference.java +++ b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/EnjoyHintJsReference.java @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package de.tudarmstadt.ukp.inception.ui.core.footer.resources; +package de.tudarmstadt.ukp.inception.tutorial; import org.apache.wicket.request.resource.JavaScriptResourceReference; diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterItem.java b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterItem.java similarity index 95% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterItem.java rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterItem.java index 61c479173ca..a7e8b9974fd 100644 --- a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterItem.java +++ b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterItem.java @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package de.tudarmstadt.ukp.inception.ui.core.footer; +package de.tudarmstadt.ukp.inception.tutorial; import org.apache.wicket.Component; import org.springframework.core.annotation.Order; diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterPanel.html b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterPanel.html similarity index 100% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterPanel.html rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterPanel.html diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterPanel.java b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterPanel.java similarity index 94% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterPanel.java rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterPanel.java index c7a9392df9d..eecd878de51 100644 --- a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/TutorialFooterPanel.java +++ b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialFooterPanel.java @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package de.tudarmstadt.ukp.inception.ui.core.footer; +package de.tudarmstadt.ukp.inception.tutorial; import javax.servlet.ServletContext; @@ -29,8 +29,6 @@ import de.agilecoders.wicket.webjars.request.resource.WebjarsCssResourceReference; import de.agilecoders.wicket.webjars.request.resource.WebjarsJavaScriptResourceReference; import de.tudarmstadt.ukp.clarin.webanno.ui.core.page.WebAnnoJavascriptReference; -import de.tudarmstadt.ukp.inception.ui.core.footer.resources.EnjoyHintJsReference; -import de.tudarmstadt.ukp.inception.ui.core.footer.resources.TutorialJavascriptReference; public class TutorialFooterPanel extends Panel diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/TutorialJavascriptReference.java b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialJavascriptReference.java similarity index 95% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/TutorialJavascriptReference.java rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialJavascriptReference.java index 72e91752874..f25292e5371 100644 --- a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/TutorialJavascriptReference.java +++ b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/TutorialJavascriptReference.java @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package de.tudarmstadt.ukp.inception.ui.core.footer.resources; +package de.tudarmstadt.ukp.inception.tutorial; import org.apache.wicket.request.resource.JavaScriptResourceReference; diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/enjoyhint.js b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/enjoyhint.js similarity index 100% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/enjoyhint.js rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/enjoyhint.js diff --git a/inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/tutorial.js b/inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/tutorial.js similarity index 100% rename from inception/inception-ui-core/src/main/java/de/tudarmstadt/ukp/inception/ui/core/footer/resources/tutorial.js rename to inception/inception-tutorial/src/main/java/de/tudarmstadt/ukp/inception/tutorial/tutorial.js diff --git a/inception/inception-ui-core/pom.xml b/inception/inception-ui-core/pom.xml index cd036a18db7..aa691b10b95 100644 --- a/inception/inception-ui-core/pom.xml +++ b/inception/inception-ui-core/pom.xml @@ -181,94 +181,9 @@ de.agilecoders.wicket.webjars wicket-webjars - - - org.webjars.bower - hover - - - org.webjars.bowergithub.xbsoftware - enjoyhint - - - org.webjars.bowergithub.flesler - jquery.scrollto - - - org.webjars.bowergithub.jquery - jquery-dist - - - - - org.webjars.npm - kinetic - - - org.webjars.bower - jquery.scrollTo - - javax.persistence javax.persistence-api - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - - org.webjars.bower:hover - org.webjars.bowergithub.xbsoftware:enjoyhint - org.webjars.npm:kinetic - org.webjars.bower:jquery.scrollTo - - - - - - - - - - rat-check - - - src/main/java - - - - - - org.apache.rat - apache-rat-plugin - - - default - verify - - check - - - - - **/de/tudarmstadt/ukp/clarin/webanno/ui/core/css/css_browser_selector.js - - - - - - - - - \ No newline at end of file diff --git a/inception/inception-ui-dashboard/src/main/java/de/tudarmstadt/ukp/inception/ui/core/dashboard/projectlist/ProjectsOverviewPage.java b/inception/inception-ui-dashboard/src/main/java/de/tudarmstadt/ukp/inception/ui/core/dashboard/projectlist/ProjectsOverviewPage.java index 0964240f709..d547feddc6e 100644 --- a/inception/inception-ui-dashboard/src/main/java/de/tudarmstadt/ukp/inception/ui/core/dashboard/projectlist/ProjectsOverviewPage.java +++ b/inception/inception-ui-dashboard/src/main/java/de/tudarmstadt/ukp/inception/ui/core/dashboard/projectlist/ProjectsOverviewPage.java @@ -349,6 +349,7 @@ private LambdaAjaxLink createStartTutorialLink() { LambdaAjaxLink startTutorialLink = new LambdaAjaxLink(MID_START_TUTORIAL, this::startTutorial); + startTutorialLink.setVisibilityAllowed(isTutorialAvailable()); startTutorialLink.add(visibleWhen(() -> { return userRepository.isAdministrator(currentUser.getObject()) || userRepository.isProjectCreator(currentUser.getObject()); @@ -359,6 +360,17 @@ private LambdaAjaxLink createStartTutorialLink() return startTutorialLink; } + private boolean isTutorialAvailable() + { + try { + Class.forName("de.tudarmstadt.ukp.inception.tutorial.TutorialFooterItem"); + return true; + } + catch (Exception e) { + return false; + } + } + private void startTutorial(AjaxRequestTarget aTarget) { aTarget.appendJavaScript(" startTutorial(); "); diff --git a/inception/installEclipseSettings.sh b/inception/installEclipseSettings.sh index 9861a91945b..6f49dcc82b6 100755 --- a/inception/installEclipseSettings.sh +++ b/inception/installEclipseSettings.sh @@ -109,6 +109,7 @@ installPrefs inception-support installPrefs inception-support-standalone installPrefs inception-telemetry installPrefs inception-testing +installPrefs inception-tutorial installPrefs inception-ui-agreement installPrefs inception-ui-annotation installPrefs inception-ui-core diff --git a/inception/pom.xml b/inception/pom.xml index 78d5b230f98..764ab798450 100644 --- a/inception/pom.xml +++ b/inception/pom.xml @@ -758,6 +758,11 @@ inception-log 27.0-SNAPSHOT + + de.tudarmstadt.ukp.inception.app + inception-tutorial + 27.0-SNAPSHOT + de.tudarmstadt.ukp.inception.app inception-testing @@ -2306,6 +2311,7 @@ inception-api-schema inception-export inception-diag + inception-tutorial inception-testing inception-agreement inception-constraints