001/* 002 * This library is part of OpenCms - 003 * the Open Source Content Management System 004 * 005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com) 006 * 007 * This library is free software; you can redistribute it and/or 008 * modify it under the terms of the GNU Lesser General Public 009 * License as published by the Free Software Foundation; either 010 * version 2.1 of the License, or (at your option) any later version. 011 * 012 * This library is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 015 * Lesser General Public License for more details. 016 * 017 * For further information about Alkacon Software, please see the 018 * company website: http://www.alkacon.com 019 * 020 * For further information about OpenCms, please see the 021 * project website: http://www.opencms.org 022 * 023 * You should have received a copy of the GNU Lesser General Public 024 * License along with this library; if not, write to the Free Software 025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 026 */ 027 028package org.opencms.gwt.shared; 029 030import org.opencms.util.CmsUUID; 031 032import java.util.Map; 033 034import com.google.gwt.user.client.rpc.IsSerializable; 035 036/** 037 * Runtime data bean for prefetching.<p> 038 * 039 * @since 8.0.0 040 */ 041public class CmsCoreData implements IsSerializable { 042 043 /** A enumeration for the ADE context. */ 044 public enum AdeContext { 045 046 /** Context for classic direct edit provider. */ 047 editprovider, 048 049 /** Context for gallery dialog. */ 050 gallery, 051 052 /** Context for container page. */ 053 pageeditor, 054 055 /** Context for publish dialog. */ 056 publish, 057 058 /** Context for resource info dialog. */ 059 resourceinfo, 060 061 /** Context for sitemap. */ 062 sitemapeditor 063 } 064 065 /** The available client modules. */ 066 public enum ModuleKey { 067 068 /** Container page editor. */ 069 containerpage, 070 071 /** Content editor. */ 072 contenteditor, 073 074 /** Direct edit provider. */ 075 editprovider, 076 077 /** Galleries. */ 078 galleries, 079 080 /** Post upload dialog. */ 081 postupload, 082 083 /** Properties dialog. */ 084 properties, 085 086 /** Publish dialog. */ 087 publish, 088 089 /** Sitemap editor. */ 090 sitemap, 091 092 /** Upload dialog. */ 093 upload 094 } 095 096 /** 097 * Bean class containing info about the current user.<p> 098 */ 099 public static class UserInfo implements IsSerializable { 100 101 /** True if the user is an administrator. */ 102 private boolean m_isAdmin; 103 104 /** True if the user is a category manager. */ 105 private boolean m_isCategoryManager; 106 107 /** True if the user is a template developer. */ 108 private boolean m_isDeveloper; 109 110 /** True if the user is managed. */ 111 private boolean m_isManaged; 112 113 /** True if the user is a workplace user. */ 114 private boolean m_isWorkplaceUser; 115 116 /** The user name. */ 117 private String m_name; 118 119 /** The user icon path. */ 120 private String m_userIcon; 121 122 /** 123 * Creates a new instance.<p> 124 * 125 * @param name the user name 126 * @param userIcon the user icon path 127 * @param isAdmin true if the user is an administrator 128 * @param isDeveloper true if the user is a template developer 129 * @param isCategoryManager true if the user is a category manager 130 * @param isWorkplaceUser true if the user is a workplace user 131 * @param isManaged true if the user is managed 132 */ 133 public UserInfo( 134 String name, 135 String userIcon, 136 boolean isAdmin, 137 boolean isDeveloper, 138 boolean isCategoryManager, 139 boolean isWorkplaceUser, 140 boolean isManaged) { 141 142 m_isDeveloper = isDeveloper; 143 m_isCategoryManager = isCategoryManager; 144 m_isAdmin = isAdmin; 145 m_isManaged = isManaged; 146 m_isWorkplaceUser = isWorkplaceUser; 147 m_name = name; 148 m_userIcon = userIcon; 149 } 150 151 /** 152 * Default constructor, needed for serialization.<p> 153 */ 154 protected UserInfo() { 155 156 // empty 157 } 158 159 /** 160 * Gets the user name.<p> 161 * 162 * @return the user name 163 */ 164 public String getName() { 165 166 return m_name; 167 } 168 169 /** 170 * Returns the user icon path.<p> 171 * 172 * @return the user icon path 173 */ 174 public String getUserIcon() { 175 176 return m_userIcon; 177 } 178 179 /** 180 * Returns true if the user is an administrator.<p> 181 * 182 * @return true if the user is an administrator 183 */ 184 public boolean isAdmin() { 185 186 return m_isAdmin; 187 } 188 189 /** 190 * Returns true if the user is a category manager.<p> 191 * 192 * @return true if the user is a category manager 193 */ 194 public boolean isCategoryManager() { 195 196 return m_isCategoryManager; 197 } 198 199 /** 200 * Returns true if the user is a template developer.<p> 201 * 202 * @return true if the user is a template developer 203 */ 204 public boolean isDeveloper() { 205 206 return m_isDeveloper; 207 } 208 209 /** 210 * Returns if the user is managed.<p> 211 * 212 * @return <code>true</code> if the user is managed 213 */ 214 public boolean isManaged() { 215 216 return m_isManaged; 217 } 218 219 /** 220 * Returns true if the current user is a workplace user.<p> 221 * 222 * @return true if the current user is a workplace user 223 */ 224 public boolean isWorkplaceUser() { 225 226 return m_isWorkplaceUser; 227 } 228 } 229 230 /** Name of the used js variable. */ 231 public static final String DICT_NAME = "org_opencms_gwt"; 232 233 /** The key for the GWT build id property. */ 234 public static final String KEY_GWT_BUILDID = "gwt.buildid"; 235 236 /** The meta element name to the requested module key. */ 237 public static final String META_PARAM_MODULE_KEY = "opencms-module"; 238 239 /** The parameter name for path. */ 240 public static final String PARAM_PATH = "path"; 241 242 /** The parameter name for the return code. */ 243 public static final String PARAM_RETURNCODE = "returncode"; 244 245 /** The time sent from the server when loading the data. */ 246 protected long m_serverTime; 247 248 /** A bean with information about the current user. */ 249 protected UserInfo m_userInfo; 250 251 /** The link to the page displayed in the "about" dialog. */ 252 private String m_aboutLink; 253 254 /** ADE parameters. */ 255 private Map<String, String> m_adeParameters; 256 257 /** The category base folder. */ 258 private String m_categoryBaseFolder; 259 260 /** The XML content editor back-link URL. */ 261 private String m_contentEditorBacklinkUrl; 262 263 /** The XML content editor URL. */ 264 private String m_contentEditorUrl; 265 266 /** The default link to use for opening the workplace. */ 267 private String m_defaultWorkplaceLink; 268 269 /** The embedded dialogs URL. */ 270 private String m_embeddedDialogsUrl; 271 272 /** The mappings of file extensions to resource types. */ 273 private Map<String, String> m_extensionMapping; 274 275 /** The file explorer link. */ 276 private String m_fileExplorerLink; 277 278 /** True if deactivated types should be hidden in the gallery dialog. */ 279 private boolean m_hideDisabledGalleryTypes; 280 281 /** The resource icon mapping. */ 282 private Map<String, String> m_iconMapping; 283 284 /** The show editor help flag. */ 285 private boolean m_isShowEditorHelp; 286 287 /** Keep-alive setting. */ 288 private boolean m_keepAlive; 289 290 /** The current request locale. */ 291 private String m_locale; 292 293 /** The login JSP URL. */ 294 private String m_loginURL; 295 296 /** Max number of locale buttons in the editor. */ 297 private int m_maxLocaleButtons; 298 299 /** The current navigation URI. */ 300 private String m_navigationUri; 301 302 /** The project id. */ 303 private CmsUUID m_projectId; 304 305 /** The shared folder. */ 306 private String m_sharedFolder; 307 308 /** The current site root. */ 309 private String m_siteRoot; 310 311 /** The structure id of the resource. */ 312 private CmsUUID m_structureId; 313 314 /** The data for the TinyMCE editor. */ 315 private CmsTinyMCEData m_tinymce; 316 317 /** A flag which indicates whether the toolbar should be shown initially. */ 318 private boolean m_toolbarVisible; 319 320 /** Flag indicating whether upload buttons should be disabled. */ 321 private boolean m_uploadDisabled; 322 323 /** The maximum file size for the upload. */ 324 private long m_uploadFileSizeLimit; 325 326 /** The upload restriction data. */ 327 private CmsUploadRestrictionInfo m_uploadRestriction; 328 329 /** The current uri. */ 330 private String m_uri; 331 332 /** The OpenCms VFS prefix. */ 333 private String m_vfsPrefix; 334 335 /** Flag which indicates whether the user should be warned when editing a reused element. */ 336 private boolean m_warnWhenEditingReusedElement; 337 338 /** The workplaces resources path prefix. */ 339 private String m_workplaceResourcesPrefix; 340 341 /** The current workplace locale. */ 342 private String m_wpLocale; 343 344 /** 345 * Constructor.<p> 346 */ 347 public CmsCoreData() { 348 349 // empty 350 } 351 352 /** 353 * Clone constructor.<p> 354 * 355 * @param clone the instance to clone 356 */ 357 public CmsCoreData(CmsCoreData clone) { 358 359 this( 360 clone.getContentEditorUrl(), 361 clone.getContentEditorBacklinkUrl(), 362 clone.getLoginURL(), 363 clone.getVfsPrefix(), 364 clone.getFileExplorerLink(), 365 clone.getWorkplaceResourcesPrefix(), 366 clone.getEmbeddedDialogsUrl(), 367 clone.getSiteRoot(), 368 clone.getSharedFolder(), 369 clone.getProjectId(), 370 clone.getLocale(), 371 clone.getWpLocale(), 372 clone.getUri(), 373 clone.getNavigationUri(), 374 clone.getStructureId(), 375 clone.getExtensionMapping(), 376 clone.getIconMapping(), 377 clone.getServerTime(), 378 clone.isShowEditorHelp(), 379 clone.isToolbarVisible(), 380 clone.getDefaultWorkplaceLink(), 381 clone.getAboutLink(), 382 clone.getUserInfo(), 383 clone.getUploadFileSizeLimit(), 384 clone.isKeepAlive(), 385 clone.isUploadDisabled(), 386 clone.m_adeParameters, 387 clone.m_uploadRestriction, 388 clone.m_categoryBaseFolder, 389 clone.m_hideDisabledGalleryTypes, 390 clone.m_warnWhenEditingReusedElement); 391 setTinymce(clone.getTinymce()); 392 setMaxLocaleButtons(clone.m_maxLocaleButtons); 393 } 394 395 /** 396 * Constructor.<p> 397 * 398 * @param contentEditorUrl the XML content editor URL 399 * @param contentEditorBacklinkUrl the XML content editor back-link URL 400 * @param loginUrl the login JSP URL 401 * @param vfsPrefix the OpenCms VFS prefix 402 * @param fileExplorerLink the file explorer link 403 * @param workplaceResourcesPrefix the workplace resources path prefix 404 * @param embeddedDialogsUrl the embedded dialogs URL 405 * @param siteRoot the current site root 406 * @param sharedFolder the shared folder 407 * @param projectId the project id 408 * @param locale the current request locale 409 * @param wpLocale the workplace locale 410 * @param uri the current uri 411 * @param structureId the structure id of tbe resource 412 * @param navigationUri the current navigation URI 413 * @param extensionMapping the mappings of file extensions to resource types 414 * @param iconMapping the resource icon mapping 415 * @param serverTime the current time 416 * @param isShowEditorHelp the show editor help flag 417 * @param toolbarVisible a flag to indicate whether the toolbar should be visible initially 418 * @param defaultWorkplaceLink the default link to use for opening the workplace 419 * @param aboutLink the link to the "About" page 420 * @param userInfo information about the current user 421 * @param uploadFileSizeLimit the file upload size limit 422 * @param isKeepAlive the keep-alive mode 423 * @param uploadDisabled true if upload buttons should be disabled 424 * @param adeParameters the map of ADE configuration parameters 425 * @param uploadRestriction the upload restriction data 426 * @param categoryBaseFolder the category base folder 427 * @param hideDisabledGalleryTypes true if deactivated types should be hidden in the gallery dialog 428 * @param warnWhenEditingReusedElement true if a warning dialog should be shown when editing a reused element 429 */ 430 public CmsCoreData( 431 String contentEditorUrl, 432 String contentEditorBacklinkUrl, 433 String loginUrl, 434 String vfsPrefix, 435 String fileExplorerLink, 436 String workplaceResourcesPrefix, 437 String embeddedDialogsUrl, 438 String siteRoot, 439 String sharedFolder, 440 CmsUUID projectId, 441 String locale, 442 String wpLocale, 443 String uri, 444 String navigationUri, 445 CmsUUID structureId, 446 Map<String, String> extensionMapping, 447 Map<String, String> iconMapping, 448 long serverTime, 449 boolean isShowEditorHelp, 450 boolean toolbarVisible, 451 String defaultWorkplaceLink, 452 String aboutLink, 453 UserInfo userInfo, 454 long uploadFileSizeLimit, 455 boolean isKeepAlive, 456 boolean uploadDisabled, 457 Map<String, String> adeParameters, 458 CmsUploadRestrictionInfo uploadRestriction, 459 String categoryBaseFolder, 460 boolean hideDisabledGalleryTypes, 461 boolean warnWhenEditingReusedElement) { 462 463 m_contentEditorUrl = contentEditorUrl; 464 m_contentEditorBacklinkUrl = contentEditorBacklinkUrl; 465 m_loginURL = loginUrl; 466 m_vfsPrefix = vfsPrefix; 467 m_workplaceResourcesPrefix = workplaceResourcesPrefix; 468 m_embeddedDialogsUrl = embeddedDialogsUrl; 469 m_siteRoot = siteRoot; 470 m_projectId = projectId; 471 m_locale = locale; 472 m_wpLocale = wpLocale; 473 m_uri = uri; 474 m_navigationUri = navigationUri; 475 m_extensionMapping = extensionMapping; 476 m_iconMapping = iconMapping; 477 m_serverTime = serverTime; 478 m_isShowEditorHelp = isShowEditorHelp; 479 m_toolbarVisible = toolbarVisible; 480 m_structureId = structureId; 481 m_defaultWorkplaceLink = defaultWorkplaceLink; 482 m_aboutLink = aboutLink; 483 m_userInfo = userInfo; 484 m_uploadFileSizeLimit = uploadFileSizeLimit; 485 m_keepAlive = isKeepAlive; 486 m_adeParameters = adeParameters; 487 m_fileExplorerLink = fileExplorerLink; 488 m_uploadDisabled = uploadDisabled; 489 m_uploadRestriction = uploadRestriction; 490 m_sharedFolder = sharedFolder; 491 m_categoryBaseFolder = categoryBaseFolder; 492 m_hideDisabledGalleryTypes = hideDisabledGalleryTypes; 493 m_warnWhenEditingReusedElement = warnWhenEditingReusedElement; 494 } 495 496 /** 497 * Gets the "About" link.<p> 498 * 499 * @return the "about" link 500 */ 501 public String getAboutLink() { 502 503 return m_aboutLink; 504 } 505 506 /** 507 * Gets the map of ADE configuration parameters.<p> 508 * 509 * @return the ADE configuration parameters 510 */ 511 public Map<String, String> getAdeParameters() { 512 513 return m_adeParameters; 514 } 515 516 /** 517 * Gets the category folder name. 518 * 519 * @return the category folder name 520 */ 521 public String getCategoryBaseFolder() { 522 523 return m_categoryBaseFolder; 524 } 525 526 /** 527 * Returns the XML content editor back-link URL.<p> 528 * 529 * @return the XML content editor back-link URL 530 */ 531 public String getContentEditorBacklinkUrl() { 532 533 return m_contentEditorBacklinkUrl; 534 } 535 536 /** 537 * Returns the XML content editor URL.<p> 538 * 539 * @return the XML content editor URL 540 */ 541 public String getContentEditorUrl() { 542 543 return m_contentEditorUrl; 544 } 545 546 /** 547 * Gets the default link to use for opening the workplace.<p> 548 * 549 * @return the default workplace link 550 */ 551 public String getDefaultWorkplaceLink() { 552 553 return m_defaultWorkplaceLink; 554 } 555 556 /** 557 * Returns the embeddedDialogsUrl.<p> 558 * 559 * @return the embeddedDialogsUrl 560 */ 561 public String getEmbeddedDialogsUrl() { 562 563 return m_embeddedDialogsUrl; 564 } 565 566 /** 567 * Returns the extensionMapping.<p> 568 * 569 * @return the extensionMapping 570 */ 571 public Map<String, String> getExtensionMapping() { 572 573 return m_extensionMapping; 574 } 575 576 /** 577 * Returns the resource icon mapping.<p> 578 * 579 * @return the resource icon mapping 580 */ 581 public Map<String, String> getIconMapping() { 582 583 return m_iconMapping; 584 } 585 586 /** 587 * Returns the current request locale.<p> 588 * 589 * @return the current request locale 590 */ 591 public String getLocale() { 592 593 return m_locale; 594 } 595 596 /** 597 * Returns the login URL.<p> 598 * 599 * @return the login URL 600 */ 601 public String getLoginURL() { 602 603 return m_loginURL; 604 } 605 606 /** 607 * Gets the maximum number of locale buttons to display in the editor. 608 * 609 * @return the maximum number of locale buttons to display in the editor 610 */ 611 public int getMaxLocaleButtons() { 612 613 return m_maxLocaleButtons; 614 } 615 616 /** 617 * Returns the current navigation (sitemap) URI.<p> 618 * 619 * @return the current navigation URI 620 */ 621 public String getNavigationUri() { 622 623 return m_navigationUri; 624 } 625 626 /** 627 * Gets the project id. 628 * 629 * @return the project id 630 */ 631 public CmsUUID getProjectId() { 632 633 return m_projectId; 634 } 635 636 /** 637 * Returns the time of the server when the data was loaded.<p> 638 * 639 * @return the time of the server when the data was loaded 640 */ 641 public long getServerTime() { 642 643 return m_serverTime; 644 } 645 646 /** 647 * Gets the shared folder. 648 * 649 * @return the shared folder 650 */ 651 public String getSharedFolder() { 652 653 return m_sharedFolder; 654 } 655 656 /** 657 * Returns the current site root.<p> 658 * 659 * @return the current site root 660 */ 661 public String getSiteRoot() { 662 663 return m_siteRoot; 664 } 665 666 /** 667 * Gets the structure id of the current resource.<p> 668 * 669 * @return the structure id of the current resource 670 */ 671 public CmsUUID getStructureId() { 672 673 return m_structureId; 674 } 675 676 /** 677 * Gets the data for the TinyMCE editor.<p> 678 * 679 * @return the data for TinyMCE 680 */ 681 public CmsTinyMCEData getTinymce() { 682 683 // TODO Auto-generated method stub 684 return m_tinymce; 685 } 686 687 /** 688 * Returns the file upload size limit.<p> 689 * 690 * @return the file upload size limit 691 */ 692 public long getUploadFileSizeLimit() { 693 694 return m_uploadFileSizeLimit; 695 } 696 697 /** 698 * Gets the upload restriction data. 699 * 700 * @return the upload restriction data 701 */ 702 public CmsUploadRestrictionInfo getUploadRestriction() { 703 704 return m_uploadRestriction; 705 } 706 707 /** 708 * Returns the current uri.<p> 709 * 710 * @return the current uri 711 */ 712 public String getUri() { 713 714 return m_uri; 715 } 716 717 /** 718 * Gets the information about the current user.<p> 719 * 720 * @return the information about the current user 721 */ 722 public UserInfo getUserInfo() { 723 724 return m_userInfo; 725 } 726 727 /** 728 * Returns the OpenCms VFS prefix.<p> 729 * 730 * @return the OpenCms VFS prefix 731 */ 732 public String getVfsPrefix() { 733 734 return m_vfsPrefix; 735 } 736 737 /** 738 * Returns the workplace resources path prefix.<p> 739 * 740 * @return the workplace resources path prefix 741 */ 742 public String getWorkplaceResourcesPrefix() { 743 744 return m_workplaceResourcesPrefix; 745 } 746 747 /** 748 * Gets the language part of the workplace locale. 749 * 750 * @return the language part of the workplace locale 751 */ 752 public String getWpLanguage() { 753 754 String locale = getWpLocale(); 755 String result = locale; 756 int underscorePos = locale.indexOf("_"); 757 if (underscorePos > -1) { 758 result = locale.substring(0, underscorePos); 759 } 760 return result; 761 } 762 763 /** 764 * Returns the current workplace locale.<p> 765 * 766 * @return the current workplace locale 767 */ 768 public String getWpLocale() { 769 770 return m_wpLocale; 771 } 772 773 /** 774 * Returns true if deactivated types should be hidden in the gallery dialog. 775 * 776 * @return true if deactivated types should be hidden 777 */ 778 public boolean isHideDisabledGalleryTypes() { 779 780 return m_hideDisabledGalleryTypes; 781 } 782 783 /** 784 * Returns true if the session should be kept alive even without user actions.<p> 785 * 786 * @return true if keep-alive mode is active 787 */ 788 public boolean isKeepAlive() { 789 790 return m_keepAlive; 791 } 792 793 /** 794 * Returns the show editor help flag.<p> 795 * 796 * @return the show editor help flag 797 */ 798 public boolean isShowEditorHelp() { 799 800 return m_isShowEditorHelp; 801 } 802 803 /** 804 * Returns true if the toolbar should be visible initially.<p> 805 * 806 * @return true if the toolbar should be visible initially 807 */ 808 public boolean isToolbarVisible() { 809 810 return m_toolbarVisible; 811 } 812 813 /** 814 * Checks if uploads are disabled. 815 * 816 * @return true if uploads are disabled 817 */ 818 public boolean isUploadDisabled() { 819 820 return m_uploadDisabled; 821 822 } 823 824 /** 825 * Checks if a warning dialog should be shown when a reused element is edited. 826 * 827 * @return true if a warning dialog should be shown when editing reused elements 828 */ 829 public boolean isWarnWhenEditingReusedElement() { 830 831 return m_warnWhenEditingReusedElement; 832 } 833 834 /** 835 * Sets the maximum number of locale buttons to display in the editor. 836 * 837 * @param maxLocaleButtons the max number of locale buttons to display in the editor 838 */ 839 public void setMaxLocaleButtons(int maxLocaleButtons) { 840 841 m_maxLocaleButtons = maxLocaleButtons; 842 } 843 844 /** 845 * Sets the data for the TinyMCE editor.<p> 846 * 847 * @param tinyMceData the data for TinyMCE 848 */ 849 public void setTinymce(CmsTinyMCEData tinyMceData) { 850 851 m_tinymce = tinyMceData; 852 } 853 854 /** 855 * Enables/disables warning dialog when editing reused elements. 856 * 857 * @param warnWhenEditingReusedElement true if a warning dialog should be shown when editing reused elements 858 */ 859 public void setWarnWhenEditingReusedElement(boolean warnWhenEditingReusedElement) { 860 861 m_warnWhenEditingReusedElement = warnWhenEditingReusedElement; 862 } 863 864 /** 865 * Returns the file explorer link prefix. Append resource site path for complete link.<p> 866 * 867 * @return the file explorer link prefix 868 */ 869 protected String getFileExplorerLink() { 870 871 return m_fileExplorerLink; 872 } 873 874 /** 875 * Sets the show editor help flag.<p> 876 * 877 * @param show <code>true</code> to show editor help 878 */ 879 protected void setShowEditorHelp(boolean show) { 880 881 m_isShowEditorHelp = show; 882 } 883}