Редактирование InvitationMembersCommon (режим вики)

Редактировать
Режимы редактирования
Создать
Управление
Действия
- Экспорт
- Предварительный просмотр
Просмотр

Родитель (скрыть)

Название

Содержание

{{velocity}}
#*
 * Invitation Application
 * This document contains common macros used by all documents in the Invitation Application which are 
 * only available to wiki members.
 *
 * Macros in this script don't rely on any variables except those which are passed to them and the following:
 *
 * $doc the com.xpn.xwiki.api.Document object representing the document containing this code.
 * $msg the internationalization message provider containing a get(String) and a get(String, List) function
 * $xcontext the com.xpn.xwiki.Context object for this request
 * $xwiki an object of the com.xpn.xwiki.api.XWiki class.
 * $escapetool an object of class org.apache.velocity.tools.generic.EscapeTool
 *
 * Macros also depend on other macros but only other macros which are contained in this script.
 *###
#if($doc.documentReference.name == 'InvitationMembersCommon')
  #set ($linkTarget = "${doc.getSpace()}.WebHome")
  #set ($linkTarget = $services.rendering.escape($linkTarget, 'xwiki/2.1'))
  {{info}}$services.localization.render('xe.invitation.internalDocument', [$linkTarget]){{/info}}
#end
##
#*
 * Display a table of messages.
 *
 * $messages (Collection<XObject>) the messages to view.
 *
 * $fieldsToDisplay (List<String>) fields which should be displayed.
 *   Options include: sendingUser, subjectLine, status, memo, recipient and _checkbox
 *   using the _checkbox option will create a checkbox which is named the message id number.
 *   the _history option will provide a link to view the memo log for the message.
 *
 * $asAdmin (Boolean) should the links point to displaying for admin or user (NOT FOR SECURITY)
 *
 * $numberOfRecipientsByMessage (Map<Integer, XObject>) the number of recipients for a given message (Optional)
 *                                                      if specified and recipient field is set in $fieldsToDisplay
 *                                                      then messages with multiple recipients will say "X recipients".
 *
 *###
#macro(displayMessageTable, $messages, $fieldsToDisplay, $asAdmin, $numberOfRecipientsByMessage)
  #if(!$messages || $messages.size() < 1)
    {{info}}$services.localization.render('xe.invitation.displayMessageTable.noMessages'){{/info}}
  #else

(%class="message-table"%)(((
     #set($checkboxCount = 0)
     #foreach($field in $fieldsToDisplay)
       #if($field == '_history')
         |=(%class="history"%)$services.localization.render('xe.invitation.displayMessageTable.history')##
       #elseif($field == '_checkbox')
         |=(%class="checkboxcol"%)##
       #elseif($field == 'recipient' || $field == 'sentDate')
       ## We need to prevent tables from overflowing
       ## unfortunately it makes displayMessageTable aware of the properties of a message.
         |=(%class="$field"%)$services.localization.render("xe.invitation.displayMessageTable.${field}")##
       #else
         |=$services.localization.render("xe.invitation.displayMessageTable.${field}")##
       #end
     #end

#foreach($message in $messages)
       #foreach($field in $fieldsToDisplay)
         #if($field == 'sendingUser')
           |[[$escapetool.xml($message.getProperty("$field").getValue())]]##
         #elseif($field == 'subjectLine')
           #set ($inspectValue = 'group')
           #if ($asAdmin)
             #set ($inspectValue = "${inspectValue}AsAdmin")
           #end
           #set ($queryString = $escapetool.url({
             'inspect': $inspectValue,
             'messageID': $message.getProperty('messageID').getValue()
           }))
           |[[$escapetool.xml($message.getProperty('subjectLine').getValue())>>$doc.getFullName()||queryString="$queryString"]]##
         #elseif($field == 'status'
                 && $numberOfRecipientsByMessage
                 && $numberOfRecipientsByMessage.get($message.get('recipient'))
                 && $numberOfRecipientsByMessage.get($message.get('recipient')) > 1)
           |$services.localization.render('xe.invitation.displayMessageTable.various')
         #elseif($field == 'status')
           |#messageStatusForCode($message.getProperty('status').getValue())##
         #elseif($field == 'recipient'
                 && $numberOfRecipientsByMessage
                 && $numberOfRecipientsByMessage.get($message.get('recipient'))
                 && $numberOfRecipientsByMessage.get($message.get('recipient')) > 1)
           |$services.localization.render('xe.invitation.displayMessageTable.multipleRecipients',
                     [$numberOfRecipientsByMessage.get($message.get('recipient'))])
         #elseif($field == '_checkbox')
           |<label for="messageCheckboxID$checkboxCount" class='sr-only'>
             $escapetool.xml($services.localization.render('xe.invitation.displayMessageTable.checkbox.input.label'))
           </label>
           <input type="checkbox" id="messageCheckboxID$checkboxCount" name="messageID"
            value="$message.getProperty('messageID').getValue()" ##
           #set($checkboxCount = $checkboxCount + 1)
           ## If there is only one message in the group, add the convenience of checking the box by default.
           #if($messages.size() == 1)
             checked="checked" ##
           #end
           />##
         #elseif($field == '_history')
           #set ($inspectValue = 'history')
           #if ($asAdmin)
             #set ($inspectValue = "${inspectValue}AsAdmin")
           #end
           #set ($queryString = $escapetool.url({
             'inspect': $inspectValue,
             'messageID': $message.getProperty('messageID').getValue()
           }))
           |[[$services.localization.render('xe.invitation.displayMessageTable.history')>>##
              $doc.getFullName()||queryString="$queryString"]]##
         #else
           |$services.rendering.escape($message.display($field, 'view') , $doc.syntax)##
         #end
       #end

#end##foreach message in mail
    )))## end of class message-table
  #end##if there is mail
#end##macro
##
#*
 * Display some tools for users and admins (if applicable).
 *
 * $mail (Map<String, XObject>) map of messages by their ID.
 *
 * $parameterMap (Map<String, String>) map obtained by calling getParameterMap on the servlet request object.
 *
 * $isAdmin (Boolean) should administrative tools be displayed?
 *
 * $config (Map<String, String>) configuration for invitation application.
 *###
#macro(invitationFooter, $mail, $parameterMap, $isAdmin, $config)
  ## Clear the float:left which puts elements side by side.
  #if($parameterMap && $parameterMap.get('inspect') && $parameterMap.get('inspect').size() > 0)
    #set($inspect = $parameterMap.get('inspect').get(0))
  #end
  (%class="clearboth" id=invitation-footer%)(((

## User Tools
   = $services.localization.render('xe.invitation.tools.heading') =
   ## Invite friends.
   #if($doc.getFullName() != $config.get('mainPage') || $parameterMap.size() > 0)
     * [[$services.localization.render('xe.invitation.tools.senderLink')>>$config.get('mainPage')]]
   #else
     * **$services.localization.render('xe.invitation.tools.senderLink')**
   #end
   ## My invitations
   #if($inspect != 'all')
     * [[$services.localization.render('xe.invitation.tools.myInvitationsLink')>>$config.get('membersActionsPage')||queryString='inspect=all']] ##
     #if($inspect == 'group')

** **$services.localization.render('xe.invitation.tools.invitationsInGroup')**
     #else
       #set($messagesByMe = [])
       #getMessagesBySender($mail.values(), $xcontext.getUser(), $messagesByMe)
       #set($myPendingInvitations = [])
       #getMessagesByStatus($messagesByMe, 'pending', $myPendingInvitations)
       #if($myPendingInvitations.size() > 0)
         (%id="my-pending-invitations"%){{info}}$myPendingInvitations.size() pending{{/info}}(%%)##
       #end
       ## If viewing message history then show history brelow group.
       #if($inspect == 'history')

#set ($queryString = $escapetool.url({
          'inspect': 'group',
          'messageID': $parameterMap.get('messageID').get(0)
        }))
         ** [[$services.localization.render('xe.invitation.tools.invitationsInGroup')>>$config.get('membersActionsPage')||queryString="$queryString"]]
         *** **$services.localization.render('xe.invitation.tools.invitationHistory')**##
       #end

#end
   #else
     * **$services.localization.render('xe.invitation.tools.myInvitationsLink')**
   #end
   #if($isAdmin)
     ## Administrative Tools

= $services.localization.render('xe.invitation.adminTools.heading') =
     ##
     ## Warn the user if guests are unable to be invited.
     #if("#canGuestAcceptInvitation($xwiki.getDocument($config.get('guestsActionsPage')))" != 'true')
       {{error}}$services.localization.render('xe.invitation.guestsCanNotJoin', [$config.get('guestsActionsPage')]){{/error}}

#end
     ## Click here to configure the friend inviter
     * {{html}}<a href="$xwiki.getURL('XWiki.XWikiPreferences', 'admin', 'admin=globaladmin&section=Invitation')">##
         $services.localization.render('xe.invitation.adminTools.configureLink')##
       </a>{{/html}}
     ## View all invitations
     #if($inspect != 'allAsAdmin')
       * [[$services.localization.render('xe.invitation.adminTools.allInvitationsLink')>>$config.get('membersActionsPage')||queryString='inspect=allAsAdmin']] ##
       #set($spamReports = [])
       #getMessagesByStatus($mail.values(), 'reported', $spamReports)
       #if($spamReports.size() > 0)
         (%id="spam-reports"%){{warning}}$spamReports.size() reported as spam{{/warning}}(%%)##
       #end

#if($inspect == 'groupAsAdmin')
         ** **$services.localization.render('xe.invitation.tools.invitationsInGroup')**
       #elseif($inspect == 'historyAsAdmin')
         #set ($queryString = $escapetool.url({
             'inspect': 'groupAsAdmin',
             'messageID': $parameterMap.get('messageID').get(0)
           }))
         ** [[$services.localization.render('xe.invitation.tools.invitationsInGroup')>>$config.get('membersActionsPage')||queryString="$queryString"]]
         *** **$services.localization.render('xe.invitation.tools.invitationHistory')**
       #end
     #else
       ## Inspect all as admin is selected.
       * **$services.localization.render('xe.invitation.adminTools.allInvitationsLink')**
     #end
   #end
  )))
#end
##
#*
 * Get only messages by a given sender
 *
 * $messages (Collection<XObject>) the messages to search though.
 *
 * $sender (String) the name of the user (document name) who sent the message.
 *
 * $messagesOut (List<XObject>) will be populated with messages which are sent by $user
 *###
#macro(getMessagesBySender, $messages, $sender, $messagesOut)
  #foreach($message in $messages)
    #if($sender == $message.getProperty('sendingUser').getValue())
      #set($discard = $messagesOut.add($message))
    #end
  #end
#end
##
#*
 * Get only messages with a given status code.
 *
 * $messages (Collection<XObject>) the messages to search though.
 *
 * $status (String) the status code for the messages to get.
 *
 * $messagesOut (List<XObject>) will be populated with messages which are sent by $user
 *###
#macro(getMessagesByStatus, $messages, $status, $messagesOut)
  #foreach($message in $messages)
    #if($status == $message.getProperty('status').getValue())
      #set($discard = $messagesOut.add($message))
    #end
  #end
#end
##
#*
 * Get a "breadcrumb trail" based on the way users are expected to navigate through the members' actions.
 * Each entry in the list is a link except for the last (which is the page the user is currently on)
 * output might look like ['[[Invitation]]', '[[My invitations]]', 'Invitations in this message group']
 * * [[output]] denotes that the output is a link.
 *
 * $parameterMap (Map<String, String>) map obtained by calling getParameterMap on the servlet request object.
 *
 * $config (Map<String, String>) configuration for invitation application.
 *
 * $trail (List<String>) this list will be populated with entries into the breadcrumb trail.
 *###
#macro(getInvitationBreadcrumbTrail, $parameterMap, $config, $trail)
  #if($parameterMap && $parameterMap.get('inspect') && $parameterMap.get('inspect').size() > 0)
    #set($inspect = $parameterMap.get('inspect').get(0))
  #end
  ##
  #if($doc.getFullName() == $config.get('mainPage'))
    ## Invitation
    #set($discard = $trail.add($services.localization.render('xe.invitation.heading')))
  #else
    #set($discard = $trail.add("[[$services.localization.render('xe.invitation.heading')>>$config.get('mainPage')]]"))
    #if($doc.getFullName() == $config.get('membersActionsPage'))
      ##
      ## Administration
      #if($inspect.contains('AsAdmin'))
        #if($inspect == 'allAsAdmin')
          ## [[Invitation]]  -->  All invitations
          #set($discard = $trail.add($services.localization.render('xe.invitation.adminTools.allInvitationsLink')))
        #else
          #set ($queryString = $escapetool.url({ 'inspect': 'allAsAdmin' }))
          #set($allAsAdminLink = "[[$services.localization.render('xe.invitation.adminTools.allInvitationsLink')"
            + ">>$config.get('membersActionsPage')||queryString='$queryString']]")
          #set($discard = $trail.add($allAsAdminLink))
          #if($inspect == 'groupAsAdmin')
            ## [[Invitation]]  -->  [[All invitations]]  -->  Invitations in group
            #set($discard = $trail.add($services.localization.render('xe.invitation.tools.invitationsInGroup')))
          #elseif($inspect == 'historyAsAdmin')
            ## [[Invitation]]  -->  [[All invitations]]  -->  [[Invitations in group]]  -->  History of this invitation
            #set ($queryString = $escapetool.url({
             'inspect': 'groupAsAdmin',
             'messageID': $parameterMap.get('messageID').get(0)
            }))
            #set($allInGroupAsAdminLink = "[[$services.localization.render('xe.invitation.tools.invitationsInGroup')>>"
                                          + "$config.get('membersActionsPage')||queryString='$queryString']]")
            #set($discard = $trail.add($allInGroupAsAdminLink))
            #set($discard = $trail.add($services.localization.render('xe.invitation.tools.invitationHistory')))
          #end
        #end
      ##
      ## For user.
      #else
        #if($inspect == 'all')
          ## [[Invitation]] --> My Invitations
          #set($discard = $trail.add($services.localization.render('xe.invitation.tools.myInvitationsLink')))
        #else
          #set($myInvitationsLink = "[[$services.localization.render('xe.invitation.tools.myInvitationsLink')>>"
                                    + "$config.get('membersActionsPage')||queryString='inspect=all']]")
          #set($discard = $trail.add($myInvitationsLink))
          #if($inspect == 'group')
            #set($discard = $trail.add($services.localization.render('xe.invitation.tools.invitationsInGroup')))
          #else
            #set ($queryString = $escapetool.url({
             'inspect': 'group',
             'messageID': $parameterMap.get('messageID').get(0)
            }))
            #set($myInvitationsinGroupLink = "[[$services.localization.render('xe.invitation.tools.invitationsInGroup')>>"
                                             + "$config.get('membersActionsPage')||queryString='$queryString']]")
            #set($discard = $trail.add($myInvitationsinGroupLink))
            #if($inspect == 'history')
              #set($discard = $trail.add($services.localization.render('xe.invitation.tools.invitationHistory')))
            #end
          #end
        #end## If not inspect 'all'
      #end## If not inspecting as admin
    #end## If we're on InvitationMemberActions
  #end## If we're not on the main page
#end## Macro
##
#*
 * Display the header for at the top of the page.
 *
 * $parameterMap (Map<String, String>) map obtained by calling getParameterMap on the servlet request object.
 *
 * $config (Map<String, String>) configuration for invitation application.
 *###
#macro(displayInvitationHeader, $parameterMap, $config)
  #set($breadcrumbTrail = [])
  #getInvitationBreadcrumbTrail($parameterMap, $config, $breadcrumbTrail)
  #if($breadcrumbTrail.size() > 0)
    = $breadcrumbTrail.get($mathtool.add($breadcrumbTrail.size(), -1)) =
  #end
#end
{{/velocity}}

Несущественное изменение

Информация о документе

Справка по синтаксису XWiki

Редактирование заголовка и содержимого InvitationMembersCommon

Информация о документе

Справка по синтаксису XWiki