Wiki source code of Get in Touch About Your XWiki Project
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{velocity wiki="false"}} | ||
| 2 | #if ($xcontext.action == 'get') | ||
| 3 | #set ($statusCode = 400) | ||
| 4 | #set ($message = 'The request could not be sent. Please try again or contact Agnease by email at alex@agnease.com.') | ||
| 5 | |||
| 6 | #set ($className = 'Agnease.Code.ContactRequest.ContactRequestClass') | ||
| 7 | #set ($allowedProperties = [ | ||
| 8 | 'scope', | ||
| 9 | 'alreadyUseXWiki', | ||
| 10 | 'name', | ||
| 11 | 'email', | ||
| 12 | 'hosting', | ||
| 13 | 'customDevelopment', | ||
| 14 | 'timeline', | ||
| 15 | 'users' | ||
| 16 | ]) | ||
| 17 | |||
| 18 | #set ($name = '') | ||
| 19 | #set ($email = '') | ||
| 20 | #set ($scope = '') | ||
| 21 | #set ($contactWebsite = '') | ||
| 22 | #set ($startedAtRaw = '') | ||
| 23 | |||
| 24 | ## Extract only the values we need for validation. | ||
| 25 | #foreach ($parameterName in $request.parameterNames) | ||
| 26 | #set ($propertyParts = $parameterName.split('_0_')) | ||
| 27 | #if ($propertyParts.size() > 1) | ||
| 28 | #set ($propertyName = $propertyParts[1]) | ||
| 29 | #set ($propertyValue = $stringtool.trim($request.get($parameterName))) | ||
| 30 | |||
| 31 | #if ($propertyName == 'name') | ||
| 32 | #set ($name = $propertyValue) | ||
| 33 | #elseif ($propertyName == 'email') | ||
| 34 | #set ($email = $propertyValue) | ||
| 35 | #elseif ($propertyName == 'scope') | ||
| 36 | #set ($scope = $propertyValue) | ||
| 37 | #elseif ($propertyName == 'contactWebsite') | ||
| 38 | #set ($contactWebsite = $propertyValue) | ||
| 39 | #elseif ($propertyName == 'contactStartedAt') | ||
| 40 | #set ($startedAtRaw = $propertyValue) | ||
| 41 | #end | ||
| 42 | #end | ||
| 43 | #end | ||
| 44 | |||
| 45 | #set ($spamScore = 0) | ||
| 46 | |||
| 47 | ## Honeypot: real users should never fill this field. | ||
| 48 | #if ("$!contactWebsite" != '') | ||
| 49 | #set ($spamScore = $spamScore + 5) | ||
| 50 | #end | ||
| 51 | |||
| 52 | ## Submission timing check. | ||
| 53 | #if ("$!startedAtRaw" == '') | ||
| 54 | ## The field is expected from the real form, so missing it is suspicious. | ||
| 55 | #set ($spamScore = $spamScore + 2) | ||
| 56 | #else | ||
| 57 | #set ($startedAt = $numbertool.toNumber($startedAtRaw)) | ||
| 58 | #if ("$!startedAt" == '') | ||
| 59 | #set ($spamScore = $spamScore + 2) | ||
| 60 | #else | ||
| 61 | #set ($now = $datetool.systemDate.time) | ||
| 62 | #set ($elapsed = $now - $startedAt) | ||
| 63 | |||
| 64 | ## Reject very fast submissions. | ||
| 65 | #if ($elapsed > 0 && $elapsed < 10000) | ||
| 66 | #set ($spamScore = $spamScore + 3) | ||
| 67 | #end | ||
| 68 | #end | ||
| 69 | #end | ||
| 70 | |||
| 71 | ## Random-looking name: long single token. | ||
| 72 | #if ($name.length() >= 16 && !$name.contains(' ')) | ||
| 73 | #set ($spamScore = $spamScore + 2) | ||
| 74 | #end | ||
| 75 | |||
| 76 | ## Random-looking project description: long single token. | ||
| 77 | #if ($scope.length() >= 12 && !$scope.contains(' ')) | ||
| 78 | #set ($spamScore = $spamScore + 2) | ||
| 79 | #end | ||
| 80 | |||
| 81 | ## Suspicious email local part with many dots and tiny fragments. | ||
| 82 | #set ($emailParts = $email.split('@')) | ||
| 83 | #if ($emailParts.size() == 2) | ||
| 84 | #set ($localPart = $emailParts[0]) | ||
| 85 | #set ($localFragments = $localPart.split('\.')) | ||
| 86 | #set ($dotCount = $localFragments.size() - 1) | ||
| 87 | #set ($oneCharFragments = 0) | ||
| 88 | |||
| 89 | #foreach ($fragment in $localFragments) | ||
| 90 | #if ($fragment.length() == 1) | ||
| 91 | #set ($oneCharFragments = $oneCharFragments + 1) | ||
| 92 | #end | ||
| 93 | #end | ||
| 94 | |||
| 95 | #if ($dotCount >= 4 && $oneCharFragments >= 3) | ||
| 96 | #set ($spamScore = $spamScore + 2) | ||
| 97 | #end | ||
| 98 | #else | ||
| 99 | #set ($spamScore = $spamScore + 2) | ||
| 100 | #end | ||
| 101 | |||
| 102 | ## Human-facing validation. | ||
| 103 | #if ("$!name" == '' && "$!email" == '') | ||
| 104 | #set ($message = 'Please enter your name and email.') | ||
| 105 | #elseif ("$!name" == '') | ||
| 106 | #set ($message = 'Please enter your name.') | ||
| 107 | #elseif ("$!email" == '') | ||
| 108 | #set ($message = 'Please enter your email address.') | ||
| 109 | #elseif ("$!scope" == '' || $scope.length() < 30) | ||
| 110 | #set ($message = 'Please add a short description of your XWiki project, question or issue.') | ||
| 111 | #elseif ($spamScore >= 3) | ||
| 112 | #set ($message = 'The request could not be sent. Please add a clearer description of your XWiki request or contact Agnease by email.') | ||
| 113 | #else | ||
| 114 | #try('contactException') | ||
| 115 | #set ($now = $datetool.get('yyyyMMddHHmm')) | ||
| 116 | #set ($random = $mathtool.random(100000, 999999)) | ||
| 117 | #set ($uniqueName = "ContactRequest-${now}-${random}") | ||
| 118 | #set ($contactRequestDoc = $xwiki.getDocumentAsAuthor('ContactRequests.' + $uniqueName)) | ||
| 119 | #set ($contactRequestObj = $contactRequestDoc.getObject($className, true)) | ||
| 120 | |||
| 121 | ## Save only known ContactRequest fields. | ||
| 122 | #foreach ($parameterName in $request.parameterNames) | ||
| 123 | #set ($propertyParts = $parameterName.split('_0_')) | ||
| 124 | #if ($propertyParts.size() > 1) | ||
| 125 | #set ($propertyName = $propertyParts[1]) | ||
| 126 | |||
| 127 | #if ($allowedProperties.contains($propertyName)) | ||
| 128 | #set ($discard = $contactRequestObj.set($propertyName, $request.get($parameterName))) | ||
| 129 | #end | ||
| 130 | #end | ||
| 131 | #end | ||
| 132 | |||
| 133 | #set ($discard = $contactRequestDoc.saveAsAuthor()) | ||
| 134 | #set ($statusCode = 200) | ||
| 135 | #set ($message = 'Your request was successfully sent.') | ||
| 136 | #end | ||
| 137 | |||
| 138 | #if ("$!contactException" != '') | ||
| 139 | #set ($statusCode = 400) | ||
| 140 | #set ($message = 'The request could not be sent. Please try again or contact Agnease by email.') | ||
| 141 | #end | ||
| 142 | #end | ||
| 143 | |||
| 144 | #set ($discard = $response.setStatus($statusCode)) | ||
| 145 | #jsonResponse({'message': $message}) | ||
| 146 | #end | ||
| 147 | {{/velocity}} | ||
| 148 | |||
| 149 | {{velocity}} | ||
| 150 | #set ($discard = $xwiki.ssx.use('contact.WebHome')) | ||
| 151 | #set ($xobject = $doc.getObject('Agnease.Code.ContactRequest.ContactRequestClass')) | ||
| 152 | #set ($totalRequests = $services.query.xwql('from doc.object(Agnease.Code.ContactRequest.ContactRequestClass) contact').execute()) | ||
| 153 | #set ($xclass = $xobject.xWikiClass) | ||
| 154 | #set ($editing = true) | ||
| 155 | = Tell Us More About Your Project = | ||
| 156 | You do not need to have a full specification. A short description is enough to start the conversation. | ||
| 157 | {{html clean="false"}} | ||
| 158 | You can also <a href="https://calendly.com/alex-agnease/30min?back=1&month=2026-06" target="_blank">book a free XWiki review call</a> to discuss your current setup. | ||
| 159 | <div class="row"> | ||
| 160 | <div class="xform col-md-7"> | ||
| 161 | #if ($totalRequests.size() > 50) | ||
| 162 | ## As a measure to avoid high load on website. | ||
| 163 | Tell us more about your project at <a href="mailto:alex@agnease.com">alex@agnease.com</a> | ||
| 164 | #else | ||
| 165 | <form id="contactForm"> | ||
| 166 | <dl> | ||
| 167 | #foreach ($property in $xclass.properties) | ||
| 168 | #if ($property.name == 'hosting') | ||
| 169 | <hr> | ||
| 170 | <h3>Optional project details</h3> | ||
| 171 | <p>These details help us understand the scope and suggest practical next steps.</p> | ||
| 172 | #end | ||
| 173 | <dt #if (!$editing && $hasEdit) | ||
| 174 | class="editableProperty" | ||
| 175 | #set ($xobjectPropertyReference = $xobject.getPropertyReference($property.name)) | ||
| 176 | data-property="$escapetool.xml($services.model.serialize($xobjectPropertyReference))" | ||
| 177 | data-property-type="object"#end> | ||
| 178 | ## This must match the id generated by the $doc.display() method below. | ||
| 179 | #set ($propertyId = "${xclass.name}_${xobject.number}_$property.name") | ||
| 180 | <label#if ($editing) for="$escapetool.xml($propertyId)"#end> | ||
| 181 | $escapetool.xml($property.translatedPrettyName) | ||
| 182 | </label> | ||
| 183 | ## Support for specifying a translation key as hint in the property definition. | ||
| 184 | <span class="xHint">$!escapetool.xml($services.localization.render($property.hint))</span> | ||
| 185 | </dt> | ||
| 186 | <dd>$doc.display($property.name, 'edit').replace('{{html clean="false" wiki="false"}}', '').replace("{{/html}}", '')</dd> | ||
| 187 | #end | ||
| 188 | #if (!$xclass.properties || $xclass.properties.size() == 0) | ||
| 189 | ## Keep the empty definition term in order to have valid HTML. | ||
| 190 | <dt></dt> | ||
| 191 | <dd>$escapetool.xml($services.localization.render('xclass.defaultObjectSheet.noProperties'))</dd> | ||
| 192 | #end | ||
| 193 | </dl> | ||
| 194 | <p class="xHint">* Your information will only be used to respond to this request.</p> | ||
| 195 | ## Hidden fields to catch requests filled by bots. | ||
| 196 | <div class="contact-hp-wrapper" aria-hidden="true"> | ||
| 197 | <label for="Agnease.Code.ContactRequest.ContactRequestClass_0_contactWebsite">Website</label> | ||
| 198 | <input | ||
| 199 | id="contactWebsite" | ||
| 200 | type="text" | ||
| 201 | name="Agnease.Code.ContactRequest.ContactRequestClass_0_contactWebsite" | ||
| 202 | autocomplete="off" | ||
| 203 | tabindex="-1" | ||
| 204 | /> | ||
| 205 | </div> | ||
| 206 | <input type="hidden" name="Agnease.Code.ContactRequest.ContactRequestClass_0_contactStartedAt" value="$datetool.systemDate.time" /> | ||
| 207 | <input id="contactSubmit" type="submit" class="btn btn-primary" value="Send my request"> | ||
| 208 | </form> | ||
| 209 | #end | ||
| 210 | {{/html}} | ||
| 211 | {{html clean="false" wiki="true"}} | ||
| 212 | <div class="reviewNotifications"> | ||
| 213 | <div class="hidden reviewNotificationSuccess"> | ||
| 214 | |||
| 215 | {{success}}reviewNotification{{/success}} | ||
| 216 | |||
| 217 | </div> | ||
| 218 | <div class="hidden reviewNotificationError"> | ||
| 219 | |||
| 220 | {{error}}reviewNotification{{/error}} | ||
| 221 | |||
| 222 | </div> | ||
| 223 | </div> | ||
| 224 | {{/html}} | ||
| 225 | {{html clean="false"}} | ||
| 226 | </div> | ||
| 227 | <div class="col-md-5"> | ||
| 228 | <div class="widget"> | ||
| 229 | <h4>$services.icon.renderHTML('check') How Agnease can help</h4> | ||
| 230 | <ul> | ||
| 231 | <li>XWiki upgrades and long-term maintenance</li> | ||
| 232 | <li>Knowledge bases, intranets, SOP and documentation workflows</li> | ||
| 233 | <li>Custom XWiki applications and integrations</li> | ||
| 234 | <li>LDAP, SSO, OIDC, SAML, and MFA setup</li> | ||
| 235 | <li>Migrations from SharePoint, Confluence, MediaWiki, or file-based documentation</li> | ||
| 236 | <li>Security-aware reviews and platform stabilization</li> | ||
| 237 | </ul> | ||
| 238 | </div> | ||
| 239 | <div class="widget"> | ||
| 240 | <h4>$services.icon.renderHTML('right') What happens next?</h4> | ||
| 241 | <ol> | ||
| 242 | <li>Your request is reviewed.</li> | ||
| 243 | <li>You receive a reply with clarifying questions or suggested next steps.</li> | ||
| 244 | <li>If useful, we schedule a short call to discuss scope, timeline, and estimated effort.</li> | ||
| 245 | </ol> | ||
| 246 | </div> | ||
| 247 | </div> | ||
| 248 | </div> | ||
| 249 | {{/html}} | ||
| 250 | {{/velocity}} |