+
+ Get('auth_user');
+ $sAuthPwd = $this->Get('auth_pwd');
+ $sEncryptedCredentials = base64_encode("$sAuthUser:$sAuthPwd");
+
+ $aHeaders[] = "Authorization: Basic $sEncryptedCredentials";
+
+ return $aHeaders;
+ }
+]]>
+
+ Get('token');
+ $aHeaders[] = "Auth-Token: " . $sToken;
+
+ return $aHeaders;
+}
+]]>
+
+ EnrichHeader($this, $aHeaders);
+
+ return $aHeaders;
+ }
+]]>
+
+ GetRemoteApplicationConnection();
+ }
+]]>
+
+ Set('headers', 'Content-type: application/json');
+ }
+]]>
+
+ SetNotificationLanguage();
+
+ // Surround with try/catch to make sure to restore user language in case of crash and don't contaminate the rest of the app.
+ try {
+ // Get web request parameters
+ // - URL
+ $sURL = $this->PrepareURL($aContextArgs, $oLog);
+ if (!is_null($oLog))
+ {
+ $oLog->Set('webhook_url', ($sURL !== null) ? $sURL : 'No test URL provided');
+ }
+ // - Method
+ $sMethod = $this->PrepareMethod($aContextArgs, $oLog);
+ // - Headers
+ $aHeaders = $this->PrepareHeaders($aContextArgs, $oLog);
+ if (!is_null($oLog))
+ {
+ $this->LogHeaders($this->Get('headers'), $aHeaders, $oLog);
+ $this->TruncateLogAttributeForDB($oLog, 'headers');
+ }
+ // - Payload
+ // ... Force payload to be prepared from callback in the method of this class (avoid polymorphic inheritance)
+ if ($this->HasPreparePayloadCallback()) {
+ $payload = self::PreparePayload($aContextArgs, $oLog);
+ }
+ // ... Payload can be prepared using the polymorphic inheritance
+ else {
+ $payload = $this->PreparePayload($aContextArgs, $oLog);
+ }
+ if (!is_null($oLog))
+ {
+ $this->LogPayload($this->Get('payload'), $payload, $oLog);
+ $this->TruncateLogAttributeForDB($oLog, 'payload');
+ }
+ } catch (Exception $oException) {
+ throw $oException;
+ } finally {
+ // Switch back to current user language
+ $this->SetNotificationLanguage($sPreviousLanguage, $aPreviousPluginProperties['language_code'] ?? null);
+ }
+
+ // Get module parameters
+ $sConnectionTimeoutInSeconds = MetaModel::GetModuleSetting('combodo-webhook-integration', 'timeout', \Combodo\iTop\Service\WebRequestSender::DEFAULT_CONNECTION_TIMEOUT_IN_SECONDS);
+
+ // Prepare cURL options
+ $aCURLOptions = array(
+ CURLOPT_RETURNTRANSFER => true,
+ CURLOPT_CUSTOMREQUEST => strtoupper($sMethod),
+ // Note: We pass headers as a cURL option to avoid bug N°3267 in \utils::DoPostRequest()
+ CURLOPT_HTTPHEADER => $aHeaders,
+ CURLOPT_CONNECTTIMEOUT => $sConnectionTimeoutInSeconds,
+ CURLOPT_POSTFIELDS => $payload,
+ );
+
+ // Actually send payload for POST and PUT requests
+ switch ($sMethod) {
+ case 'post':
+ case 'put':
+ $aCURLOptions[CURLOPT_POST] = true;
+ break;
+ }
+
+ // Certificate options
+ // - Should we check its validity?
+ if (MetaModel::GetModuleSetting('combodo-webhook-integration', 'certificate_check', true))
+ {
+ $aCURLOptions[CURLOPT_SSL_VERIFYPEER] = true;
+ $aCURLOptions[CURLOPT_SSL_VERIFYHOST] = 2;
+ }
+ else
+ {
+ $aCURLOptions[CURLOPT_SSL_VERIFYPEER] = false;
+ $aCURLOptions[CURLOPT_SSL_VERIFYHOST] = 0;
+ }
+ // - Location of CA certificate file
+ $sCACertFile = MetaModel::GetModuleSetting('combodo-webhook-integration', 'ca_certificate_file', '');
+ if (!empty($sCACertFile))
+ {
+ // The name of a file containing a PEM formatted certificate.
+ $aCURLOptions[CURLOPT_SSLCERT] = $sCACertFile;
+ }
+
+ $oWebRequest = new \Combodo\iTop\Core\WebRequest($sURL);
+ $oWebRequest->SetOptions($aCURLOptions);
+
+ return $oWebRequest;
+ }
+]]>
+
+ GetRemoteApplicationConnection();
+
+ // Get URL
+ if($oRemoteApplicationConnection !== null)
+ {
+ $sURL = MetaModel::ApplyParams($oRemoteApplicationConnection->Get('url').$this->Get('path'), $aContextArgs);
+ }
+ elseif($this->IsBeingTested())
+ {
+ $sURL = null;
+ }
+ else
+ {
+
+ throw new Exception('Action should have at least one webhook URL set!');
+ }
+
+ return $sURL;
+ }
+]]>
+
+ Get('method');
+ }
+]]>
+
+ Get('headers'), $aContextArgs);
+ $aLines = preg_split('/\r\n|\r|\n/', $sHeadersAsText);
+ foreach ($aLines as $sLine) {
+ $sLine = trim($sLine);
+ if (empty($sLine)) {
+ continue;
+ }
+
+ $aHeaders[] = $sLine;
+ }
+
+ if (count($aHeaders) === 0) {
+ $aHeaders[] = 'Content-type: application/json';
+ }
+
+ // Retrieve connection, to let it add some extra headers (e.g. authentication)
+ $oRemoteApplicationconnection = $this->GetRemoteApplicationConnection();
+ $aExtraHeaders = $oRemoteApplicationconnection->PrepareHeaders($aContextArgs, $oLog);
+
+ foreach($aExtraHeaders as $sExtraHeader)
+ {
+ $aHeaders[] = $sExtraHeader;
+ }
+
+ return $aHeaders;
+ }
+]]>
+
+ Get('prepare_payload_callback');
+ if (empty($sCallbackFQCN))
+ {
+ // Convert / encode payload depending on the content-type header
+ $sContentType = null;
+ $aHeaders = $this->PrepareHeaders($aContextArgs, $oLog);
+ $sContentType = $this->GetContentType($aHeaders);
+
+ switch ($sContentType) {
+ case 'application/json':
+ // Apply params to payload recursively, to send properly encoded JSON
+ $payload = $this->ApplyParamsToJson($aContextArgs, $this->Get('payload'));
+ break;
+
+ default:
+ $payload = MetaModel::ApplyParams($this->Get('payload'), $aContextArgs);
+ break;
+ }
+ }
+ else
+ {
+ /** @var \DBObject $oTriggeringObject */
+ $oTriggeringObject = $aContextArgs['this->object()'];
+
+ $oCallBack = new Combodo\iTop\Service\CallbackService($sCallbackFQCN);
+ $oCallBack->CheckCallbackSignature(get_class($oTriggeringObject), ['array', EventNotification::class, ActionWebhook::class]);
+ $oCallBack->Invoke($oTriggeringObject, [$aContextArgs, $oLog, $this]);
+ }
+
+ return $payload;
+ }
+]]>
+
+ ObfuscateRawHeader($sAuthHeaderObfuscated);
+ $sObfuscatedPreparedHeaders = Combodo\iTop\Service\WebRequestService::GetInstance()->ObfuscateRawHeader(implode("\n", $aPreparedHeaders));
+
+ $oLog->Set('headers', "Raw:\n".$sObfuscatedRawHeaders."\n\nAfter preparation:\n".$sObfuscatedPreparedHeaders);
+ }
+]]>
+
+ Set('payload', "Raw:\n".$sRawPayload."\n\nAfter preparation:\n".$sPreparedPayload);
+ }
+]]>
+
+ $value) {
+ $sPreparedKey = MetaModel::ApplyParams($sKey, $aContextArgs);
+ $aPreparedData[$sPreparedKey] = $this->ApplyParamsToValue($aContextArgs, $value);
+ }
+
+ return $aPreparedData;
+ }
+]]>
+
+ ApplyParamsToArray($aContextArgs, $value) : (is_string($value) ? MetaModel::ApplyParams($value, $aContextArgs) : $value);
+ return $preparedValue;
+ }
+]]>
+
+ get_class($this),
+ 'action_id' => $this->GetKey(),
+ 'action_name' => $this->Get('name'),
+ 'payload' => $sInputAsJson,
+ 'json_last_error' => json_last_error(),
+ 'json_last_error_msg' => json_last_error_msg(),
+ ];
+ IssueLog::Error('Webhook Action failed: Wrong JSON format for input', $sLogChannel, $aLogContext);
+
+ throw new Combodo\iTop\Core\Notification\Action\Webhook\Exception\WebhookInvalidJsonValueException('Wrong JSON format for input, see error log for more information.');
+ }
+ $aJsonInputAsArray = $this->ApplyParamsToValue($aContextArgs, $aJsonInputAsArray);
+ $sJsonWithReplacedPlaceholders = json_encode($aJsonInputAsArray);
+
+ return $sJsonWithReplacedPlaceholders;
+ }
+]]>
+
+ IsBeingTested() ? 'test_remoteapplicationconnection_id' : 'remoteapplicationconnection_id';
+ $sID = $this->Get($sAttCode);
+
+ /** @var \AttributeExternalKey $oAttDef */
+ $oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
+ $sClass = $oAttDef->GetTargetClass();
+
+ return MetaModel::GetObject($sClass, $sID, false, true);
+ }
+]]>
+
+ Get('prepare_payload_callback')) > 0;
+ }
+]]>
+
+ Get('process_response_callback')) > 0;
+ }
+]]>
+
+
+
+ GetMaxSize();
+ $sFitText = $oLog->Get($sAttCode);
+ $sEndingText = '[TRUNCATED]';
+ // Note: We don't use mb_* functions as we don't want to cut after a whole character but after a certain byte length
+ if ($iMaxSize && (strlen($sFitText) > $iMaxSize))
+ {
+ $sFitText = substr($sFitText, 0, $iMaxSize - strlen($sEndingText)) . $sEndingText;
+ $oLog->Set($sAttCode, $sFitText);
+ }
+ }
+]]>
+
+
+ function(Combodo\iTop\Service\Events\EventData $oEventData)
+ {
+ if (trim($this->Get('payload')) === '') {
+ return ;
+ }
+ try {
+ Combodo\iTop\Core\Notification\Action\_ActionWebhook::JsonDecodeWithError($this->Get('payload'));
+ } catch(Combodo\iTop\Core\Notification\Action\Webhook\Exception\WebhookInvalidJsonValueException $e) {
+ $this->AddCheckIssue(Dict::S('Class:ActionWebhook/Error:InvalidJSONFormatForPayload'));
+ }
+ }
+
+ Set("headers", "Content-type: application/x-www-form-urlencoded");
+ }
+]]>
+
+ GetRemoteApplicationConnection();
+
+ // Retrieve basis parameters
+ $aParameters = array(
+ 'version' => MetaModel::ApplyParams($oRemoteApplicationConnection->Get('version'), $aContextArgs),
+ 'json_data' => $this->ApplyParamsToJson($aContextArgs, $this->Get('payload')), // Apply params to payload recursively
+ );
+
+ foreach($aParameters as $sParamName => $sParamValue)
+ {
+ if(empty($sParamValue))
+ {
+ throw new Exception('Missing at least of the following mandatory parameters: '.implode(', ', array_keys($aParameters)));
+ }
+ }
+
+ // Transform array to HTTP query parameters (eg. https://target-url?version=XXX&json_data=XXX)
+ return http_build_query($aParameters);
+ }
+]]>
+
+
+
+ array(),
+ );
+
+ // Prepare basis message
+ $sMessage = static::TransformHTMLToSlackMarkup(MetaModel::ApplyParams($this->Get('message'), $aContextArgs));
+ if(!empty($sMessage))
+ {
+ $aSlackBlocks['blocks'][] = array(
+ 'type' => 'section',
+ 'text' => array(
+ 'type' => 'mrkdwn',
+ 'text' => $sMessage,
+ ),
+ );
+ }
+
+ // Prepare extra attributes
+ $aBlock = $this->PrepareExtraAttributesForBlockKit($aContextArgs);
+ if(!empty($aBlock))
+ {
+ $aSlackBlocks['blocks'][] = $aBlock;
+ }
+
+ // Prepare user information
+ if($this->Get('include_user_info') === 'yes')
+ {
+ $aSlackBlocks['blocks'][] = $this->PrepareUserInfoForBlockKit($aContextArgs);
+ }
+
+ // Prepare action buttons
+ $aBlock = $this->PrepareActionsForBlockKit($aContextArgs);
+ if(!empty($aBlock))
+ {
+ $aSlackBlocks['blocks'][] = $aBlock;
+ }
+
+ return json_encode($aSlackBlocks);
+ }
+]]>
+
+ object()'];
+ $sObjClass = get_class($oObject);
+
+ // Retrieve attributes
+ $aListItems = MetaModel::GetZListItems($sObjClass, $this->Get('include_list_attributes'));
+
+ // No attributes in the list
+ if(empty($aListItems))
+ {
+ return null;
+ }
+
+ // Prepare block structure
+ $aBlock = array(
+ 'type' => 'section',
+ 'fields' => array(),
+ );
+
+ foreach($aListItems as $sAttCode)
+ {
+ $oAttDef = MetaModel::GetAttributeDef($sObjClass, $sAttCode);
+ // We have to decode HTML entities as they are added on the value by \AttributeDefinition::GetAsHtml()
+ $sValueAsHtml = html_entity_decode($oObject->GetAsHtml($sAttCode), ENT_QUOTES, 'UTF-8');
+ $aBlock['fields'][] = array(
+ 'type' => 'mrkdwn',
+ 'text' => sprintf("*%s*\n%s", $oAttDef->GetLabel(), static::TransformHTMLToSlackMarkup($sValueAsHtml)),
+ );
+ }
+
+ return $aBlock;
+ }
+]]>
+
+ GetContactObject() ?: $oUser;
+
+ $sContactClass = get_class($oContact);
+ $sContactClassLabel = MetaModel::GetName($sContactClass);
+ $sContactName = $oContact->GetName();
+ $sContactUrl = ApplicationContext::MakeObjectUrl($sContactClass, $oContact->GetKey(), null, false);
+
+ $aBlock = array(
+ 'type' => 'context',
+ 'elements' => array(
+ array(
+ 'type' => 'mrkdwn',
+ 'text' => Dict::Format('ActionSlackNotification:Payload:BlockKit:UserInfo', $sContactName, $sContactUrl, $sContactClassLabel),
+ ),
+ ),
+ );
+
+ return $aBlock;
+ }
+]]>
+
+ object()'];
+ $sObjClass = get_class($oObject);
+ $iObjID = $oObject->GetKey();
+
+ $sBaseURL = utils::GetAbsoluteUrlAppRoot();
+
+ // Modify button
+ if($this->Get('include_modify_button') === 'yes')
+ {
+ $aActionElements[] = array(
+ 'type' => 'button',
+ 'text' => array(
+ 'type' => 'plain_text',
+ 'text' => Dict::S('UI:Menu:Modify'),
+ ),
+ 'action_id' => 'modify',
+ 'url' => sprintf('%spages/UI.php?operation=modify&class=%s&id=%d', $sBaseURL, $sObjClass, $iObjID),
+ 'style' => 'primary',
+ );
+ }
+
+ // Other actions buttons (transitions)
+ $sIncludeOtherActionsButton = $this->Get('include_other_actions_button');
+ if($sIncludeOtherActionsButton !== 'no')
+ {
+ $aTransitions = $oObject->EnumTransitions();
+ $aStimuli = MetaModel::EnumStimuli($sObjClass);
+ if ($sIncludeOtherActionsButton == 'yes')
+ {
+ $aAllowedStimuli = array_keys($aTransitions);
+ }
+ else
+ {
+ $aAllowedStimuli = preg_split('/\s*,\s*/', $this->Get('specified_other_actions'));
+ }
+
+ // Note: We don't filter stimuli on user rights, it's up to the notification creator
+ // to tailored it regarding the recipients.
+ foreach ($aAllowedStimuli as $sStimulusCode)
+ {
+ if (isset($aTransitions[$sStimulusCode]) && is_a($aStimuli[$sStimulusCode], StimulusUserAction::class))
+ {
+ $aActionElements[] = array(
+ 'type' => 'button',
+ 'text' => array(
+ 'type' => 'plain_text',
+ 'text' => $aStimuli[$sStimulusCode]->GetLabel(),
+ ),
+ 'action_id' => $sStimulusCode,
+ 'url' => sprintf('%spages/UI.php?operation=stimulus&stimulus=%s&class=%s&id=%d', $sBaseURL, $sStimulusCode, $sObjClass, $iObjID),
+ );
+ }
+ }
+ }
+
+ // Delete button
+ if($this->Get('include_delete_button') === 'yes')
+ {
+ $aActionElements[] = array(
+ 'type' => 'button',
+ 'text' => array(
+ 'type' => 'plain_text',
+ 'text' => Dict::S('UI:Menu:Delete'),
+ ),
+ 'action_id' => 'delete',
+ 'url' => sprintf('%spages/UI.php?operation=delete&class=%s&id=%d', $sBaseURL, $sObjClass, $iObjID),
+ 'style' => 'danger',
+ );
+ }
+
+ // Prepare block
+ $aBlock = (empty($aActionElements)) ? null : array(
+ 'type' => 'actions',
+ 'elements' => $aActionElements,
+ );
+
+ return $aBlock;
+ }
+]]>
+
+ #i', "\n" ],
+ [ ['##i', '#
#i'], ['', "\n"] ],
+ [ ['##i', '# #i'], ['*', "*\n"] ],
+ [ ['#<(strong|b)>#i', '##i'], '*' ],
+ [ ['#<(em|i)>#i', '##i'], '_' ],
+ [ ['#<(del|s)>#i', '##i'], '~' ],
+ [ ['##i', '# #i'], ['• ', "\n"] ],
+ [ ['#(]*>)?#i', '#(
)?#i'], ['```', "```\n"] ],
+ [ ['#<(mark[^>]*|code)>#i', '##i'], '`' ],
+ );
+
+ // Replace HTML tags (list must contain at least tags from the $aReplacementsMatrix)
+ $sContent = strip_tags($sContent, '');
+ foreach($aReplacementsMatrix as $aReplacements)
+ {
+ $sContent = preg_replace($aReplacements[0], $aReplacements[1], $sContent);
+ }
+
+ // Replace hyperlinks
+ preg_match_all('/<\s*a.*?href\s*=\s*(?:\"|\')(.*?)(?:\"|\')[^>]*>(.*?)<\s*?\/\s*?a\s*?>/i', $sContent, $aResult);
+ for($iIdx = 0; $iIdx < count($aResult[0]); $iIdx++) {
+ $sContent = str_replace($aResult[0][$iIdx], '<'.$aResult[1][$iIdx].'|'.$aResult[2][$iIdx].'>', $sContent);
+ }
+
+ // Replace users and groups IDs to ensure they don't have HTML entities
+ // Note: As an input, only HTML entities IDs (eg. "<@U123ABC>") are supported as raw IDs (eg. "<@U123ABC>") will be considered unexpected tags and be removed by the `strip_tags()` above.
+ $sContent = preg_replace('/<([!@].*?)>/', '<$1>', $sContent);
+
+ return $sContent;
+ }
+]]>
+
+ static::TransformHTMLToRocketChatMarkup(MetaModel::ApplyParams($this->Get('message'), $aContextArgs)),
+ 'attachments' => array(),
+ );
+
+ // Bot information
+ $aBotAttCodes = array('bot_alias' => 'alias', 'bot_url_avatar' => 'avatar', 'bot_emoji_avatar' => 'emoji');
+ foreach($aBotAttCodes as $sBotAttCode => $sPropCode)
+ {
+ $sPropValue = MetaModel::ApplyParams($this->Get($sBotAttCode), $aContextArgs);
+ if(empty($sPropValue) === false)
+ {
+ $aData[$sPropCode] = $sPropValue;
+ }
+ }
+
+ return json_encode($aData);
+ }
+]]>
+
+ ', '
', '
'), "\n" ),
+ array( array('', '
'), array('*', '*') ),
+ array( array('', '
'), array('*', '*') ),
+ array( array('', '
'), array('*', '*') ),
+ array( array('', ''), array('*', '*') ),
+ array( array('', ''), array('*', '*') ),
+ array( array('', ''), array('_', '_') ),
+ array( array('', ''), array('_', '_') ),
+ array( array('', ''), array('~', '~') ),
+ array( array('', ''), array('~', '~') ),
+ array( array('', ' '), array('• ', '') ),
+ array( array('', ''), array('`', '`') ),
+ array( array('', '
'), array('```', '```') ),
+ );
+
+ // Replace HTML tags
+ $sContent = strip_tags($sContent, '
');
+ foreach($aReplacementsMatrix as $aReplacements)
+ {
+ $sContent = str_replace($aReplacements[0], $aReplacements[1], $sContent);
+ }
+
+ // Replace hyperlinks
+ preg_match_all('/<\s*a.*?href\s*=\s*(?:\"|\')(.*?)(?:\"|\')[^>]*>(.*?)<\s*?\/\s*?a\s*?>/i', $sContent, $aResult);
+ for($iIdx = 0; $iIdx < count($aResult[0]); $iIdx++) {
+ $sContent = str_replace($aResult[0][$iIdx], '<'.$aResult[1][$iIdx].'|'.$aResult[2][$iIdx].'>', $sContent);
+ }
+
+ return $sContent;
+ }
+]]>
+
MetaModel::ApplyParams($this->Get('message'), $aContextArgs),
+ );
+
+ return json_encode($aData);
+ }
+]]>
+
+ Get('json_format');
+ return match ($sJsonFormat) {
+ 'message_card' => $this->PreparePayloadMessageCard($aContextArgs),
+ 'adaptive_card' => $this->PreparePayloadAdaptiveCard($aContextArgs),
+ default => throw new Exception('Unknown json_format ($sJsonFormat)'),
+ };
+ }
+]]>
+
+ 'MessageCard',
+ '@context' => 'http://schema.org/extensions',
+ );
+ $aSections = array(
+ array(), // First section initialized for easier code below, but will be unset if empty at the end of the processing
+ );
+ $aPotentialActions = array();
+
+ // Prepare theme
+ // - Color
+ $sThemeColor = MetaModel::ApplyParams($this->Get('theme_color'), $aContextArgs);
+ if (strlen($sThemeColor) > 0) {
+ $aData['themeColor'] = $sThemeColor;
+ }
+ // - Image
+ $sImageUrl = MetaModel::ApplyParams($this->Get('image_url'), $aContextArgs);
+ if (strlen($sImageUrl) > 0) {
+ $aSections[0]['activityImage'] = $sImageUrl;
+ }
+
+ // Prepare title
+ $sTitle = MetaModel::ApplyParams($this->Get('title'), $aContextArgs);
+ if (strlen($sTitle) > 0) {
+ // For summary
+ $aData['summary'] = $sTitle;
+
+ // For activity title
+ $aSections[0]['activityTitle'] = $sTitle;
+ }
+
+ // Prepare message
+ // Note: For now we don't convert HTML to Markdown as it is more limited on Teams end (and easier for us 😁)
+ $sMessage = MetaModel::ApplyParams($this->Get('message'), $aContextArgs);
+ if (strlen($sMessage) > 0) {
+ $aSections[0]['activitySubtitle'] = $sMessage;
+ }
+
+ // Prepare extra attributes
+ $aFacts = $this->PrepareExtraAttributesForMSTeamsAPI($aContextArgs);
+ if(false === empty($aFacts))
+ {
+ $aSections[0]['facts'] = $aFacts;
+ }
+
+ // Add sections to data
+ if (false === empty($aSections[0])) {
+ $aData['sections'] = $aSections;
+ }
+
+ // Prepare action buttons
+ $aActions = $this->PrepareActionsForMSTeamsAPI($aContextArgs);
+ if(false == empty($aActions))
+ {
+ $aData['potentialAction'] = $aActions;
+ }
+
+ return json_encode($aData);
+ }
+]]>
+
+ 'message',
+ ];
+
+ // Prepare theme
+ // - Color
+ // TODO: Not possible with adaptive card, you only could use accents
+ // "default", "emphasis", "good", "attention", "warning","accent"
+ $sContainerStyle = null;
+ $sThemeColor = MetaModel::ApplyParams($this->Get('theme_color'), $aContextArgs);
+ if (in_array($sThemeColor, ["default", "emphasis", "good", "attention", "warning","accent"])) {
+ $sContainerStyle = $sThemeColor;
+ }
+
+ // - Image
+ $aImageBlock = null;
+ $sImageUrl = MetaModel::ApplyParams($this->Get('image_url'), $aContextArgs);
+ if (strlen($sImageUrl) > 0) {
+ $aImageBlock = [
+ "type" => "Image",
+ "style" => "person",
+ "url" => $sImageUrl,
+ "size" => "small"
+ ];
+ }
+
+ // Prepare title
+ $aTitleBlock = null;
+ $sTitle = MetaModel::ApplyParams($this->Get('title'), $aContextArgs);
+ if (strlen($sTitle) > 0) {
+ // For summary
+ $aData['summary'] = $sTitle;
+ $aTitleBlock = [
+ "type" => "TextBlock",
+ "size" => "Medium",
+ "weight" => "Bolder",
+ "text" => $sTitle
+ ];
+ }
+
+ // Prepare message
+ $aMessageBlock = null;
+ $sMessage = MetaModel::ApplyParams($this->Get('message'), $aContextArgs);
+ if (strlen($sMessage) > 0) {
+ $aMessageBlock = [
+ "type" => "TextBlock",
+ "text" => static::TransformHTMLToMSTeamsMarkup($sMessage, 'adaptive_card'),
+ "wrap" => true
+ ];
+ }
+
+ // Prepare extra attributes
+ $aFactsBlock = null;
+ $aFacts = $this->PrepareExtraAttributesForMSTeamsAPI($aContextArgs, 'adaptive_card');
+ if(!empty($aFacts))
+ {
+ $aFactsBlock = [
+ "type" => "FactSet",
+ "facts" => $aFacts
+ ];
+ }
+
+ // Prepare items
+ $aItems = [];
+
+ // Add Header to items
+ if($aImageBlock)
+ {
+ $aItems[] = [
+ "type" => "ColumnSet",
+ "columns" => [
+ [
+ "type" => "Column",
+ "items" => [
+ $aImageBlock
+ ]
+ ],
+ [
+ "type" => "Column",
+ "items" => [
+ $aTitleBlock
+ ]
+ ]
+ ]
+ ];
+ }
+ else
+ {
+ $aItems[] = $aTitleBlock;
+ }
+
+ // Add Message to items
+ if($aMessageBlock)
+ {
+ $aItems[] = $aMessageBlock;
+ }
+ // Add Facts to items
+ if($aFactsBlock)
+ {
+ $aItems[] = $aFactsBlock;
+ }
+
+ // Prepare action buttons
+ $aActions = $this->PrepareActionsForMSTeamsAPI($aContextArgs, 'adaptive_card');
+
+ // Add attachments to data
+ $aData['attachments'] = [
+ [
+ 'contentType' => 'application/vnd.microsoft.card.adaptive',
+ 'content' => [
+ 'type' => 'AdaptiveCard',
+ '$schema'=> 'https://adaptivecards.io/schemas/adaptive-card.json',
+ 'version' => '1.5',
+ 'body' => [
+ [
+ 'type' => 'Container',
+ 'items' => $aItems,
+ 'style' => $sContainerStyle ?? 'default'
+ ]
+ ],
+ 'actions' => $aActions
+ ]
+ ]
+ ];
+
+ return json_encode($aData);
+ }
+]]>
+
+ object()'];
+ $sObjClass = get_class($oObject);
+
+ // Retrieve attributes
+ $aListItems = MetaModel::GetZListItems($sObjClass, $this->Get('include_list_attributes'));
+
+ // No attributes in the list
+ if(empty($aListItems))
+ {
+ return array();
+ }
+
+ // Prepare facts structure
+ $aFacts = array();
+
+ // Check format in oder to build the appropriate structure
+ $sLabelKey = match ($sJsonFormat) {
+ 'message_card' => 'name',
+ 'adaptive_card' => 'title',
+ default => throw new Exception('Extra Attributes only supported for format "message_card" or "adaptive_card"'),
+ };
+
+ foreach($aListItems as $sAttCode)
+ {
+ $oAttDef = MetaModel::GetAttributeDef($sObjClass, $sAttCode);
+ // We have to decode HTML entities as they are added on the value by \AttributeDefinition::GetAsHtml()
+ $sValueAsHtml = utils::HtmlEntityDecode($oObject->GetAsHtml($sAttCode));
+ $aFacts[] = array(
+ $sLabelKey => $oAttDef->GetLabel(),
+ 'value' => static::TransformHTMLToMSTeamsMarkup($sValueAsHtml, $sJsonFormat),
+ );
+ }
+
+ return $aFacts;
+ }
+]]>
+
+ object()'];
+ $sObjClass = get_class($oObject);
+ $iObjID = $oObject->GetKey();
+
+ $sBaseURL = utils::GetAbsoluteUrlAppRoot();
+
+ // Modify button
+ if($this->Get('include_modify_button') === 'yes')
+ {
+ $aActionElements[] = $this->PrepareActionElementForMSTeamsAPI(
+ Dict::S('UI:Menu:Modify'),
+ sprintf('%spages/UI.php?operation=modify&class=%s&id=%d', $sBaseURL, $sObjClass, $iObjID),
+ $sJsonFormat
+ );
+ }
+
+ // Other actions buttons (transitions)
+ $sIncludeOtherActionsButton = $this->Get('include_other_actions_button');
+ if($sIncludeOtherActionsButton !== 'no')
+ {
+ $aTransitions = $oObject->EnumTransitions();
+ $aStimuli = MetaModel::EnumStimuli($sObjClass);
+ if ($sIncludeOtherActionsButton == 'yes')
+ {
+ $aAllowedStimuli = array_keys($aTransitions);
+ }
+ else
+ {
+ $aAllowedStimuli = preg_split('/\s*,\s*/', $this->Get('specified_other_actions'));
+ }
+
+ // Note: We don't filter stimuli on user rights, it's up to the notification creator
+ // to tailored it regarding the recipients.
+ foreach ($aAllowedStimuli as $sStimulusCode)
+ {
+ if (isset($aTransitions[$sStimulusCode]) && is_a($aStimuli[$sStimulusCode], StimulusUserAction::class))
+ {
+ $aActionElements[] = $this->PrepareActionElementForMSTeamsAPI(
+ $aStimuli[$sStimulusCode]->GetLabel(),
+ sprintf('%spages/UI.php?operation=stimulus&stimulus=%s&class=%s&id=%d', $sBaseURL, $sStimulusCode, $sObjClass, $iObjID),
+ $sJsonFormat
+ );
+ }
+ }
+ }
+
+ // Delete button
+ if($this->Get('include_delete_button') === 'yes')
+ {
+ $aActionElements[] = $this->PrepareActionElementForMSTeamsAPI(
+ Dict::S('UI:Menu:Delete'),
+ sprintf('%spages/UI.php?operation=delete&class=%s&id=%d', $sBaseURL, $sObjClass, $iObjID),
+ $sJsonFormat
+ );
+ }
+
+ return $aActionElements;
+ }
+]]>
+
+ [
+ '@type' => 'OpenUri',
+ 'name' => $sLabel,
+ 'targets' => [
+ [
+ 'os' => 'default',
+ 'uri' => $sUrl,
+ ],
+ ],
+ ],
+ 'adaptive_card' => [
+ "type" => "Action.OpenUrl",
+ "title" => $sLabel,
+ "url" => $sUrl
+ ],
+ default => throw new Exception('Action Elements only supported for format "message_card" or "adaptive_card"'),
+ };
+ }
+]]>
+
+ ', '
', '
'), "\n\n"),
+ array(array('', ''), array('**', '**')),
+ array(array('', ''), array('**', '**')),
+ array(array('', ''), array('_', '_')),
+ array(array('', ''), array('_', '_')),
+ array(array('', ''), array('~', '~')),
+ array(array('', ''), array('~', '~')),
+ array(array('', ' '), array('-', '')),
+ );
+
+ if ($sJsonFormat === 'adaptive_card') {
+ $aReplacementsMatrix[] = array(array('', '
'), array('**', "**\n\n"));
+ $aReplacementsMatrix[] = array(array('', '
'), array('**', "**\n\n"));
+ $aReplacementsMatrix[] = array(array('', '
'), array('**', "**\n\n"));
+ $aReplacementsMatrix[] = array(array(''), "\n\n"); // new line instead of carriage return (which does not seem to be supported)
+ $aReplacementsMatrix[] = array(array(''), '');
+ }
+
+ // Replace HTML tags (list must contain at least tags from the $aReplacementsMatrix)
+ $sAllowedTags = $sJsonFormat === 'message_card' ?
+ '
'
+ :
+ '
'; // code/pre blocs not supported in adaptive_card
+ $sContent = strip_tags($sContent, $sAllowedTags); // what about unkown tags ?
+
+ foreach ($aReplacementsMatrix as $aReplacements) {
+ $sContent = str_replace($aReplacements[0], $aReplacements[1], $sContent);
+ }
+
+ // Replace hyperlinks
+ preg_match_all('/<\s*a.*?href\s*=\s*(?:\"|\')(.*?)(?:\"|\')[^>]*>(.*?)<\s*?\/\s*?a\s*?>/i', $sContent, $aResult);
+ for ($iIdx = 0; $iIdx < count($aResult[0]); $iIdx++) {
+ $sContent = str_replace($aResult[0][$iIdx], '['.$aResult[2][$iIdx].']('.$aResult[1][$iIdx].')', $sContent);
+ }
+
+ return $sContent;
+ }
+]]>
+